springboot自动装配原理

application.properties/.yaml配置文件内部到底能写什么？怎么写？

在springboot的官方文档中可以看到有大量的配置，无法全部都记住

官方文档：https://docs.spring.io/spring-boot/docs/2.4.3/reference/htmlsingle/#spring.application.name

旧版的官方文档更直观(https://docs.spring.io/spring-boot/docs/2.1.9.RELEASE/reference/htmlsingle/#getting-started-manual-cli-installation)

分析自动配置原理

在springboot-boot-autoconfigure依赖的META-INF下面的spring.factories配置类中选择HttpEncodingAutoConfiguration（Http编码自动配置）为例解释自动配置原理

通过HttpEncodingAutoConfiguration的源码就行分析：

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

    //只有一个有参构造器的情况下，参数的值就会从容器中拿
    public HttpEncodingAutoConfiguration(ServerProperties properties) {
        this.properties = properties.getServlet().getEncoding();
    }

    //给容器中添加一个组件，这个组件的某些值需要从properties中获取
    @Bean
    //判断容器没有这个组件
    @ConditionalOnMissingBean
    public CharacterEncodingFilter characterEncodingFilter() {
        CharacterEncodingFilter filter = new OrderedCharacterEncodingFilter();
        filter.setEncoding(this.properties.getCharset().name());
        filter.setForceRequestEncoding(this.properties.shouldForce(Encoding.Type.REQUEST));
        filter.setForceResponseEncoding(this.properties.shouldForce(Encoding.Type.RESPONSE));
        return filter;
    }

@EnableConfigurationProperties(ServerProperties.class)表示自动配置属性，将配置文件(application.properties/.yaml)中对应的值和ServerProperties类中的属性绑定起来

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

• 一但这个配置类(HttpEncodingAutoConfiguration)生效；这个配置类就会给容器中添加各种组件
• 这些组件的属性是从对应的properties类(ServerProperties)中获取的，这些类里面的每一个属性又是和配置文件绑定的
• 所有在配置文件中能配置的属性都是在xxxxProperties类中封装着
• 配置文件能配置什么就可以参照某个功能对应的这个属性类

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

在application.properties/.yaml配置文件中试试前缀，看提示信息，这就是自动装配的原理

总结

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

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

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

思考：自动配置类必须在一定的条件下才能生效，是通过@Conditional注解来判断指定条件是否成立

@Conditional派生注解（Spring注解版原生的@Conditional作用）

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

如此多的自动配置类，必须在一定的条件下才能生效，也就是说，我们加载了这么多的配置类，但不是所有配置类都生效了

思考：如何自动我们的项目哪些自动配置类生效了呢？

通过启用 debug=true属性；来让控制台打印自动配置报告，这样我们就可以很方便的知道哪些自动配置类生效

#开启springboot的调试类
debug=true

运行完毕：



Positive matches:（启用的自动配置类：正匹配）
Negative matches:（没有启动，或没有匹配成功的自动配置类：负匹配）
Unconditional classes: （没有条件的类）