对springIOC容器实现的结构分析.docx
《对springIOC容器实现的结构分析.docx》由会员分享,可在线阅读,更多相关《对springIOC容器实现的结构分析.docx(20页珍藏版)》请在冰豆网上搜索。
对springIOC容器实现的结构分析
对springIOC容器实现的结构分析
本文的目标:
从实现的角度来认识SpringIoC容器。
观察的角度:
从外部接口,内部实现,组成部分,执行过程四个方面来认识SpringIoC容器。
本文的风格:
首先列出SpringIoC的外部接口及内部实现所涉及到的组件列表;
其次介绍组件之间的相互关系以对整个执行过程有所把握;
然后针对每一个组件的简单介绍,包括组件的类结构图,核心功能描述,重要接口的重要方法描述;
接下来看SpringIoC容器实现对面向对象基本设计原则的遵守;
最后是后记部分。
术语约定:
组件:
本文中的组件是指在功能概念上具有相对独立性的功能单元,物理结构上的特征一般由一组接口、一组抽象类、一组具体实现类、异常类、工具类所组成;
这里的组件是一种相当狭义的描述,根据上下文的不同,组件可以有不同的表现形式,如:
相对于Spring框架,SpringIoC容器就是Spring框架的一个组件,
相对于系统的整体框架设计,Spring框架就是整体框架的一个组件,这里组件与模块的概念基本等同。
接口方法:
一般定义在接口中,提供给外部调用的方法,接口方法最重要的在于接口提供者以清晰、简洁的定义提供了接口使用者所必需的功能特征;
基础方法:
首先基础方法也是一个接口方法,但和接口方法的差别在于接口方法的直接实现依赖于基础方法(参见BeanDefintionReader接口中的方法定义);
钩子方法:
超类留给子类需要实现或重写的方法,
默认实现钩子方法:
超类提供默认实现,子类可以选择是否有必要重写,
默认空实现钩子方法:
超类提供一个空实现方法,子类可以选择是否有必要重写,
抽象钩子方法:
超类留给子类必须实现的方法,
内部实现方法:
对某一相对独立的处理逻辑的封装,以便增强代码的可读性、可修改性、可重用性,达到代码的清晰性、简洁性。
注:
本文的源代码基于Spring2.x。
Spring的源代码也处于演变中,但对基础代码的影响并不大。
正文:
SpringIoC容器的外部接口:
ApplicationContext
BeanFactory
WebApplicationContext
BeanFactory是IoC容器的核心组件,其它组件都是在为BeanFactory提供服务.
ConfigurableBeanFactory
AutowireCapableBeanFactory
ListableBeanFactory
HierarchicalBeanFactory
AbstractBeanFactory
AbstractAutowireCapableBeanFactory
DefaultListableBeanFactory
SingletonBeanRegistry接口,
BeanDefintionRegistry接口,
Resource组件,
ResourceLoader组件,
BeanDefintion组件,
BeanDefintionReader组件,
XmlBeanDefinitionParser组件,
BeanDefintionParser组件,
NamespaceHandler组件,
NamespaceHandlerResolver组件,
BeanWrapper组件,
------------------------------------------------
ApplicationContext
ConfigurableApplicationContext
AbstractApplicationContext
AbstractRefreshApplicationContext
AbstractXmlApplicationContext
ClassPathXmlApplicationContext
FileSystemXmlApplicationContext
Lifecycle接口
ApplicationEventPublisher接口
ApplicationEventMulticaster组件
MessageSource组件
MessageSourceResolvable组件
-----------------------------------------------
WebApplicationContext
ConfigurableWebApplicationContext
AbstractRefreshWebApplicationContext
XmlWebApplicationContext
ContextLoader组件
ContextLoaderListener
ContextLoaderServlet
------------------------------------------------------------------------------------------
FactoryBean
一组回调接口,
InitializingBean
DisposableBean
BeanPostProcessor
BeanFactoryPostProcessor
BeanNameAware
BeanFactoryAware
ResourceLoaderAware
ApplicationContextPublisherAware
MessageSourceAware
ApplicationContextAware
ApplicationContextAwareProcessor
ServletContextAware
ServletConfigAware
ServletContextAwareProcessor
------------------------------------------------------------------------------------------------
对这三个接口(ApplicationContext、BeanFactory、WebApplicationContext)的讨论:
ApplicationContext接口是IoC容器概念的直接对应物,包括容器自身生命周期的管理(容器的启动,容器的初始化,容器的销毁)
一些便利功能的提供如:
资源文件的读取,容器级事件的发布。
BeanFactory接口是IoC容器的核心,其它组件都为此组件提供支持,如Resource组件,ResourceLoader组件,BeanDefintionReader组件,
BeanDefintion组件,BeanWrapper组件等。
BeanFactory接口相对于容器的概念太过低级,以至于直接使用需要应对较复杂的API。
WebApplicationContext接口提供IoC容器对Web环境的支持,与ServletAPI的集成工作。
普通Java应用程序选择IoC容器使用ApplicationContext,
Web环境下的IoC容器使用WebApplicationContext。
下面来关注这两行代码的执行都发生了那些事情,以了解容器的整个执行过程。
ApplicationContextapplicationContext=newClassPathXmlApplicationContext("applicationContext.xml");
Foofoo=(Foo)applicationContext.getBean("foo");
1.首先实例化一个容器对象,
2.然后由ResourceLoader组件对参数"applicationContext.xml"进行解析,将此路径上指定的文件解析为Resource对象。
3.BeanDefinitionReader将Resource资源对象内的bean元素数据封装到BeanDefintion组件中,并通过BeanDefintionRegistry将BeanDefintion注册到
BeanFactory中,
4.对Resource的解析工作主要包括三个主要部分,
a:
对xml文档的schema验证,
b:
对默认命名空间元素的解析,这部分委托给XmlBeanDefintionParser组件完成,
c:
对客户化命名空间元素的解析,这部分工作委托给BeanDefintionParser完成,NamespaceHadler组件和NamespaceHandlerResolver组件对BeanDefintionParser提供支持工作。
这里需要提到的是一些特殊元素的解析如:
import元素的解析;另外一点是对applicationContext.xml文件中的bean元素的实际解析工作是委托给
XmlBeanDefintionParserHelper类完成的;上面提到的组件接口列表中与BeanDefinition相关的组件有BeanDefinition组件,BeanDefintionRegistry接口,
除了这两个最重要的,还有如:
BeanDefintionBuilder,BeanDefintionDecorator,BeanDefinitionValueResolver,BeanDefinitionRegistryBuilder等其它与BeanDefintion相关组件,
都对BeanDefintion的操作提供支持。
至此,已经完成了阶段性工作,就是已经将类型信息从applicationContext.xml配置文件bean元素中读取到内存对象的BeanDefinition组件中,接下来的工作就是如何将
BeanDefintion组件中所保存的类型信息实例化为最终的对象。
5.接下来是容器的初始化工作:
调用BeanFactoryPostProcessor接口,
注册BeanPostProcessor接口,
初始化MessageSource组件,
初始化ApplicationEventMulticaster,
注册容器级监听器,
发布容器已刷新的事件,
ApplicationContext接口对bean对象的初始化采取一种积极初始化策略,这样做容器初始化过程虽然比较慢,但后续的每一次bean访问相对较快,因为可以从singletonCache缓存中直接获取,
6.
至此下面这行代码的执行过程已结束,
ApplicationContextapplicationContext=newClassPathXmlApplicationContext("applicationContext.xml");
接下来看这行代码的执行过程,
Foofoo=(Foo)applicationContext.getBean("foo");
7.
getBean(String)的目标很明确,就是根据bean的名称得到一个bean对象,
对bean对象的不同角度的分类,
首先可以分为普通的非FactoryBean类型的bean对象和FactoryBean类型的bean对象,
其次可以分为singleton类型的bean对象和非singleton类型的bean对象,
但是这些分类是建立在一个已创建的bean对象基础之上。
8.下面来看创建一个bean对象的过程,
createBean();
首先容器对BeanDefintion进行整理,根据依赖、继承关系进行合并以得到最终的BeanDefintion,
然后进行bean对象的实例化、初始化、对需要销毁操作的bean对象进行注册。
在这一过程中涉及到一组回调接口的调用,包括实例化前后的处理逻辑,初始化前后的处理逻辑,初始化过程的回调逻辑,销毁操作执行逻辑,
主要的回调接口有
InitializingBean
DisposableBean
BeanPostProcessor
XXXXXXAware
配置风格的回调机制(init-method,destroy-method)
对bean对象的初始化工作依赖于BeanWrapper组件,BeanWrapper组件以反射的方式将BeanDefintion组件中保存的属性信息设置到bean对象中。
组件描述:
Resource组件与ResourceLoader组件一起工作,将字符串格式指示的资源解析为Resource对象。
事实上ResourceLoader是Resource的工厂类,
Java代码
1publicinterfaceResourceLoader{
2publicResourcegetResource(Stringlocation);
3}
ResourceLoader的核心工作就是解析location,
location示例:
"classpath:
applicationContext.xml","classpath*:
applicationContext-*.xml","file:
/some/resource/path/myTemplate.txt","
ResourceLoader根据所指示的前缀返回特定的Resource对象。
BeanDefintionReader组件,
Java代码
4//将Resource中的内容通过BeanDefintionRegistry注册到BeanFactory中。
5publicinterfaceBeanDefintionReader{
6BeanDefinitionRegistrygetBeanFactory();
7ResourceLoadergetResourceLoader();
8intloadBeanDefinitions(Resource[]resources)throwsBeanDefinitionStoreException;
9intloadBeanDefinitions(Stringlocation)throwsBeanDefinitionStoreException;
10intloadBeanDefinitions(String[]locations)throwsBeanDefinitionStoreException;
11/*
12*这是一个基础方法,从Resource中加载BeanDefinition;
13*这三个方法loadBeanDefintions(Resources[]),loadBeanDefintions(String[]),loadBeanDefintion(String)的实现
14*依赖于此方法的实现;
15*上面三个方法的实现在AbstractBeanDefinitionReader骨架类中完成,此方法的实现在XmlBeanDefintionReader中完成。
16*/
17intloadBeanDefinitions(Resourceresource)throwsBeanDefinitionStoreException;
18}
Java代码
19//XmlBeanDefinitionParser组件处理配置文件中默认命名空间的元素解析,
20publicinterfaceXmlBeanDefinitionParser{
21//对Document文档的解析,将解析出的内容封装到BeanDefintion中。
22voidregisterBeanDefinitions(Documentdoc,ReaderContextreaderContext)throwsBeanDefinitionStoreException;
23}
这三个组件(BeanDefintionParser组件,NamespaceHandler组件,NamespaceHandlerResolver组件)处理客户化的命名空间元素的解析,
此机制使用配置文件易于书写,具有可扩展性。
如spring提供的实现:
list>,config>,annotation-driven>,annotation-config>,
第三方组件提供的实现:
endpoint>,broker>等其它实现。
Java代码
24//对客户化命名空间的bean元素进行解析操作。
25publicinterfaceBeanDefintionParser{
26//对Element的解析。
27BeanDefinitionparse(Elementelement,ParserContextparserContext);
28}
29//根据元素命名空间得到此元素的BeanDefinitionParser处理程序;此类是BeanDefintionParser的工厂类。
30publicinterfaceNamespaceHandler{
31voidinit();
32BeanDefinitionParserfindParserForElement(Elementelement);
33BeanDefinitionDecoratorfindDecoratorForElement(Elementelement);
34}
35//解析META-INF/spring.handlers中的配置信息;此类是NamespaceHandler的工厂,
36publicinterfaceNamespaceHandlerResolver{
37//根据命名空间指示符得到指定的命名空间处理器。
38NamespaceHandlerresolve(StringnamespaceUri);
39}
BeanWrapper组件,
对javabean对象提供设置属性值、获取属性值操作,并能够将字符串类型值转换为正确的类型,这个工作依赖于PropertyEditor。
操作示例:
beanWrapper.setPropertyValue("name","foo");
beanWrapper.setPropertyValue("address.country","China");
beanWrapper.setPropertyValue("array[2]","arrayValue");
Java代码
40//PropertyEditor注册器;提供注册、获取PropertyEditor操用。
41publicinterfacePropertyEditorRegistry{
42voidregisterCustomEditor(ClassrequiredType,PropertyEditorpropertyEditor);
43voidregisterCustomEditor(ClassrequiredType,StringpropertyPath,PropertyEditorpropertyEditor);
44PropertyEditorfindCustomEditor(ClassrequiredType,StringpropertyPath);
45}
46//bean对象的属性访问器。
47publicinterfacePropertyAccessor{
48publicbooleanisReadableProperty(Stringname);
49publicbooleanisWritableProperty(Stringname);
50publicClass
>getPropertyType(Stringname);
51publicObjectgetPropertyValue(Stringname);
52publicvoidsetPropertyValues(PropertyValuespvs);
53publicvoidsetPropertyValues(Mappvs);
54publicvoidsetPropertyValue(PropertyValuepv);
55publicvoidsetPropertyValue(Stringname,Objectvalue);
56}
57//对PropertyEditor增加管理功能。
58publicinterfaceConfigurablePropertyAccessorextendsPropertyEditorRegistry,PropertyAccessor{
59voidsetExtractOldValueForEditor(booleanextractOldValueForEditor);
60booleanisExtractOldValueForEditor();
61}
62//对bean对象进行管理。
63publicinterfaceBeanWrapperextendsConfigurablePropertyAccessor{
64//设置所在包装的object
65voidsetWrappedInstance(Objectobj);
66//返回包装对象.
67ObjectgetWrappedInstance();
68//返回包装对象类型
69ClassgetWrappedClass();
70//返回包装对象属性描述..
71PropertyDescriptor[]getPropertyDescriptors()throwsBeansException;
72//根据属性名返回特定的属性描述对象.
73PropertyDescriptorgetPropertyDescriptor(StringpropertyName)throwsBeansException;
74}
Java代码
75//IoC容器的核心接口,提供访问IoC容器的基本操作。
76publicinterfaceBeanFactory{
77//根据bean名称获取相应的bean对象.此方法在AbstractBeanFactory骨架类中实现,
78publicObjectgetBean(Stringname)throwsBeansException;
79}
80//定义分层的BeanFactory容器结构。