springboot自动配置原理

发布时间：2024-07-28 15:01

一、简介
不知道大家第一次搭SpringBoot环境的时候，有没有觉得非常简单。无须各种的配置文件，无须各种繁杂的pom坐标，一个main方法，就能run起来了。与其他框架整合也贼方便，使用EnableXXXXX注解就可以搞起来了！
所以今天来讲讲SpringBoot是如何实现自动配置的~

@SpringBootApplication: Spring Boot应用标注在某个类上说明这个类是SpringBoot的主配置类，SpringBoot需要运行这个类的main方法来启动SpringBoot应用；

先看一下@SpringBootApplication注解

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(excludeFilters = { @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
      @Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
public @interface SpringBootApplication {

注解说明：

@SpringBootConﬁguration:
Spring Boot的配置类；标注在某个类上，表示这是一个Spring Boot的配置类（对@Conﬁguration做了继承，目的只是标识是springboot的配置类）；

@EnableAutoConﬁguration：
开启自动配置功能的关键注解，就是通过这个注解把所需的bean自动装配到spring容器中。
再看一下这个注解：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import(AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {

其中有一个通过@Import注解导入了一个重要的对象AutoConfigurationImportSelector，它实现了DeferredImportSelector接口，
关于这个接口的的作用是延迟导入所有自动装配的BeanDefinition，把这些BeanDefinition和生成的bean对比其它的bean是放在最后导入，这样后面使用springboot封装的@ConditionalOnBean、@ConditionalOnMissingBean 、@ConditionalOnClass、@ConditionalOnMissingClass、@ConditionalOnProperty判断这个类需不需要装配具有前提条件。

例如：如果我们自己在项目中配置类mybatis的SqlSessionFactory对象，则springboot中则不会再进行自动装配，
自定义
@Bean
Public SqlSessionFactory getSqlSessionFactory (){
…
Return sqlSessionFactory ;
}

再看一下AutoConfigurationImportSelector对象：
其实现了延迟导入bean的接口DeferredImportSelector
这个可以往spring容器中注入对象。
String[] selectImports(AnnotationMetadata annotationMetadata) 此方法是在public Class getImportGroup() 方法返回null的情况下，才执行生效的。否则不生效，所以此方法不做特别讲解。

主要看实现的方法：

@Override
public Class<? extends Group> getImportGroup() {
   return AutoConfigurationGroup.class;
}

在spring中会执行AutoConfigurationGroup类的process方法，先分析此方法的作用：

@Override
public void process(AnnotationMetadata annotationMetadata, DeferredImportSelector deferredImportSelector) {
   Assert.state(deferredImportSelector instanceof AutoConfigurationImportSelector,
         () -> String.format("Only %s implementations are supported, got %s",
               AutoConfigurationImportSelector.class.getSimpleName(),
               deferredImportSelector.getClass().getName()));
//在此方法中找到候选自动转入的bean的class的name。
   AutoConfigurationEntry autoConfigurationEntry = ((AutoConfigurationImportSelector) deferredImportSelector)
         .getAutoConfigurationEntry(annotationMetadata);
   this.autoConfigurationEntries.add(autoConfigurationEntry);
   for (String importClassName : autoConfigurationEntry.getConfigurations()) {
      this.entries.putIfAbsent(importClassName, annotationMetadata);
   }
}

此方法的作用是找出所有候选的需要自动装配bean的class对象名字；都封装在AutoConfigurationEntry对象中，然后装入全局变量中待后面方法的使用。

看一下如何找到候选待装配的bean，调用下面的方法：

protected AutoConfigurationEntry getAutoConfigurationEntry(AnnotationMetadata annotationMetadata) {
   if (!isEnabled(annotationMetadata)) {
      return EMPTY_ENTRY;
   }
//此方法就是获取注解中设置的排除装配的bean
   AnnotationAttributes attributes = getAttributes(annotationMetadata);
//此方法就是获取所有的候选的bean
   List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes);
//根据名称去重
   configurations = removeDuplicates(configurations);
//获取排除的Bean
   Set<String> exclusions = getExclusions(annotationMetadata, attributes);
   checkExcludedClasses(configurations, exclusions);
//进行排除
   configurations.removeAll(exclusions);
//这一步也是比较重要的，就是根据那些@Condition注解从候选的class中选择符合条件的
   configurations = getConfigurationClassFilter().filter(configurations);
//执行自动导入的监听事件AutoConfigurationImportListener
   fireAutoConfigurationImportEvents(configurations, exclusions);
   return new AutoConfigurationEntry(configurations, exclusions);
}

那如何获取到合适的class的呢？
1、是获取项目中（pom.xml导入jar包）META-INF/spring.factories文件中配置的的所有key-value
2、所以找到Map类型的数据;
3、根据可以org.springframework.boot.autoconfigure.EnableAutoConfiguration作为key找到其中的List数据；
4、这些就是所有候选的class的名字

如下就是候选的class

configurations = getConfigurationClassFilter().filter(configurations);
这一步是根据候选class中的以@Condition开头注解来过滤合适的自动装配的bean。

先获取三个如果所示的过滤器对象；然后传入所有候选的class名字进行过滤，返回合适的自动装配的bean，以mybatis为例：

根据这些条件进行过滤是否装入bean；

最后一List返回所有符合条件的配置类；也会在list组内进行排序：根据@Order、@AutoConfigureAfter、@AutoConfigureBefore注解进行排序

AutoConfigurationGroup#selectImports

我们可以看到过滤完之后，只剩下少量作为的对象作为配置类；

总结：
Spring自动装配的原理是：
1、通过延迟导入bean的对象DeferredImportSelector批量的把符合条件的配置类class名称进行返回；
2、然后根据上步返回的class名称，也就是组件的配置类全限定名，把组件的配置对象装配到spring容器中；
3、而springboot筛选合适的组件配置类是通过获取META-INF/spring.factorys文件下key为org.springframework.boot.autoconfigure.EnableAutoConfiguration
的calss名称value只集合，然后根据这些class上面的相关以@ConditionalOn
开通的注解来过滤正在的配置类的class名称进行返回。

@xxxConditional根据当前不同的条件判断，决定这个配置类是否生效？
@Conditional派生注解（Spring注解版原生的@Conditional作用）
作用：必须是@Conditional指定的条件成立，才给容器中添加组件，配置配里面的所有内容才生效；

springboot自动配置原理

相关推荐