【SpringBoot】6、自动配置原理【狂神篇】

SpringBoot 官方文档中有大量的配置，无法全部记住

1、分析自动配置原理

以 HttpEncodingAutoConfiguration（Http编码自动配置）为例分析自动配置原理

@Configuration(
    proxyBeanMethods = false
)
@EnableConfigurationProperties({ServerProperties.class})
@ConditionalOnWebApplication(
    type = Type.SERVLET
)
@ConditionalOnClass({CharacterEncodingFilter.class})
@ConditionalOnProperty(
    prefix = "server.servlet.encoding",
    value = {"enabled"},
    matchIfMissing = true
)
public class HttpEncodingAutoConfiguration {
    // 已经和SpringBoot的配置文件映射了
    private final Encoding properties;

    // 只有一个有参构造器的情况下，参数的值就会从容器中拿
    public HttpEncodingAutoConfiguration(ServerProperties properties) {
        this.properties = properties.getServlet().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.web.servlet.server.Encoding.Type.REQUEST));
        filter.setForceResponseEncoding(this.properties.shouldForce(org.springframework.boot.web.servlet.server.Encoding.Type.RESPONSE));
        return filter;
    }
}

• @Configuration

  表示这是一个配置类，和以前编写的配置文件一样，也可以给容器中添加组件

• @EnableConfigurationProperties

  启动指定类的 ConfigurationProperties 功能

  • ServerProperties.class

  @ConfigurationProperties(
      prefix = "server",
      ignoreUnknownFields = true
  )
  public class ServerProperties {
      // ...
      private final ServerProperties.Servlet servlet;
      // ...
      
      // 内部静态类
      public static class Servlet {
          //
          private final Encoding encoding = new Encoding();        
  
          public Encoding getEncoding() {
              return this.encoding;
          }        
      }
  }    
  

• @ConditionalOnXxx

  根据不同的条件判断，如果满足指定的条件，整个配置类里面的配置就会生效

  • @ConditionalOnWebApplication(type = Type.SERVLET)

    判断当前应用是否是web应用，如果是，当前配置类生效

  • @ConditionalOnClass({CharacterEncodingFilter.class})

    判断当前项目有没有这个类CharacterEncodingFilter；

    SpringMVC 中解决乱码的过滤器；

  • @ConditionalOnProperty( prefix = "server.servlet.encoding", value = {"enabled"}, matchIfMissing = true )

    判断配置文件中是否存在某个配置：server.servlet.encoding

    matchIfMissing = true

    如果不存在，判断也是成立的；即使配置文件中不配置 server.servlet.encoding = true，也是默认生效的；

总结：根据当前不同的条件判断，决定这个配置类是否生效！

• 一但这个配置类生效；就会给容器中添加各种组件；
• 这些组件的属性是从对应的 properties类 中获取的，这些类里面的每一个属性又是和配置文件绑定的；
• 所有在配置文件中能配置的属性都是在 XxxProperties类 中封装着；
• 配置文件能配置什么就可以参照某个功能对应的这个属性类

2、精髓

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

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

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

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

XxxAutoConfigurartion 自动配置类，给容器中添加组件

XxxProperties 封装配置文件中相关属性

3、@Conditional

自动配置类必须在一定的条件下才能生效

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

那么多的自动配置类，必须在一定的条件下才能生效；也就是说，虽然加载了这么多的配置类，但不是所有的都生效了。

如何知道哪些自动配置类生效？

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

#开启springboot的调试类
debug=true

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

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

Unconditional classes: （没有条件的类）