肝疼了3万字的Spring容器启动流程

 Spring Framework 是 Java 语言中影响最为深远的框架之一,其中的 IOC 和 AOP 两个经典思想更是一直被程序员津津乐道,后面推出的 Spring Boot、Spring Cloud 系列也是在其基础之上开发,要想搞明白 Spring 全家桶系列,必须脚踏实地的从 Spring Framework 学习起。

创新互联公司是一家集网站建设,锦江企业网站建设,锦江品牌网站建设,网站定制,锦江网站建设报价,网络营销,网络优化,锦江网站推广为一体的创新建站企业,帮助传统企业提升企业形象加强企业竞争力。可充分满足这一群体相比中小企业更为丰富、高端、多元的互联网需求。同时我们时刻保持专业、时尚、前沿,时刻以成就客户成长自我,坚持不断学习、思考、沉淀、净化自己,让我们为更多的企业打造出实用型网站。

这是我 Spring Framework 源码解析系列的第一篇,主要是从代码层面对 Spring 框架的启动做一个完整解析,这里的思想都是笔者根据自己使用 Spring 的经验和对 Spring 的了解综合而成,以下内容谨代表个人看法,若有疑问请不吝赐教。

另外提醒一下,本篇文章是基于 5.1.6.RELEASE 版本的代码进行分析,入口代码也是采用官方推荐的 java-config 技术,而非 xml。

源码解析

考虑到直接看源码是一个非常枯燥无味的过程,而且 Spring 的代码设计非常优秀规范,这会导致在翻开源码时,类与类之间的跳跃会非常频繁,不熟悉的同学可能直接晕菜,所以每一个重要流程前我都会先准备一个流程图,建议大家先通过流程图了解一下整体步骤,然后再对代码硬撸,这样能够降低不少难度。

相信每一个使用过 Spring 技术的同学都知道 Spring 在初始化过程中有一个非常重要的步骤,即 Spring 容器的刷新,这个步骤固然重要,但是刷新前的初始化流程也非常重要。

本篇文章将整个启动过程分为了两个部分,即容器的初始化与刷新,下面正式开始。

初始化流程

流程分析

因为是基于 java-config 技术分析源码,所以这里的入口是 AnnotationConfigApplicationContext ,如果是使用 xml 分析,那么入口即为 ClassPathXmlApplicationContext ,它们俩的共同特征便是都继承了 AbstractApplicationContext 类,而大名鼎鼎的 refresh 方法便是在这个类中定义的,现在就不剧透了,我们接着分析 AnnotationConfigApplicationContext 类,可以绘制成如下流程图:

 看完流程图,我们应该思考一下:如果让你去设计一个 IOC 容器,你会怎么做?首先我肯定会提供一个入口(AnnotationConfigApplicationContext )给用户使用,然后需要去初始化一系列的工具组件:

①:如果我想生成 bean 对象,那么就需要一个 beanFactory 工厂(DefaultListableBeanFactory);

②:如果我想对加了特定注解(如 @Service、@Repository)的类进行读取转化成 BeanDefinition 对象(BeanDefinition 是 Spring 中极其重要的一个概念,它存储了 bean 对象的所有特征信息,如是否单例,是否懒加载,factoryBeanName 等),那么就需要一个注解配置读取器(AnnotatedBeanDefinitionReader);

③:如果我想对用户指定的包目录进行扫描查找 bean 对象,那么还需要一个路径扫描器(ClassPathBeanDefinitionScanner)。

通过上面的思考,是不是上面的图理解起来就轻而易举呢?

ps:图中的黄色备注可以不看,只是在这里明确展示出来 Spring 的部分内置组件是何时何地添加到容器中的,关于组件的作用在后面的系列文章中会详细分析。

核心代码剖析

考虑到要是对所有代码都进行解析,那么文章篇幅会过长,因此这里只对核心内容进行源码层面的分析,凡是图中标注了 ①、②、③等字样的步骤,都可以理解为是一个比较重要的步骤,下面开始进行详细分析。

org.springframework.context.annotation.AnnotationConfigUtils#registerAnnotationConfigProcessors

