《学会 SpringBoot 系列 · spring.factories 详解》

文章目录

《学会 SpringBoot 系列 · spring.factories 详解》-LMLPHP

写在前面的话

spring.factories 文件是 Spring Boot 项目中的一个重要配置文件，用于定义自动配置、环境后处理器和其他 Spring Boot 组件的实现。这个文件通常位于 META-INF 目录下，Spring Boot 在启动时会读取这个文件，以便加载相应的配置和功能。
此篇博文分享一下 spring.factories 的相关用法。

spring.factories 示例

先上一段示例，如下所示：

# EnableAutoConfiguration 允许注册自动配置类
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
  com.lw.sbex.ExternalConfig

# EnvironmentPostProcessor 允许你在应用程序上下文创建之前修改环境。
org.springframework.boot.env.EnvironmentPostProcessor=\
  com.lw.sbdemo2.common.custom.CustomEnvironmentPostProcessor

# SpringApplicationRunListener 允许你在应用程序的不同生命周期阶段进行操作。
org.springframework.boot.SpringApplicationRunListener=\
  com.lw.sbdemo2.common.start.CustomSpringApplicationRunListener

解析一下这个文件内容：

org.springframework.boot.autoconfigure.EnableAutoConfiguration
这一行定义了自动配置类，Spring Boot 的自动配置功能可以根据类路径中的库和配置自动配置 Spring 应用程序。
org.springframework.boot.env.EnvironmentPostProcessor
这一行定义了环境后处理器。环境后处理器允许开发者在 Spring 应用程序的环境准备阶段对环境进行修改。

public class CustomEnvironmentPostProcessor implements EnvironmentPostProcessor {

    @Override
    public void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application) {
        // 在这里可以添加自定义的环境变量
        environment.getSystemProperties()
                .put("custom.property", "customValue");
        System.out.println("Custom property added to environment: custom.property=customValue");
    }
}

org.springframework.boot.SpringApplicationRunListener
这一行定义了 Spring 应用程序运行监听器。运行监听器可以在 Spring 应用程序的生命周期中执行特定的操作。
com.zoe.onelink.business.init.BizDefaultLoggingLevelApplicationRunner：这个类可能用于设置应用程序的默认日志级别，确保在应用启动时日志记录的行为符合预期。

public class CustomSpringApplicationRunListener implements SpringApplicationRunListener {

    public CustomSpringApplicationRunListener(SpringApplication application, String[] args) {
    }

    @Override
    public void contextPrepared(ConfigurableApplicationContext context) {
        System.out.println("Application context is prepared.");
    }

    @Override
    public void contextLoaded(ConfigurableApplicationContext context) {
        System.out.println("Application context is loaded.");
    }
}

Spring Boot 3.x 的变动

在 Spring Boot 3.x 中，自动配置类的导入可以通过META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports文件来实现。
如下，ExternalConfig是不在启动类目录的配置类。

com.lw.sbex.ExternalConfig

@Configuration
public class ExternalConfig {

    @Bean
    public ExternalService external() {
        return new ExternalService();
    }
}

注意，只是自动配置功能移动到这边，其他功能，比如环境后置处理器和应用程序运行监听器，还是在 spring.factories，如下所示。

# EnvironmentPostProcessor 允许你在应用程序上下文创建之前修改环境。
org.springframework.boot.env.EnvironmentPostProcessor=\
  com.lw.sbdemo2.common.custom.CustomEnvironmentPostProcessor

# SpringApplicationRunListener 允许你在应用程序的不同生命周期阶段进行操作。
org.springframework.boot.SpringApplicationRunListener=\
  com.lw.sbdemo2.common.start.CustomSpringApplicationRunListener

是否需要 @Configuration

spring.factories 配置的类一般用于不在启动类路径下的配置类，此时加不加 @Configuration 注解都可以，但建议加上。
@Configuration 注解是 Spring Boot 自动配置机制中必不可少的，它告诉 Spring Boot 哪类是一个配置类，应该被加载和应用。如果你在 spring.factories 中添加的类没有添加 @Configuration 注解，那么它不会被自动配置。
详细见下方说明：
在Spring框架中，使用spring.factories文件来添加自动配置类确实可以实现自动注册Bean，而不需要显式地使用@Configuration注解。这两种方式的区别主要体现在以下几点：
代码侵入性：
1、使用@Configuration注解的方式更加符合Spring的编程模型，具有更好的代码侵入性。这意味着代码的意图更加明确，易于理解和维护。
2、不使用@Configuration注解，仅仅通过spring.factories文件注册自动配置类，代码的侵入性较低，但可能使得代码的意图不够明确，特别是在大型项目中。
功能限制：
1、当使用@Configuration注解时，可以充分利用Spring提供的各种功能，如@Bean、@Component、@Lazy、@Profile等注解，以及条件注解（如@Conditional系列注解）等。
2、不使用@Configuration注解时，虽然仍然可以注册Bean，但无法直接使用上述功能，需要通过其他方式（如Java Config或XML配置）来实现。
配置的优先级：
1、在Spring Boot项目中，使用@Configuration注解的类会按照配置的顺序被加载，这意味着可以通过调整配置类的加载顺序来控制Bean的创建顺序。
2、通过spring.factories文件注册的自动配置类，其加载顺序可能不如@Configuration类那么容易控制。
Bean的作用域：
1、使用@Configuration注解，可以方便地定义Bean的作用域（如prototype、singleton等）。
2、不使用@Configuration注解时，默认情况下所有的Bean都是singleton作用域，要改变作用域需要通过其他配置方式实现。
总之，虽然不使用@Configuration注解也可以通过spring.factories文件添加自动配置类，但从代码的可读性、可维护性以及功能完整性方面考虑，建议使用@Configuration注解。这样可以使代码更加规范，也便于后续的开发和维护。

总结陈词

本篇文章介绍了 SpringBoot 框架中，使用 spring.factories 进行自动配置等诸多操作，仅供参考。
💗 后续会逐步分享企业实际开发中的实战经验，有需要交流的可以联系博主。

战神刘玉栋