org.springframework.boot.autoconfigure.AutoConfiguration.imports 是 Spring Boot 2.4 引入的一种新的自动配置注册机制，用于替代传统的 spring.factories 文件方式。
AutoConfiguration.imports 文件详解
1. 文件位置和作用
src/main/resources/
└── META-INF/
└── spring/
└── org.springframework.boot.autoconfigure.AutoConfiguration.imports
这个文件用于声明需要自动注册的自动配置类，是 Spring Boot 2.4+ 推荐的自动配置注册方式。
2. 文件格式
文件内容非常简单，每行一个自动配置类的全限定名：
# 注释行（可选）
com.example.MyAutoConfiguration
com.example.AnotherAutoConfiguration
com.example.thirdparty.ThirdPartyAutoConfiguration
3. 与 spring.factories 的对比
传统方式 (spring.factories)
# META-INF/spring.factories
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.example.MyAutoConfiguration,\
com.example.AnotherAutoConfiguration
新方式 (AutoConfiguration.imports)
# META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports
com.example.MyAutoConfiguration
com.example.AnotherAutoConfiguration
4. 实际示例
假设我们有一个自定义的 Starter，包含以下自动配置类：
// 数据库自动配置
@Configuration
@ConditionalOnClass(DataSource.class)
public class DatabaseAutoConfiguration {
// 配置内容
}
// 缓存自动配置
@Configuration
@ConditionalOnClass(RedisTemplate.class)
public class CacheAutoConfiguration {
// 配置内容
}
// Web自动配置
@Configuration
@ConditionalOnWebApplication
public class WebAutoConfiguration {
// 配置内容
}
对应的 AutoConfiguration.imports 文件内容：
# My Custom Starter Auto Configuration
com.example.starter.DatabaseAutoConfiguration
com.example.starter.CacheAutoConfiguration
com.example.starter.WebAutoConfiguration
5. 条件化导入
虽然文件本身不支持条件判断，但可以通过在自动配置类上使用条件注解来实现条件化配置：
// 只有当类路径存在特定类时才生效
@Configuration
@ConditionalOnClass(RedisTemplate.class)
@ConditionalOnProperty(prefix = "my.cache", name = "enabled", havingValue = "true", matchIfMissing = true)
public class RedisCacheAutoConfiguration {
// 配置内容
}
6. 优先级和排序
如果需要控制自动配置的加载顺序，可以使用以下方式：
方式一：使用 @AutoConfigureBefore/@AutoConfigureAfter
@Configuration
@AutoConfigureBefore(DataSourceAutoConfiguration.class)
@AutoConfigureAfter(WebMvcAutoConfiguration.class)
public class MyAutoConfiguration {
// 配置内容
}
方式二：在 imports 文件中按顺序排列
# 按照加载顺序排列
com.example.starter.FirstAutoConfiguration
com.example.starter.SecondAutoConfiguration
com.example.starter.ThirdAutoConfiguration
7. 与 @AutoConfiguration 注解配合使用
Spring Boot 2.4+ 引入了 @AutoConfiguration 注解，可以与 imports 文件配合使用：
@AutoConfiguration
@ConditionalOnClass(SomeClass.class)
@EnableConfigurationProperties(MyProperties.class)
public class MyAutoConfiguration {
@Bean
@ConditionalOnMissingBean
public MyService myService(MyProperties properties) {
return new MyServiceImpl(properties);
}
}
与@Configuration区别见：juejin.cn/post/755160…
8. 多模块项目中的使用
在多模块项目中，每个模块可以有自己的自动配置：
my-project/
├── my-core-module/
│ └── src/main/resources/META-INF/spring/
│ └── org.springframework.boot.autoconfigure.AutoConfiguration.imports
├── my-web-module/
│ └── src/main/resources/META-INF/spring/
│ └── org.springframework.boot.autoconfigure.AutoConfiguration.imports
└── my-data-module/
└── src/main/resources/META-INF/spring/
└── org.springframework.boot.autoconfigure.AutoConfiguration.imports
9. 优势和特点
优势：
- 更简洁的语法：不需要键值对格式，直接列出类名
- 更好的可读性：文件内容更加直观
- 统一的目录结构：所有Spring相关配置文件都放在
META-INF/spring/目录下 - 性能优化：Spring Boot 可以更高效地处理这种格式
特点：
- 纯文本格式：不支持复杂的属性配置
- 无键值对：只包含类名列表
- 支持注释：以
#开头的行被视为注释 - 自动去重：Spring Boot 会自动处理重复的配置类
10. 完整示例
项目结构
my-custom-starter/
├── pom.xml
└── src/
├── main/
│ ├── java/
│ │ └── com/
│ │ └── example/
│ │ └── mystarter/
│ │ ├── MyStarterAutoConfiguration.java
│ │ ├── properties/
│ │ │ └── MyStarterProperties.java
│ │ └── service/
│ │ └── MyService.java
│ └── resources/
│ └── META-INF/
│ └── spring/
│ └── org.springframework.boot.autoconfigure.AutoConfiguration.imports
└── test/
└── java/
AutoConfiguration.imports 文件
# My Custom Starter Auto Configuration
com.example.mystarter.MyStarterAutoConfiguration
自动配置类
@AutoConfiguration
@ConditionalOnClass(MyService.class)
@EnableConfigurationProperties(MyStarterProperties.class)
public class MyStarterAutoConfiguration {
@Bean
@ConditionalOnMissingBean
public MyService myService(MyStarterProperties properties) {
return new MyServiceImpl(properties);
}
}
这种方式是 Spring Boot 2.4+ 版本推荐的标准做法，提供了更好的可维护性和性能。
