美文网首页
spring boot自动配置原理

spring boot自动配置原理

作者: topshi | 来源:发表于2019-06-28 21:19 被阅读0次

自动配置原理

  • spring boot主程序启动后开启自动配置功能(@EnableAutoConfiguration)
  • @EnableAutoConfiguration作用:
    • 利用AutoConfigurationImportSelector给容器中导入一些组件
    • selectImports()方法
    • List<String> getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes)获取候选的配置
      • SpringFactoriesLoader.loadFactoryNames()扫描所有jar包类路径下的META-INF/spring.factories文件,把扫描到的这些文件的内容包装成properties对象(数据格式如下代码块),然后从properties文件中获取EnableAutoConfiguration.class(类名)所对应的值,添加到容器中
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration,\
org.springframework.boot.autoconfigure.aop.AopAutoConfiguration,\
org.springframework.boot.autoconfigure.amqp.RabbitAutoConfiguration,\
org.springframework.boot.autoconfigure.batch.BatchAutoConfiguration,\

(以上代码块是所有的自动配置类的信息,它们会作为一个组件被加入到容器中进行自动配置工作)

HttpEncodingAutoConfiguration(http编码功能自动配置)为例解释自动配置原理

@Configuration  //表示该类是一个配置类
/**
*   启动指定类的ConfigurationProperties功能
*   将配置文件中对应的值和HttpProperties类的字段绑定起来
*   并将其加入到容器中
**/
@EnableConfigurationProperties({HttpProperties.class})  
//spring底层@Conditional注解,根据不同条件,如果满足条件则整个配置类的配置生效。
//判断当前应用是否是web应用
@ConditionalOnWebApplication(
    type = Type.SERVLET
)
//判断当前项目有没有这个类
@ConditionalOnClass({CharacterEncodingFilter.class})
//判断配置文件中是否存在某个配置spring.http.encoding.enabled,如果不存在也生效
@ConditionalOnProperty(
    prefix = "spring.http.encoding",
    value = {"enabled"},
    matchIfMissing = true
)
public class HttpEncodingAutoConfiguration {
  • 配置文件中所有配置的属性都是xxxProperties类中的字段;配置文件中可以配置什么属性可以参照某个功能的属性类
@ConfigurationProperties(
    prefix = "spring.http"
)
public class HttpProperties {
    private boolean logRequestDetails;
    private final HttpProperties.Encoding encoding = new HttpProperties.Encoding();

以上,将配置文件中配置的属性和Http编码自动配置功能的properties属性类进行了绑定,并且属性类被加入到了容器中,接下来就是该功能类将各种组件加入到容器中。
(这些组件的属性从properties类中获取,而properties类的属性是和配置文件绑定的)

public class HttpEncodingAutoConfiguration {
    private final Encoding properties;
   //只有一个有参构造器,参数的值从容器中取
    public HttpEncodingAutoConfiguration(HttpProperties properties) {
        this.properties = properties.getEncoding();
    }
    @Bean
    @ConditionalOnMissingBean
    public CharacterEncodingFilter characterEncodingFilter() {

精髓

  • spring boot启动会加载大量的自动配置类
  • 看我们所需要的功能spring boot是否默认写好自动的配置类;再看这个自动配置类配置了哪些组件,如果有我们需要的组件,则不需要再配置
  • 给容器中自动配置类中添加组件时,会从properties类中获取某些属性,我们可以再配置文件中指定这些属性的值
    xxxAutoConfiguration:自动配置类,给容器中添加组件
    xxxProperties:封装配置文件中相关的属性

@Conditional派生注解

作用:必须满足@Conditional条件才给容器中添加组件,配置类中的内容才能生效

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

spring boot的自动配置类很多,但是必须要满足一定的条件才能生效。
可以在全局配置文件中使用debug = true配置在控制台打印自动配置报告以知道哪些自动配置类生效。

相关文章

网友评论

      本文标题:spring boot自动配置原理

      本文链接:https://www.haomeiwen.com/subject/tpnrcctx.html