zoukankan      html  css  js  c++  java
  • SpringBoot自动配置原理

    SpringBoot自动配置原理

    本节主要分析:

    • 核心注解SpringBootApplication注解
    • EnableAutoConfiguration自动配置的源码分析

    1 SpringBootApplication注解

    @SpringBootApplication,标识某个类上说明这个类是 SpringBorn的主配置类。

    @Target({ElementType.TYPE})
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    @Inherited
    @SpringBootConfiguration
    @EnableAutoConfiguration
    @ComponentScan(
        excludeFilters = {@Filter(
        type = FilterType.CUSTOM,
        classes = {TypeExcludeFilter.class}
    ), @Filter(
        type = FilterType.CUSTOM,
        classes = {AutoConfigurationExcludeFilter.class}
    )}
    )
    public @interface SpringBootApplication
    

    1.1 @ SpringBootConfiguration: Spring Boot的配置类

    标注在某个类上,表示这是一个 Spring boot的配置类;

    @Target({ElementType.TYPE})
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    @Configuration
    public @interface SpringBootConfiguration {
    }
    

    @ Configuration配罩类上来标注这个注解; 配置类---配置文件。配置类,本质上也是容器中的一个组件;@ Component

    1.2 @ EnableAutoConfiguration:开启自动配置功能

    以前我们需要配置的东西, Spring boot帮我们自动配置;@ EnableAuto Configuration告诉Springboot开启自动配置功能:这样自动配置才能生效。

    @Target({ElementType.TYPE})
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    @Inherited
    @AutoConfigurationPackage
    @Import({AutoConfigurationImportSelector.class})
    public @interface EnableAutoConfiguration {
        String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";
    
        Class<?>[] exclude() default {};
    
        String[] excludeName() default {};
    }
    

    @ AutoConfigurationPackage:自动配置包

    @Target({ElementType.TYPE})
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    @Inherited
    @Import({Registrar.class})
    public @interface AutoConfigurationPackage {
    }
    

    @Import({Registrar.class})

    Spring的底层注解@Import,给容器中导入一个组件;导入的组件由AutoConfigurationPackages. Registrar. class

    主要作用是:将主配置类(@ Spring BootApplicationa标注的类)的所在包及下面所有子包里面的所有组件扫描到 Spring容器

    image

    @Import({AutoConfigurationImportSelector.class}) 给容器导入组件。

    AutoConfigurationImportSelector :导入哪些组件的选择器。将所有需要导入的组件以全类名的方式返回;这些组件就会被添加到容器中。会给容器中导入非常多的自动配置类( XXXAutoConfiguration),并配置号这些组件。

    image

    protected List<String> getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) {
       List<String> configurations = SpringFactoriesLoader.loadFactoryNames(getSpringFactoriesLoaderFactoryClass(),
             getBeanClassLoader());
       Assert.notEmpty(configurations, "No auto configuration classes found in META-INF/spring.factories. If you "
             + "are using a custom packaging, make sure that file is correct.");
       return configurations;
    }
    

    Spring Boot在启动的时候从类路径下的 META-INF/spring.factories中获取 EnableAutoConfiguration指定的值,将这些值封装成Properties对象,并返回给加载器。

    image

    而外部传入的class是EnableAutoConfiguration.class,也就是说从 properties中获取到EnableAutoConfiguration.class类对应的很多配置加载到容器中,每个配置都是自动配置类xxxAutoConfigration。每个Configuration类作为容器的组件加载到容器中,进行自动配置。

    protected Class<?> getSpringFactoriesLoaderFactoryClass() {
        return EnableAutoConfiguration.class;
    }
    SpringFactoriesLoader.loadFactoryNames(EnableAutoConfiguration.class, classLoader)
    

    以HttpEncodingAutoConfiguration为例,自动配置类上有多个注解。所有配置类的属性都在xxProperties类中封装,配置类配置了什么功能可以参考属性文件。

    // 标识配置类
    @Configuration
    // 启用ConfigurationProperties功能呢,绑定HttpProperties属性类,注入到IOC容器中
    @EnableConfigurationProperties(HttpProperties.class)
    // conditional是spring底层注解,满足指定条件,则配置类中的配置才会生效
    // 本例中是满足web应用时,配置生效
    @ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET)
    // 判断是否有CharacterEncodingFilter过滤器
    @ConditionalOnClass(CharacterEncodingFilter.class)
    // 判断是否存在某个配置spring.http.encoding.enabled,如果没有配置这条属性,默认生效
    @ConditionalOnProperty(prefix = "spring.http.encoding", value = "enabled", matchIfMissing = true)
    public class HttpEncodingAutoConfiguration {
        private final HttpProperties.Encoding properties;
    
        // 指定使用HttpProperties中的Encoding属性
    	public HttpEncodingAutoConfiguration(HttpProperties properties) {
    		this.properties = properties.getEncoding();
    	}
    
        // 返回Bean,使用properties
    	@Bean
    	@ConditionalOnMissingBean
    	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;
    	}
    }
    

    如果AutoConfiguration类的所有条件都满足,就会执行自动配置,创建Bean注入到容器中。由此可见,META-INF/spring.factories的EnableAutoConfiguration属性配置了很多自动配置类名,并不是所有的都生效。

    一但这个配置类生效;这个配置类就会给容器中添加各种组件:这些组件的属性是从对应的 properties类中获取的,这些类里面的每一个属性又是和配置文件绑定的。我们在项目配置文件中能配置下面的属性,属性来源主要是HttpProperties属性绑定类。

    spring.http.encoding.enabled=true
    spring.http.encoding.charset=utf-8
    spring.http.encoding.force=true
    

    J2E的整体整合解决方案和自动配置都在 spring-boot-autoconfigure-2.XX. RELEASE. jar;

    SpringBoot自动配置的总结与运用

    SpringBoot启动时会加载大量自动配置类,我们根据需要的功能查看springboot是否默认自动配置,如果用到的组件已经加载,就不用自己配置了。springboot自动配置类添加组件时,会从properties类中获取某些属性。如果对这些默认属性不满意,可以在项目配置文件中自定义配置。

    @ Conditional派生注解( spring注解版原生的@Conditional作用)

    作用:必须是@Conditional指定的条件成立,才给容器中添加组件,配置配里面的所有内容才生效。自动配置类必须在一定条件下才生效,例如上面的HttpEncodingAutoConfiguration自动配置类必须满足是web应用,具有编码过滤器,并且没有该bean时才生成。

    然而,如果对于每个配置类都要挨个查是否生效配置,效率太差。我们可以启动springboot的debug属性,在控制台打印自动配置报告。

    debug:
    	true
    
    Positive matches:生效
    Negative matches:未生效
    
    版权声明:本文为博主原创文章,未经博主允许不得转载。
  • 相关阅读:
    二层、三层、四层交换机的区别
    在origin 中任意设定X坐标值
    Eclipse 配置 ONE 仿真环境
    ns3 安装
    sprintf 函数
    transition属性实现hover渐变动画效果
    Mybatis处理oracle的clob类型
    Mybatis模糊查询(like)
    java.lang.OutOfMemoryError: PermGen space错误
    ORA-28000: the account is locked-的解决办法
  • 原文地址:https://www.cnblogs.com/dtyy/p/15431676.html
Copyright © 2011-2022 走看看