Spring Boot - 自动配置实例解读

我就是我 2022-10-15 00:36 14阅读 0赞

### 文章目录 ###

*  Pre
 *  启用 debug=true输出自动配置
 *  HttpEncodingAutoConfiguration
 *   *  什么情况下，Spring Boot 会自动装配 HttpEncodingAutoConfiguration
     *  @EnableConfigurationProperties & ServerProperties
     *  是否生效演示
 *  原理流程图

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70]

--------------------

# Pre #

[Spring Boot - 自动配置实现原理][Spring Boot -]中我们说了自动装配的原理，这里我们继续接着说，用一个自动装配的例子，来感受下Spring Boot 的魅力

![在这里插入图片描述][20210522165238431.png]

--------------------

# 启用 debug=true输出自动配置 #

我们新建一个SpringBoot的工程，在application.properties中 开启属性设置

debug=true

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 1]

启动工程后，输出的格式如下

============================
    CONDITIONS EVALUATION REPORT
    ============================
    
    
    Positive matches:---**表示自动配置类启用的**
    -----------------
    ...省略...
    
    Negative matches:---**没有匹配成功的自动配置类**
    -----------------
    ...省略...

我们找个看看吧

--------------------

# HttpEncodingAutoConfiguration #

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 2]

*  @Configuration(proxyBeanMethods = false)
    
    > 标记了@Configuration Spring底层会给配置创建cglib动态代理。 作用：就是防止每次调用本类的Bean方法而重新创建对象，Bean是默认单例的
 *  @EnableConfigurationProperties(ServerProperties.class)
    
    > 启用可以在配置类设置的属性 对应的类
 *  @ConditionalXXX 根据当前不同的条件判断，决定这个配置类是否生效
    
    > @Conditional派生注解（Spring注解版原生的@Conditional作用）  
    > 作用：必须是@Conditional指定的条件成立，才给容器中添加组件，配置配里面的所有内容才生效；

--------------------

以前写过一篇@Condition的，请移步 [Spring - @Conditional全解][Spring - _Conditional]

<table> 
 <thead> 
  <tr> 
   <th align="left">@Conditional扩展注解</th> 
   <th align="left">作用（判断是否满足当前指定条件）</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">@ConditionalOnJava</td> 
   <td align="left">系统的java版本是否符合要求</td> 
  </tr> 
  <tr> 
   <td align="left">@ConditionalOnBean</td> 
   <td align="left">容器中存在指定Bean；</td> 
  </tr> 
  <tr> 
   <td align="left">@ConditionalOnMissingBean</td> 
   <td align="left">容器中不存在指定Bean；</td> 
  </tr> 
  <tr> 
   <td align="left">@ConditionalOnExpression</td> 
   <td align="left">满足SpEL表达式指定</td> 
  </tr> 
  <tr> 
   <td align="left">@ConditionalOnClass</td> 
   <td align="left">系统中有指定的类</td> 
  </tr> 
  <tr> 
   <td align="left">@ConditionalOnMissingClass</td> 
   <td align="left">系统中没有指定的类</td> 
  </tr> 
  <tr> 
   <td align="left">@ConditionalOnSingleCandidate</td> 
   <td align="left">容器中只有一个指定的Bean，或者这个Bean是首选Bean</td> 
  </tr> 
  <tr> 
   <td align="left">@ConditionalOnProperty</td> 
   <td align="left">系统中指定的属性是否有指定的值</td> 
  </tr> 
  <tr> 
   <td align="left">@ConditionalOnResource</td> 
   <td align="left">类路径下是否存在指定资源文件</td> 
  </tr> 
  <tr> 
   <td align="left">@ConditionalOnWebApplication</td> 
   <td align="left">当前是web环境</td> 
  </tr> 
  <tr> 
   <td align="left">@ConditionalOnNotWebApplication</td> 
   <td align="left">当前不是web环境</td> 
  </tr> 
  <tr> 
   <td align="left">@ConditionalOnJndi</td> 
   <td align="left">JNDI存在指定项</td> 
  </tr> 
 </tbody> 
</table>

--------------------

## 什么情况下，Spring Boot 会自动装配 HttpEncodingAutoConfiguration ##

