spring容器的初始化过程
fresh()函数核心流程图
fresh()
@Override
public void refresh() throws BeansException, IllegalStateException {
synchronized (this.startupShutdownMonitor) {
StartupStep contextRefresh = this.applicationStartup.start("spring.context.refresh");
// Prepare this context for refreshing.
// 替换配置文件中的占位符,检查配置文件中的必要属性是否缺失。
prepareRefresh();
// Tell the subclass to refresh the internal bean factory.
// 刷新bean工厂。即销毁旧的bean工厂,并创建新的bean工厂
ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory();
// Prepare the bean factory for use in this context.
// 注册了一个beanPostProcessor,用来给几种特殊的类注入属性。
prepareBeanFactory(beanFactory);
try {
// Allows post-processing of the bean factory in context subclasses.
// 空方法,如果想在工厂创建完毕后,执行一些其他逻辑 可以自定义子类重写该方法。
postProcessBeanFactory(beanFactory);
StartupStep beanPostProcess = this.applicationStartup.start("spring.context.beans.post-process");
// Invoke factory processors registered as beans in the context.
// 从bean工厂中找到所有的BeanDefinitionRegistryPostProcessor,将它们实例化并调用它们。
// BeanDefinitionRegistryPostProcessor的作用是在容器中的bean被实例化之前可以修改bean的定义信息。
// 然后再实例化并调用所有的BeanFactoryPostProcessor。
invokeBeanFactoryPostProcessors(beanFactory);
// Register bean processors that intercept bean creation.
// 实例化所有的BeanPostProcessor,并注册
// 具体的流程是这样的,当运行到这个位置时,无论是xml方式还是注解方式配置的bean信息,都已经被解析成了beanDefinition,
// bean工厂就可以从bean工厂中找到类型为BeanPostProcessor.class的所有bean,再调用getBean()方法将所有找到的类型为
// BeanPostProcessor.class的bean实例化,并注册到bean工厂的beanPostProcessors属性中
registerBeanPostProcessors(beanFactory);
beanPostProcess.end();
// Initialize message source for this context.
// 用来支持国际化
initMessageSource();
// Initialize event multicaster for this context.
// 初始化一个事件广播器,该事件广播器的作用是,当有ApplicationEvent发布时,将这个ApplicationEvent发布给所有对这个事件感兴趣的ApplicationListener
initApplicationEventMulticaster();
// Initialize other special beans in specific context subclasses.
// 这里是一个空方法,留给子类自定义初始化一些特殊的bean。
onRefresh();
// Check for listener beans and register them.
// 注册所有的Listener给事件广播器
registerListeners();
// Instantiate all remaining (non-lazy-init) singletons.
// 实例化所有非懒加载单例的bean
finishBeanFactoryInitialization(beanFactory);
// Last step: publish corresponding event.
// 容器启动完成,清除容器启动产生的缓存,发布ContextRefreshedEvent事件
finishRefresh();
}
catch (BeansException ex) {
if (logger.isWarnEnabled()) {
logger.warn("Exception encountered during context initialization - " +
"cancelling refresh attempt: " + ex);
}
// Destroy already created singletons to avoid dangling resources.
// 容器启动失败,就销毁所有的已创建的bean
destroyBeans();
// Reset 'active' flag.
cancelRefresh(ex);
// Propagate exception to caller.
throw ex;
}
finally {
// Reset common introspection caches in Spring's core, since we
// might not ever need metadata for singleton beans anymore...
// 容器启动完成后,缓存的bean定义信息已经没有用了,所以在这里清除所有的bean定义信息。
resetCommonCaches();
contextRefresh.end();
}
}
}
prepareRefresh
prepareRefresh函数,主要做了一些容器刷新之前的配置工作,如:配置容器启动时间,配置容器状态,检查配置文件,创建事件监听器容器,创建存储事件的容器。
protected void prepareRefresh() {
// Switch to active.
this.startupDate = System.currentTimeMillis();
this.closed.set(false);
this.active.set(true);
if (logger.isDebugEnabled()) {
if (logger.isTraceEnabled()) {
logger.trace("Refreshing " + this);
}
else {
logger.debug("Refreshing " + getDisplayName());
}
}
// Initialize any placeholder property sources in the context environment.
// 替换配置文件中的占位符。这里是空方法,留给子类实现。
initPropertySources();
// Validate that all properties marked as required are resolvable:
// see ConfigurablePropertyResolver#setRequiredProperties
// 验证所有被标记为required的属性是否有缺失。这里是空方法,留给子类实现。
getEnvironment().validateRequiredProperties();
// Store pre-refresh ApplicationListeners...
// 创建监听器的容器,用来存储那些需要在refresh之前注册的监听器。
if (this.earlyApplicationListeners == null) {
this.earlyApplicationListeners = new LinkedHashSet<>(this.applicationListeners);
}
else {
// Reset local application listeners to pre-refresh state.
// 再次调用此方法,会将earlyApplicationListeners中的监听器全部添加到applicationListeners中
this.applicationListeners.clear();
this.applicationListeners.addAll(this.earlyApplicationListeners);
}
// Allow for the collection of early ApplicationEvents,
// to be published once the multicaster is available...
// 创建事件发布的容器,存储refresh之前要发布的事件
this.earlyApplicationEvents = new LinkedHashSet<>();
}
obtainFreshBeanFactory
销毁原有的bean工厂,变创建新的bean工厂
protected ConfigurableListableBeanFactory obtainFreshBeanFactory() {
// 刷新bean工厂,这里是空方法
refreshBeanFactory();
return getBeanFactory();
}
这里来看一下AbstractRefreshableApplicationContext.java中 refreshBeanFactory()的实现
@Override
protected final void refreshBeanFactory() throws BeansException {
if (hasBeanFactory()) {
//如果存在bean工厂,就销毁并关闭bean工厂
destroyBeans();
closeBeanFactory();
}
try {
// 创建新的bean工厂
DefaultListableBeanFactory beanFactory = createBeanFactory();
beanFactory.setSerializationId(getId());
customizeBeanFactory(beanFactory);
// 加载配置文件,并解析出bean的定义信息。
loadBeanDefinitions(beanFactory);
this.beanFactory = beanFactory;
}
catch (IOException ex) {
throw new ApplicationContextException("I/O error parsing bean definition source for " + getDisplayName(), ex);
}
}
refreshBeanFactory()方法中,它销毁了原有的bean工厂,并创建了新的bean工厂,并且加载并解析了配置文件中的bean的配置信息,但这一步并没有将bean实例化。
prepareBeanFactory
这一步是给bean工厂添加一些额外的配置。
包括给bean工厂添加了两个bean后置处理器(beanPostProcessor): ApplicationContextAwareProcessor 和 ApplicationListenerDetector。
设置了4个可解析的自动装配器:BeanFactory,ResourceLoader,ApplicationEventPublisher,ApplicationContext。
添加了4个组件:environment,systemProperties,systemEnvironment,applicationStartup
protected void prepareBeanFactory(ConfigurableListableBeanFactory beanFactory) {
// Tell the internal bean factory to use the context's class loader etc.
beanFactory.setBeanClassLoader(getClassLoader());
if (!shouldIgnoreSpel) {
beanFactory.setBeanExpressionResolver(new StandardBeanExpressionResolver(beanFactory.getBeanClassLoader()));
}
beanFactory.addPropertyEditorRegistrar(new ResourceEditorRegistrar(this, getEnvironment()));
// Configure the bean factory with context callbacks.
// 添加了一个beanPostProcessor ApplicationContextAwareProcessor,这个postProcessor的作用是,给下面7个接口设置属性值。
beanFactory.addBeanPostProcessor(new ApplicationContextAwareProcessor(this));
// 设置忽略自动装配,下面7个接口不能使用自动装配
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.ignoreDependencyInterface(ApplicationStartupAware.class);
// BeanFactory interface not registered as resolvable type in a plain factory.
// MessageSource registered (and found for autowiring) as a bean.
// 当需要自动注入指定类型的bean的时候,优先注入指定的bean,registerResolvableDependency方法的作用是
// 当容器中存在多个与注入目标类型匹配的bean时,优先注入我们所指定的bean
beanFactory.registerResolvableDependency(BeanFactory.class, beanFactory);
beanFactory.registerResolvableDependency(ResourceLoader.class, this);
beanFactory.registerResolvableDependency(ApplicationEventPublisher.class, this);
beanFactory.registerResolvableDependency(ApplicationContext.class, this);
// Register early post-processor for detecting inner beans as ApplicationListeners.
// 注册一个beanPostProcessor 作用是在bean被实例化后,检测这个bean是不是ApplicationListener的实现类,
// 如果是,就将这个类添加到监听器的集合中。
beanFactory.addBeanPostProcessor(new ApplicationListenerDetector(this));
// Detect a LoadTimeWeaver and prepare for weaving, if found.
// 添加编译时的 AspectJ
if (!NativeDetector.inNativeImage() && 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()));
}
// Register default environment beans.
// 注册environment
if (!beanFactory.containsLocalBean(ENVIRONMENT_BEAN_NAME)) {
beanFactory.registerSingleton(ENVIRONMENT_BEAN_NAME, getEnvironment());
}
// 注册systemProperties组件
if (!beanFactory.containsLocalBean(SYSTEM_PROPERTIES_BEAN_NAME)) {
beanFactory.registerSingleton(SYSTEM_PROPERTIES_BEAN_NAME, getEnvironment().getSystemProperties());
}
// 注册systemEnvironment组件
if (!beanFactory.containsLocalBean(SYSTEM_ENVIRONMENT_BEAN_NAME)) {
beanFactory.registerSingleton(SYSTEM_ENVIRONMENT_BEAN_NAME, getEnvironment().getSystemEnvironment());
}
// 注册applicationStartup
if (!beanFactory.containsLocalBean(APPLICATION_STARTUP_BEAN_NAME)) {
beanFactory.registerSingleton(APPLICATION_STARTUP_BEAN_NAME, getApplicationStartup());
}
}
invokeBeanFactoryPostProcessors
这个方法的作用是调用所有的beanFactory的后置处理器,来执行一些beanFactory创建完成之后的工作。
主要做了两项工作,实例化并调用所有的BeanDefinitionRegistryPostProcessor
、实例化并调用所有的BeanFactoryPostProcessor
BeanDefinitionRegistryPostProcessor
的作用是在容器中的bean被实例化之前可以修改bean的定义信息。
如果BeanDefinitionRegistryPostProcessor
,BeanFactoryPostProcessor
实现了PriorityOrdered
, Ordered
接口,要按照其定义的优先级顺序执行。
registerBeanPostProcessors
实例化并注册所有的BeanPostProcessors
。
分开处理 实现了PriorityOrdered
接口,Ordered
接口的BeanPostProcessors
,和没有实现这两种接口的BeanPostProcessors
。
public static void registerBeanPostProcessors(
ConfigurableListableBeanFactory beanFactory, AbstractApplicationContext applicationContext) {
// 找出所有BeanPostProcessor.class类型bean的名称。
String[] postProcessorNames = beanFactory.getBeanNamesForType(BeanPostProcessor.class, true, false);
// 注册一个BeanPostProcessorChecker,用来检测每个bean的实例化并输出日志
int beanProcessorTargetCount = beanFactory.getBeanPostProcessorCount() + 1 + postProcessorNames.length;
beanFactory.addBeanPostProcessor(new BeanPostProcessorChecker(beanFactory, beanProcessorTargetCount));
// 分开处理实现了PriorityOrdered接口,Ordered接口的BeanPostProcessors,和没有实现这两种接口的BeanPostProcessors。
List<BeanPostProcessor> priorityOrderedPostProcessors = new ArrayList<>();
List<BeanPostProcessor> internalPostProcessors = new ArrayList<>();
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);
}
}
// 按照优先级对BeanPostProcessors排序,再注册这些BeanPostProcessors
sortPostProcessors(priorityOrderedPostProcessors, beanFactory);
registerBeanPostProcessors(beanFactory, priorityOrderedPostProcessors);
// 这是对于实现了Ordered接口的处理策略
List<BeanPostProcessor> orderedPostProcessors = new ArrayList<>(orderedPostProcessorNames.size());
for (String ppName : orderedPostProcessorNames) {
BeanPostProcessor pp = beanFactory.getBean(ppName, BeanPostProcessor.class);
orderedPostProcessors.add(pp);
if (pp instanceof MergedBeanDefinitionPostProcessor) {
internalPostProcessors.add(pp);
}
}
// 对BeanPostProcessors排序,并注册
sortPostProcessors(orderedPostProcessors, beanFactory);
registerBeanPostProcessors(beanFactory, orderedPostProcessors);
// Now, register all regular BeanPostProcessors.
// 对于剩余的BeanPostProcessors的处理策略
List<BeanPostProcessor> nonOrderedPostProcessors = new ArrayList<>(nonOrderedPostProcessorNames.size());
for (String ppName : nonOrderedPostProcessorNames) {
BeanPostProcessor pp = beanFactory.getBean(ppName, BeanPostProcessor.class);
nonOrderedPostProcessors.add(pp);
if (pp instanceof MergedBeanDefinitionPostProcessor) {
internalPostProcessors.add(pp);
}
}
// 注册剩余的BeanPostProcessors
registerBeanPostProcessors(beanFactory, nonOrderedPostProcessors);
// Finally, re-register all internal BeanPostProcessors.
sortPostProcessors(internalPostProcessors, beanFactory);
registerBeanPostProcessors(beanFactory, internalPostProcessors);
// Re-register post-processor for detecting inner beans as ApplicationListeners,
// moving it to the end of the processor chain (for picking up proxies etc).
// 重新注入ApplicationListenerDetector,让它位于所有后置处理器的后面
beanFactory.addBeanPostProcessor(new ApplicationListenerDetector(applicationContext));
}
从代码中可以发现,实现PriorityOrdered
接口的BeanPostProcessors
优先注册,再注册实现Ordered
接口的BeanPostProcessors
,最后再注册普通的BeanPostProcessors
。
在实际应用中,如果想让我们自定义的BeanPostProcessors
优先执行,就要实现PriorityOrdered
或Oedered
接口。并指定较高的优先级。
initApplicationEventMulticaster
初始化ApplicationEventMulticaster, ApplicationEventMulticaster的作用是广播事件给对此事件按兴趣的事件监听器。
protected void initApplicationEventMulticaster() {
ConfigurableListableBeanFactory beanFactory = getBeanFactory();
// 如果存在名为applicationEventMulticaster的bean的定义信息,就将这个bean实例化。
// 如果不存在,就new一个SimpleApplicationEventMulticaster,并把它注册到bean工厂。
if (beanFactory.containsLocalBean(APPLICATION_EVENT_MULTICASTER_BEAN_NAME)) {
// 如果存在applicationEventMulticaster这个bean的定义信息就将它初始化。
// 默认是不存在这个bean的定义信息的,我们可以定义自己的applicationEventMulticaster,来替换默认的applicationEventMulticaster。
this.applicationEventMulticaster =
beanFactory.getBean(APPLICATION_EVENT_MULTICASTER_BEAN_NAME, ApplicationEventMulticaster.class);
if (logger.isTraceEnabled()) {
logger.trace("Using ApplicationEventMulticaster [" + this.applicationEventMulticaster + "]");
}
}
else {
// 如果不存在applicationEventMulticaster这个bean的定义信息,就创建并注册applicationEventMulticaster。
this.applicationEventMulticaster = new SimpleApplicationEventMulticaster(beanFactory);
beanFactory.registerSingleton(APPLICATION_EVENT_MULTICASTER_BEAN_NAME, this.applicationEventMulticaster);
if (logger.isTraceEnabled()) {
logger.trace("No '" + APPLICATION_EVENT_MULTICASTER_BEAN_NAME + "' bean, using " +
"[" + this.applicationEventMulticaster.getClass().getSimpleName() + "]");
}
}
}
onRefresh
在AbstractApplicationContext.java中是一个空方法。留给子类实现,可以在此初始化一些特殊的bean。
registerListeners
将所有的事件监听器交给applicationEventMulticaster,由applicationEventMulticaster全权发布事件。
protected void registerListeners() {
// Register statically specified listeners first.
// 把所有的ApplicationListener交给事件广播器
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!
// 找到bean工厂中所有的ApplicationListener,但是不实例化它们,因为还需要让PostProcessor改造它们
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 (!CollectionUtils.isEmpty(earlyEventsToProcess)) {
for (ApplicationEvent earlyEvent : earlyEventsToProcess) {
getApplicationEventMulticaster().multicastEvent(earlyEvent);
}
}
}
finishBeanFactoryInitialization
完成bean工厂的初始化。
这个方法里主要是初始化了非懒加载的单例bean。
此外还初始化了名为conversionService的bean,一个属性后置处理器,和所有的LoadTimeWeaverAware。
protected void finishBeanFactoryInitialization(ConfigurableListableBeanFactory beanFactory) {
// Initialize conversion service for this context.
// 实例化名为conversionService的bean 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 BeanFactoryPostProcessor
// (such as a PropertySourcesPlaceholderConfigurer 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.
// 初始化所有的LoadTimeWeaverAware,跟aop有关
String[] weaverAwareNames = beanFactory.getBeanNamesForType(LoadTimeWeaverAware.class, false, false);
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.
// 不允许对bean的定义信息再做修改
beanFactory.freezeConfiguration();
// Instantiate all remaining (non-lazy-init) singletons.
// 实例化所有非懒加载的单例bean
beanFactory.preInstantiateSingletons();
}
ConversionService的作用是可以将一个对象转化成另一种类型的对象。
属性后置处理器,是处理那些添加了注解的属性的处理器。
finishRefresh
容器刷新完毕,清除缓存的配置文件,并发布容器刷新完成事件。
@SuppressWarnings("deprecation")
protected void finishRefresh() {
// Clear context-level resource caches (such as ASM metadata from scanning).
// 清除缓存文件
clearResourceCaches();
// Initialize lifecycle processor for this context.
// 初始化lifecycleProcessor
initLifecycleProcessor();
// Propagate refresh to lifecycle processor first.
getLifecycleProcessor().onRefresh();
// Publish the final event.
// 发布ContextRefreshedEvent事件
publishEvent(new ContextRefreshedEvent(this));
// Participate in LiveBeansView MBean, if active.
if (!NativeDetector.inNativeImage()) {
LiveBeansView.registerApplicationContext(this);
}
}
resetCommonCaches
容器启动完成后,缓存的bean定义信息已经没有用了,所以在这里清除所有的bean定义信息。