溫馨提示×
您好，登錄后才能下訂單哦！
點擊 登錄注冊 即表示同意《億速云用戶服務條款》
您好，登錄后才能下訂單哦！
SpringBoot如何自定義starter？很多新手對此不是很清楚，為了幫助大家解決這個難題，下面小編將為大家詳細講解，有這方面需求的人可以來學習下，希望你能有所收獲。
前言
使用過SpringBoot的都應該知道，一個SpringBoot 項目就是由一個一個 Starter 組成的，一個 Starter 代表該項目的 SpringBoot 啟動依賴，除了官方已有的 Starter，我們可以根據自己的需要自定義新的Starter。
一、自定義SpringBoot Starter
自定義Starter，首選需要實現自動化配置，而要實現自動化配置需要滿足以下兩個條件：
(1)能夠自動配置項目所需要的配置信息，也就是自動加載依賴環境；
(2)能夠根據項目提供的信息自動生成Bean，并且注冊到Bean管理容器中；
要實現自動化配置需要在項目的pom.xml文件中引入如下依賴：
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-autoconfigure</artifactId> <version>2.1.4.RELEASE</version> </dependency>
根據需要自定義Starter的實現過程大致如下（以我定義的Starter為例）：
工程目錄結構：
1、引入項目的配置依賴
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-autoconfigure</artifactId> <version>2.1.4.RELEASE</version> </dependency>
2、創建xxxService類，完成相關的操作邏輯
代碼：StringService.java
public class StringService {
private String str1;
private String str2;
private String default_str;
public String getStr1() {
return str1;
}
public void setStr1(String str1) {
this.str1 = str1;
}
public String getStr2() {
return str2;
}
public void setStr2(String str2) {
this.str2 = str2;
}
public String getDefault_str() {
return default_str;
}
public void setDefault_str(String default_str) {
this.default_str = default_str;
}
public String addStr(){
if(str1 != null){
if(str2 != null){
return str1 + "，" + str2;
}
return str1;
}
return default_str;
}
}3、 定義xxxProperties類，屬性配置類，完成屬性配置相關的操作，比如設置屬性前綴，用于在application.properties中配置
代碼：StringProperties.java
//指定項目在屬性文件中配置的前綴為str，即可以在屬性文件中通過 str.str1=springboot，就可以改變屬性類字段 str1 的值了
@SuppressWarnings("ConfigurationProperties")
@ConfigurationProperties(prefix = "str")
public class StringProperties {
public static final String DEFAULT_STR1 = "I know, you need me";
public static final String DEFAULT_STR2 = "but I also need you";
private String str1 = DEFAULT_STR1;
private String str2 = DEFAULT_STR2;
public String getStr1() {
return str1;
}
public void setStr1(String str1) {
this.str1 = str1;
}
public String getStr2() {
return str2;
}
public void setStr2(String str2) {
this.str2 = str2;
}
}4、定義xxxConfigurationProperties類，自動配置類，用于完成Bean創建等工作
代碼：StringAutoConfiguration.java
// 定義 java 配置類
@Configuration
//引入StringService
@ConditionalOnClass({StringService.class})
// 將 application.properties 的相關的屬性字段與該類一一對應，并生成 Bean
@EnableConfigurationProperties(StringProperties.class)
public class StringAutoConfiguration {
// 注入屬性類
@Autowired
private StringProperties stringProperties;
@Bean
// 當容器沒有這個 Bean 的時候才創建這個 Bean
@ConditionalOnMissingBean(StringService.class)
public StringService helloworldService() {
StringService stringService = new StringService();
stringService.setStr1(stringProperties.getStr1());
stringService.setStr2(stringProperties.getStr2());
return stringService;
}
}5、在resources下創建目錄META-INF，在 META-INF 目錄下創建 spring.factories，在SpringBoot啟動時會根據此文件來加載項目的自動化配置類
代碼：spring.factories
# Auto Configure org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.lhf.springboot.config.StringAutoConfiguration
6、到這里自定義Starter就定義完成了，只需在其他項目中引入即可使用。
二、其他項目中使用自定義的Starter
1、在新項目中引入自定義Starter依賴配置
創建一個新的SpringBoot項目，在項目的pom.xml文件中引入自定義SpringBoot Starter的依賴配置如下：
<!--引入自定義Starter--> <dependency> <groupId>com.lhf.springboot</groupId> <artifactId>spring-boot-starter-string</artifactId> <version>0.0.1-SNAPSHOT</version> </dependency>
2、編寫一個簡單的Controller
@RestController
public class StringController {
@Autowired
private StringService stringService; //引入自定義Starter中的StringService
@RequestMapping("/")
public String addString(){
return stringService.addStr();
}
}3、編寫屬性配置文件，內容如下：
#配置自定義的屬性信息 str.str1=為什么我的眼里常含淚水 str.str2=那是因為我對你愛的深沉
4、啟動項目進行訪問，效果如圖：
看完上述內容是否對您有幫助呢？如果還想對相關知識有進一步的了解或閱讀更多相關文章，請關注億速云行業資訊頻道，感謝您對億速云的支持。
免責聲明：本站發布的內容（圖片、視頻和文字）以原創、轉載和分享為主，文章觀點不代表本網站立場，如果涉及侵權請聯系站長郵箱：is@yisu.com進行舉報，并提供相關證據，一經查實，將立刻刪除涉嫌侵權內容。