我们来分析下 在满足什么情况下，Spring Boot 会自动装配 HttpEncodingAutoConfiguration

主要都在这里了

@Configuration(proxyBeanMethods = false)
    @EnableConfigurationProperties(ServerProperties.class)
    @ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET)
    @ConditionalOnClass(CharacterEncodingFilter.class)
    @ConditionalOnProperty(prefix = "server.servlet.encoding", value = "enabled", matchIfMissing = true)

*  @Configuration：表示这是一个配置类，以前编写的配置文件一样，也可以给容器中添加组件
 *  @ConditionalOnWebApplication：Spring底层@Conditional注解（Spring注解版），根据不同的条件，如果满足指定的条件，整个配置类里面的配置就会生效； 判断当前应用是否是web应用，如果是，当前配置类生效
 *  @ConditionalOnClass：判断当前项目有没有这个类CharacterEncodingFilter；SpringMVC中进行乱码解决的过滤器
 *  @ConditionalOnProperty：判断配置文件中是否存在某个配置 spring.http.encoding.enabled；如果不存在，判断也是成立的 . 即使我们配置文件中不配置`server.servlet.encoding.enabled=true`，也是默认生效的
 *  **@EnableConfigurationProperties(\{ServerProperties.class\})：将配置文件中对应的值和 ServerProperties绑定起来；并把 ServerProperties加入到 IOC 容器中并注册.** ConfigurationPropertiesBindingPostProcessor用于将@ConfigurationProperties的类和配置进行绑定

![在这里插入图片描述][20210522171720978.jpg_pic_center]

--------------------

## @EnableConfigurationProperties & ServerProperties ##

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 3]

**ServerProperties通过 @ConfigurationProperties 注解将配置文件与自身属性绑定。**

**@ConfigurationProperties注解的作用就是把全局配置文件中的值绑定到实体类JavaBean上面（将配置文件中的值与ServerProperites绑定起来），而@EnableConfigurationProperties主要是把以绑定值JavaBean加入到spring容器中。**

举个例子： 我们在**application.properties** 声明**spring.application.name** 是通过@ConfigurationProperties注解，绑定到对应的XxxxProperties配置实体类上，然后再通过@EnableConfigurationProperties注解导入到Spring容器中.

![在这里插入图片描述][20210522171648403.jpg_pic_center]

--------------------

## 是否生效演示 ##

我们知道了 Web环境 会生效

非web环境，我们搞一把

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 4]  
not match

--------------------

加入

<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-web</artifactId>
    		</dependency>

以debug=true的形式启动

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 5]

还记得另外一个属性吗？

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

我们设置成 false试试

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 6]

重启 没有自动装配，原因也在下方体现了

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 7]

--------------------

# 原理流程图 #

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 8]

![在这里插入图片描述][20210522171711677.gif_pic_center]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70]: /images/20221014/8d2e51c0206a4a0cb64188dd850189db.png
[Spring Boot -]: https://blog.csdn.net/yangshangwei/article/details/116887020?spm=1001.2014.3001.5501
[20210522165238431.png]: /images/20221014/edf538c5f94e4853b71fe40f3082916f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 1]: /images/20221014/81ac2d74af7c470dae931e4e0b90a69c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 2]: /images/20221014/31faae1567a1491e94918a029df76b4f.png
[Spring - _Conditional]: https://blog.csdn.net/yangshangwei/article/details/115413988
[20210522171720978.jpg_pic_center]: /images/20221014/2e49ccff932349f5b105096963433d5b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 3]: /images/20221014/2e035a8f70c941778927b99b6c2e9a44.png
[20210522171648403.jpg_pic_center]: /images/20221014/ac31c0ed84ff4cc5a8baaf26e9611e7f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 4]: /images/20221014/b4c2ee56f31b4309bfe5ceba5e4d7624.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 5]: /images/20221014/a547c0fa93d94b5ab56ab8e9070f0e4c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 6]: /images/20221014/42c6590c0bf44491ab88c80896ddcc84.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 7]: /images/20221014/64316c2e1a534b5bb641efbd38be018f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 8]: /images/20221014/84842de76666438c930bc83f1af1c1ff.png
[20210522171711677.gif_pic_center]: /images/20221014/2767c07c25ea49a8bce7a2b5965ef280.png