### 创建
Spring Boot 3 自定义 Starter 的方法
在
Spring Boot 3 中创建自定义 starter 是一种将常用功能模块化并提供给其他项目复用的有效方式。以下是关于如何实现这一目标的具体说明。
#### 1. 自定义 Starter 的目的
自定义 starter 的主要目的是为了简化开发流程，通过封装一组特定的功能逻辑到一个独立的
依赖包中，使得开发者可以在多个项目之间轻松共享这些功能[^1]。
#### 2. 构建 Maven 或 Gradle 工程
首先需要构建一个新的 Maven 或 Gradle 工程来作为自定义 starter 的基础框架。假设我们使用的是 Maven，则 `pom.xml` 文件应包含如下核心
依赖项：
```xml
<dependencies>
<!
-- 引入
Spring Boot Autoconfigure
-->
<dependency>
<groupId>org.
springframework.
boot</groupId>
<artifactId>
spring-boot-autoconfigure</artifactId>
<version>
3.x.x</version> <!
-- 替换为实际版本号
-->
</dependency>
<!
-- 引入
Spring Boot Core
-->
<dependency>
<groupId>org.
springframework.
boot</groupId>
<artifactId>
spring-boot-starter</artifactId>
<version>
3.x.x</version> <!
-- 替换为实际版本号
-->
</dependency>
</dependencies>
```
上述代码片段展示了如何引入必要的
Spring Boot 核心库以及自动配置支持。
####
3. 编写自动化配置类
接下来，在工程中创建一个名为 `MyStarterAutoConfiguration.java` 的 Java 类文件用于处理自动化的初始化工作。该类需标注有 `@ConditionalOnClass` 和 `@EnableConfigurationProperties` 注解以便于条件加载和属性绑定操作。
```java
import org.
springframework.
boot.autoconfigure.condition.ConditionalOnProperty;
import org.
springframework.context.annotation.Bean;
import org.
springframework.context.annotation.Configuration;
@Configuration
@ConditionalOnProperty(name = "my.starter.enabled", havingValue = "true")
public class MyStarterAutoConfiguration {
@Bean
public String welcomeMessage(MyStarterProperties properties) {
return properties.getMessage();
}
}
```
此部分实现了基于配置参数决定是否启用某些服务的能力[^2]。
#### 4. 定义 Properties 配置类
继续添加另一个名为 `MyStarterProperties.java` 的 Bean 对象用来映射外部传入的应用程序设置数据源。
```java
import org.
springframework.
boot.context.properties.ConfigurationProperties;
@ConfigurationProperties(prefix = "my.starter")
public class MyStarterProperties {
private boolean enabled;
private String message;
// Getters and Setters omitted for brevity.
public boolean isEnabled() {return this.enabled;}
public void setEnabled(boolean enabled){this.enabled = enabled;}
public String getMessage(){return this.message;}
public void setMessage(String message){this.message=message;}
}
```
这段代码允许用户通过修改 `application.properties` 来调整行为模式。
#### 5. 添加 META
-INF/
spring.factories 文件
最后一步是在资源目录下新建路径 `/META
-INF/` 并放置名称为 `
spring.factories` 的纯文本文档内容如下所示:
```
org.
springframework.
boot.autoconfigure.EnableAutoConfiguration=\
com.example.mystarter.MyStarterAutoConfiguration
```
这步注册了前面编写的自动化配置类至整个应用上下文中去执行其职责范围内的任务。
完成以上步骤之后即可发布这个新的 Starter 到私有的或者公共仓库供他人下载安装使用啦！
---
博客介绍了自动配置原理，还提及启动类里使用@EnableAsync，这些内容与后端开发中的配置相关，有助于理解程序启动时的自动配置机制和异步功能启用。
扫一扫
1448
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
