(一)概述
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依賴即可:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-autoconfigure</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.example</groupId>
<artifactId>report-spring-boot-starter</artifactId>
<version>1.0-SNAPSHOT</version>
<scope>compile</scope>
</dependency>
複制代碼
接着寫一個測試的controller測試自動注入的效果:
@RestController
public 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,希望對大家有所幫助。我是阿遠,我們下期再見!