SpringBoot的自动配置原理

• 2020 年 5 月 30 日
• 筆記
• JAVA-SpringBoot

自动配置原理-当前版本SpringBoot 2.3.0

（纯属个人理解，有理解错误的地方还希望大家评论指点）

1. Spring Boot启动的时候加载主配置类，开启了自动配置功能 @EnableAutoConfiguration

2. @EnableAutoConfiguration作用：

• 利用AutoConfigurationImportSelector给容器中导入一些组件

• 可以查看selectImport()方法来查看导入哪些组件

  List<String> configurations = this.getCandidateConfigurations(annotationMetadata, attributes);
  进入
  List<String> configurations = SpringFactoriesLoader.loadFactoryNames(this.getSpringFactoriesLoaderFactoryClass(), this.getBeanClassLoader());
   //SpringFactoriesLoader.loadFactoryNames（）扫描所有jar包类路径下 META-INF/spring.factories
   //把扫描到的这些文件的内容包装成properties对象
   //从properties中获取到EnableAutoConfiguration.class类（类名）对应的值，然后把他们添加到容器中
  

• 将类路径下META-INF/spring.factories里面配置的所有EnableAutoConfiguration的值（97个值）加入到了容器中；

  • 每一个这样的xxxAutoConfiguration类都是容器中的一个组件，都加入到容器中，用他们来做自动配置

3.每一个自动配置类进行自动配置功能

每一个xxxAutoConfiguration类都为容器添加组件 ，并且都有一个@EnableConfigurationProperties注解，传入一个对应的配置类

@EnableConfigurationProperties({xxxProperties.class})

每一个自动配置类都定义为xxxproperties ，每个这个的类都各自有@ConfigurationProperties注解，自动绑定对应的配置文件

@ConfigurationProperties(
    prefix = "xxx",
    ignoreUnknownFields = true
)

4. 以HttpEncodingAutoConfiguration为例解释自动配置原理

@Configuration  //标注这是一个配置类，以前编写的配置文件也一样，也可以给容器添加组件
@EnableConfigurationProperties({ServerProperties.class}) //启动指定类的ConfigurationProperties功能；将配置文件中对应的值和ServerProperties绑定起来，并把ServerProperties加入到容器中
@ConditionalOnWebApplication //Spring底层@Conditional注解，根据不同的条件，如果满足指定的条件，整个配置类里面的配置就会生效；判断当前应用是否是web应用，如果是，当前配置类生效
@ConditionalOnClass({CharacterEncodingFilter.class})//判断当前项目有没有这个类CharacterEncodingFilter；SpringMVC中进行解决乱码解决的过滤器
@ConditionalOnProperty(    //判断配置文件中是否存在某个配置server.servlet.encoding.enabled
    //matchIfMissing为true，如果不存在配置，判断也是成立的
    prefix = "server.servlet.encoding",
    value = {"enabled"},
    matchIfMissing = true
)  //即使我们配置文件中不配置server.servlet.encoding.enabled=true，也是默认生效的
public class HttpEncodingAutoConfiguration {
    //他已经和springBoot的配置文件映射了
	private final Encoding properties;

    //只有一个有参构造器的情况下，参数的值就会从容器中拿，参数值在注解@EnableConfigurationProperties({ServerProperties.class})的时候就加入了容器
    public HttpEncodingAutoConfiguration(ServerProperties properties) {
        this.properties = properties.getServlet().getEncoding();
    }
    
    @Bean   //生效了则添加该配置类中定义的组件，这个组件的某些值需要从properties中获取
    @ConditionalOnMissingBean
    public CharacterEncodingFilter characterEncodingFilter() {
        CharacterEncodingFilter filter = new OrderedCharacterEncodingFilter();
        filter.setEncoding(this.properties.getCharset().name());
        filter.setForceRequestEncoding(this.properties.shouldForce(org.springframework.boot.web.servlet.server.Encoding.Type.REQUEST));
        filter.setForceResponseEncoding(this.properties.shouldForce(org.springframework.boot.web.servlet.server.Encoding.Type.RESPONSE));
        return filter;
    }
}

根据当前不同的条件判断，决定这个配置类是否生效？

Y:@Bean就生效，这个配置类就会给容器中添加各种组件，这些组件的属性是从对应的properties类中获取的，这些类里边的每一个属性又是和配置文件绑定的；

5. 所有配置文件中能配置的属性都是在xxxProperties类中封装的，配置文件能配置什么就可以参照某个功能对应的这个属性类

@ConfigurationProperties(   //从配置文件中获取指定的值和bean的属性进行绑定
    prefix = "server",
    ignoreUnknownFields = true
)
public class ServerProperties {}

6. 精髓：

1. Spring Boot启动会加载大量的自动配置类
2. 我们看我们需要的功能有没有SpringBoot默认写好的自动配置类
3. 我们再来看这个自动配置类中配置了哪些组件；没有需要的组件就自定义一个配置类
4. 给容器中自动配置类添加组件的时候，会从properties类中获取某些属性。我们就可以在配置文件中指定这些属性的值
5. xxxAutoConfiguration 为自动配置类，给容器中添加组件，它都对应一个xxxProperties 封装配置文件中的相关属性

7. 我们在配置文件中可以配置的内容

​ 找到某个功能的配置类，去到对应的properties对象中，在@ConfigurationProperties注解中的前缀可以找到我们需要的属性，既可以为其进行配置修改等

//以Cache为例
@ConfigurationProperties(
    prefix = "spring.cache"
)
public class CacheProperties {
    private CacheType type;
    private List<String> cacheNames = new ArrayList();
    private final CacheProperties.Caffeine caffeine = new CacheProperties.Caffeine();
    private final CacheProperties.Couchbase couchbase = new CacheProperties.Couchbase();
    private final CacheProperties.EhCache ehcache = new CacheProperties.EhCache();
    private final CacheProperties.Infinispan infinispan = new CacheProperties.Infinispan();
    private final CacheProperties.JCache jcache = new CacheProperties.JCache();
    private final CacheProperties.Redis redis = new CacheProperties.Redis();

细节

1.@Conditional派生注解

作用：必须是@Conditional指定的条件成立，才给容器中添加组件，配置的内容才生效；

自动配置类必须在一定条件下才能生效；

我们怎么知道哪些自动配置类生效：

我们可以在配置文件中通过启动debug=true属性，启动项目后会在控制台输出自动配置报告（CONDITIONS EVALUATION REPORT）

Positive matches: 启动的

Negative matches: 没有启用的