SpringBoot 这两个配置文件有什么区别？

news2024/11/24 14:47:54

本文讲解了关于 SpringBoot 自动装配的两个配置文件spring.factories 和 spring-autoconfigure-metadata.properties有什么区别？

点击上方“后端开发技术”，选择“设为星标” ，优质资源及时送达

读过上一片文章你可能会发现，在自动装配相关源码阅读的过程中涉及到了两个配置文件 spring.factories 和 spring-autoconfigure-metadata.properties，如果查看过内容，你会觉得他们非常相似。

那么 spring.factories 和 spring-autoconfigure-metadata.properties有什么区别呢？

SpringBoot 自动装配原理，一文掌握！｜原创

2022-12-27

spring.factories

“约定大于配置”在 Springboot 是一个很重要的思想，有一个约定就是 SpringBoot 启动的时候会加载 META-INF/spring.factories 配置文件。在 spring.factories 文件中，配置都是按照 Key-Value 形式保存的，Key 是需要解析类的全路径名，Value 是一个或多个类的全路径名，用逗号分隔，并且 spring.factories 文件可能有多个。Spring Boot 自动装配解析的核心配置文件就是它。

以 Feign 举例：

# spring.factories 文件
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.springframework.cloud.openfeign.ribbon.FeignRibbonClientAutoConfiguration,\
org.springframework.cloud.openfeign.FeignAutoConfiguration,\
org.springframework.cloud.openfeign.encoding.FeignAcceptGzipEncodingAutoConfiguration,\
org.springframework.cloud.openfeign.encoding.FeignContentGzipEncodingAutoConfiguration

spring-autoconfigure-metadata.properties

spring.factories 和 spring-autoconfigure-metadata.properties 类似，都是位于 META-INF 目录下的文件，并且都是 Key-Value 形式保存数据。不同的是，后者的 Key 的格式为 类的全路径名.自动装配条件，Value 为 类的全路径名，使用逗号分隔。它管理的是 Bean 的装配条件。

假设有两个类需要自动装配，但是有装配的顺序要求，这就无法仅仅依靠 spring.factories 来实现，于是有了 spring-autoconfigure-metadata.properties，他的 Key 后面追加名字就代表了对应的装配条件。

以 Feign 的配置文件举例：

org.springframework.cloud.openfeign.encoding.FeignAcceptGzipEncodingAutoConfiguration.AutoConfigureAfter=org.springframework.cloud.openfeign.FeignAutoConfiguration

上面这段配置就代表 FeignAcceptGzipEncodingAutoConfiguration 必须在 FeignAutoConfiguration 装配之后再装配。

如何生成 spring-autoconfigure-metadata.properties

如果你阅读过源码，可能会发现源码文件中并没有找到 spring-autoconfigure-metadata.properties 文件，但是编译好的包中却有，这是怎么一回事呢？

因为它是自动生成的！

对于类路径上的每个自动配置类，Spring Boot 必须计算 @ConditionalXXX 条件值，用于决定是否加载自动配置及其所需的所有类，根据 Spring 启动应用程序中 starter 的数量，这可能会花费很多时间，为了提升启动时间，我们需要在 pom.xml 中添加一个依赖:

<dependency>  
    <groupId>org.springframework.boot</groupId>  
    <artifactId>spring-boot-autoconfigure-processor</artifactId> 
    <optional>true</optional>  
</dependency>

这样它会解析各种 condition，生成 spring-autoconfigure-metadata.properties 文件。这样，Spring Boot 在启动期间读取这些元数据，可以过滤出不满足条件的配置，而不必实际检查这些类，提升启动速度。