前面一篇文章创建自己的spring-boot-starter介绍了怎么创建一个spring-boot-starter,那spring-boot是怎么把starter自动装配进来的呢?这章我们来探讨一下
创建自动装配主要两个点:
1、SpringApplication注解上的@import 引入AutoConfigurationImportSelector.class类选择器
2、META-INF\spring.factories中配置类上的条件注解
跟踪源码我们会发现spring-boot的解析过程:
SpringApplication.run()-》context = createApplicationContext()//创建上下文-》//判断启动方式{REACTIVE、SERVLET、非web环境} 初始化上下文(以非web环境启动为例)
-》创建AnnotationConfigApplicationContext
-》this.reader = new AnnotatedBeanDefinitionReader(this)初始化一个读取器reader
-》AnnotationConfigUtils.registerAnnotationConfigProcessors(this.registry)注册注解驱动默认各种执行器 (配置类执行器ConfigurationClassPostProcessor.class实现了BeanDefinitionRegistryPostProcessors接口)
-》refreshContext(context)//刷新上下文
-》AbstractApplicationContext#refresh
-》invokeBeanFactoryPostProcessors(beanFactory);//调用所有注册的BeanFactoryPostProcessor的Bean
-》PostProcessorRegistrationDelegate.invokeBeanFactoryPostProcessors(beanFactory, getBeanFactoryPostProcessors());
-》invokeBeanDefinitionRegistryPostProcessors(currentRegistryProcessors, registry);//调用BeanDefinitionRegistryPostProcessors 实现Ordered接口的
-》postProcessor.postProcessBeanDefinitionRegistry(registry);
-》ConfigurationClassPostProcessor#postProcessBeanDefinitionRegistry(registry);
-》processConfigBeanDefinitions(registry);
-》parser.parse(candidates);//解析
-》ConfigurationClassParser#parse(AnnotationMetadata,String)//根据类型选择不同的解析方式
-》ConfigurationClassParser#processConfigurationClass//解析配置类(判断条件注解是否满足不满足直接返回)
-》ConfigurationClassParser#doProcessConfigurationClass
-》 ConfigurationClassParser#processImports//解析import标签
-》selectImports()//如果实现DeferredImportSelector接口 则放到deferredImportSelectors中等配置类解析完再调用 否则直接调用selectImports()选出要加载的类递归ConfigurationClassParser#processImports
-》ConfigurationClassParser#processDeferredImportSelectors//调用实现DeferredImportSelector的加载选择器 后面的流程和19行差不多
-》 this.reader.loadBeanDefinitions(configClasses);//加载 注册 BeanDefinitions 有条件注解判断
-》//判断加载的BeanDefinition是否变化,如果BeanDefinition数量发生变化切还有没有被加载的类信息重复执行parser.parse(candidates) 否则结束
现在我们来看下关键点的解析
1、条件注解
在spring4.X的时候引入了@Conditional注解。官方文档的说明是“只有当所有指定的条件都满足是,组件才可以注册”。主要的用处是在创建bean时增加一系列限制条件。
在解析类的时候 会通过早先初始化的条件判断器进行判断当前类是否符合加载的要求
条件判断器会调用所有条件注解指定的条件规则器的macth()方法 ,当所有的规则器都校验通过返回false进行解析
2、META-INF\spring.factories中的自动加载类
在spring-boot启动类上的注解SpringBootApplication中,我们来看下它上面的注解EnableAutoConfiguration
在EnableAutoConfiguration注解中 它又被@import注解标注,说明在这里会引入一些资源或者类,我们来看下AutoConfigurationImportSelector.class(注:2.0之前的版本是EnableConfigurationPropertiesImportSelector.class)
我们会发现AutoConfigurationImportSelector类实现了DeferredImportSelector接口,那DeferredImportSelector接口是干啥的呢?
我的理解:
DeferredImportSelector继承了ImportSelector接口,是ImportSelector接口的扩展,用来区分一部分Selector在解析配置类其他标签之后来执行,spring-boot自动装配就是这种类型。
在ConfigurationClassParser#processImports方法中
spring会获取配置类上的import注解中的Selector类,如果是DeferredImportSelector则把Selector类放到this.deferredImportSelectors list中,否则直接调用Selector类的selectImports()方法,再进行递归调用processImports()解析这些类信息,直到所有符合条件的类信息解析完成。
当解析配置类解析完成后 会调用ConfigurationClassParser#processDeferredImportSelectors方法,执行this.deferredImportSelectors中的所有Selector类的selectImports()方法。
接下来,我们看下AutoConfigurationImportSelector#selectImports
AutoConfigurationMetadataLoader.loadMetadata(this.beanClassLoader)这个方法会加载META-INF/spring-autoconfigure-metadata.properties文件中的配置 一些自动装配的条件比如:
根据官网说法,使用这种配置方式可以有效的降低SpringBoot的启动时间,因为通过这种过滤方式能减少@Configuration类的数量,从而降低初始化Bean时的耗时。
getAutoConfigurationEntry()这个方法会加载要自动装配的类信息。跟踪代码你会发现:
在这里,你会发现spring-boot会加载META-INF\spring.factories文件中key是org.springframework.boot.autoconfigure.EnableAutoConfiguration的信息,也就是我们要自动装配的类。
到此,你应该明白spring-boot自动装配的过程了吧。
那我们现在就可以对前面那个starter做些其他 的扩展
比如增加扫描特定的类:
增加自己的条件注解:
在spring-5.1.x后解析DeferredImportSelector有些略微的变化,在新版本中DeferredImportSelector接口增加了默认方法和一个接口
我们在看下解析的过程
在ConfigurationClassParser中原来的this.deferredImportSelectors属性被DeferredImportSelectorHandler所取代
在ConfigurationClassParser#processImports方法中
如果引入的selector类实现了DeferredImportSelector接口,则调用DeferredImportSelectorHandler#handle()
根据源码我们可以看出,它把原来的Selectors包装成DeferredImportSelectorHolder放到了list中存储起来。
当解析配置类解析完成后 ,调用DeferredImportSelectorHolder#process()方法
在DeferredImportSelectorHolder#process()方法中 主要两个操作
1、注册Group
2、调用ConfigurationClassParser.DeferredImportSelectorGroupingHandler#processGroupImports()
注册Group就是把this.deferredImportSelectors每个的ImportGroup注册到Map<Object, ConfigurationClassParser.DeferredImportSelectorGrouping> groupings 中
执行processGroupImports方法,遍历所有注册的Group,调用每个的getImports()方法
遍历当前Group中的所有this.deferredImports并执行Group#process也就是AutoConfigurationImportSelector.AutoConfigurationGroup#process
AutoConfigurationGroup是AutoConfigurationImportSelector类新加的一个内部类实现了DeferredImportSelector.Group接口。在这个方法中AutoConfigurationImportSelector#getAutoConfigurationEntry没有变化,还是加载META-INF\spring.factories文件中key是org.springframework.boot.autoconfigure.EnableAutoConfiguration的信息,也就是我们要自动装配的类。然后会吧加载的类和类与配置类的注解分别保存。
再回到ConfigurationClassParser.DeferredImportSelectorGrouping#getImports中,当调用完AutoConfigurationImportSelector.AutoConfigurationGroup#process后 会调用DeferredImportSelector.Group#selectImports也就是AutoConfigurationImportSelector.AutoConfigurationGroup#selectImports方法
在返回自动装配类的时候,这里增加了一个排序的动作。
首先会根据AutoConfigureOrder注解的value来排序然后再根据注解AutoConfigureBefore与AutoConfigureAfter配置的前后关系来排序,最终返回一个合理顺序的加载类列表,在ConfigurationClassParser.DeferredImportSelectorGroupingHandler#processGroupImports方法中 调用ConfigurationClassParser#processImports方法进行解析返回的加载类。
综上所述spring5.1.X把selector类增加了分组加载 排序操作 使配置类加载的前后顺序可控,更能满足开发者不同的场景需求。
所以以spring-boot自动装配加载流程更改如下:
SpringApplication.run()-》context = createApplicationContext()//创建上下文-》//判断启动方式{REACTIVE、SERVLET、非web环境} 初始化上下文(以非web环境启动为例)
-》创建AnnotationConfigApplicationContext
-》this.reader = new AnnotatedBeanDefinitionReader(this)//初始化一个读取器reader
-》AnnotationConfigUtils.registerAnnotationConfigProcessors(this.registry)//注册注解驱动默认各种执行器 (配置类执行器ConfigurationClassPostProcessor.class实现了BeanDefinitionRegistryPostProcessors接口)
-》refreshContext(context)//刷新上下文
-》AbstractApplicationContext#refresh
-》invokeBeanFactoryPostProcessors(beanFactory);//调用所有注册的BeanFactoryPostProcessor的Bean
-》PostProcessorRegistrationDelegate.invokeBeanFactoryPostProcessors(beanFactory, getBeanFactoryPostProcessors());
-》invokeBeanDefinitionRegistryPostProcessors(currentRegistryProcessors, registry);//调用BeanDefinitionRegistryPostProcessors 实现Ordered接口的
-》postProcessor.postProcessBeanDefinitionRegistry(registry);
-》ConfigurationClassPostProcessor#postProcessBeanDefinitionRegistry(registry);
-》processConfigBeanDefinitions(registry);
-》parser.parse(candidates);//解析
-》ConfigurationClassParser#parse(AnnotationMetadata,String)//根据类型选择不同的解析方式
-》ConfigurationClassParser#processConfigurationClass//解析配置类(判断条件注解是否满足不满足直接返回)
-》ConfigurationClassParser#doProcessConfigurationClass
-》 ConfigurationClassParser#processImports//解析import标签
//如果实现DeferredImportSelector接口 调用this.deferredImportSelectorHandler.handle方法
-》selectImports()|| this.deferredImportSelectorHandler.handle//将DeferredImportSelector包装成DeferredImportSelectorHolder放到属性deferredImportSelectors List中
-》 this.deferredImportSelectorHandler.process();//调用process方法初始化一个DeferredImportSelectorGroupingHandler
-》ConfigurationClassParser.DeferredImportSelectorGroupingHandler#register//将DeferredImportSelector.ImportGroup注册到Map<Object, ConfigurationClassParser.DeferredImportSelectorGrouping> groupings中并且以配置类的注解为key Selector具体实现类为value存储到Map<AnnotationMetadata, ConfigurationClass> configurationClasses中
-》handler.processGroupImports()//遍历所有的this.groupings调用grouping.getImports()
-》grouping.getImports()//遍历所有的this.deferredImports每个DeferredImportSelectorHolder
-》this.group.process()//调用组的执行器 处理每个DeferredImportSelectorHolder在spring-boot中执行的是AutoConfigurationImportSelector.AutoConfigurationGroup#process 获取所有要加载的类AutoConfigurationImportSelector#getAutoConfigurationEntry并把类信息分成两份保存
-》this.group.selectImports()//调用AutoConfigurationImportSelector.AutoConfigurationGroup#selectImports 进行过滤和排序
-》AutoConfigurationImportSelector.AutoConfigurationGroup#sortAutoConfigurations//排序
-》AutoConfigurationSorter#getInPriorityOrder//首先根据AutoConfigureOrder注解进行排序
-》AutoConfigurationSorter#sortByAnnotation//根据AutoConfigureBefore和AutoConfigureAfter注解信息进行排序
-》ConfigurationClassParser.this.processImports()//解析引入的类
-》 this.reader.loadBeanDefinitions(configClasses);//加载 注册 BeanDefinitions 有条件注解判断
-》//判断加载的BeanDefinition是否变化,如果BeanDefinition数量发生变化切还有没有被加载的类信息重复执行parser.parse(candidates) 否则结束
看完所有的自动装配流程后,我们可以发现spring-boot只是把spring的轮子重新包装了一下,其真正的核心还是spring。