Spring Boot（五）--------自动配置原理再探究

Spring Boot（五）--------自动配置原理再探究

12、自动配置原理

• 配置文件到底可以写什么，配置的东西和spring.factories有很强的联系

• Spring Boot官方文档中有大量配置，可以随时去官网查看：Common Application properties (spring.io)

12.1 分析自动配置原理

• SpringBoot启动的时候加载主配置类，开启了自动配置功能@EnableAutoConfiguration

• @EnableAutoConfiguration作用

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

  • 可以查看selectImports()方法的内容,他返回了一个autoConfigurationEnty,来自this.getAutoConfigurationEntry(autoConfigurationMetadata,annotationMetadata);这个方法我们继续来跟踪

  • 这个方法有一个值：List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes);叫做获取候选的配置 ，我们点击继续跟踪

  • SpringFactoriesLoader.loadFactoryNames()

  • 扫描所有jar包类路径下META-INF/spring.factories
    把扫描到的这些文件的内容包装成properties对象

  • 从properties中获取到EnableAutoConfiguration.class类（类名）对应的值，然后把他们添加在容器中

  • 在类路径下,META-INF/spring.factories里面配置的所有EnableAutoConfiguration的值加入到容器中

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

• 每一个自动配置类进行自动配置功能；

• 我们以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(Encoding.Type.REQUEST));
        filter.setForceResponseEncoding(this.properties.shouldForce(Encoding.Type.RESPONSE));
        return filter;
    }
    //....
}

• 即根据不同条件判断，这个配置类是否生效

12.2 小结

• Spring Boot启动会加载大量的自动配置类
• 看自己需要的功能有没有再Spring Boot中默认写好再自动配置类中的
• 这个自动配置类到底配置了哪些组件
• 给容器中自动配置类添加组件的时候，会从properties类中获取某些属性。只需要在配置文件中指定这些属性的值即可
• xxxxAutoConfigurartion：自动配置类 ：给容器中添加组件
• xxxxProperties:封装配置文件中相关属性 ：对应springboot配置，xxx.yaml

12.3 @Conditional

@Conditional扩展注解	作用(判断是否满足当前指定条件)
@ConditionalOnJava	系统的java版本是否符合要求
@ConditionalOnJava	容器中存在指定Bean ;
@ConditionalOnMissingBean	容器中不存在指定Bean ;
@ConditionalOnExpression	满足SpEL表达式指定
@ConditionalOnClass	系统中有指定的类
@ConditionalOnMissingClass	系统中没有指定的类
@ConditionalOnSingleCandidate	容器中只有一个指定的Bean ,或者这个Bean是首选Bean
@ConditionalOnProperty	系统中指定的属性是否有指定的值
@ConditionalOnResource	类路径下是否存在指定资源文件
@ConditionalOnWebApplication	当前是web环境
@ConditionalOnNotWebApplication	当前不是web环境
@ConditionalOnJndi	JNDI存在指定项

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

12.4 自动配置类是否生效

• 我们可以在application.properties通过启用debug=true属性

• 在控制台打印自动配置报告，这样我们就可以很方便的知道哪些自动配置类生效

#开启springboot的调试类
debug=true 

• 几种输出结果的意思
  • Positive matches:（自动配置类启用的：正匹配）
  • Negative matches:（没有启动，没有匹配成功的自动配置类：负匹配）
  • Unconditional classes: （没有条件的类）
• 可以在输出日志中查看具体的结果