美文网首页
SpringBoot自动配置原理

SpringBoot自动配置原理

作者: 拉提娜的爸爸 | 来源:发表于2019-08-22 11:05 被阅读0次

    自动配置的属性参照:
    https://docs.spring.io/spring-boot/docs/1.5.9.RELEASE/reference/htmlsingle/#common-application-properties

    1、自动配置原理

    1)、SpringBoot启动的时候加载主配置类,开启了自动配置功能 @EnableAutoConfiguration
    2)、@EnableAutoConfiguration 作用:

    • 利用EnableAutoConfigurationImportSelector给容器中导入一些组件?
    • 可以查看selectImports()方法的内容;
    • List configurations = getCandidateConfigurations(annotationMetadata, attributes);获取候选的配置
    1.SpringFactoriesLoader.loadFactoryNames()
    2 扫描所有jar包类路径下 META‐INF/spring.factories
    3 把扫描到的这些文件的内容包装成properties对象
    4 从properties中获取到EnableAutoConfiguration.class类(类名)对应的值,然后把他们添加在容器中
    

    将 类路径下 META-INF/spring.factories 里面配置的所有EnableAutoConfiguration的值加入到了容器中;
    3)、每一个自动配置类进行自动配置功能;
    4)、以HttpEncodingAutoConfiguration(Http编码自动配置)为例解释自动配置原理;

    @Configuration //表示这是一个配置类,以前编写的配置文件一样,也可以给容器中添加组件
    
    //启动指定类的ConfigurationProperties功能;将配置文件中对应的值和HttpEncodingProperties绑定起来,并把HttpEncodingProperties加入到ioc容器中
    @EnableConfigurationProperties(HttpEncodingProperties.class) 
    @ConditionalOnWebApplication//Spring底层@Conditional注解(Spring注解版),根据不同的条件,如果 满足指定的条件,整个配置类里面的配置就会生效; 判断当前应用是否是web应用,如果是,当前配置类生效
    @ConditionalOnClass(CharacterEncodingFilter.class) //判断当前项目有没有这个类
    CharacterEncodingFilter;SpringMVC中进行乱码解决的过滤器; 7
    @ConditionalOnProperty(prefix="spring.http.encoding",value="enabled",matchIfMissing= true) //判断配置文件中是否存在某个配置 spring.http.encoding.enabled;如果不存在,判断也是成立的
    //即使我们配置文件中不配置pring.http.encoding.enabled=true,也是默认生效的;
    public class HttpEncodingAutoConfiguration{
    
     //他已经和SpringBoot的配置文件映射了
      private final HttpEncodingProperties properties;
    //只有一个有参构造器的情况下,参数的值就会从容器中拿
      public HttpEncodingAutoConfiguration(HttpEncodingProperties properties) {
          this.properties = properties;
      }
    
       @Bean //给容器中添加一个组件,这个组件的某些值需要从properties中获取
       @ConditionalOnMissingBean(CharacterEncodingFilter.class) //判断容器没有这个组件?
       public CharacterEncodingFilter characterEncodingFilter() {
           CharacterEncodingFilter filter = new OrderedCharacterEncodingFilter();
           filter.setEncoding(this.properties.getCharset().name());
           filter.setForceRequestEncoding(this.properties.shouldForce(Type.REQUEST));
           filter.setForceResponseEncoding(this.properties.shouldForce(Type.RESPONSE));
           return filter;
       }
    }
    

    根据当前不同的条件判断,决定这个配置类是否生效?
    一但这个配置类生效;这个配置类就会给容器中添加各种组件;这些组件的属性是从对应的properties类中获取 的,这些类里面的每一个属性又是和配置文件绑定的;
    5)、所有在配置文件中能配置的属性都是在xxxxProperties类中封装者‘;配置文件能配置什么就可以参照某个功 能对应的这个属性类

    总结:
    1)、SpringBoot启动会加载大量的自动配置类
    2)、我们看我们需要的功能有没有SpringBoot默认写好的自动配置类;
    3)、我们再来看这个自动配置类中到底配置了哪些组件;(只要我们要用的组件有,我们就不需要再来配置了)
    4)、给容器中自动配置类添加组件的时候,会从properties类中获取某些属性。我们就可以在配置文件中指定这 些属性的值;

    xxxxAutoConfigurartion:自动配置类; 给容器中添加组件
    xxxxProperties:封装配置文件中相关属性;

    2、补充

    1. @Conditional派生注解(Spring注解版原生的@Conditional作用)
      作用:必须是@Conditional指定的条件成立,才给容器中添加组件,配置配里面的所有内容才生效;
    @ConditionalOnJava    
    系统的java版本是否符合要求
    @ConditionalOnBean   
    容器中存在指定Bean;
    @ConditionalOnMissingBean    
    容器中不存在指定Bean;
    @ConditionalOnExpression    
    满足SpEL表达式指定
    @ConditionalOnClass    
    系统中有指定的类
    @ConditionalOnMissingClass    
    系统中没有指定的类
    @ConditionalOnSingleCandidate    
    容器中只有一个指定的Bean,或者这个Bean是首选Bean
    @ConditionalOnProperty    
    系统中指定的属性是否有指定的值
    @ConditionalOnResource    
    类路径下是否存在指定资源文件
    @ConditionalOnWebApplication    
    当前是web环境
    @ConditionalOnNotWebApplication    
    当前不是web环境
    @ConditionalOnJndi    
    JNDI存在指定项
    
    1. 自动配置类必须在一定的条件下才能生效,怎么知道哪些自动配置类生效?
      可以通过在application.properties里加上debug=true属性,来让控制台打印自动配置报告,这样就可以知道哪些自动配置类生效;
    ============================
    CONDITIONS EVALUATION REPORT
    ============================
    
    
    Positive matches:  (自动配置类启用的)
    -----------------
    
       CodecsAutoConfiguration matched:
          - @ConditionalOnClass found required class 'org.springframework.http.codec.CodecConfigurer' (OnClassCondition)
    
       CodecsAutoConfiguration.JacksonCodecConfiguration matched:
          - @ConditionalOnClass found required class 'com.fasterxml.jackson.databind.ObjectMapper' (OnClassCondition)
    
       CodecsAutoConfiguration.JacksonCodecConfiguration#jacksonCodecCustomizer matched:
          - @ConditionalOnBean (types: com.fasterxml.jackson.databind.ObjectMapper; SearchStrategy: all) found bean 'jacksonObjectMapper' (OnBeanCondition)
    
    。。。。。。(省略)
    
    Negative matches:  (没有启动,没有匹配成功的自动配置类)
    -----------------
    
       ActiveMQAutoConfiguration:
          Did not match:
             - @ConditionalOnClass did not find required class 'javax.jms.ConnectionFactory' (OnClassCondition)
    
       AopAutoConfiguration:
          Did not match:
             - @ConditionalOnClass did not find required class 'org.aspectj.lang.annotation.Aspect' (OnClassCondition)
    
       ArtemisAutoConfiguration:
          Did not match:
             - @ConditionalOnClass did not find required class 'javax.jms.ConnectionFactory' (OnClassCondition)
    
    。。。。。。(省略)
    

    相关文章

      网友评论

          本文标题:SpringBoot自动配置原理

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