• Spring Boot 自动配置原理


    自动配置原理
    配置文件到底能写什么?怎么写?自动配置原理;

    参考: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);获取候选的配置

     注:      

    SpringFactoriesLoader.loadFactoryNames()
    扫描所有jar包类路径下  META‐INF/spring.factories
    把扫描到的这些文件的内容包装成properties对象
    从properties中获取到EnableAutoConfiguration.class类(类名)对应的值,然后把他们添加在容器

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

     

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

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

    以HttpEncodingAutoConfiguration(Http编码自动配置)为例解释自动配置原理;


      

    @Configuration   //表示这是一个配置类,以前编写的配置文件一样,也可以给容器中添加组件
        @EnableConfigurationProperties(HttpEncodingProperties.class)  //启动指定类的ConfigurationProperties功能;将配置文件中对应的值和HttpEncodingProperties绑定起来;并把HttpEncodingProperties加入到ioc容器中
        @ConditionalOnWebApplication //Spring底层@Conditional注解(Spring注解版),根据不同的条件,如果满足指定的条件,整个配置类里面的配置就会生效;    判断当前应用是否是web应用,如果是,当前配置类生效
        @ConditionalOnClass(CharacterEncodingFilter.class)  //判断当前项目有没有这个类CharacterEncodingFilter;SpringMVC中进行乱码解决的过滤器;
        @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类中获取
    的,这些类里面的每一个属性又是和配置文件绑定的;

     所有在配置文件中能配置的属性都是在xxxxProperties类中封装者‘;配置文件能配置什么就可以参照某个功
    能对应的这个属性类

    @ConfigurationProperties(prefix = "spring.http.encoding")  //从配置文件中获取指定的值和bean的属
    性进行绑定
    public class HttpEncodingProperties {
       public static final Charset DEFAULT_CHARSET = Charset.forName("UTF‐8");

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

    xxxxAutoConfigurartion:自动配置类;
    给容器中添加组件

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

    细节
    1、@Conditional派生注解(Spring注解版原生的@Conditional作用)
          作用:必须是@Conditional指定的条件成立,才给容器中添加组件,配置配里面的所有内容才生效;

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

     底层都是 @Conditional

    自动配置类必须在一定的条件下才能生效;
    我们怎么知道哪些自动配置类生效?
    我们可以通过在 yml中启用 debug=true属性;

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

     会打印日志:

    =========================
    AUTO‐CONFIGURATION REPORT
    =========================
    Positive matches:(自动配置类启用的)
    ‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐
       DispatcherServletAutoConfiguration matched:

     ‐ @ConditionalOnClass found required class
    'org.springframework.web.servlet.DispatcherServlet'; @ConditionalOnMissingClass did not find
    unwanted class (OnClassCondition)
          ‐ @ConditionalOnWebApplication (required) found StandardServletEnvironment
    (OnWebApplicationCondition)
           
       
    Negative matches:(没有启动,没有匹配成功的自动配置类)
    ‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐
       ActiveMQAutoConfiguration:
          Did not match:
             ‐ @ConditionalOnClass did not find required classes 'javax.jms.ConnectionFactory',
    'org.apache.activemq.ActiveMQConnectionFactory' (OnClassCondition)
       AopAutoConfiguration:
          Did not match:
             ‐ @ConditionalOnClass did not find required classes
    'org.aspectj.lang.annotation.Aspect', 'org.aspectj.lang.reflect.Advice' (OnClassCondition)

    近期项目做的案例


    yml:

    yml:
     # 自定义配置参数
    default:
      job-thread-pool:
        corePoolSize: 10
        maximumPoolSize: 200
        keepAliveTime: 0
        nameFormat: Job-Thread-%d
        queueCapacity: 1024

    对应的类去读取成Bean:

    @Getter
    @Setter
    @ConfigurationProperties(prefix = "default.job-thread-pool")
    public class JobThreadPoolConfig {
        private int corePoolSize;
        private int maximumPoolSize;
        private long keepAliveTime;
        private String nameFormat;
        private int queueCapacity;
    }

    config中去获取配置信息:

    
    @Configuration
    @Slf4j
    @EnableConfigurationProperties({JobThreadPoolConfig.class})
    public class CommonConfiguration {
     
        @Autowired
        private JobThreadPoolConfig jobThreadPoolConfig;
  • 相关阅读:
    超能英雄第一至四季/全集Heroes迅雷下载
    吸血鬼猎人巴菲第一至八季/全集Buffy迅雷下载
    明星伙伴第一至八季/全集Entourage迅雷下载
    实习医生风云第一至九季/全集Scrubs迅雷下载
    阿里云linux图形界面(centos6)
    linux下mysql的root密码忘记解决方
    wdcp支持两种安装方式
    如何搭建lamp(CentOS7+Apache+MySQL+PHP)环境
    丑女贝蒂第一至四季/全集Ugly Betty迅雷下载
    云服务器 ECS Linux 系统安装图形化桌面 (centos7 ubuntu14)
  • 原文地址:https://www.cnblogs.com/toov5/p/10640023.html
Copyright © 2020-2023  润新知