了解 SpringBoot 的自动配置类

前言

• 上一篇文章通过分析知道了 SpringBoot 在启动的时候从类路径下的 META-INF/spring.factories 中获取自动配置类导入容器 ， 帮我们进行自动配置工作。

• 通过约定大于配置的方式，加快开发进度，我们剩下的工作就是修改配置。

属性配置

• SpringBoot 官方文档 中有对配置的说明，但是我们无法全部记住，只有了解原理，配置属性的时候才能得心应手。

  

@Conditional 注解

• 了解完自动装配的原理后，我们来关注一个细节问题，自动配置类必须在一定的条件下才能生效；

@Conditional 派生注解

• 作用：必须是@Conditional指定的条件成立，才给容器中添加组件，配置配里面的所有内容才生效；

  @ConditionalOnClass ： classpath 中存在该类时起效 
  @ConditionalOnMissingClass ： classpath 中不存在该类时起效 
  @ConditionalOnBean ： DI 容器中存在该类型 Bean 时起效 
  @ConditionalOnMissingBean ： DI 容器中不存在该类型 Bean 时起效 
  @ConditionalOnSingleCandidate ： DI 容器中该类型 Bean 只有一个或@Primary 的只有一个时起效 
  @ConditionalOnExpression ： SpEL 表达式结果为 true 时 
  @ConditionalOnProperty ： 参数设置或者值一致时起效 
  @ConditionalOnResource ： 指定的文件存在时起效 
  @ConditionalOnJndi ： 指定的 JNDI 存在时起效 
  @ConditionalOnJava ： 指定的 Java 版本存在时起效 
  @ConditionalOnWebApplication ： Web 应用环境下起效 
  @ConditionalOnNotWebApplication ： 非 Web 应用环境下起效

• @Conditional 注解主要用在以下位置：

  • 可以放在注标识有@Component（包含@Configuration）的类上
  • 作为一个 meta-annotation, 组成自定义注解
  • 方法级别可以放在标识由@Bean 的方法上
  • 如果一个@Configuration 的类标记了@Conditional，所有标识了@Bean 的方法和@Import 注解导入的相关类将遵从这些条件。

  //@Conditional 定义
  @Retention(RetentionPolicy.RUNTIME)  
  @Target(ElementType.TYPE, ElementType.METHOD)  
  public @interface Conditional{  
      Class<? extends Condition>[] value();
  } 

自定义 Conditional

• 实现 Condtin 接口，完成对系统环境判断

  package top.fulsun.helloworld.condition;
  
  import org.springframework.context.annotation.Condition;
  import org.springframework.context.annotation.ConditionContext;
  import org.springframework.core.type.AnnotatedTypeMetadata;
  
  /**
   * @className: LinuxCondition
   * @Description: 实现了 Condtin 接口，重载的方法返回一个基于操作系统类型的布尔值。
   * @version: v1.８.0
   * @author: Fulsun
   * @date: 2020/3/27 22:14
   */
  public class LinuxCondition implements Condition {
      @Override
      public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) {
          return conditionContext.getEnvironment().getProperty("os.name").contains("Linux");
      }
  }
  
  //===================================
  
  package top.fulsun.helloworld.condition;
  
  import org.springframework.context.annotation.Condition;
  import org.springframework.context.annotation.ConditionContext;
  import org.springframework.core.type.AnnotatedTypeMetadata;
  
  /**
   * @className: WindowsCondition
   * @Description: 实现了 Condtin 接口，重载的方法返回一个基于操作系统类型的布尔值。
   * @version: v1.８.0
   * @author: Fulsun
   * @date: 2020/3/27 22:15
   */
  public class WindowsCondition implements Condition {
      @Override
      public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) {
          return conditionContext.getEnvironment().getProperty("os.name").contains("Windows");
      }
  }

• 定义两个 bean

  package top.fulsun.helloworld.condition;
  
  import org.springframework.context.annotation.Bean;
  import org.springframework.context.annotation.Conditional;
  import org.springframework.context.annotation.Configuration;
  
  /**
   * @className: MyConfiguration
   * @Description: 定义两个 bean, 一个符合条件另外一个不符合条件：
   * @version: v1.８.0
   * @author: Fulsun
   * @date: 2020/3/27 22:18
   */
  @Configuration
  public class MyConfiguration {
      @Bean(name = "emailerService")
      @Conditional(WindowsCondition.class)
      public void windowsEmailerService() {
          System.out.println("send windows email");
      }
  
      @Bean(name = "emailerService")
      @Conditional(LinuxCondition.class)
      public void linuxEmailerService() {
          System.out.println("send linux email");
      }
  }

• 修改配置文件，启动主启动类，实现判断后自动导入

  os:
    name: Windows # linux

自动配置分析

了解配置类

• 我们以HttpEncodingAutoConfiguration（Http 编码自动配置）为例解释自动配置原理；

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

• 一句话总结 ：根据当前不同的条件判断，决定这个配置类是否生效！这个配置类生效，就会给容器中添加各种组件；

属性分析

• 通过分析配置类，属性是从对应的 properties 类中获取的

  // 从 ServerProperties 类中获取信息
  public HttpEncodingAutoConfiguration(ServerProperties properties) {
      this.properties = properties.getServlet().getEncoding();
  }

• 配置类上的通过注解@EnableConfigurationProperties({XXXXProperties.class})将 properties 类注入到容器中

  @EnableConfigurationProperties(ServerProperties.class)
  public class HttpEncodingAutoConfiguration {
  // ...
  }

• 查看 ServerProperties 类，发现类里面的每一个属性又是和配置文件绑定的；

• 通过上面的分析，我们在配置文件中能配置的属性都是在 xxxxProperties 类中封装着，配置文件能配置什么就可以参照某个功能对应的这个属性类，避免去记忆大量的配置。

  

查看生效配置类

• 那么多的自动配置类，必须在一定的条件下才能生效；也就是说，我们加载了这么多的配置类，但不是所有的都生效了。我们怎么知道哪些自动配置类生效？

• 我们可以通过启用 debug=true 属性；来让控制台打印自动配置报告，这样我们就可以很方便的知道哪些自动配置类生效；

  #开启 springboot 的调试类
  debug: true

• Positive matches:（自动配置类启用的：正匹配）

• Negative matches:（没有启动，没有匹配成功的自动配置类：负匹配）

• Unconditional classes: （没有条件的类）

  

小结

1. SpringBoot 启动会加载大量的自动配置类

2. 我们看我们需要的功能有没有在 SpringBoot 默认写好的自动配置类当中；

3. 我们再来看这个自动配置类中到底配置了哪些组件；（只要我们要用的组件存在在其中，我们就不需要再手动配置了）

4. 给容器中自动配置类添加组件的时候，会从 properties 类中获取某些属性。我们只需要在配置文件中指定这些属性的值即可；

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

本文作者： 凉月
发布时间： 2020-03-25
最后更新： 2022-02-12
本文标题： 了解 SpringBoot 的自动配置类
本文链接： https://fulsun.github.io/post/627ee5dd.html
版权声明： 本作品采用 CC BY-NC-SA 4.0 许可协议进行许可。转载请注明出处！