快捷導(dǎo)航

如何自定義一個(gè)SpringBoot?Starter(步驟和代碼示例)

更新時(shí)間：2025年08月22日 14:34:11 作者：悟能不能悟

創(chuàng)建自定義Spring?Boot?Starter涉及封裝特定功能供其他項(xiàng)目復(fù)用,下面給大家詳細(xì)介紹如何自定義一個(gè)SpringBoot Starter,感興趣的朋友跟隨小編一起看看吧

核心步驟

?項(xiàng)目結(jié)構(gòu)?

創(chuàng)建 Maven 項(xiàng)目（兩個(gè)模塊）：

my-starter-parent
├── my-spring-boot-autoconfigure  // 自動(dòng)配置核心
└── my-spring-boot-starter        // 輕量依賴聚合

1. 創(chuàng)建自動(dòng)配置模塊 (my-spring-boot-autoconfigure)

① POM 依賴

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-autoconfigure</artifactId>
        <version>3.1.0</version>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-configuration-processor</artifactId>
        <version>3.1.0</version>
        <optional>true</optional>
    </dependency>
</dependencies>

② 創(chuàng)建配置屬性類

@ConfigurationProperties(prefix = "my.service")
public class MyServiceProperties {
    private String prefix = "Hello";
    private String suffix = "!";
    // 省略 getter/setter
}

③ 編寫(xiě)業(yè)務(wù)服務(wù)類

public class MyService {
    private final String prefix;
    private final String suffix;
    public MyService(String prefix, String suffix) {
        this.prefix = prefix;
        this.suffix = suffix;
    }
    public String greet(String name) {
        return prefix + " " + name + suffix;
    }
}

④ 自動(dòng)配置類（核心）

@Configuration
@EnableConfigurationProperties(MyServiceProperties.class)
@ConditionalOnClass(MyService.class) // 類路徑存在時(shí)生效
@ConditionalOnProperty(prefix = "my.service", name = "enabled", matchIfMissing = true)
public class MyServiceAutoConfiguration {
    @Bean
    @ConditionalOnMissingBean // 用戶未定義時(shí)初始化
    public MyService myService(MyServiceProperties properties) {
        return new MyService(properties.getPrefix(), properties.getSuffix());
    }
}

⑤ 注冊(cè)自動(dòng)配置

在 src/main/resources/META-INF/spring/創(chuàng)建文件：

?文件路徑: org.springframework.boot.autoconfigure.AutoConfiguration.imports

com.example.autoconfigure.MyServiceAutoConfiguration

2. 創(chuàng)建 Starter 模塊 (my-spring-boot-starter)

POM 配置

<dependencies>
    <dependency>
        <groupId>com.example</groupId>
        <artifactId>my-spring-boot-autoconfigure</artifactId>
        <version>1.0.0</version>
    </dependency>
</dependencies>

?? ?關(guān)鍵點(diǎn)?：Starter 本身無(wú)代碼，僅聚合依賴

3. 安裝到本地倉(cāng)庫(kù)

mvn clean install

4. 在其他項(xiàng)目中使用

添加依賴

<dependency>
    <groupId>com.example</groupId>
    <artifactId>my-spring-boot-starter</artifactId>
    <version>1.0.0</version>
</dependency>

配置參數(shù) (application.yml)

my:
  service:
    prefix: "Welcome"
    suffix: "!!!"
    # enabled: true # 默認(rèn)啟用

代碼調(diào)用

@RestController
public class DemoController {
    @Autowired
    private MyService myService;
    @GetMapping("/greet")
    public String greet(String name) {
        return myService.greet(name);
    }
}

高級(jí)配置技巧

?條件化Bean?

使用 Spring Boot 的條件注解控制Bean創(chuàng)建：

@Bean
@ConditionalOnWebApplication // 僅Web環(huán)境生效
@ConditionalOnMissingBean
public MyWebService myWebService() {...}

?自定義指標(biāo)監(jiān)控?

集成 Micrometer 暴露指標(biāo)：

@Bean
public MyServiceMetrics myServiceMetrics(MyService service) {
    return new MyServiceMetrics(service);
}

?Starter 元數(shù)據(jù)?

在 autoconfigure模塊的 META-INF/spring-configuration-metadata.json中添加配置提示：

{
  "properties": [
    {
      "name": "my.service.prefix",
      "type": "java.lang.String",
      "defaultValue": "Hello",
      "description": "Custom greeting prefix."
    }
  ]
}

調(diào)試技巧

啟用 debug 模式查看自動(dòng)配置報(bào)告：

debug: true

檢查 Condition Evaluation Report 中的 Positive matches和 Negative matches

通過(guò)以上步驟，您已創(chuàng)建了一個(gè)可復(fù)用、可配置的 Spring Boot Starter。關(guān)鍵點(diǎn)在于解耦自動(dòng)配置與依賴管理，并遵循 Spring Boot 的約定大于配置原則。實(shí)際開(kāi)發(fā)中可結(jié)合具體需求擴(kuò)展錯(cuò)誤處理、健康檢查等企業(yè)級(jí)特性。

到此這篇關(guān)于如何自定義一個(gè)SpringBoot Starter(步驟和代碼示例)的文章就介紹到這了,更多相關(guān)自定義SpringBoot Starter內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: