自定义spring Boot Starter需创建自动配置类和属性类，通过条件注解控制Bean加载，使用spring.factories注册配置，避免依赖、Bean名和加载顺序冲突，并通过测试验证功能。
自定义spring boot Starter，简单来说，就是把一系列配置和依赖打包成一个可重用的模块，方便其他项目快速集成某个功能。核心在于自动配置，让 Spring Boot 能够自动发现并应用你的配置。
创建一个自定义 Spring Boot Starter，需要以下步骤：
定义自动配置类
自动配置类是 Starter 的核心，它负责根据条件自动配置 Bean。
- 创建配置类: 创建一个带有
@Configuration
注解的类，用于定义 Bean。
- 使用条件注解: 使用
@ConditionalOnClass
,
@ConditionalOnMissingBean
,
@ConditionalOnProperty
等条件注解，控制 Bean 的创建。例如，只有当 classpath 中存在某个类时才创建 Bean。
- 配置属性绑定: 使用
@EnableConfigurationProperties
- 自动配置生效: 使用
@AutoConfigureAfter
或
@AutoConfigureBefore
控制自动配置类的加载顺序，确保依赖的 Bean 已经创建。
一个简单的例子：
@Configuration @ConditionalOnClass(MyService.class) @EnableConfigurationProperties(MyServiceProperties.class) public class MyServiceAutoConfiguration { @Autowired private MyServiceProperties properties; @Bean @ConditionalOnMissingBean public MyService myService() { return new MyService(properties.getMessage()); } }
创建配置属性类
配置属性类用于定义可以从
application.properties
或
application.yml
中配置的属性。
- 创建属性类: 创建一个带有
@ConfigurationProperties
注解的类，指定属性的前缀。
- 定义属性: 定义与配置文件中的属性对应的字段，并提供 getter 和 setter 方法。
例如：
@ConfigurationProperties("my.service") public class MyServiceProperties { private String message = "Hello, World!"; public String getMessage() { return message; } public void setMessage(String message) { this.message = message; } }
创建 Starter 项目
- 创建 maven 项目: 创建一个 Maven 项目，并添加必要的依赖，例如
spring-boot-autoconfigure
和
spring-boot-configuration-processor
。
spring-boot-configuration-processor
用于在编译时生成配置元数据，方便 ide 自动提示。
- 打包方式: 将打包方式设置为
jar
。
- 目录结构: 确保目录结构正确，自动配置类放在
src/main/java
目录下，配置文件放在
src/main/resources/META-INF/spring.factories
中。
注册自动配置类
在
src/main/resources/META-INF/spring.factories
文件中注册自动配置类。
org.springframework.boot.autoconfigure.EnableAutoConfiguration= com.example.MyServiceAutoConfiguration
发布 Starter
- 本地安装: 使用
mvn install
命令将 Starter 安装到本地 Maven 仓库。
- 发布到 Maven 中央仓库: 如果要发布到 Maven 中央仓库，需要配置 Maven 的
settings.xml
文件，并使用
mvn deploy
命令发布。
如何避免Starter之间的冲突？
Starter 之间的冲突，通常是由于依赖版本冲突、Bean 名称冲突或者自动配置顺序冲突引起的。
依赖版本冲突:
- 统一依赖版本: 尽可能统一各个 Starter 依赖的版本。可以使用 Spring Boot 的 Dependency Management 来管理依赖版本。
- 排除冲突依赖: 如果无法统一版本，可以使用 Maven 的
<exclusions>
标签排除冲突的依赖。
Bean 名称冲突:
- 自定义 Bean 名称: 使用
@Bean
注解时，显式指定 Bean 的名称，避免使用默认名称。
- 使用条件注解: 使用
@ConditionalOnMissingBean
注解，只有当容器中不存在同名 Bean 时才创建 Bean。
自动配置顺序冲突:
- 使用
@AutoConfigureAfter
和
@AutoConfigureBefore
:
控制自动配置类的加载顺序，确保依赖的 Bean 已经创建。 - 避免循环依赖: 避免自动配置类之间存在循环依赖关系。
除了以上方法，还可以考虑使用 Spring Boot 的
spring.autoconfigure.exclude
属性，在应用程序中排除不需要的自动配置类。
如何测试自定义 Spring Boot Starter？
测试自定义 Spring Boot Starter，可以验证其是否能够正确地自动配置 Bean，以及配置属性是否能够生效。
- 创建测试项目: 创建一个新的 Spring Boot 项目，并添加自定义 Starter 的依赖。
- 编写测试用例: 使用 junit 和 Spring Test 编写测试用例，验证 Bean 是否被正确创建，以及配置属性是否生效。
例如：
@RunWith(SpringRunner.class) @springbootTest public class MyServiceAutoConfigurationTest { @Autowired private MyService myService; @Value("${my.service.message}") private String message; @Test public void testMyService() { assertNotNull(myService); assertEquals(message, myService.getMessage()); } }
如何选择合适的条件注解？
选择合适的条件注解，是确保自动配置类能够正确生效的关键。
-
@ConditionalOnClass
: 当 classpath 中存在指定的类时，才会创建 Bean。适用于依赖特定类库的场景。
-
@ConditionalOnMissingBean
: 当容器中不存在指定名称或类型的 Bean 时，才会创建 Bean。适用于提供默认 Bean 的场景。
-
@ConditionalOnProperty
: 当配置文件中存在指定的属性，且属性值为指定值时，才会创建 Bean。适用于根据配置属性控制 Bean 的创建的场景。
-
@ConditionalOnResource
: 当 classpath 中存在指定的资源时，才会创建 Bean。适用于依赖特定资源的场景。
-
@ConditionalOnWebApplication
: 当应用是 Web 应用时，才会创建 Bean。适用于只在 Web 应用中生效的场景。
-
@ConditionalOnNotWebApplication
: 当应用不是 Web 应用时，才会创建 Bean。适用于只在非 Web 应用中生效的场景。
选择条件注解时，需要根据实际需求，选择最合适的注解，确保自动配置类能够正确生效。 比如，如果你的 Starter 依赖于某个特定的类库，那么就应该使用
@ConditionalOnClass
注解。如果你的 Starter 想要提供一个默认的 Bean，但是允许用户自定义 Bean，那么就应该使用
@ConditionalOnMissingBean
注解。