SpringBoot-04-自动配置原理再理解

Posted 2020-12-21 CodeHuba

4. 自动配置原理再理解

? 配置文件到底能写什么？怎么写？SpringBoot官方文档有大量的配置，但是难以全部记住。

分析自动配置原理

? 官方文档

? 我们以HttpEncodingAutoConfiguration（Http编码自动配置）为例解释自动配置原理；

//表示这是一个配置类，和以前编写的配置文件一样，也可以给容器中添加组件；
@Configuration 

//启动指定类的ConfigurationProperties功能；
  //进入这个HttpProperties查看，将配置文件中对应的值和HttpProperties绑定起来；
  //并把HttpProperties加入到ioc容器中
@EnableConfigurationProperties({HttpProperties.class}) 

//Spring底层@Conditional注解
  //根据不同的条件判断，如果满足指定的条件，整个配置类里面的配置就会生效；
  //这里的意思就是判断当前应用是否是web应用，如果是，当前配置类生效
@ConditionalOnWebApplication(
    type = Type.SERVLET
)

//判断当前项目有没有这个类CharacterEncodingFilter；SpringMVC中进行乱码解决的过滤器；
@ConditionalOnClass({CharacterEncodingFilter.class})

//判断配置文件中是否存在某个配置：spring.http.encoding.enabled；
  //如果不存在，判断也是成立的
  //即使我们配置文件中不配置pring.http.encoding.enabled=true，也是默认生效的；
@ConditionalOnProperty(
    prefix = "spring.http.encoding",
    value = {"enabled"},
    matchIfMissing = true
)

public class HttpEncodingAutoConfiguration {
    //他已经和SpringBoot的配置文件映射了
    private final Encoding properties;
    //只有一个有参构造器的情况下，参数的值就会从容器中拿
    public HttpEncodingAutoConfiguration(HttpProperties properties) {
        this.properties = properties.getEncoding();
    }
    
    //给容器中添加一个组件，这个组件的某些值需要从properties中获取
    @Bean
    @ConditionalOnMissingBean //判断容器没有这个组件？
    public CharacterEncodingFilter characterEncodingFilter() {
        CharacterEncodingFilter filter = new OrderedCharacterEncodingFilter();
        filter.setEncoding(this.properties.getCharset().name());
        filter.setForceRequestEncoding(this.properties.shouldForce(org.springframework.boot.autoconfigure.http.HttpProperties.Encoding.Type.REQUEST));
        filter.setForceResponseEncoding(this.properties.shouldForce(org.springframework.boot.autoconfigure.http.HttpProperties.Encoding.Type.RESPONSE));
        return filter;
    }
    
}

一句话总结：

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

• 一旦配置类生效，它就会给容器中添加各种组件；
• 这些组件的属性是从对应的properties类中获取的，且每个属性又和配置文件绑定；
• 所有在配置文件中能配置的属性都是xxxxProperties类中封装着；
• 配置文件能配置什么就参考某个功能对应的这个属性类；

精髓

1. SpringBoot启动会加载大量的自动配置类：xxxProperties
2. 看我们需要的功能有没有在SpringBoot默认写好的自动配置类中；
3. 再看这个自动配置类中到底配置了哪些组件（只要我们用的组件存在其中，那么就不需要手动配置）；
4. 给容器中的自动配置类添加组件的时候，会从properties类中获取某些属性（我们可以在配置文件中指定）；

xxxxAutoConfiguration：自动配置类 ；给容器添加组件

xxxxProperties：封装配置文件中相关属性

了解：@Conditional

我们了解了 自动配置类必须在一定条件下才能生效！

@Conditional派生注解

作用：必须是@Conditional指定的条件成立，才会给容器添加组件，配置配里面的所有内容才会生效！

我们怎么知道哪些自动配置类生效了呢？

启动debug=true属性；来让控制台打印自动配置报告

# 开启springboot的调试类
debug=true

Positive matches：（自动配置类启动的：正匹配）

Negative matches：（没有匹配成功的：负匹配）

Unconditional classes：（没有条件的类）