詳解SpringBoot如何自定義自己的Starter組件
一、為什么要自定義starter
在我們的日常開發(fā)工作中，經常會有一些獨立于業(yè)務之外的配置模塊，我們經常將其放到一個特定的 包下，然后如果另一個工程需要復用這塊功能的時候，需要將代碼硬拷貝到另一個工程，重新集成一 遍，麻煩至極。如果我們將這些可獨立于業(yè)務代碼之外的功能配置模塊封裝成一個個starter，復用的時 候只需要將其在pom中引用依賴即可，SpringBoot為我們完成自動裝配，簡直不要太爽。
二、starter的實現
雖然不同的starter實現起來各有差異，但是他們基本上都會使用到兩個相同的內容：ConfigurationProperties和AutoConfiguration。因為Spring Boot堅信“約定大于配置”這一理念，所以我們使用ConfigurationProperties來保存我們的配置，并且這些配置都可以有一個默認值，即在我們沒有主動覆寫原始配置的情況下，默認值就會生效，這在很多情況下是非常有用的。除此之外，starter的ConfigurationProperties還使得所有的配置屬性被聚集到一個文件中（一般在resources目錄下的application.properties），這樣我們就告別了Spring項目中XML地獄。
三、命名規(guī)范
如果你快有孩子了，出生前你比較急的一定是起個名字。孩子的姓名標識著你和你愛人的血統(tǒng)，一定不會起隔壁老王的姓氏，肯定會招來異樣的眼光。在maven中，groupId代表著姓氏，artifactId代表著名字。Spring Boot也是有一個命名的建議的。所以名字是不能夠隨隨便便取得，可以按照官方的建議來取。
What’s in a name All official starters follow a similar naming pattern; spring-boot-starter-, whereis a particular type of application. This naming structure is intended to help when you need to find a starter. The Maven integration in many IDEs lets you search dependencies by name. For example, with the appropriate Eclipse or STS plugin installed, you can press ctrl-space in the POM editor and type “spring-boot-starter” for a complete list. As explained in the “Creating Your Own Starter” section, third party starters should not start with spring-boot, as it is reserved for official Spring Boot artifacts. Rather, a third-party starter typically starts with the name of the project. For example, a third-party starter project called thirdpartyproject would typically be named thirdpartyproject-spring-boot-starter.
大概意思：官方的 starter 的命名格式為 spring-boot-starter-{xxxx} 比如spring-boot-starter-activemq，第三方我們自己的命名格式為 {xxxx}-spring-boot-starter。比如mybatis-spring-boot-starter。如果我們忽略這種約定，是不是會顯得我們寫的東西不夠“專業(yè)“。
四、代碼工程
pom.xml
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<artifactId>springboot-demo</artifactId>
<groupId>com.et</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>xxx-spring-boot-starter</artifactId>
<properties>
<maven.compiler.source>8</maven.compiler.source>
<maven.compiler.target>8</maven.compiler.target>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-autoconfigure</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
</dependencies>
屬性文件
com.person.age=23 com.person.name=Lynch com.person.sex=F
自動配置類
package com.et.config;
import com.et.service.PersonService;
import com.et.starter.PersonProperties;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
@EnableConfigurationProperties(PersonProperties.class)
@ConditionalOnClass(PersonService.class)
@ConditionalOnProperty(prefix = "com.person", value = "enabled", matchIfMissing = true)
public class PersonServiceAutoConfiguration {
@Autowired
private PersonProperties properties;
// if spring container do not config bean，auto config PersonService
@Bean
@ConditionalOnMissingBean(PersonService.class)
public PersonService personService(){
PersonService personService = new PersonService(properties);
return personService;
}
}
service類
package com.et.service;
import com.et.starter.PersonProperties;
public class PersonService {
private PersonProperties properties;
public PersonService() {
}
public PersonService(PersonProperties properties) {
this.properties = properties;
}
public void sayHello() {
String message = String.format("hi，my name: %s, today,I'am %s , gender: %s",
properties.getName(), properties.getAge(), properties.getSex());
System.out.println(message);
}
}
PersonProperties
package com.et.starter;
import java.io.Serializable;
import org.springframework.boot.context.properties.ConfigurationProperties;
@SuppressWarnings("serial")
@ConfigurationProperties(prefix = "com.person")
public class PersonProperties implements Serializable {
private String name;
private int age;
private String sex = "M";
public PersonProperties() {
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public int getAge() {
return age;
}
public void setAge(int age) {
this.age = age;
}
public String getSex() {
return sex;
}
public void setSex(String sex) {
this.sex = sex;
}
}
spring.factories文件
/META-INF/spring.factories文件放在/src/main/resources目錄下 注意：META-INF是自己手動創(chuàng)建的目錄，spring.factories也是自己手動創(chuàng)建的文件，在該文件中配置自己的自動配置類。
org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.et.config.PersonServiceAutoConfiguration
項目打包
mvn clean install
代碼倉庫
github.com/Harries/springboot-demo
五、測試
在另外一個項目中添加starter的依賴
<dependency>
<groupId>com.et</groupId>
<artifactId>xxx-spring-boot-starter</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
單元測試類
package com.et.starter;
import com.et.service.PersonService;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;
@RunWith(SpringRunner.class)
@SpringBootTest
public class PersonServiceTest {
@Autowired
private PersonService personService;
@Test
public void testHelloWorld() {
personService.sayHello();
}
}
運行測試類
2024-03-11 10:35:18.374 INFO 10960 --- [ main] com.et.starter.PersonServiceTest : Starting PersonServiceTest on BJDPLHHUAPC with PID 10960 (started by Dell in D:\IdeaProjects\ETFramework\xxx-spring-boot-starter-test)
2024-03-11 10:35:18.376 INFO 10960 --- [ main] com.et.starter.PersonServiceTest : No active profile set, falling back to default profiles: default
2024-03-11 10:35:19.387 INFO 10960 --- [ main] o.s.s.concurrent.ThreadPoolTaskExecutor : Initializing ExecutorService 'applicationTaskExecutor'
2024-03-11 10:35:19.657 INFO 10960 --- [ main] com.et.starter.PersonServiceTest : Started PersonServiceTest in 1.507 seconds (JVM running for 2.188)
hi，my name: Lynch, today,I'am 23 , gender: F
2024-03-11 10:35:19.827 INFO 10960 --- [extShutdownHook] o.s.s.concurrent.ThreadPoolTaskExecutor : Shutting down ExecutorService 'applicationTaskExecutor'
以上就是詳解SpringBoot如何自定義自己的Starter組件的詳細內容，更多關于SpringBoot自定義Starter組件的資料請關注腳本之家其它相關文章！
相關文章
這篇文章主要為大家詳細介紹了如何實現一個簡單的使用Spring AI框架結合Sentinel限流的功能,場景是一個智能客服系統(tǒng),感興趣的小伙伴可以了解下2025-06-06
java中常見XML解析器的使用詳解(JAXP,DOM4J,Jsoup,JsoupXPath)
為了處理和操作XML數據,我們需要使用XML解析器,本文將介紹幾種常用的XML解析器,包括JAXP、DOM4J、Jsoup和JsoupXPath,需要的小伙伴可以參考一下2023-11-11
Springboot解決ajax+自定義headers的跨域請求問題
由于瀏覽器同源策略（同源策略，它是由Netscape提出的一個著名的安全策略，現在所有支持JavaScript 的瀏覽器都會使用這個策略。接下來通過本文給大家介紹Springboot如何優(yōu)雅的解決ajax+自定義headers的跨域請求 ,需要的朋友可以參考下2019-05-05
本文是通過AnnotationConfigApplicationContext讀取配置類來一步一步去了解Spring的啟動過程。本文重點給大家介紹Spring啟動過程源碼分析及基本概念，感興趣的朋友一起看看吧2021-10-10
Spring Boot、Redis、RabbitMQ 在項目中的核心作用詳解(代碼示例)
在現代企業(yè)級應用開發(fā)中,Spring Boot、Redis 和 RabbitMQ 已經成為不可或缺的技術組件,本文將深入剖析這三者在實際項目中的作用,并通過代碼示例和流程圖展示它們的實際應用,感興趣的朋友一起看看吧2025-11-11
Spring Cloud Gateway 記錄請求應答數據日志操作
這篇文章主要介紹了Spring Cloud Gateway 記錄請求應答數據日志操作，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2020-12-12
Springboot讀取外部配置文件,項目部署時配置讀取不到問題及解決
這篇文章主要介紹了Springboot讀取外部配置文件,項目部署時配置讀取不到問題及解決,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-06-06
下面小編就為大家?guī)硪黄狫ava邏輯控制的基礎文章。小編覺得挺不錯的，現在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2021-08-08
多數據源下@transactional事務踩坑實戰(zhàn)指南
在微服務架構日益普及的現在,多數據源事務管理成為常見需求,這篇文章主要介紹了多數據源下@transcation事務踩坑的相關資料,文中通過代碼介紹的非常詳細,需要的朋友可以參考下2026-05-05
當使用@Autowired注解時,它可以自動注入依賴項,例如其他類的實例,本文就來詳細的介紹一下,具有一定的參考價值,感興趣的可以了解一下2023-09-09