Spring Boot 自动配置原理

2019-05-29 本文已影响0人 OOMNPE

自动配置原理

1、过程

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

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

...

利用AutoConfigurationImportSelector.class给容器中导入N多的组件：

源码重现：

1）、通过AutoConfigurationImportSelector.class里的selectImports方法中的getCandidateConfigurations，获取候选的配置

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

2)、将类路径下META-INF/spring.factories里面配置的所有EnableAutoConfiguration的值放到容器中。

3）、这样的每一个xxxAutoConfiguration类都是一个自动配置类，这样的每一个类对应一个XXXProperties配置节点类，专门控制XXX可以有哪些节点配置以及默认的配置值

4）、 xxxAutoConfiguration配置类只有满足一定的条件（比如@ConditionalOnClass）整个配置类才能生效，也才能放到容器中。

@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;
    }

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

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

2、注解说明

@ConditionalOnClass

@ConditionalOnClass：表示存在对应的Class文件时才会去解析RabbitAutoConfiguration，否则直接跳过不解析，这也是为什么在不导入RabbitMQ依赖Jar时工程能正常启动的原因

@Configuration
@ConditionalOnClass({ RabbitTemplate.class, Channel.class })
@EnableConfigurationProperties(RabbitProperties.class)
@Import(RabbitAnnotationDrivenConfiguration.class)
public class RabbitAutoConfiguration {

@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存在指定项