Spring Boot自动配置的原理简介以及配置文件的优先级

Posted 2021-07-23 L-Java

  基于Spring Boot 2.x详细介绍了Spring Boot自动配置的原理以及配置文件的优先级。

  我正在参与CSDN《新程序员》有奖征文，活动地址：https://marketing.csdn.net/p/52c37904f6e1b69dc392234fff425442。

文章目录

• 1 @SpringBootApplication自动配置原理
• 2 @Conditional系列条件注解
• 3 配置文件加载优先级

1 @SpringBootApplication自动配置原理

  @SpringBootApplication是一个组合注解，主要由@ComponentScan、@SpringBootConfiguration、@EnableAutoConfiguration这三个注解组成。

  @ComponentScan用于扫描指定包及子包路径，并将符合条件的组件类注册到Spring容器中 。默认的包路径是当前@ComponentScan所在的包及其子包。默认的过滤条件是，如果类上具有包括@Component、@Service、@Repository、@Controller、@Configuration等注解，那么该类作为组件类而被注册到容器中，也可以通过指定includeFilters和excludeFilters属性来自定义条件。
  @SpringBootConfiguration用于声明当前类是一个Spring Boot配置类，具有和@Configuration注解同样的作用。但应用程序中可以添加N个@Configuration注解的配置类，但是只能存在一个@SpringBootConfiguration注解的配置类。推荐使用@SpringBootConfiguration来表示作为一个Boot应用程序的启动类。
  @EnableAutoConfiguration用于声明在程序启动时，将会自动加载Spring Boot默认的配置 。内部主要是借助 @Import注解引入的AutoConfigurationImportSelector类，该类借助SpringFactoriesLoader工具获取spring-boot-autoconfigure.jar下的/META-INF/spring.factories文件中的配置信息，其中名为“org.springframework.boot.autoconfigure.EnableAutoConfiguration”的key对应的value就是一系列自动配置类的全路径名。实际上所有 Spring Boot Starter下的META-INF/spring.factories都会被读取到。

  Spring将会拆分这个value为一个全路径名集合，但他并不会将这些配置类全都加载，而是会将符合规则的自动配置类加载到Spring 容器中。
  在过滤的时候，将会检查类上的Conditional系列注解，@ConditionalOnClass和@ConditionalOnMissingClass、@ConditionalOnWebApplication和@ConditionalOnNotWebApplication、@ConditionalOnBean和@ConditionalOnMissingBean和@ConditionalOnSingleCandidate注解（如果存在），只有符合规则的自动配置类才会注册到容器中。
  我们也可以通过@SpringBootApplication的exclude和excludeName属性指定排除某些自动配置类的注册，这样Spring Boot就不会自动注册某些配置。
  这些自动配置类基本上都是@Configuration注解标注，其内部均有一系列的@Bean方法。当加载到容器中之后，这些自动配置类将会被解析，就有可能进行一系列自动化的配置。

2 @Conditional系列条件注解

  @Conditional注解用于判断某个配置是否需要跳过，并且可被用作元注解而标注在其他注解上，这样就提供了丰富的校验机制，可用于判断某个自动配置类是否需要进行某些自动配置。
  spring-boot-autoconfigure包中提供了一系列的@Conditional注解的衍生注解，它们已被标注在各种自动配置类上，，当条件满足时，就会进行自动配置。我们也可以直接使用，常见的@Conditional系列注解如下：

@ConditionalOnBean	容器里存在指定类型的Bean时生效
@ConditionalOnClass	类路径存在指定的类时生效
@ConditionalOnExpression	SpEL表达式结果为true时生效
@ConditionalOnJava	指定的Java版本存在时生效
@ConditionalOnJndi	指定的JNDI存在时生效
@ConditionalOnMissingBean	容器里不存在指定类型的Bean时生效
@ConditionalOnMissingClass	类路径不存在指定的类时生效
@ConditionalOnNotWebApplication	当前项目不是 Web 项目时生效
@ConditionalOnWebApplicatio	当前项目是 Web 项目时生效
@ConditionalOnProperty	指定的属性值和预期值一致时生效
@ConditionalOnResource	类路径存在指定的资源时生效
@ConditionalOnSingleCandidate	容器里指定类型的Bean只有一个或或者指定了一个首选Bean（@Primary）时生效

3 配置文件加载优先级

  Spring boot支持非常多的配置，常见的外部配置和内部配置的整体优先级（https://docs.spring.io/spring-boot/docs/2.3.10.RELEASE/reference/html/spring-boot-features.html#boot-features-external-config）：

1. 命令行参数，比如–server.port=8080。
2. JVM系统属性，通过System.getProperties()方法获取。
3. 系统环境属性，通过System.getenv()方法获取。
4. jar包外部的application-{profile}.properties/yml配置文件，如果没有指明激活的profile，则默认为default。
5. jar包内部的application-{profile}.properties/yml配置文件，如果没有指明激活的profile，则默认为default。
6. jar包外部的application.properties/yml配置文件。
7. jar包内部的application.properties/yml配置文件。
8. 通过@Configuration注解类上的@PropertySource注解引入的配置文件。

  配置文件查找时首先查找指定profile的，然后再查找没有profile的。查找的目录优先级（https://docs.spring.io/spring-boot/docs/2.3.10.RELEASE/reference/html/spring-boot-features.html#boot-features-external-config-application-property-files）：

1. 项目根目录下的/config目录下的配置文件。
2. 项目根目录下的配置文件。
3. 项目类路径（resources）下的/config目录下的配置文件。
4. 项目类路径（resources）下的配置文件。

  同一目录下，.properties文件优先于.yml文件加载。
  可以使用spring.config.location属性替换默认查找位置，也可以使用spring.config.additional-location属性来添加额外的配置位置，将会首先查找指定的位置然后查找默认位置。
  需要注意的是，项目根目录下的配置文件或者/config目录下的配置文件在打包的时候不会被打入jar包中，因此一般很少用到。

  bootstrap和application的优先级：
  bootstrap配置文件由spring父上下文加载，并且比application配置文件优先加载（父上下文不会使用application配置文件），而application配置文件由子上下文加载。bootstrap加载的配置信息不能被application的相同配置覆盖。
  但是注意，如果要使用配置文件中的变量，那么同名变量将使用application文件中的配置，比如如果两个配置文件都有server.post变量，那么Spring将使用application中配置的值。为什么？因为在Environment中，application配置文件的propertySource排在bootstrap配置文件的propertySource之前，Spring 在进行属性注入、获取时，将会顺序遍历所有的propertySource查找属性，如果找到了就直接返回。.peoperties文件比.yaml文件的属性查找优先级更高的原理一样。

相关文章：
  https://spring.io/
  Spring Framework 5.x 学习
  Spring MVC 5.x 学习
  Spring Framework 5.x 源码

如有需要交流，或者文章有误，请直接留言。另外希望点赞、收藏、关注，我将不间断更新各种Java学习博客！