本文开始,将利用《spring源码阅读1——环境搭建&阅读方法》中提到的方法逐步对spring源码进行解读。
本文主要对DefaultListtableBeanFactory的父级接口进行剖析、解读,旨在探究明白spring是如何
对组件(bean)进行管理的。
本文使用的spring版本:4.1.1.RELEASE
顺藤摸瓜——DefaultListableBeanFactory
public static void main(String[] args) {
ApplicationContext context = new ClassPathXmlApplicationContext("spring-config.xml");
HelloService helloService = context.getBean(HelloService.class);
System.out.println(helloService.sayHello());
}
还是从这个main函数入手,容器的getBean(Class<T> requiredType)方法,是通过类对象来获取实例对象,通过调试可以知道,该方法的具体实现在
AbstractApplicationContext.java
@Override
public <T> T getBean(Class<T> requiredType) throws BeansException {
assertBeanFactoryActive();
return getBeanFactory().getBean(requiredType);
}
查看getBeanFactory()方法
AbstractRefreshableApplicationContext.java
/** Bean factory for this context */
private DefaultListableBeanFactory beanFactory;
...
@Override
public final ConfigurableListableBeanFactory getBeanFactory() {
synchronized (this.beanFactoryMonitor) {
if (this.beanFactory == null) {
throw new IllegalStateException("BeanFactory not initialized or already closed - " +
"call 'refresh' before accessing beans via the ApplicationContext");
}
return this.beanFactory;
}
}
通过debug过程中,可以看到这个beanFactory的类型是DefaultListableBeanFactory。
继续调试,进入getBean方法,可以看到这个方法的具体实现确实在类DefaultListableBeanFactory中
@Override
public <T> T getBean(Class<T> requiredType) throws BeansException {
return getBean(requiredType, (Object[]) null);
}
@Override
public <T> T getBean(Class<T> requiredType, Object... args) throws BeansException {
Assert.notNull(requiredType, "Required type must not be null");
String[] beanNames = getBeanNamesForType(requiredType);
if (beanNames.length > 1) {
ArrayList<String> autowireCandidates = new ArrayList<String>();
for (String beanName : beanNames) {
if (!containsBeanDefinition(beanName) || getBeanDefinition(beanName).isAutowireCandidate()) {
autowireCandidates.add(beanName);
}
}
if (autowireCandidates.size() > 0) {
beanNames = autowireCandidates.toArray(new String[autowireCandidates.size()]);
}
}
...
}
至此,我感觉已经找到了所谓的“瓜”,就是DefaultListableBeanFactory这个类,暂且不纠结这个beanFactory是如何实例化的,这不是本文的重点。
化整为零
这一节,我们将整理出DefaultListableBeanFactory这个类的层次结构,逐步了解各个关联的类的作用。
子类
通过工具,查看DefaultListableBeanFactory有哪些子类
可以看到DefaultListableBeanFactory只有一个子类XmlBeanFactory。回顾spring中bean的几种装配方式,在对照该类的注释,可知这个类就是使用xml文件来装配bean组件的。后面的章节会详细介绍这个类,这里不做赘述。
父级层次结构
同样的,用工具查看DefaultListableBeanFactory的层级结构以及类图
小技巧:
Ctrl + H 展示当前类的层级结构图:左上角可选父类、子类以及全部展示视图
Ctrl + Alt + Shift + U 展示当前类的类图,可过滤展示内容
通过这个图可以知道DefaultListableBeanFactory继承了AbstractAutowireCapableBeanFactory类,并且实现了ConfigurableListableBeanFactory接口和BeanDefinitionRegistry接口,已经可以清晰地从全局角度了解DefaultListableBeanFactory的脉络。
各个击破——接口
小技巧:
Ctrl + F12 查看当前类的所有方法和属性
AliasRegistry
在对bean进行定义时,除了使用id属性来指定名称之外,为了提供多个名称,可以使用alias标签来指定。该接口定义了对alias的注册管理功能。
getAliases() : 获取alias标签数组
isAlias() : 判断标签是否存在
registerAlias() : 注册alias标签
removeAlias() : 移除已注册的alias标签
BeanDefinitionRegistry
提供bean的配置清单注册管理功能。
方法说明:
registerBeanDefinition() : 注册BeanDefinition
removeBeanDefinition() : 移除BeanDefinition
isBeanNameInUse() : 重名校验
containsBeanDefinition() : 工厂中是否存在BeanDefinition
getBeanDefinitionCount() : 返回工厂中BeanDefinition的总数
getBeanDefinitionNames() : 返回工厂中BeanDefinition的名称
bean的配置清单(BeanDefinition)是什么?
回忆下spring中,根据xml文档来装配bean,举个栗子:
<bean id="123" class="com.spring.student">
<property name="name" value="XiaoMing" />
<property name="age" value="17" />
<property name="sex" value="man" />
</bean>
这是一个student实例的配置文件,里面记录着id为123的student实例的姓名、年龄和
性别三个属性,spring读取以后就保存为BeanDefinition,容器可以根据这个信息进行
实例化。这就是配置清单~
BeanFactory
查看BeanFactory接口中定义的方法:
BeanFactory接口,定义了一个基本的bean管理工厂。
方法说明:
containsBean() : 工厂中是否存在bean实例
getAliases() : 获取实例bean的别名数组
getBean() : 获取bean实例(多个重载方法)
getType() ; 获取bean实例类型
isPrototype() : bean实例是否为prototype
isSingleton() : bean实例是否为单例
isTypeMatch() : bean实例类型是否和给定值匹配
ListableBeanFactory
这个接口是对BeanFactory的扩展,提供了根据条件获取bean的配置清单(BeanDefinition,暂且就这么称呼吧)。
方法说明:
containsBeanDefinition() : 工厂中是否存在BeanDefinition
getBeanDefinitionCount() : 返回工厂中BeanDefinition的总数
getBeanDefinitionNames() : 返回工厂中BeanDefinition的名称
getBeanNamesForType() : 根据类型获取BeanDefinition的名称
getBeansOfType() : 根据类型获取Bean
getBeanNamesForAnnotation() : 根据注解获取Bean名称
getBeansWithAnnotation() : 根据注解获取Bean
findAnnotationOnBean() : 获取BeanDefinition的注解
HierarchicalBeanFactory
同样是继承于BeanFactory,这个接口主要和层级关系相关,包含两个方法:
方法说明:
getParentBeanFactory() : 获取父级BeanFactory
containsLocalBean() : 返回当前BeanFactory是否存在bean
如果对方法的作用有所疑问,也没有关系,到后面碰到对其实现和使用,便会豁然开朗。
AutowireCapableBeanFactory
这个接口为BeanFactory定义了支持依赖注入功能,主要包含:
方法说明:
createBean() : 创建bean实例
autowireBean() : 注入bean实例
configureBean() : 配置bean实例,注入bean属性,执行回调函数等
resolveDependency() : 解决bean实例的依赖
autowireBeanProperties() : 注入bean实例的属性
applyBeanPropertyValues() : 注入bean实例的属性值
initializeBean() : 初始化bean实例
applyBeanPostProcessorsBeforeInitialization() : 应用bean的前置处理
applyBeanPostProcessorsAfterInitialization() : 应用bean的后置处理
destroyBean() : 销毁bean实例
SigletonBeanRegistry
这个接口定义了容器对单例的注册管理方法。
方法说明:
registerSingleton() : 注册bean
getSingleton() : 获取bean
containsSingleton() : 返回是否包含bean
getSingletonNames() : 获取bean实例(单例)的名称数组
getSingletonCount() : 获取容器中bean实例的总数
ConfigurableBeanFactory
这个接口继承了SingletonBeanRegistry和HierarchicalBeanFactory两个接口,增加了beanFactory的配置功能。主要是许多属性的get和set方法。由于配置项较多,较为复杂,这里先不详细介绍
ConfigurableListableBeanFactory
新增了忽略类型以及接口
总结
至此,已经了解完所有的相关接口,整理下所有的接口中定义的概念:
- Bean : 组件对象,sping容器所管理的对象
- SingletonBean : 特殊的bean,其在容器中仅有一个实例
- BeanDefinition : bean的配置清单,或者说定义文件,spring可以根据该文件实例化出对象
- Alias : bean的别名,一个bean可以有多个名称
- BeanFactory : bean工厂,为其他组件提供管理容器
通过这个类图,感觉整个BeanFactory生态圈已经构建起来了。不得不感叹面向对象的魅力,仅仅是定义了接口,便展示了一个完整的功能模块。
本文到这就要结束了,回顾下
1、首先是通过调试的方法,找到了整个bean管理功能模块的核心DefaultListableBeanFactory
2、然后是对DefaultListableBeanFactory所实现的各个父级接口进行源码阅读和分析
3、最后再通过系统的整理出该功能模块的概览
通过以上三步,完成了BeanFactory的整个功能定义的概览,下次会给大家带来的是如何一步一步的
实现上述的定义
本文到此就结束,希望能够帮到大家。
纯属原创,转载请声明出处。
——作者:陈来件(QQ:810522442)