当前位置：首页 > news >正文

SpringBoot3.0不建议使用spring.factories，使用AutoConfiguration.imports新的自动配置方案

news 来源：原创 2025/4/28 1:14:53

文章目录

一、写在前面
二、使用imports文件
- 1、使用
- 2、示例比对
- 3、完整示例
参考资料

一、写在前面

spring.factories是一个位于META-INF/目录下的配置文件，它基于Java的SPI(Service Provider Interface)机制的变种实现。
这个文件的主要功能是允许开发者声明接口的实现类，从而实现SpringBoot的自动装配和扩展点注册。

这个文件在SpringBoot2.7以前，真就是SpringBoot的扩展神器，各种自动配置的插件几乎都是基于这种方式来实现的。
但是SpringBoot2.7以后，spring.factories就不是最优解了，而是替换为了META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports。

具体文档地址：https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-2.7-Release-Notes#changes-to-auto-configuration
在这里插入图片描述
以下是翻译：

简单来说，只需要创建一个META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports文件，每一行都是一个自动配置的条目即可，用法比以前简洁不少。

而以前的spring.factories的org.springframework.boot.autoconfigure.EnableAutoConfiguration键已经被删除了，详情：
https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-3.0-Migration-Guide
在这里插入图片描述

在这里插入图片描述

二、使用imports文件

1、使用

从SpringBoot 3.0开始，引入了基于imports文件的新机制，作为spring.factories的替代方案。这些文件位于META-INF/spring/目录下，每种类型的扩展点对应一个专门的文件：
在这里插入图片描述

2、示例比对

旧方式（spring.factories）：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.example.FooAutoConfiguration,\
com.example.BarAutoConfiguration

新方式（AutoConfiguration.imports）：

com.example.FooAutoConfiguration
com.example.BarAutoConfiguration

3、完整示例

// 1. 创建配置属性类
@ConfigurationProperties(prefix = "myapp")
publicclass MyProperties {
    privateboolean enabled = true;
    private String name = "default";
    
    // getter和setter方法
    // ...
}

// 2. 创建自动配置类
@AutoConfiguration// 注意这里使用了@AutoConfiguration而非@Configuration
@EnableConfigurationProperties(MyProperties.class)
@ConditionalOnProperty(prefix = "myapp", name = "enabled", havingValue = "true", matchIfMissing = true)
publicclass MyAutoConfiguration {
    
    privatefinal MyProperties properties;
    
    public MyAutoConfiguration(MyProperties properties) {
        this.properties = properties;
    }
    
    @Bean
    @ConditionalOnMissingBean
    public MyService myService() {
        // 根据属性创建服务
        returnnew MyServiceImpl(properties.getName());
    }
}