Spring Boot（三）—— 自动装配原理

7. Spring Boot自动装配原理

配置文件属性参照

7.1 自动配置原理

1. Spring Boot启动的时候加载主配置类，开启了自动配置功能 @EnableAutoConfiguration

2. @EnableAutoConfiguration作用：

   • 利用

     @Import({AutoConfigurationImportSelector.class})

     给容器中导入一些组件

   • 导入的组件可以查看其源码中

     public String[] selectImports(AnnotationMetadata annotationMetadata) {

     中的内容

   • return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());
     ​
     this.configurations = Collections.emptyList();

     获取候选配置

     将 类路径下 META-INF/spring.factories 里面配置的所有EnableAutoConfiguration的值加入到了容器中；

     

     每一个这样的 xxxAutoConfiguration类都是容器中的一个组件，都加入到容器中；用他们来做自动配置

3. 以HttpAutoConfiguration（Http编码自动配置）为例解释自动配置原理

   @Configuration( //表示这是一个配置类，和以前的配置文件一样，可以给容器中添加组件
       proxyBeanMethods = false
   )
   ​
   @EnableConfigurationProperties({ServerProperties.class})//启用ConfigurationProperties，从配置文件中获取指定的值和bean的属性进行绑定，并把HttpEncodingProperties加入到IOC容器中
   ​
   @ConditionalOnWebApplication(
       type = Type.SERVLET
   )//Spring底层@conditional注解，根据不同的条件，如果满足指定的条件真个配置类里面的配置才会生效，判断当前应用是否是web应用，如果是当前配置类生效
   ​
   @ConditionalOnClass({CharacterEncodingFilter.class})//判断当前项目有没有CharacterEncodingFilter.class这个类
   //CharacterEncodingFilter，SpringMVC中进行乱码解决的过滤器
   ​
   @ConditionalOnProperty(
       prefix = "server.servlet.encoding",
       value = {"enabled"},
       matchIfMissing = true
   )//判断配置文件中是否存在某个配置，spring.http.encoding.enabled;如果不存在，判断也是成立的
   //即是配置文件中不配置spring.http.encoding.enabled;也是默认生效的
   ​
   public class HttpEncodingAutoConfiguration {
       private final Encoding properties;
   ​
       //只有一个有参构造器的情况下，参数的值就会从容器中拿
       public HttpEncodingAutoConfiguration(ServerProperties properties) {
           this.properties = properties.getServlet().getEncoding();
       }
   ​
       @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;
       }

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

   一旦这个配置生效，这个配置类就会给容器中添加各种组件；这些组件的属性是从对应的properties类中获取的，这些类里面的每一个属性又是和配置文件绑定的

4. 所有在配置文件中能配置的属性都是在xxxProperties类中封装着。配置文件能配置什么就可以参照某个功能对应的这个类属性

精髓

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

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

3. 再看自动配置类中到底配置了哪些组件（只要要用的组件有，就不需要再来配置了）

4. 给容器中自动配置类添加组件的时候，会从prperties类中获取某些属性，我们就可以在配置文件中指定这些属性的值

xxxxAutoConfigurartion：自动配置类；

给容器中添加组件

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

7.2 细节

@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属性，让控制台打印自动配置报告，这样我们就可以方便的知道哪些自动配置类生效了

#开启Spring Boot的debug模式
debug=true

已经启用的自动配置类

未启用的自动配置类