(一)概述
SpringBoot以其自動裝配的能力被廣泛應用,我們在寫程式碼時肯定遇到過很多spring-boot-starter命名的依賴,比如spring-boot-starter-web,在pom檔案中引入這些starter依賴後,SpringBoot就能透過自動裝配的技術掃描到這些類並裝載到Bean容器中。
除了SpringBoot官方的這些Starter外,我們自己也可以開發Starter。為了和官方的starter區分,建議自定義的starter命名格式為xxxx-spring-boot-starter,比如mybatis-spring-boot-starter。
本文將介紹如何自己實現一個starter。
(二)看個例子
在寫自己的Starter之前,很有必要看一下別人是怎樣去寫的。這裡拿RedisAutoConfiguration這個類作為例子。
SpringBoot在啟動時會透過自動裝配去掃描專案MATA-INF/spring。factories檔案,這個檔案中定義了所有需要去自動裝配的類。Redis的自動裝配類就是下圖的RedisAutoConfiguration。
更多面試題可以私信我666哦
進入 RedisAutoConfiguration後,首先看最重要的幾個註解,@Configuration不用多提了,@ConditionalOnClass表示當這個註解後面的類存在時,該Bean才會被載入。下圖中很明顯RedisOperations並不存在,所以Redis不會被自動裝配進去。
@EnableConfigurationProperties用於自動載入配置類的資訊,配置類和我們平常寫的基本一樣,透過ConfigurationProperties讀取properties或者yaml中的配置資訊。
RedisAutoConfiguration這個類中定義的Bean有兩個,我們應該都比較熟悉。@ConditionalOnMissingBean的意思是當Spring容器中不存在這個Bean的時候,才會載入這個Bean,所以如果我們在程式碼中自己定義了redisTemplate之後,注入到Bean容器中的就是我們自己寫的那個Bean。
看到這裡基本已經知道一個Starter的實現方案了,接下來就寫一個簡單的Starter。
(三)實現資訊播報Starter
要做的這個Starter其實很簡單,就是輸出配置檔案中配置的資訊。
首先新建一個Maven專案,在專案中新建兩個Module,我給兩個專案分別命名為report-spring-boot-starter和example-spring-boot
首先介紹report-spring-boot-starter,這是一個Starter,主要實現輸出一些內容的功能,我們可以完全按照RedisAutoConfiguration去寫。首先新建自動裝配類:ReportAutoConfiguration
@Configuration@ConditionalOnClass(ReportOperation。class)@EnableConfigurationProperties(ReportProperties。class)public class ReportAutoConfiguration { @Bean public ReportOperation reportOperation(ReportProperties reportProperties){ ReportOperation reportOperation = new ReportOperation(reportProperties。getMsg()); return reportOperation; }}複製程式碼
當ReportOperation存在時才會載入該配置,啟用配置檔案ReportProperties
public class ReportOperation { private String msg; public ReportOperation(String msg){ this。msg = msg; } public String getMsg() { return msg; } public void setMsg(String msg) { this。msg = msg; } public String report(){ return msg; }}複製程式碼
ReportProperties如下:
@ConfigurationProperties(prefix = “report”)public class ReportProperties { private String msg; public void setMsg(String msg) { this。msg = msg; } public String getMsg() { return msg; }}複製程式碼
接下來是實現自動注入的關鍵,前面已經說到了,SpringBoot會去掃描依賴Jar包中META-INF/spring。factories中的內容,因此在resources目錄下新建META-INF/spring。factories,寫下配置資訊:
org。springframework。boot。autoconfigure。EnableAutoConfiguration=\com。javayz。starter。ReportAutoConfiguration複製程式碼
這樣一個簡單的Starter就完成了。
(四)呼叫這個Starter
接下來在example-spring-boot這個module中呼叫上面的starter,首先第一步引入相關依賴,這裡只需要引入springboot相關依賴和自己寫的starter依賴即可:
接著寫一個測試的controller測試自動注入的效果:
@RestControllerpublic class TestController { @Autowired private ReportOperation reportOperation; @GetMapping(“test”) public String test(){ System。out。println(reportOperation。getMsg()); return reportOperation。getMsg(); }}複製程式碼
在配置檔案中增加一條配置:
report。msg = hello複製程式碼
執行專案呼叫介面,可以發現ReportOperation這個Bean已經被自動注入了。
(五)總結
本文結合redis自動注入的例子,寫了一個屬於自己的Starter,希望對大家有所幫助。我是阿遠,我們下期再見!