SpringBoot如何手寫一個starter并使用這個starter詳解
1、stater工程的命名
starter 是一個開箱即用的組件，減少不必要的重復代碼，重復配置。例如，在mavne項目進行配置的時候，我們需要引用 spring-boot-starter-parent。
Spring 官方定義的 starter 通常命名遵循的格式為 spring-boot-starter-{name}，例如 spring-boot-starter-web。
非官方 starter 命名應(yīng)遵循 {name}-spring-boot-starter 的格式，例如，dubbo-spring-boot-starter。
2、需求
寫一個序列化的插件，并且可以自由的選擇 fastjson 還是 gson，如果沒選的情況下默認選擇fastjson。
3、stater步驟
創(chuàng)建一個Spring Boot項目，這里項目名字叫 jackformat-spring-boot-starter
3.1 引入依賴
<!-- autoconfigure-->
<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>
<!-- fastjson-->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>1.2.56</version>
</dependency>
<!-- gson-->
<dependency>
<groupId>com.google.code.gson</groupId>
<artifactId>gson</artifactId>
<version>2.2.4</version>
</dependency>注意： 如果在后續(xù)引用stater工程中出現(xiàn) ：Unable to read meta-data for class 這個錯誤
處理意見，可以參考文末。
參考博客里面是對依賴進行處理，防止stater引用失敗。
3.2 格式化接口
3.3 配置類
先定義一個配置類，具體的實現(xiàn)邏輯在具體的實現(xiàn)類里面實現(xiàn)。
public interface FormatProcessor {
/**
* 定義一個格式化的方法
*/
<T> String format(T obj);
}下面是兩個具體的配置類
import com.google.gson.Gson;
public class GsonFormatProcessor implements FormatProcessor{
@Override
public <T> String format(T obj) {
return "GsonFormatProcessor" + new Gson().toJson(obj);
}
}import com.alibaba.fastjson.JSON;
public class FastJsonFormatProcessor implements FormatProcessor{
@Override
public <T> String format(T obj) {
return "FastJsonFormatProcessor:" + JSON.toJSONString(obj);
}
}3.3.1 條件配置
這個條件配置里面用到了條件注解，如果fastjson和gson類存在的情況下才加載對應(yīng)的實現(xiàn)類。
因為在pom文件里面都引用了，所以在這里是都會被加載的。
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Primary;
@Configuration
public class FormatAutoConfiguration {
/**
* @return
* @ConditionalOnClass條件注解。如果 fastjson 類存在的情況下才加載對應(yīng)的實現(xiàn)類
* 同一個接口，有幾種不同的實現(xiàn)類時，@Autowired 是按類型注入的，不知道要選哪一個.
* 按照第二點需求，用戶在沒選的情況下默認選擇 fastjson，所以這里給 fastjson 的實現(xiàn)上打上 @Primary
*/
@ConditionalOnClass(name = "com.alibaba.fastjson.JSON")
@Bean
@Primary
public FormatProcessor fastJsonFormat() {
return new FastJsonFormatProcessor();
}
/**
* 如果 Gson 類存在的情況下才加載對應(yīng)的實現(xiàn)類
*
* @return
*/
@ConditionalOnClass(name = "com.google.gson.Gson")
@Bean
public FormatProcessor gsonJsonFormat() {
return new FastJsonFormatProcessor();
}
}代碼段里面有 @Primary 注解，這是為了用戶在沒有手動選擇的時候，默認選擇fastjson。（如果自動注入選的是@Autowired的話，因為@Autowired默認是類型注入的，不知道選擇哪一種類型）
3.3.2 讀取配置
這個配置類主要是用來讀取用戶的選擇，作用和@Value作用一致
import org.springframework.boot.context.properties.ConfigurationProperties;
@ConfigurationProperties(prefix = FormatProperties.ORMAT_PREFIX)
public class FormatProperties {
public static final String ORMAT_PREFIX = "jackluo.format";
private String type;
public String getType() {
return type;
}
public void setType(String type) {
this.type = type;
}
}3.4 序列化實現(xiàn)類
import com.jackluo.autoconfiguration.FormatProcessor;
public class FormatTemplate {
private FormatProcessor formatProcessor;
public FormatTemplate(FormatProcessor formatProcessor) {
this.formatProcessor = formatProcessor;
}
public <T> String doFormat(T obj) {
return formatProcessor.format(obj);
}
}序列化實現(xiàn)類，這個是來提供給用戶序列化的。
3.5 邏輯配置類
import com.jackluo.format.FormatTemplate;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
@Import(FormatAutoConfiguration.class)
@EnableConfigurationProperties(FormatProperties.class)
@Configuration
public class JackluoFormatConfiguration {
@Bean
public FormatTemplate helloFormatTemplate(FormatProperties formatProperties, @Qualifier("fastJsonFormat") FormatProcessor formatProcessor) {
if ("fastjson".equals(formatProperties.getType())) {
return new FormatTemplate(new FastJsonFormatProcessor());
}
if ("gson".equals(formatProperties.getType())) {
return new FormatTemplate(new GsonFormatProcessor());
}
return new FormatTemplate(formatProcessor);
}
}@Import 導入配置類，就是將該配置類中的 Bean 注入到容器
@EnableConfigurationProperties 這是在將屬性類激活，注入到容器中，也可以用 @Bean 的方式
@Configuration 說明這是一個配置類
流程是 FormatProperties 屬性類注入到容器當中，如果是fastjson就去走fastjaon的邏輯實現(xiàn)類；反之是gson也是一樣。如果沒有以上情況，就走上面配置的默認項。
3.6 創(chuàng)建 META-INF/spring.factories
因為springboot在啟動的時候是讀取該文件下面的配置類，從而將Bean加載到容器當中。所以我們寫stater也是一樣的道理。
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ com.jackluo.autoconfiguration.JackluoFormatConfiguration
注意：有多個文件的時候是需要用 ,\ 來隔開的。如：
以上。一個手寫的stater就OK了，我們需要引用直接打jar包在其他項目直接引用即可。
下面是引用過程。
4、 引用-測試
4.1 打包
4.2 引入依賴
<dependency>
<groupId>com.jackluo</groupId>
<artifactId>jackformat-spring-boot-starter</artifactId>
<version>0.0.1-SNAPSHOT</version>
</dependency>這個依賴命名方式就是我們寫的stater工程的名稱，這個一眼就是能看出來的。
4.3 選用序列化
在.yml文件中配置我們需要選用的序列化方式。
我們選用gson。測試完可以試試什么也不選出來什么結(jié)果
4.4 調(diào)用
定義一個實體類，定義一個controller，直接調(diào)用即可。
4.5結(jié)果
當選用gson的時候出來的是：GsonFormatProcessor。
默認什么也不選的時候，出現(xiàn)的是：FastJsonFormatProcessor。
和我們在stater的結(jié)果是一樣的。
至此，一個完整的stater和引用已經(jīng)OK了。
補充：自定義starter出現(xiàn)Unable to read meta-data for class 這樣解決
錯誤：
在自己寫了一個stater包后，在其他工程進行調(diào)用。
正常情況是自定義的stater包打包完畢，在另一個工程maven里面調(diào)用就行。
但是這次調(diào)用的時候出現(xiàn)了以下情況。
這種情況，由截圖錯誤可知，就是：不能在XXX包中讀取XXX文件
排查：
查找很多方法，大多數(shù)問題是由于spring.factories配置有問題。
大多存在的問題是多行之間沒有用.\連接，或者是.和\之間有空格之類的問題
或者是要掃描的包路徑直接寫錯了（說明確實得檢查一下）
我們?nèi)ゲ榭磗pring.factories，發(fā)現(xiàn)沒有什么問題。
糾錯：
鑒于這個問題是個細節(jié)問題，不能輕言放棄。
ok，又在找到底是什么錯。
看到了網(wǎng)上的一篇帖子。
主要解決方案就是去掉springboot的打包插件，然后打包就正常了。在此感謝。
我采用的是直接在maven打包插件中間加了一行。
最后就可以了。
后記：遇見問題還是得一點點排查，不能輕言放棄。多看看大家的想法和思路。根據(jù)自己的實際情況酌情采用。
總結(jié)
到此這篇關(guān)于SpringBoot如何手寫一個starter并使用這個starter的文章就介紹到這了,更多相關(guān)SpringBoot手寫starter并使用內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
mybatis-plus實體類主鍵策略有3種(小結(jié))
這篇文章主要介紹了mybatis-plus實體類主鍵策略有3種(小結(jié))，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2020-08-08
Java Swing實現(xiàn)簡單的體重指數(shù)(BMI)計算器功能示例
這篇文章主要介紹了Java Swing實現(xiàn)簡單的體重指數(shù)(BMI)計算器功能,涉及Java Swing窗口組件布局、響應(yīng)及數(shù)值運算相關(guān)操作技巧,需要的朋友可以參考下2017-12-12
這篇文章主要為大家詳細介紹了Java實現(xiàn)簡單點餐系統(tǒng)，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下2022-01-01
Spring事務(wù)傳播機制是指，包含多個事務(wù)的方法在相互調(diào)用時，事務(wù)是如何在這些方法間傳播的。本文通過示例詳細介紹了Spring的事務(wù)傳播機制，需要的可以參考一下2023-01-01
spring Boot查詢數(shù)據(jù)分頁顯示的方法實例
這篇文章主要給大家介紹了關(guān)于spring Boot查詢數(shù)據(jù)分頁顯示的相關(guān)資料，文中通過示例代碼介紹的非常詳細，對大家學習或者使用spring Boot具有一定的參考學習價值，需要的朋友們下面來一起學習學習吧2020-08-08
這篇文章主要為大家詳細介紹了java編程實現(xiàn)多人聊天室功能，具有一定的參考價值，感興趣的小伙伴們可以參考一下2018-07-07
本文主要介紹了Java處理XSS漏洞的四種方法小結(jié),包含使用HTML實體編碼、使用內(nèi)容安全策略（CSP）、使用框架內(nèi)置的XSS防護和自定義過濾器等方法,具有一定的參考價值,感興趣的可以了解一下2024-05-05
java基礎(chǔ)在Java中我們經(jīng)常需要復制一個數(shù)組,下面這篇文章主要給大家介紹了關(guān)于Java復制(拷貝)數(shù)組的五種方法,文中通過實例代碼介紹的非常詳細,需要的朋友可以參考下2023-03-03
Mybatis中動態(tài)SQL，if,where,foreach的使用教程詳解
MyBatis的動態(tài)SQL是基于OGNL表達式的，它可以幫助我們方便的在SQL語句中實現(xiàn)某些邏輯。這篇文章主要介紹了Mybatis中動態(tài)SQL，if,where,foreach的使用教程,需要的朋友可以參考下2017-11-11
這篇文章主要介紹了Java DWR內(nèi)存泄漏問題解決方案,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2020-10-10