一、前言
文章目录:Spring源码深度解析:文章目录
我们先通过Spring源码的整体流程,来了解Spring的工作流程是什么,接着根据这个工作流程一步一步的阅读源码
二、Spring容器的启动
public class Test {
public static void main(String[] args) {
ApplicationContext applicationContext = new ClassPathXmlApplicationContext("applicationContext.xml");
Person person = (Person) applicationContext.getBean("person");
System.out.println(person);
}
}
源码分析
先来看看这行代码都做了哪些事情。
ApplicationContext applicationContext = new ClassPathXmlApplicationContext("applicationContext.xml");
ClassPathXmlApplicationContext
调用ClassPathXmlApplicationContext
的构造方法,入参是配置文件的地址。
public ClassPathXmlApplicationContext(String configLocation) throws BeansException {
this(new String[] {configLocation}, true, null);
}
ClassPathXmlApplicationContext
是一个XML应用上下文,从类路径获取上下文定义文件。再接着调用本类的另一个构造方法,传入的refresh参数为true,表示要调用AbstractApplicationContext
的refresh()
方法自动刷新上下文。
public ClassPathXmlApplicationContext(String[] configLocations, boolean refresh, @Nullable ApplicationContext parent)
throws BeansException {
// 调用父类构造方法,进行相关对象创建等操作
super(parent);
// 设置配置路径
setConfigLocations(configLocations);
if (refresh) {
refresh();
}
}
三、refresh() 概览
AbstractApplicationContext#refresh()
refresh()
方法是用来加载所有的Bean定义和创建所有的单例。首先需要明确,这里调用的 refresh()
方法是 AnnotationConfigServletWebServerApplicationContext
上下文, obtainFreshBeanFactory()
获取的 beanFactory
实际类型是 DefaultListableBeanFactory。
首先我们来看整体代码, refresh()
的方法很清晰,因为他将所有的功能封装到了各个方法中。后面我们会来一 一介绍这些方法。
public void refresh() throws BeansException, IllegalStateException {
synchronized (this.startupShutdownMonitor) {
// 准备刷新上下文环境。作用就是初始化一些状态和属性,为后面的工作做准备。
prepareRefresh();
// 创建容器对象:DefaultListableBeanFactory; 加载xml配置文件的属性值到当前工厂中,最重要的就是BeanDefinition
ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory();
// 对beanFactory 进行各种功能填充(配置bean工厂的标准上下文特征)
prepareBeanFactory(beanFactory);
try {
// 对 BeanFactory 做额外处理(允许在上下文子类中对bean工厂进行后处理)。默认没有实现
postProcessBeanFactory(beanFactory);
// 激活各种BeanFactory后处理器(调用在上下文中注册为bean的工厂处理器(BeanFactoryPostProcessor))
invokeBeanFactoryPostProcessors(beanFactory);
// 注册并创建拦截bean的bean处理器
registerBeanPostProcessors(beanFactory);
// 为上下文初始化Message源,即不同语言的消息体,国际化处理
initMessageSource();
// 初始化应用消息广播器,并放入"applicationEventMulticaster" bean 中
initApplicationEventMulticaster();
// 留给子类来初始化其他的bean
onRefresh();
// 在所有注册的bean中查找监听器bean(listener bean),并注册到消息广播器中
registerListeners();
// 初始化剩下的单实例(非延迟初始化)
finishBeanFactoryInitialization(beanFactory);
// 完成刷新过程,通知生命周期处理器 lifecycleProcesseor 刷新过程,同时发出相应的事件ContextRefreshEvent 通知别人。
finishRefresh();
}
catch (BeansException ex) {
if (logger.isWarnEnabled()) {
logger.warn("Exception encountered during context initialization - " +
"cancelling refresh attempt: " + ex);
}
// 如果以上过程出现异常,就销毁已创建的单例以避免资源悬空。将active标识设置为false,将异常向上抛出。
destroyBeans();
cancelRefresh(ex);
throw ex;
}
finally {
// 无论是否出现异常,最后重置Spring核心中的常见自省缓存,因为我们可能不再需要单例bean的元数据。
resetCommonCaches();
}
}
}
下面简单概括一下上面的初始化步骤
- prepareRefresh: 初始化前的准备工作,例如对系统属性或者环境变量进行准备及验证。在某些情况下项目的使用需要读取某些系统变量,那么在启动时候,就可以通过准备函数来进行参数的校验。
- obtainFreshBeanFactory :初始化BeanFactory,并进行XML 文件读取(如果需要的话)。告诉子类刷新内部bean工厂,准备在上下文使用的Bean工厂。 这一步之后ApplicationContext就具有BeanFactory 所提供的功能,也就是可以进行Bean的提取等基础操作了。
- prepareBeanFactory :对BeanFactory 进行各种功能填充(配置bean工厂的标准上下文特征)。
- postProcessBeanFactory : 对 BeanFactory 做额外处理(允许在上下文子类中对bean工厂进行后处理)。默认没有实现
- invokeBeanFactoryPostProcessors : 激活各种BeanFactory 处理器(调用在上下文中注册为bean的工厂处理器(BeanFactoryPostProcessor))。其中最为关键的是 ConfigurationClassPostProcessor ,在这里完成了配置类的解析,生成的注入容器中的bean 的 BeanDefinition。
- registerBeanPostProcessors :注册和创建拦截bean的bean处理器。BeanPostProcessor 在这一步已经完成了创建。
- initMessageSource :为上下文初始化Message 源,即对不同语言的消息体进行国际化处理
- initApplicationEventMulticaster :初始化应用消息广播器,并放入"applicationEventMulticaster" bean 中
- onRefresh :留给子类来初始化其他bean
- registerListeners :在所有注册的bean中查找listener bean,注册到消息广播器中
- finishBeanFactoryInitialization :初始化剩下的实例(非延迟初始化),在这里调用了getBean方法,创建了非延迟初始化的bean实例
- finishRefresh :完成刷新过程,通知生命周期处理器 lifecycleProcesseor 刷新过程,同时发出相应的事件ContextRefreshEvent 通知别人。
下面我们来分析每一步的具体内容。
四、refresh() 详述
1. 准备环境 - prepareRefresh()
AbstractApplicationContext#prepareRefresh()
prepareRefresh()
方法整体还是比较清晰的,作用就是初始化一些状态和属性,为后面的工作做准备。
具体代码如下:
protected void prepareRefresh() {
// 设置启动时间,startupDate是用来记录上下文启动的系统时间。
this.startupDate = System.currentTimeMillis();
// 将上下文是否关闭的标识设置为false。将上下文是否活跃的标识设置为true。
this.closed.set(false);
this.active.set(true);
if (logger.isInfoEnabled()) {
logger.info("Refreshing " + this);
}
// 用来初始化上下文环境的所有占位符属性源(留给子类覆盖)。
initPropertySources();
// 初始化environment属性,验证必需的属性文件是否都已经放入环境中
getEnvironment().validateRequiredProperties();
//earlyApplicationListeners是刷新之前就会注册的本地监听器Set集合,applicationListeners是静态指定的监听器Set集合,当earlyApplicationListeners为空时,会初始化内容是applicationListeners;当earlyApplicationListeners不为空时,会将applicationListeners清空,内容再重置为earlyApplicationListeners。
if (this.earlyApplicationListeners == null) {
this.earlyApplicationListeners = new LinkedHashSet<>(this.applicationListeners);
} else {
this.applicationListeners.clear();
this.applicationListeners.addAll(this.earlyApplicationListeners);
}
// 最后再初始化earlyApplicationEvents属性,earlyApplicationEvents是在多播器设置之前发布的应用程序事件。
this.earlyApplicationEvents = new LinkedHashSet<>();
}
这里需要注意的两个方法:
initPropertySources()
:这个方法是为了给用户自己实现初始化逻辑,可以初始化一些属性资源。因此Spring并没有实现这个方法。validateRequiredProperties()
:这个方法是对一些启动必须的属性的验证。
我们可以通过实现或者继承 ApplicationContext 来重写这两个方法,从而完成一些基本属性的校验。
2. 加载BeanFactory - obtainFreshBeanFactory()
AbstractApplicationContext#obtainFreshBeanFactory()
obtainFreshBeanFactory()
从字面意思就是获取BeanFactory。经过这个方法,BeanFactory 就已经被创建完成。
具体代码如下:
protected ConfigurableListableBeanFactory obtainFreshBeanFactory() {
// 创建BeanFactory:判断是否存在bean工厂,如果存在就进行销毁;再重新实例化一个bean工厂。
refreshBeanFactory();
// 再调用AbstractRefreshableApplicationContext的getBeanFactory()方法获取在refresh()创建的bean工厂
ConfigurableListableBeanFactory beanFactory = getBeanFactory();
// 如果获取到的bean工厂是空,会抛出异常。
if (logger.isDebugEnabled()) {
logger.debug("Bean factory for " + getDisplayName() + ": " + beanFactory);
}
return beanFactory;
}
而实际上obtainFreshBeanFactory
方法将 BeanFactory
的创建委托给了 refreshBeanFactory()
方法, refreshBeanFactory()
方法被两个类实现 AbstractRefreshableApplicationContext
和 GenericApplicationContext
。
AbstractRefreshableApplicationContext .refreshBeanFactory()
的实现如下:
判断是否存在bean工厂,如果存在就进行销毁;再重新实例化一个bean工厂。
protected final void refreshBeanFactory() throws BeansException {
if (hasBeanFactory()) {
destroyBeans();
closeBeanFactory();
}
try {
DefaultListableBeanFactory beanFactory = createBeanFactory();
beanFactory.setSerializationId(getId());
customizeBeanFactory(beanFactory);
loadBeanDefinitions(beanFactory);
this.beanFactory = beanFactory;
}
catch (IOException ex) {
throw new ApplicationContextException("I/O error parsing bean definition source for " + getDisplayName(), ex);
}
}
GenericApplicationContext.refreshBeanFactory()
的实现如下:
protected final void refreshBeanFactory() throws IllegalStateException {
// CAS 设置将刷新状态置为 true
if (!this.refreshed.compareAndSet(false, true)) {
throw new IllegalStateException(
"GenericApplicationContext does not support multiple refresh attempts: just call 'refresh' once");
}
// 设置序列id
this.beanFactory.setSerializationId(getId());
}
这里可以看到,GenericApplicationContext 中的实现非常简单。只是简单的将刷新状态置为true。
需要注意的是 this.beanFactory 的实际类型为 DefaultListableBeanFactory。在GenericApplicationContext 的构造函数中进行了对象创建或指定。如下:
3. 功能扩展 - prepareBeanFactory()
AbstractApplicationContext#prepareBeanFactory()
prepareBeanFactory()
配置bean工厂的标准上下文特征。对beanFactry
做了一些准备工作,设置了一些属性来扩展功能。
我们这里看AbstractApplicationContext#prepareBeanFactory
的实现。具体代码如下:
protected void prepareBeanFactory(ConfigurableListableBeanFactory beanFactory) {
// 设置当前beanFactory 的classLoader 为当前context 的classLoader
beanFactory.setBeanClassLoader(getClassLoader());
// 设置beanFactory 的表达式语言处理器,Spring3 增加了表达式语言的支持
// 默认可以使用 #{bean.xxx}的形式来调用处理相关属性。
beanFactory.setBeanExpressionResolver(new StandardBeanExpressionResolver(beanFactory.getBeanClassLoader()));
// 为beanFactory 增加一个默认的propertyEditor,这个主要是针对bean的属性等设置管理的一个工具
beanFactory.addPropertyEditorRegistrar(new ResourceEditorRegistrar(this, getEnvironment()));
// 添加BeanPostProcessor
beanFactory.addBeanPostProcessor(new ApplicationContextAwareProcessor(this));
// 设置了几个忽略自动装配的接口
beanFactory.ignoreDependencyInterface(EnvironmentAware.class);
beanFactory.ignoreDependencyInterface(EmbeddedValueResolverAware.class);
beanFactory.ignoreDependencyInterface(ResourceLoaderAware.class);
beanFactory.ignoreDependencyInterface(ApplicationEventPublisherAware.class);
beanFactory.ignoreDependencyInterface(MessageSourceAware.class);
beanFactory.ignoreDependencyInterface(ApplicationContextAware.class);
// 设置了几个自动装配的特殊规则
beanFactory.registerResolvableDependency(BeanFactory.class, beanFactory);
beanFactory.registerResolvableDependency(ResourceLoader.class, this);
beanFactory.registerResolvableDependency(ApplicationEventPublisher.class, this);
beanFactory.registerResolvableDependency(ApplicationContext.class, this);
beanFactory.addBeanPostProcessor(new ApplicationListenerDetector(this));
// 增加对 AspectJ的支持
if (beanFactory.containsBean(LOAD_TIME_WEAVER_BEAN_NAME)) {
beanFactory.addBeanPostProcessor(new LoadTimeWeaverAwareProcessor(beanFactory));
// Set a temporary ClassLoader for type matching.
beanFactory.setTempClassLoader(new ContextTypeMatchClassLoader(beanFactory.getBeanClassLoader()));
}
// 添加默认的系统环境bean
if (!beanFactory.containsLocalBean(ENVIRONMENT_BEAN_NAME)) {
beanFactory.registerSingleton(ENVIRONMENT_BEAN_NAME, getEnvironment());
}
if (!beanFactory.containsLocalBean(SYSTEM_PROPERTIES_BEAN_NAME)) {
beanFactory.registerSingleton(SYSTEM_PROPERTIES_BEAN_NAME, getEnvironment().getSystemProperties());
}
if (!beanFactory.containsLocalBean(SYSTEM_ENVIRONMENT_BEAN_NAME)) {
beanFactory.registerSingleton(SYSTEM_ENVIRONMENT_BEAN_NAME, getEnvironment().getSystemEnvironment());
}
}
上面函数中主要对几个方面进行了扩展:
- 增加 SpEL 语言的支持
- 增加对属性编辑器的支持
- 增加对一些内置类,比如 EnvironmentAware、EmbeddedValueResolverAware等。
- 设置了依赖功能可忽略的接口
- 注册一些固定依赖的属性
- 增加 AspectJ 的支持
- 将相关环境变量及属性注册以单例模式注册
3.1. SpEL 的支持
SpEL 使用 #{…} 作为界定符,所有在大括号里面的字符都被认为是SpEL,使用格式如下:
<bean id="demoB" name="demoB" class="com.kingfish.springbootdemo.replace.DemoB">
<property name="demoA" value="#{demoA}"/>
</bean>
相当于
<bean id="demoA" name="demoA" class="com.kingfish.springbootdemo.replace.DemoA" >
</bean>
<bean id="demoB" name="demoB" class="com.kingfish.springbootdemo.replace.DemoB">
<property name="demoA" value="#{demoA}"/>
</bean>
在上面的代码中可以通过如下的代码注册语言解析器,就可以对SpEL 进行解析了。
beanFactory.setBeanExpressionResolver(new StandardBeanExpressionResolver(beanFactory.getBeanClassLoader()));
其解析过程是在 bean 初始化的属性注入阶段(AbstractAutowireCapableBeanFactory#populateBean
) 中调用了 applyPropertyValues(beanName, mbd, bw, pvs);
方法。在这个方法中,会通过构造BeanDefinitionValueResolver
类型实例 valueResolver
来进行属性值的解析,同时也是在这个步骤中一般通过AbstractBeanFactory
中的 evaluateBeanDefinitionString
方法完成了SpEL的解析。
protected Object evaluateBeanDefinitionString(@Nullable String value, @Nullable BeanDefinition beanDefinition) {
if (this.beanExpressionResolver == null) {
return value;
}
Scope scope = null;
if (beanDefinition != null) {
String scopeName = beanDefinition.getScope();
if (scopeName != null) {
scope = getRegisteredScope(scopeName);
}
}
return this.beanExpressionResolver.evaluate(value, new BeanExpressionContext(this, scope));
}
当调用这个方法时会判断 是否存在语言解析器,如果存在则调用语言解析器的方法进行解析,解析的过程是在 Spring的expression 的包内,应用语言解析器的调用主要是在解析依赖注册bean 的时候,以及在完成bean的初始化和属性获取后进行属性填充的时候。
4. postProcessBeanFactory
postProcessBeanFactory()方法在AbstractApplicationContext是个空方法,子类可以覆写这个方法。用于标准初始化后,修改应用程序上下文的内部bean工厂。 所有bean定义都将被加载,但尚未实例化任何bean。 这允许在某些ApplicationContext实现中注册特殊的BeanPostProcessor等。如下
protected void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) {
}
而在Springboot2.x 版本中,其实现如下:
AnnotationConfigServletWebServerApplicationContext#postProcessBeanFactory
@Override
protected void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) {
super.postProcessBeanFactory(beanFactory);
// 扫描 指定 目录下的bean并注册
if (this.basePackages != null && this.basePackages.length > 0) {
this.scanner.scan(this.basePackages);
}
// 扫描指定注解下的bean 并注册
if (!this.annotatedClasses.isEmpty()) {
this.reader.register(ClassUtils.toClassArray(this.annotatedClasses));
}
}
需要注意的是 basePackages
和 annotatedClasses
默认都为空。即如果需要执行这一段逻辑,我们需要在指定 basePackages
和 annotatedClasses
后重新刷新容器。
5. 调用BeanFactory的后处理器 - invokeBeanFactoryPostProcessors
AbstractApplicationContext#invokeBeanFactoryPostProcessors()
实例化并调用所有注册的BeanFactoryPostProcessor Bean,并遵循显式顺序(如果给定的话)。必须在单例实例化之前调用。BeanFactory 作为Spring中容器功能的基础,用于存放所有已经加载的bean,为了保证程序的可扩展性,Spring针对BeanFactory做了大量的扩展,如PostProcessor。
这一步的功能主要是激活各种 BeanFactoryPostProcessors。
protected void invokeBeanFactoryPostProcessors(ConfigurableListableBeanFactory beanFactory) {
PostProcessorRegistrationDelegate.invokeBeanFactoryPostProcessors(beanFactory, getBeanFactoryPostProcessors());
if (beanFactory.getTempClassLoader() == null && beanFactory.containsBean(LOAD_TIME_WEAVER_BEAN_NAME)) {
beanFactory.addBeanPostProcessor(new LoadTimeWeaverAwareProcessor(beanFactory));
beanFactory.setTempClassLoader(new ContextTypeMatchClassLoader(beanFactory.getBeanClassLoader()));
}
}
由于篇幅问题,该部分的分析具体请看:Spring源码分析二:BeanFactoryPostProcessor 的处理
6. BeanPostProcessor的注册 - registerBeanPostProcessors
AbstractApplicationContext#registerBeanPostProcessors()
这一部分的部分叙述内容和 invokeBeanFactoryPostProcessors
的分析有关联,建议看完 invokeBeanFactoryPostProcessors
方法的分析再来看此部分。
这里的分析和 invokeBeanFactoryPostProcessors
方法中类似,但是相比之下更加简单。因为这里不需要考虑硬编码的问题。 registerBeanPostProcessors
将 BeanPostProcessor
初始化后并将其保存到了AbstractBeanFactory#beanPostProcessors
,方便之后对 BeanPostProcessor
的调用。
下面来看看代码:
PostProcessorRegistrationDelegate#registerBeanPostProcessors
public static void registerBeanPostProcessors(
ConfigurableListableBeanFactory beanFactory, AbstractApplicationContext applicationContext) {
// 获取所有后处理器的name
String[] postProcessorNames = beanFactory.getBeanNamesForType(BeanPostProcessor.class, true, false);
int beanProcessorTargetCount = beanFactory.getBeanPostProcessorCount() + 1 + postProcessorNames.length;
//可能会有些情况当Spring 的配置中的后处理器还没有被注册就已经开始了bean的实例化,便会打印出BeanPostProcessorChecker 中设定的信息
beanFactory.addBeanPostProcessor(new BeanPostProcessorChecker(beanFactory, beanProcessorTargetCount));
// 保存实现了PriorityOrderd 接口的 后处理器
List<BeanPostProcessor> priorityOrderedPostProcessors = new ArrayList<>();
// 保存MergedBeanDefinitionPostProcessor 后处理器
List<BeanPostProcessor> internalPostProcessors = new ArrayList<>();
// 保存实现了Orderd 接口的 后处理器
List<String> orderedPostProcessorNames = new ArrayList<>();
// 保存没有实现任何排序接口的后处理器
List<String> nonOrderedPostProcessorNames = new ArrayList<>();
// 按照规则筛选出不同的后处理器保存到集合中
for (String ppName : postProcessorNames) {
if (beanFactory.isTypeMatch(ppName, PriorityOrdered.class)) {
BeanPostProcessor pp = beanFactory.getBean(ppName, BeanPostProcessor.class);
priorityOrderedPostProcessors.add(pp);
if (pp instanceof MergedBeanDefinitionPostProcessor) {
internalPostProcessors.add(pp);
}
}
else if (beanFactory.isTypeMatch(ppName, Ordered.class)) {
orderedPostProcessorNames.add(ppName);
}
else {
nonOrderedPostProcessorNames.add(ppName);
}
}
// 对实现了PriorityOrderd 接口的 后处理器 进行排序
sortPostProcessors(priorityOrderedPostProcessors, beanFactory);
// 注册,实际上就是保存到 AbstractBeanFactory#beanPostProcessors 集合中。在getBean使用的时候直接拿取该属性即可
registerBeanPostProcessors(beanFactory, priorityOrderedPostProcessors);
// 下面逻辑类似
List<BeanPostProcessor> orderedPostProcessors = new ArrayList<>();
for (String ppName : orderedPostProcessorNames) {
// 创建了 BeanPostProcessor 实例
BeanPostProcessor pp = beanFactory.getBean(ppName, BeanPostProcessor.class);
orderedPostProcessors.add(pp);
if (pp instanceof MergedBeanDefinitionPostProcessor) {
internalPostProcessors.add(pp);
}
}
sortPostProcessors(orderedPostProcessors, beanFactory);
registerBeanPostProcessors(beanFactory, orderedPostProcessors);
List<BeanPostProcessor> nonOrderedPostProcessors = new ArrayList<>();
for (String ppName : nonOrderedPostProcessorNames) {
BeanPostProcessor pp = beanFactory.getBean(ppName, BeanPostProcessor.class);
nonOrderedPostProcessors.add(pp);
if (pp instanceof MergedBeanDefinitionPostProcessor) {
internalPostProcessors.add(pp);
}
}
registerBeanPostProcessors(beanFactory, nonOrderedPostProcessors);
sortPostProcessors(internalPostProcessors, beanFactory);
// 这里并不是重复注册, registerBeanPostProcessors 方法会先移除已存在的 BeanPostProcessor 随后重新加入。
registerBeanPostProcessors(beanFactory, internalPostProcessors);
beanFactory.addBeanPostProcessor(new ApplicationListenerDetector(applicationContext));
}
相较于invokeBeanFactoryPostProcessors
方法,这里并没有考虑打硬编码的后处理器的顺序问题。其原因在于invokeBeanFactoryPostProcessors
中不仅要实现BeanFactoryPostProcessor
的注册功能,还需要完成激活(执行对应方法)操作,所以需要载入配置中的定义并进行激活。而对于BeanPostProcessor
并不需要马上调用,并且硬编码方式实现的功能是将后处理器提取并调用,这里了并不需要调用,所以不需要考虑硬编码问题。这里只需要将配置文件中的BeanPostProcessor
创建之后出来并注册进行BeanFactory
中即可。需要注意 : 这里虽然没有调用 BeanPostProcessor
,但是 BeanPostProcessor
的实例已经通过 beanFactory.getBean
创建完成。
7. 初始化消息资源 - initMessageSource
AbstractApplicationContext#initMessageSource()
这里的作用很明显就是提取配置中定义的MessageSource
,并将其记录在Spring容器中,也就是AbstractApplicationContext
中。如果用户没有设置资源文件,Spring提供了默认的配置 DelegatingMessageSource
。
代码逻辑也很简单:在这里Spring 通过 beanFactory.getBean(MESSAGE_SOURCE_BEAN_NAME
, MessageSource.class)
; 来获取名称为 MESSAGE_SOURCE_BEAN_NAME (messageSource)
的bean作为 资源文件。这里也体现出了Spring “约束大于规定”的原则。
protected void initMessageSource() {
ConfigurableListableBeanFactory beanFactory = getBeanFactory();
// 判断bean工厂是否存在MessageResource:
if (beanFactory.containsLocalBean(MESSAGE_SOURCE_BEAN_NAME)) {
// 获取自定义资源文件。这里可以看出使用了硬编码,默认资源文件为messageSource,否则便获取不到自定义配置资源
this.messageSource = beanFactory.getBean(MESSAGE_SOURCE_BEAN_NAME, MessageSource.class);
// Make MessageSource aware of parent MessageSource.
// 如果存在,获取,再判断是否有父MessageSource,如果没有,就把父上下文设置为父MessageSource;
if (this.parent != null && this.messageSource instanceof HierarchicalMessageSource) {
HierarchicalMessageSource hms = (HierarchicalMessageSource) this.messageSource;
if (hms.getParentMessageSource() == null) {
hms.setParentMessageSource(getInternalParentMessageSource());
}
}
if (logger.isDebugEnabled()) {
logger.debug("Using MessageSource [" + this.messageSource + "]");
}
}
else {
// 如果不存在,实例化一个空MessageSource以接受getMessage的调用,并设置父MessageSource为父上下文;
DelegatingMessageSource dms = new DelegatingMessageSource();
dms.setParentMessageSource(getInternalParentMessageSource());
this.messageSource = dms;
beanFactory.registerSingleton(MESSAGE_SOURCE_BEAN_NAME, this.messageSource);
if (logger.isDebugEnabled()) {
logger.debug("Unable to locate MessageSource with name '" + MESSAGE_SOURCE_BEAN_NAME +
"': using default [" + this.messageSource + "]");
}
}
}
8. 初始化事件监听 - initApplicationEventMulticaster
AbstractApplicationContext#initApplicationEventMulticaster()
initApplicationEventMulticaster 的方法比较简单,考虑了两种情况:
- 如果用户自定义了事件广播器,在使用用户自定义的事件广播器
- 如果用户没有自定义事件广播器,则使用默认的 ApplicationEventMulticaster
protected void initApplicationEventMulticaster() {
ConfigurableListableBeanFactory beanFactory = getBeanFactory();
// 如果用户自定义了事件广播器,则使用用户自定义
if (beanFactory.containsLocalBean(APPLICATION_EVENT_MULTICASTER_BEAN_NAME)) {
this.applicationEventMulticaster =
beanFactory.getBean(APPLICATION_EVENT_MULTICASTER_BEAN_NAME, ApplicationEventMulticaster.class);
if (logger.isDebugEnabled()) {
logger.debug("Using ApplicationEventMulticaster [" + this.applicationEventMulticaster + "]");
}
}
else {
// 否则使用默认的事件广播器 SimpleApplicationEventMulticaster
this.applicationEventMulticaster = new SimpleApplicationEventMulticaster(beanFactory);
beanFactory.registerSingleton(APPLICATION_EVENT_MULTICASTER_BEAN_NAME, this.applicationEventMulticaster);
if (logger.isDebugEnabled()) {
logger.debug("Unable to locate ApplicationEventMulticaster with name '" +
APPLICATION_EVENT_MULTICASTER_BEAN_NAME +
"': using default [" + this.applicationEventMulticaster + "]");
}
}
}
在 SimpleApplicationEventMulticaster
中有一段代码如下,可以看到,当Spring事件产生的时候,默认会使用SimpleApplicationEventMulticaster#multicastEvent
方法来广播事件,遍历所有的监听器,并使用监听器中的 onApplicationEvent
方法来进行监听事件的处理(通过 invokeListener
方法激活监听方法)。而对于每个监听器来说,其实都可以获取到产生的事件,但使用进行处理由监听器自己决定。
@Override
public void multicastEvent(final ApplicationEvent event, @Nullable ResolvableType eventType) {
ResolvableType type = (eventType != null ? eventType : resolveDefaultEventType(event));
Executor executor = getTaskExecutor();
for (ApplicationListener<?> listener : getApplicationListeners(event, type)) {
if (executor != null) {
executor.execute(() -> invokeListener(listener, event));
}
else {
invokeListener(listener, event);
}
}
}
9. onRefresh()
AbstractApplicationContext#onRefresh
可以被覆盖的模板方法,用来添加上下文指定的刷新工作。在单例的实例化之前,被特殊bean的实例化调用。
protected void onRefresh() throws BeansException {
}
在Springboot 中会刷新 调用 ServletWebServerApplicationContext#onRefresh
方法。
protected void onRefresh() {
super.onRefresh();
try {
createWebServer();
}
catch (Throwable ex) {
throw new ApplicationContextException("Unable to start web server", ex);
}
}
其中
super.onRefresh();
调用了 GenericWebApplicationContext
中的实现也就是初始化一下主题资源。
@Override
protected void onRefresh() {
this.themeSource = UiApplicationContextUtils.initThemeSource(this);
}
但是在 createWebServer(); 中会启动Tomcat服务器
private void createWebServer() {
WebServer webServer = this.webServer;
ServletContext servletContext = getServletContext();
if (webServer == null && servletContext == null) {
// 获取 webServer 工厂类,因为webServer 的提供者有多个:JettyServletWebServerFactory、TomcatServletWebServerFactory、UndertowServletWebServerFactory
ServletWebServerFactory factory = getWebServerFactory();
// 获取webserver。其中启动了tomcat
this.webServer = factory.getWebServer(getSelfInitializer());
}
else if (servletContext != null) {
try {
getSelfInitializer().onStartup(servletContext);
}
catch (ServletException ex) {
throw new ApplicationContextException("Cannot initialize servlet context", ex);
}
}
// 初始化资源
initPropertySources();
}
10. 注册监听器 - registerListeners()
AbstractApplicationContext#registerListeners()
注册监听器的方法实现非常简单,分为如下几步
- 注册硬编码注册的监听器
- 注册配置注册的监听器
- 发布早先的监听事件
具体代码如下:
protected void registerListeners() {
// Register statically specified listeners first.
// 硬编码方式注册的监听器处理
for (ApplicationListener<?> listener : getApplicationListeners()) {
getApplicationEventMulticaster().addApplicationListener(listener);
}
// Do not initialize FactoryBeans here: We need to leave all regular beans
// uninitialized to let post-processors apply to them!
// 配置文件注册的监听处理器
String[] listenerBeanNames = getBeanNamesForType(ApplicationListener.class, true, false);
for (String listenerBeanName : listenerBeanNames) {
getApplicationEventMulticaster().addApplicationListenerBean(listenerBeanName);
}
// Publish early application events now that we finally have a multicaster...
// 发布之前保存的需要发布的事件
Set<ApplicationEvent> earlyEventsToProcess = this.earlyApplicationEvents;
this.earlyApplicationEvents = null;
if (earlyEventsToProcess != null) {
for (ApplicationEvent earlyEvent : earlyEventsToProcess) {
getApplicationEventMulticaster().multicastEvent(earlyEvent);
}
}
}
11. BeanFactory的收尾工作 - finishBeanFactoryInitialization
AbstractApplicationContext#finishBeanFactoryInitialization()
这一步的目的是 结束BeanFactory 的初始化工作,其中包括如下几步 :
对 ConversionService
的设置。通过 ConversionService
的配置可以很轻松完成一些类型转换工作。
冻结所有的bean定义 。到这一步,也就说所有的bean定义已经定型了,不可被修改了,也正式可以缓存bean的元数据了。
初始化剩下的非惰性单实例。ApplicationContext
实现的默认行为就是启动时将所有单例 bean提前进行实例化。提前实例化意味着作为初始化过程的一部分,ApplicationContext
实例会创建并配置所有的单例bean。而这个实例化的过程就是在 preInstantiateSingletons
中完成的。
protected void finishBeanFactoryInitialization(ConfigurableListableBeanFactory beanFactory) {
// Initialize conversion service for this context.
// 1. 对 ConversionService 的设置
// 如果 BeanFactory 中加载了beanName 为 ConversionService 的bean,并且类型是 ConversionService。那么将其设置为 conversionService
if (beanFactory.containsBean(CONVERSION_SERVICE_BEAN_NAME) &&
beanFactory.isTypeMatch(CONVERSION_SERVICE_BEAN_NAME, ConversionService.class)) {
beanFactory.setConversionService(
beanFactory.getBean(CONVERSION_SERVICE_BEAN_NAME, ConversionService.class));
}
// Register a default embedded value resolver if no bean post-processor
// (such as a PropertyPlaceholderConfigurer bean) registered any before:
// at this point, primarily for resolution in annotation attribute values.
if (!beanFactory.hasEmbeddedValueResolver()) {
beanFactory.addEmbeddedValueResolver(strVal -> getEnvironment().resolvePlaceholders(strVal));
}
// Initialize LoadTimeWeaverAware beans early to allow for registering their transformers early.
String[] weaverAwareNames = beanFactory.getBeanNamesForType(LoadTimeWeaverAware.class, false, false);
// 开始调用 getBean 方法初始化LoadTimeWeaverAware
for (String weaverAwareName : weaverAwareNames) {
getBean(weaverAwareName);
}
// Stop using the temporary ClassLoader for type matching.
beanFactory.setTempClassLoader(null);
// Allow for caching all bean definition metadata, not expecting further changes.
// 2. 冻结所有的bean定义,说明注册的bean定义将不被修改或任何进一步的处理
beanFactory.freezeConfiguration();
// Instantiate all remaining (non-lazy-init) singletons.
// 3. 初始化剩下的非惰性单实例
beanFactory.preInstantiateSingletons();
}
这里我们需要特别关注一下 DefaultListableBeanFactory#preInstantiateSingletons
,在这里面,容器创建了所有的非惰性单实例。(之所以不创建原型bean,是因为原型bean没必要进行缓存,每次使用直接创建即可)
@Override
public void preInstantiateSingletons() throws BeansException {
if (logger.isTraceEnabled()) {
logger.trace("Pre-instantiating singletons in " + this);
}
// Iterate over a copy to allow for init methods which in turn register new bean definitions.
// While this may not be part of the regular factory bootstrap, it does otherwise work fine.
// 获取所有 beanName
List<String> beanNames = new ArrayList<>(this.beanDefinitionNames);
// Trigger initialization of all non-lazy singleton beans...
for (String beanName : beanNames) {
// 获取合并后的 BeanDefinition
RootBeanDefinition bd = getMergedLocalBeanDefinition(beanName);
// 非抽象 && 单例 && 非惰性加载
if (!bd.isAbstract() && bd.isSingleton() && !bd.isLazyInit()) {
// 判断是否是 FactoryBean 类型
if (isFactoryBean(beanName)) {
// 如果是 Factorybean 则 拼接 & 前缀获取bean
Object bean = getBean(FACTORY_BEAN_PREFIX + beanName);
if (bean instanceof FactoryBean) {
// 判断是否要立即初始化Bean。对于 FactoryBean,可能并不需要立即初始化其getObject 方法代理的对象。
final FactoryBean<?> factory = (FactoryBean<?>) bean;
boolean isEagerInit;
if (System.getSecurityManager() != null && factory instanceof SmartFactoryBean) {
isEagerInit = AccessController.doPrivileged((PrivilegedAction<Boolean>)
((SmartFactoryBean<?>) factory)::isEagerInit,
getAccessControlContext());
}
else {
isEagerInit = (factory instanceof SmartFactoryBean &&
((SmartFactoryBean<?>) factory).isEagerInit());
}
// 如果需要立即初始化,则初始化bean
if (isEagerInit) {
getBean(beanName);
}
}
}
else {
// 非 FactoryBean 类型直接获取bean
getBean(beanName);
}
}
}
// Trigger post-initialization callback for all applicable beans...
// 触发所有适用bean的初始化后回调。 这里实际上是触发 SmartInitializingSingleton#afterSingletonsInstantiated 方法
for (String beanName : beanNames) {
Object singletonInstance = getSingleton(beanName);
if (singletonInstance instanceof SmartInitializingSingleton) {
final SmartInitializingSingleton smartSingleton = (SmartInitializingSingleton) singletonInstance;
if (System.getSecurityManager() != null) {
AccessController.doPrivileged((PrivilegedAction<Object>) () -> {
smartSingleton.afterSingletonsInstantiated();
return null;
}, getAccessControlContext());
}
else {
smartSingleton.afterSingletonsInstantiated();
}
}
}
}
12. 完成刷新 - finishRefresh()
AbstractApplicationContext#finishRefresh()
在 Spring 中还提供了 Lifecycle 接口,Lifecycle 接口包含 start、stop 方法,实现此接口后Spring会保证在启动的时候调用其 start 方法开始生命周期,并在Spring关闭的时候调用stop方法来结束生命周期,通常用来配置后台程序,在启动后一直运行(如对MQ进行轮询等)。而ApplicationContext
的初始化最后证实保证了这一功能的实现。
protected void finishRefresh() {
// Clear context-level resource caches (such as ASM metadata from scanning).
// 清除资源缓存
clearResourceCaches();
// Initialize lifecycle processor for this context.
// 当Application 启动或停止时,会通过 LifecycleProcessor 来与所有声明的bean周期做状态更新,
// 而在LifecycleProcessor 的使用前首先需要初始化,这里进行了LifecycleProcessor 的初始化。
initLifecycleProcessor();
// Propagate refresh to lifecycle processor first.
// 启动所有实现了Lifecycle 接口的bean
getLifecycleProcessor().onRefresh();
// Publish the final event.
// 当完成ApplicationContext 初始化的时候,要通过Spring 中的事件发布机制来发出ContextRefreshedEvent 的事件,以保证对应的监听器可以做进一步的逻辑处理。
publishEvent(new ContextRefreshedEvent(this));
// Participate in LiveBeansView MBean, if active.
// 注册 ApplicationContext
LiveBeansView.registerApplicationContext(this);
}
以上:内容部分参考
《Spring源码深度解析》
如有侵扰,联系删除。 内容仅用于自我记录学习使用。如有错误,欢迎指正