根据上图分析,代码运行到这里时候,Spring 容器已经构造完毕,那么就可以为容器添加一些内置组件了,其中最主要的组件便是 ConfigurationClassPostProcessor 和 AutowiredAnnotationBeanPostProcessor ,前者是一个 beanFactory 后置处理器,用来完成 bean 的扫描与注入工作,后者是一个 bean 后置处理器,用来完成 @AutoWired 自动注入。

 
 
 
 
  1. public static Set registerAnnotationConfigProcessors( 
  2.   BeanDefinitionRegistry registry, @Nullable Object source) { 
  3.  
  4.  DefaultListableBeanFactory beanFactory = unwrapDefaultListableBeanFactory(registry); 
  5.  if (beanFactory != null) { 
  6.   if (!(beanFactory.getDependencyComparator() instanceof AnnotationAwareOrderComparator)) { 
  7.    beanFactory.setDependencyComparator(AnnotationAwareOrderComparator.INSTANCE); 
  8.   } 
  9.   if (!(beanFactory.getAutowireCandidateResolver() instanceof ContextAnnotationAutowireCandidateResolver)) { 
  10.    beanFactory.setAutowireCandidateResolver(new ContextAnnotationAutowireCandidateResolver()); 
  11.   } 
  12.  } 
  13.  
  14.  Set beanDefs = new LinkedHashSet<>(8); 
  15.  // 向 beanDefinitionMap 中注册【BeanFactoryPostProcessor】:【ConfigurationClassPostProcessor】 
  16.  if (!registry.containsBeanDefinition(CONFIGURATION_ANNOTATION_PROCESSOR_BEAN_NAME)) { 
  17.   RootBeanDefinition def = new RootBeanDefinition(ConfigurationClassPostProcessor.class); 
  18.   def.setSource(source); 
  19.   beanDefs.add(registerPostProcessor(registry, def, CONFIGURATION_ANNOTATION_PROCESSOR_BEAN_NAME)); 
  20.  } 
  21.  // 向 beanDefinitionMap 中注册【BeanPostProcessor】:【AutowiredAnnotationBeanPostProcessor】 
  22.  if (!registry.containsBeanDefinition(AUTOWIRED_ANNOTATION_PROCESSOR_BEAN_NAME)) { 
  23.   RootBeanDefinition def = new RootBeanDefinition(AutowiredAnnotationBeanPostProcessor.class); 
  24.   def.setSource(source); 
  25.   beanDefs.add(registerPostProcessor(registry, def, AUTOWIRED_ANNOTATION_PROCESSOR_BEAN_NAME)); 
  26.  } 
  27.  
  28.  // Check for JSR-250 support, and if present add the CommonAnnotationBeanPostProcessor. 
  29.  // 向 beanDefinitionMap 中注册【BeanPostProcessor】:【CommonAnnotationBeanPostProcessor】 
  30.  if (jsr250Present && !registry.containsBeanDefinition(COMMON_ANNOTATION_PROCESSOR_BEAN_NAME)) { 
  31.   RootBeanDefinition def = new RootBeanDefinition(CommonAnnotationBeanPostProcessor.class); 
  32.   def.setSource(source); 
  33.   beanDefs.add(registerPostProcessor(registry, def, COMMON_ANNOTATION_PROCESSOR_BEAN_NAME)); 
  34.  } 
  35.  
  36.  // Check for JPA support, and if present add the PersistenceAnnotationBeanPostProcessor. 
  37.  // 向 beanDefinitionMap 中注册【BeanPostProcessor】:【PersistenceAnnotationBeanPostProcessor】,前提条件是在 jpa 环境下 
  38.  if (jpaPresent && !registry.containsBeanDefinition(PERSISTENCE_ANNOTATION_PROCESSOR_BEAN_NAME)) { 
  39.   RootBeanDefinition def = new RootBeanDefinition(); 
  40.   try { 
  41.    def.setBeanClass(ClassUtils.forName(PERSISTENCE_ANNOTATION_PROCESSOR_CLASS_NAME, 
  42.      AnnotationConfigUtils.class.getClassLoader())); 
  43.   } 
  44.   catch (ClassNotFoundException ex) { 
  45.    throw new IllegalStateException( 
  46.      "Cannot load optional framework class: " + PERSISTENCE_ANNOTATION_PROCESSOR_CLASS_NAME, ex); 
  47.   } 
  48.   def.setSource(source); 
  49.   beanDefs.add(registerPostProcessor(registry, def, PERSISTENCE_ANNOTATION_PROCESSOR_BEAN_NAME)); 
  50.  } 
  51.  // 向 beanDefinitionMap 中注册【BeanFactoryPostProcessor】:【EventListenerMethodProcessor】 
  52.  if (!registry.containsBeanDefinition(EVENT_LISTENER_PROCESSOR_BEAN_NAME)) { 
  53.   RootBeanDefinition def = new RootBeanDefinition(EventListenerMethodProcessor.class); 
  54.   def.setSource(source); 
  55.   beanDefs.add(registerPostProcessor(registry, def, EVENT_LISTENER_PROCESSOR_BEAN_NAME)); 
  56.  } 
  57.  // 向 beanDefinitionMap 中注册组件:【DefaultEventListenerFactory】 
  58.  if (!registry.containsBeanDefinition(EVENT_LISTENER_FACTORY_BEAN_NAME)) { 
  59.   RootBeanDefinition def = new RootBeanDefinition(DefaultEventListenerFactory.class); 
  60.   def.setSource(source); 
  61.   beanDefs.add(registerPostProcessor(registry, def, EVENT_LISTENER_FACTORY_BEAN_NAME)); 
  62.  } 
  63.  
  64.  return beanDefs; 

org.springframework.context.annotation.AnnotatedBeanDefinitionReader#doRegisterBean

这个步骤主要是用来解析用户传入的 Spring 配置类,其实也是解析成一个 BeanDefinition 然后注册到容器中,没有什么好说的。

 
 
 
 
  1.  void doRegisterBean(Class annotatedClass, @Nullable Supplier instanceSupplier, @Nullable String name, 
  2.   @Nullable Class[] qualifiers, BeanDefinitionCustomizer... definitionCustomizers) { 
  3.  // 解析传入的配置类,实际上这个方法既可以解析配置类,也可以解析 Spring bean 对象 
  4.  AnnotatedGenericBeanDefinition abd = new AnnotatedGenericBeanDefinition(annotatedClass); 
  5.  // 判断是否需要跳过,判断依据是此类上有没有 @Conditional 注解 
  6.  if (this.conditionEvaluator.shouldSkip(abd.getMetadata())) { 
  7.   return; 
  8.  } 
  9.  
  10.  abd.setInstanceSupplier(instanceSupplier); 
  11.  ScopeMetadata scopeMetadata = this.scopeMetadataResolver.resolveScopeMetadata(abd); 
  12.  abd.setScope(scopeMetadata.getScopeName()); 
  13.  String beanName = (name != null ? name : this.beanNameGenerator.generateBeanName(abd, this.registry)); 
  14.  // 处理类上的通用注解 
  15.  AnnotationConfigUtils.processCommonDefinitionAnnotations(abd); 
  16.  if (qualifiers != null) { 
  17.   for (Class qualifier : qualifiers) { 
  18.    if (Primary.class == qualifier) { 
  19.     abd.setPrimary(true); 
  20.    } 
  21.    else if (Lazy.class == qualifier) { 
  22.     abd.setLazyInit(true); 
  23.    } 
  24.    else { 
  25.     abd.addQualifier(new AutowireCandidateQualifier(qualifier)); 
  26.    } 
  27.   } 
  28.  } 
  29.  // 封装成一个 BeanDefinitionHolder 
  30.  for (BeanDefinitionCustomizer customizer : definitionCustomizers) { 
  31.   customizer.customize(abd); 
  32.  } 
  33.  BeanDefinitionHolder definitionHolder = new BeanDefinitionHolder(abd, beanName); 
  34.  // 处理 scopedProxyMode 
  35.  definitionHolder = AnnotationConfigUtils.applyScopedProxyMode(scopeMetadata, definitionHolder, this.registry); 
  36.  
  37.  // 把 BeanDefinitionHolder 注册到 registry 
  38.  BeanDefinitionReaderUtils.registerBeanDefinition(definitionHolder, this.registry); 

刷新流程

流程分析

下面这一段代码则是 Spring 中最为重要的一个步骤:容器刷新,同样先看图再分析。

 看完流程图,我们也先思考一下:在 3.1 中我们知道了如何去初始化一个 IOC 容器,那么接下来就是让这个 IOC 容器真正起作用的时候了:即先扫描出要放入容器的 bean,将其包装成 BeanDefinition 对象,然后通过反射创建 bean,并完成赋值操作,这个就是 IOC 容器最简单的功能了。

但是看完上图,明显 Spring 的初始化过程比这个多的多,下面我们就详细分析一下这样设计的意图:

如果用户想在扫描完 bean 之后做一些自定义的操作:假设容器中包含了 a 和 b,那么就动态向容器中注入 c,不满足就注入 d,这种骚操作 Spring 也是支持的,得益于它提供的 BeanFactoryPostProcessor 后置处理器,对应的是上图中的 invokeBeanFactoryPostProcessors 操作。

如果用户还想在 bean 的初始化前后做一些操作呢?比如生成代理对象,修改对象属性等,Spring 为我们提供了 BeanPostProcessor 后置处理器,实际上 Spring 容器中的大多数功能都是通过 Bean 后置处理器完成的,Spring 也是给我们提供了添加入口,对应的是上图中的 registerBeanPostProcessors 操作。

整个容器创建过程中,如果用户想监听容器启动、刷新等事件,根据这些事件做一些自定义的操作呢?Spring 也早已为我们考虑到了,提供了添加监听器接口和容器事件通知接口,对应的是上图中的 registerListeners 操作。

此时再看上图,是不是就觉得简单很多呢,下面就一些重要代码进行分析。

核心代码剖析

org.springframework.context.support.AbstractApplicationContext#refresh

这个方法是对上图中的具体代码实现,可划分为12个步骤,其中比较重要的步骤下面会有详细说明。

在这里,我们需要记住:Spring 中的每一个容器都会调用 refresh 方法进行刷新,无论是 Spring 的父子容器,还是 Spring Cloud Feign 中的 feign 隔离容器,每一个容器都会调用这个方法完成初始化。

 
 
 
 
  1. public void refresh() throws BeansException, IllegalStateException { 
  2.  synchronized (this.startupShutdownMonitor) { 
  3.   // Prepare this context for refreshing. 
  4.   // 1. 刷新前的预处理 
  5.   prepareRefresh(); 
  6.  
  7.   // Tell the subclass to refresh the internal bean factory. 
  8.   // 2. 获取 beanFactory,即前面创建的【DefaultListableBeanFactory】 
  9.   ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory(); 
  10.  
  11.   // Prepare the bean factory for use in this context. 
  12.   // 3. 预处理 beanFactory,向容器中添加一些组件 
  13.   prepareBeanFactory(beanFactory); 
  14.  
  15.   try { 
  16.    // Allows post-processing of the bean factory in context subclasses. 
  17.    // 4. 子类通过重写这个方法可以在 BeanFactory 创建并与准备完成以后做进一步的设置 
  18.    postProcessBeanFactory(beanFactory); 
  19.  
  20.    // Invoke factory processors registered as beans in the context. 
  21.    // 5. 执行 BeanFactoryPostProcessor 方法,beanFactory 后置处理器 
  22.    invokeBeanFactoryPostProcessors(beanFactory); 
  23.  
  24.    // Register bean processors that intercept bean creation. 
  25.    // 6. 注册 BeanPostProcessors,bean 后置处理器 
  26.    registerBeanPostProcessors(beanFactory); 
  27.  
  28.    // Initialize message source for this context. 
  29.    // 7. 初始化 MessageSource 组件(做国际化功能;消息绑定,消息解析) 
  30.    initMessageSource(); 
  31.  
  32.    // Initialize event multicaster for this context. 
  33.    // 8. 初始化事件派发器,在注册监听器时会用到 
  34.    initApplicationEventMulticaster(); 
  35.  
  36.    // Initialize other special beans in specific context subclasses. 
  37.    // 9. 留给子容器(子类),子类重写这个方法,在容器刷新的时候可以自定义逻辑,web 场景下会使用 
  38.    onRefresh(); 
  39.  
  40.    // Check for listener beans and register them. 
  41.    // 10. 注册监听器,派发之前步骤产生的一些事件(可能没有) 
  42.    registerListeners(); 
  43.  
  44.    // Instantiate all remaining (non-lazy-init) singletons. 
  45.    // 11. 初始化所有的非单实例 bean 
  46.    finishBeanFactoryInitialization(beanFactory); 
  47.  
  48.    // Last step: publish corresponding event. 
  49.    // 12. 发布容器刷新完成事件 
  50.    finishRefresh(); 
  51.   } 
  52.  
  53.   ... 
  54.    
  55.  } 

org.springframework.context.support.AbstractApplicationContext#prepareBeanFactory

顾名思义,这个接口是为 beanFactory 工厂添加一些内置组件,预处理过程。

 
 
 
 
  1. protected void prepareBeanFactory(ConfigurableListableBeanFactory beanFactory) { 
  2.  // Tell the internal bean factory to use the context's class loader etc. 
  3.  // 设置 classLoader 
  4.  beanFactory.setBeanClassLoader(getClassLoader()); 
  5.  //设置 bean 表达式解析器 
  6.  beanFactory.setBeanExpressionResolver(new StandardBeanExpressionResolver(beanFactory.getBeanClassLoader())); 
  7.  beanFactory.addPropertyEditorRegistrar(new ResourceEditorRegistrar(this, getEnvironment())); 
  8.  
  9.  // Configure the bean factory with context callbacks. 
  10.  // 添加一个 BeanPostProcessor【ApplicationContextAwareProcessor】 
  11.  beanFactory.addBeanPostProcessor(new ApplicationContextAwareProcessor(this)); 
  12.  
  13.  // 设置忽略自动装配的接口,即不能通过注解自动注入 
  14.  beanFactory.ignoreDependencyInterface(EnvironmentAware.class); 
  15.  beanFactory.ignoreDependencyInterface(EmbeddedValueResolverAware.class); 
  16.  beanFactory.ignoreDependencyInterface(ResourceLoaderAware.class); 
  17.  beanFactory.ignoreDependencyInterface(ApplicationEventPublisherAware.class); 
  18.  beanFactory.ignoreDependencyInterface(MessageSourceAware.class); 
  19.  beanFactory.ignoreDependencyInterface(ApplicationContextAware.class); 
  20.  
  21.  // BeanFactory interface not registered as resolvable type in a plain factory. 
  22.  // MessageSource registered (and found for autowiring) as a bean. 
  23.  // 注册可以解析的自动装配类,即可以在任意组件中通过注解自动注入 
  24.  beanFactory.registerResolvableDependency(BeanFactory.class, beanFactory); 
  25.  beanFactory.registerResolvableDependency(ResourceLoader.class, this); 
  26.  beanFactory.registerResolvableDependency(ApplicationEventPublisher.class, this); 
  27.  beanFactory.registerResolvableDependency(ApplicationContext.class, this); 
  28.  
  29.  // Register early post-processor for detecting inner beans as ApplicationListeners. 
  30.  // 添加一个 BeanPostProcessor【ApplicationListenerDetector】 
  31.  beanFactory.addBeanPostProcessor(new ApplicationListenerDetector(this)); 
  32.  
  33.  // Detect a LoadTimeWeaver and prepare for weaving, if found. 
  34.  // 添加编译时的 AspectJ 
  35.  if (beanFactory.containsBean(LOAD_TIME_WEAVER_BEAN_NAME)) { 
  36.   beanFactory.addBeanPostProcessor(new LoadTimeWeaverAwareProcessor(beanFactory)); 
  37.   // Set a temporary ClassLoader for type matching. 
  38.   beanFactory.setTempClassLoader(new ContextTypeMatchClassLoader(beanFactory.getBeanClassLoader())); 
  39.  } 
  40.  
  41.  // Register default environment beans. 
  42.  // 注册 environment 组件,类型是【ConfigurableEnvironment】 
  43.  if (!beanFactory.containsLocalBean(ENVIRONMENT_BEAN_NAME)) { 
  44.   beanFactory.registerSingleton(ENVIRONMENT_BEAN_NAME, getEnvironment()); 
  45.  } 
  46.  // 注册 systemProperties 组件,类型是【Map】 
  47.  if (!beanFactory.containsLocalBean(SYSTEM_PROPERTIES_BEAN_NAME)) { 
  48.   beanFactory.registerSingleton(SYSTEM_PROPERTIES_BEAN_NAME, getEnvironment().getSystemProperties()); 
  49.  } 
  50.  // 注册 systemEnvironment 组件,类型是【Map】 
  51.  if (!beanFactory.containsLocalBean(SYSTEM_ENVIRONMENT_BEAN_NAME)) { 
  52.   beanFactory.registerSingleton(SYSTEM_ENVIRONMENT_BEAN_NAME, getEnvironment().getSystemEnvironment()); 
  53.  } 

org.springframework.context.support.PostProcessorRegistrationDelegate#invokeBeanFactoryPostProcessors

前文我们说过,Spring 在扫描完所有的 bean 转成 BeanDefinition 时候,我们是可以做一些自定义操作的,这得益于 Spring 为我们提供的 BeanFactoryPostProcessor 接口。

其中 BeanFactoryPostProcessor 又有一个子接口 BeanDefinitionRegistryPostProcessor ,前者会把 ConfigurableListableBeanFactory 暴露给我们使用,后者会把 BeanDefinitionRegistry 注册器暴露给我们使用,一旦获取到注册器,我们就可以按需注入了,例如搞定这种需求:假设容器中包含了 a 和 b,那么就动态向容器中注入 c,不满足就注入 d。

熟悉 Spring 的同学都知道,Spring 中的同类型组件是允许我们控制顺序的,比如在 AOP 中我们常用的 @Order 注解,这里的 BeanFactoryPostProcessor 接口当然也是提供了顺序,最先被执行的是实现了 PriorityOrdered 接口的实现类,然后再到实现了 Ordered 接口的实现类,最后就是剩下来的常规 BeanFactoryPostProcessor 类。

 此时再看上图,是不是发现和喝水一般简单,首先会回调 postProcessBeanDefinitionRegistry() 方法,然后再回调 postProcessBeanFactory() 方法,最后注意顺序即可,下面一起看看具体的代码实现吧。

 
 
 
 
  1. public static void invokeBeanFactoryPostProcessors( 
  2.   ConfigurableListableBeanFactory beanFactory, List beanFactoryPostProcessors) { 
  3.  // beanFactoryPostProcessors 这个参数是指用户通过 AnnotationConfigApplicationContext.addBeanFactoryPostProcessor() 方法手动传入的 BeanFactoryPostProcessor,没有交给 spring 管理 
  4.  // Invoke BeanDefinitionRegistryPostProcessors first, if any. 
  5.  // 代表执行过的 BeanDefinitionRegistryPostProcessor 
  6.  Set processedBeans = new HashSet<>(); 
  7.  
  8.  if (beanFactory instanceof BeanDefinitionRegistry) { 
  9.   BeanDefinitionRegistry registry = (BeanDefinitionRegistry) beanFactory; 
  10.   // 常规后置处理器集合,即实现了 BeanFactoryPostProcessor 接口 
  11.   List regularPostProcessors = new ArrayList<>(); 
  12.   // 注册后置处理器集合,即实现了 BeanDefinitionRegistryPostProcessor 接口 
  13.   List registryProcessors = new ArrayList<>(); 
  14.   // 处理自定义的 beanFactoryPostProcessors(指调用 context.addBeanFactoryPostProcessor() 方法),一般这里都没有 
  15.   for (BeanFactoryPostProcessor postProcessor : beanFactoryPostProcessors) { 
  16.    if (postProcessor instanceof BeanDefinitionRegistryPostProcessor) { 
  17.     BeanDefinitionRegistryPostProcessor registryProcessor = 
  18.       (BeanDefinitionRegistryPostProcessor) postProcessor; 
  19.     // 调用 postProcessBeanDefinitionRegistry 方法 
  20.     registryProcessor.postProcessBeanDefinitionRegistry(registry); 
  21.     registryProcessors.add(registryProcessor); 
  22.    } 
  23.    else { 
  24.     regularPostProcessors.add(postProcessor); 
  25.    } 
  26.   } 
  27.  
  28.   // Do not initialize FactoryBeans here: We need to leave all regular beans 
  29.   // uninitialized to let the bean factory post-processors apply to them! 
  30.   // Separate between BeanDefinitionRegistryPostProcessors that implement 
  31.   // PriorityOrdered, Ordered, and the rest. 
  32.   // 定义一个变量 currentRegistryProcessors,表示当前要处理的 BeanFactoryPostProcessors 
  33.   List currentRegistryProcessors = new ArrayList<>(); 
  34.  
  35.   // First, invoke the BeanDefinitionRegistryPostProcessors that implement PriorityOrdered. 
  36.   // 首先,从容器中查找实现了 PriorityOrdered 接口的 BeanDefinitionRegistryPostProcessor 类型,这里只会查找出一个【ConfigurationClassPostProcessor】 
  37.   String[] postProcessorNames = 
  38.     beanFactory.getBeanNamesForType(BeanDefinitionRegistryPostProcessor.class, true, false); 
  39.   for (String ppName : postProcessorNames) { 
  40.    // 判断是否实现了 PriorityOrdered 接口 
  41.    if (beanFactory.isTypeMatch(ppName, PriorityOrdered.class)) { 
  42.     // 添加到 currentRegistryProcessors 
  43.     currentRegistryProcessors.add(beanFactory.getBean(ppName, BeanDefinitionRegistryPostProcessor.class)); 
  44.     // 添加到 processedBeans,表示已经处理过这个类了 
  45.     processedBeans.add(ppName); 
  46.    } 
  47.   } 
  48.   // 设置排列顺序 
  49.   sortPostProcessors(currentRegistryProcessors, beanFactory); 
  50.   // 添加到 registry 中 
  51.   registryProcessors.addAll(currentRegistryProcessors); 
  52.   // 执行 [postProcessBeanDefinitionRegistry] 回调方法 
  53.   invokeBeanDefinitionRegistryPostProcessors(currentRegistryProcessors, registry); 
  54.   // 将 currentRegistryProcessors 变量清空,下面会继续用到 
  55.   currentRegistryProcessors.clear(); 
  56.  
  57.   // Next, invoke the BeanDefinitionRegistryPostProcessors that implement Ordered. 
  58.   // 接下来,从容器中查找实现了 Ordered 接口的 BeanDefinitionRegistryPostProcessors 类型,这里可能会查找出多个 
  59.   // 因为【ConfigurationClassPostProcessor】已经完成了 postProcessBeanDefinitionRegistry() 方法,已经向容器中完成扫描工作,所以容器会有很多个组件 
  60.   postProcessorNames = beanFactory.getBeanNamesForType(BeanDefinitionRegistryPostProcessor.class, true, false); 
  61.   for (String ppName : postProcessorNames) { 
  62.    // 判断 processedBeans 是否处理过这个类,且是否实现 Ordered 接口 
  63.    if (!processedBeans.contains(ppName) && beanFactory.isTypeMatch(ppName, Ordered.class)) { 
  64.     currentRegistryProcessors.add(beanFactory.getBean(ppName, BeanDefinitionRegistryPostProcessor.class)); 
  65.     processedBeans.add(ppName); 
  66.    } 
  67.   } 
  68.   // 设置排列顺序 
  69.   sortPostProcessors(currentRegistryProcessors, beanFactory); 
  70.   // 添加到 registry 中 
  71.   registryProcessors.addAll(currentRegistryProcessors); 
  72.   // 执行 [postProcessBeanDefinitionRegistry] 回调方法 
  73.   invokeBeanDefinitionRegistryPostProcessors(currentRegistryProcessors, registry); 
  74.   // 将 currentRegistryProcessors 变量清空,下面会继续用到 
  75.   currentRegistryProcessors.clear(); 
  76.  
  77.   // Finally, invoke all other BeanDefinitionRegistryPostProcessors until no further ones appear. 
  78.   // 最后,从容器中查找剩余所有常规的 BeanDefinitionRegistryPostProcessors 类型 
  79.   boolean reiterate = true; 
  80.   while (reiterate) { 
  81.    reiterate = false; 
  82.    // 根据类型从容器中查找 
  83.    postProcessorNames = beanFactory.getBeanNamesForType(BeanDefinitionRegistryPostProcessor.class, true, false); 
  84.    for (String ppName : postProcessorNames) { 
  85.     // 判断 processedBeans 是否处理过这个类 
  86.     if (!processedBeans.contains(ppName)) { 
  87.      // 添加到 currentRegistryProcessors 
  88.      currentRegistryProcessors.add(beanFactory.getBean(ppName, BeanDefinitionRegistryPostProcessor.class)); 
  89.      // 添加到 processedBeans,表示已经处理过这个类了 
  90.      processedBeans.add(ppName); 
  91.      // 将标识设置为 true,继续循环查找,可能随时因为防止下面调用了 invokeBeanDefinitionRegistryPostProcessors() 方法引入新的后置处理器 
  92.      reiterate = true; 
  93.     } 
  94.    } 
  95.    // 设置排列顺序 
  96.    sortPostProcessors(currentRegistryProcessors, beanFactory); 
  97.    // 添加到 registry 中 
  98.    registryProcessors.addAll(currentRegistryProcessors); 
  99.    // 执行 [postProcessBeanDefinitionRegistry] 回调方法 
  100.    invokeBeanDefinitionRegistryPostProcessors(currentRegistryProcessors, registry); 
  101.    // 将 currentRegistryProcessors 变量清空,因为下一次循环可能会用到 
  102.    currentRegistryProcessors.clear(); 
  103.   } 
  104.  
  105.   // Now, invoke the postProcessBeanFactory callback of all processors handled so far. 
  106.   // 现在执行 registryProcessors 的 [postProcessBeanFactory] 回调方法 
  107.   invokeBeanFactoryPostProcessors(registryProcessors, beanFactory); 
  108.   // 执行 regularPostProcessors 的 [postProcessBeanFactory] 回调方法,也包含用户手动调用 addBeanFactoryPostProcessor() 方法添加的 BeanFactoryPostProcessor 
  109.   invokeBeanFactoryPostProcessors(regularPostProcessors, beanFactory); 
  110.  } 
  111.  
  112.  else { 
  113.   // Invoke factory processors registered with the context instance. 
  114.   invokeBeanFactoryPostProcessors(beanFactoryPostProcessors, beanFactory); 
  115.  } 
  116.  
  117.  // Do not initialize FactoryBeans here: We need to leave all regular beans 
  118.  // uninitialized to let the bean factory post-processors apply to them! 
  119.  // 从容器中查找实现了 BeanFactoryPostProcessor 接口的类 
  120.  String[] postProcessorNames = 
  121.    beanFactory.getBeanNamesForType(BeanFactoryPostProcessor.class, true, false); 
  122.  
  123.  // Separate between BeanFactoryPostProcessors that implement PriorityOrdered, 
  124.  // Ordered, and the rest. 
  125.  // 表示实现了 PriorityOrdered 接口的 BeanFactoryPostProcessor 
  126.  List priorityOrderedPostProcessors = new ArrayList<>(); 
  127.  // 表示实现了 Ordered 接口的 BeanFactoryPostProcessor 
  128.  List orderedPostProcessorNames = new ArrayList<>(); 
  129.  // 表示剩下来的常规的 BeanFactoryPostProcessors 
  130.  List nonOrderedPostProcessorNames = new ArrayList<>(); 
  131.  for (String ppName : postProcessorNames) { 
  132.   // 判断是否已经处理过,因为 postProcessorNames 其实包含了上面步骤处理过的 BeanDefinitionRegistry 类型 
  133.   if (processedBeans.contains(ppName)) { 
  134.    // skip - already processed in first phase above 
  135.   } 
  136.   // 判断是否实现了 PriorityOrdered 接口 
  137.   else if (beanFactory.isTypeMatch(ppName, PriorityOrdered.class)) { 
  138.    priorityOrderedPostProcessors.add(beanFactory.getBean(ppName, BeanFactoryPostProcessor.class)); 
  139.   } 
  140.   // 判断是否实现了 Ordered 接口 
  141.   else if (beanFactory.isTypeMatch(ppName, Ordered.class)) { 
  142.    orderedPostProcessorNames.add(ppName); 
  143.   } 
  144.   // 剩下所有常规的 
  145.   else { 
  146.    nonOrderedPostProcessorNames.add(ppName); 
  147.   } 
  148.  } 
  149.  
  150.  // First, invoke the BeanFactoryPostProcessors that implement PriorityOrdered. 
  151.  // 先将 priorityOrderedPostProcessors 集合排序 
  152.  sortPostProcessors(priorityOrderedPostProcessors, beanFactory); 
  153.  // 执行 priorityOrderedPostProcessors 的 [postProcessBeanFactory] 回调方法 
  154.  invokeBeanFactoryPostProcessors(priorityOrderedPostProcessors, beanFactory); 
  155.  
  156.  // Next, invoke the BeanFactoryPostProcessors that implement Ordered. 
  157.  // 接下来,把 orderedPostProcessorNames 转成 orderedPostProcessors 集合 
  158.  List orderedPostProcessors = new ArrayList<>(); 
  159.  for (String postProcessorName : orderedPostProcessorNames) { 
  160.   orderedPostProcessors.add(beanFactory.getBean(postProcessorName, BeanFactoryPostProcessor.class)); 
  161.  } 
  162.  // 将 orderedPostProcessors 集合排序 
  163.  sortPostProcessors(orderedPostProcessors, beanFactory); 
  164.  // 执行 orderedPostProcessors 的 [postProcessBeanFactory] 回调方法 
  165.  invokeBeanFactoryPostProcessors(orderedPostProcessors, beanFactory); 
  166.  
  167.  // Finally, invoke all other BeanFactoryPostProcessors. 
  168.  // 最后把 nonOrderedPostProcessorNames 转成 nonOrderedPostProcessors 集合,这里只有一个,myBeanFactoryPostProcessor 
  169.  List nonOrderedPostProcessors = new ArrayList<>(); 
  170.  for (String postProcessorName : nonOrderedPostProcessorNames) { 
  171.   nonOrderedPostProcessors.add(beanFactory.getBean(postProcessorName, BeanFactoryPostProcessor.class)); 
  172.  } 
  173.  // 执行 nonOrderedPostProcessors 的 [postProcessBeanFactory] 回调方法 
  174.  invokeBeanFactoryPostProcessors(nonOrderedPostProcessors, beanFactory); 
  175.  
  176.  // Clear cached merged bean definitions since the post-processors might have 
  177.  // modified the original metadata, e.g. replacing placeholders in values... 
  178.  // 清除缓存 
  179.  beanFactory.clearMetadataCache(); 

org.springframework.context.support.PostProcessorRegistrationDelegate#registerBeanPostProcessors

这一步是向容器中注入 BeanPostProcessor ,注意这里仅仅是向容器中注入而非使用。参考上面的步骤和下面的代码,读者自行分析即可,应该不是很困难。

关于 BeanPostProcessor ,它的作用在后续 Spring 创建 bean 流程文章里我会详细分析一下,当然不可能分析全部的 BeanPostProcessor 组件,那样可能得写好几篇续文,这里我们只需要简单明白这个组件会干预 Spring 初始化 bean 的流程,从而完成代理、自动注入、循环依赖等各种功能。

 
 
 
 
  1. public static void registerBeanPostProcessors( 
  2.   ConfigurableListableBeanFactory beanFactory, AbstractApplicationContext applicationContext) { 
  3.  
  4.  // 从容器中获取 BeanPostProcessor 类型 
  5.  String[] postProcessorNames = beanFactory.getBeanNamesForType(BeanPostProcessor.class, true, false); 
  6.  
  7.  // Register BeanPostProcessorChecker that logs an info message when 
  8.  // a bean is created during BeanPostProcessor instantiation, i.e. when 
  9.  // a bean is not eligible for getting processed by all BeanPostProcessors. 
  10.  int beanProcessorTargetCount = beanFactory.getBeanPostProcessorCount() + 1 + postProcessorNames.length; 
  11.  // 向容器中添加【BeanPostProcessorChecker】,主要是用来检查是不是有 bean 已经初始化完成了, 
  12.  // 如果没有执行所有的 beanPostProcessor(用数量来判断),如果有就会打印一行 info 日志 
  13.  beanFactory.addBeanPostProcessor(new BeanPostProcessorChecker(beanFactory, beanProcessorTargetCount)); 
  14.  
  15.  // Separate between BeanPostProcessors that implement PriorityOrdered, 
  16.  // Ordered, and the rest. 
  17.  // 存放实现了 PriorityOrdered 接口的 BeanPostProcessor 
  18.  List priorityOrderedPostProcessors = new ArrayList<>(); 
  19.  // 存放 MergedBeanDefinitionPostProcessor 类型的 BeanPostProcessor 
  20.  List internalPostProcessors = new ArrayList<>(); 
  21.  // 存放实现了 Ordered 接口的 BeanPostProcessor 的 name 
  22.  List orderedPostProcessorNames = new ArrayList<>(); 
  23.  // 存放剩下来普通的 BeanPostProcessor 的 name 
  24.  List nonOrderedPostProcessorNames = new ArrayList<>(); 
  25.  // 从 beanFactory 中查找 postProcessorNames 里的 bean,然后放到对应的集合中 
  26.  for (String ppName : postProcessorNames) { 
  27.   // 判断有无实现 PriorityOrdered 接口 
  28.   if (beanFactory.isTypeMatch(ppName, PriorityOrdered.class)) { 
  29.    BeanPostProcessor pp = beanFactory.getBean(ppName, BeanPostProcessor.class); 
  30.    priorityOrderedPostProcessors.add(pp); 
  31.    // 如果实现了 PriorityOrdered 接口,且属于 MergedBeanDefinitionPostProcessor 
  32.    if (pp instanceof MergedBeanDefinitionPostProcessor) { 
  33.     // 把 MergedBeanDefinitionPostProcessor 类型的添加到 internalPostProcessors 集合中 
  34.     internalPostProcessors.add(pp); 
  35.    } 
  36.   } 
  37.   else if (beanFactory.isTypeMatch(ppName, Ordered.class)) { 
  38.    orderedPostProcessorNames.add(ppName); 
  39.   } 
  40.   else { 
  41.    nonOrderedPostProcessorNames.add(ppName); 
  42.   } 
  43.  } 
  44.  
  45.  // First, register the BeanPostProcessors that implement PriorityOrdered. 
  46.  // 给 priorityOrderedPostProcessors 排序 
  47.  sortPostProcessors(priorityOrderedPostProcessors, beanFactory); 
  48.  // 先注册实现了 PriorityOrdered 接口的 beanPostProcessor 
  49.  registerBeanPostProcessors(beanFactory, priorityOrderedPostProcessors); 
  50.  
  51.  // Next, register the BeanPostProcessors that implement Ordered. 
  52.  // 从 beanFactory 中查找 orderedPostProcessorNames 里的 bean,然后放到对应的集合中 
  53.  List orderedPostProcessors = new ArrayList<>(); 
  54.  for (String ppName : orderedPostProcessorNames) { 
  55.   BeanPostProcessor pp = beanFactory.getBean(ppName, BeanPostProcessor.class); 
  56.   orderedPostProcessors.add(pp); 
  57.   if (pp instanceof MergedBeanDefinitionPostProcessor) { 
  58.    internalPostProcessors.a

    网页名称:肝疼了3万字的Spring容器启动流程
    文章出自:http://www.shufengxianlan.com/qtweb/news25/59625.html

    网站建设、网络推广公司-创新互联,是专注品牌与效果的网站制作,网络营销seo公司;服务项目有等

    广告

    声明:本网站发布的内容(图片、视频和文字)以用户投稿、用户转载内容为主,如果涉及侵权请尽快告知,我们将会在第一时间删除。文章观点不代表本网站立场,如需处理请联系客服。电话:028-86922220;邮箱:631063699@qq.com。内容未经允许不得转载,或转载时需注明来源: 创新互联