自定義Spring Boot Starter，實(shí)現(xiàn)組件化復(fù)用！

“

眾所周知，Spring Boot由眾多Starter組成，隨著版本的推移Starter家族成員也與日俱增。在傳統(tǒng)Maven項目中通常將一些層、組件拆分為模塊來管理，以便相互依賴復(fù)用，在Spring Boot項目中我們則可以創(chuàng)建自定義Spring Boot Starter來達(dá)成該目的。

好，開始，先創(chuàng)建一個Maven項目并引入依賴，pom.xml如下，供參考~

<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">
????<modelVersion>4.0.0modelVersion>
????<groupId>com.examplegroupId>
????<artifactId>example-spring-boot-starterartifactId>
????<version>1.0-SNAPSHOTversion>
????<dependencies>
????????<dependency>
????????????<groupId>org.springframework.bootgroupId>
????????????<artifactId>spring-boot-autoconfigureartifactId>
????????dependency>
????dependencies>
????<dependencyManagement>
????????<dependencies>
????????????<dependency>
????????????????
????????????????<groupId>org.springframework.bootgroupId>
????????????????<artifactId>spring-boot-dependenciesartifactId>
????????????????<version>1.5.2.RELEASEversion>
????????????????<type>pomtype>
????????????????<scope>importscope>
????????????dependency>
????????dependencies>
????dependencyManagement>
project>

這里說下artifactId的命名問題，Spring 官方 Starter通常命名為spring-boot-starter-{name}如 spring-boot-starter-web， Spring官方建議非官方Starter命名應(yīng)遵循{name}-spring-boot-starter的格式。

這里講一下我們的Starter要實(shí)現(xiàn)的功能，很簡單，提供一個Service，包含一個能夠?qū)⒆址由锨昂缶Y的方法String wrap(String word)。

public?class?ExampleService?{

????private?String?prefix;
????private?String?suffix;

????public?ExampleService(String?prefix,?String?suffix)?{
????????this.prefix?=?prefix;
????????this.suffix?=?suffix;
????}
????public?String?wrap(String?word)?{
????????return?prefix?+?word?+?suffix;
????}
}

前綴、后綴通過讀取application.properties(yml)內(nèi)的參數(shù)獲得

@ConfigurationProperties("example.service")
public?class?ExampleServiceProperties?{
????private?String?prefix;
????private?String?suffix;
????//省略?getter?setter

重點(diǎn)，編寫AutoConfigure類

@Configuration
@ConditionalOnClass(ExampleService.class)
@EnableConfigurationProperties(ExampleServiceProperties.class)
public?class?ExampleAutoConfigure?{

????@Autowired
????private?ExampleServiceProperties?properties;

????@Bean
????@ConditionalOnMissingBean
????@ConditionalOnProperty(prefix?=?"example.service",value?=?"enabled",havingValue?=?"true")
????ExampleService?exampleService?(){
????????return??new?ExampleService(properties.getPrefix(),properties.getSuffix());
????}

}

解釋下用到的幾個和Starter相關(guān)的注解：

• @ConditionalOnClass，當(dāng)classpath下發(fā)現(xiàn)該類的情況下進(jìn)行自動配置。
• @ConditionalOnMissingBean，當(dāng)Spring Context中不存在該Bean時。
• @ConditionalOnProperty(prefix = "example.service",value = "enabled",havingValue = "true")，當(dāng)配置文件中example.service.enabled=true時。

更多相關(guān)注解，建議閱讀官方文檔該部分。

最后一步，在resources/META-INF/下創(chuàng)建spring.factories文件，內(nèi)容供參考下面~

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.example.autocinfigure.ExampleAutoConfigure

OK，完事，運(yùn)行 mvn:install打包安裝，一個Spring Boot Starter便開發(fā)完成了。如果你需要該Starter的源代碼，點(diǎn)這里。

創(chuàng)建一個Spring Boot項目來 試試~

引入example-spring-boot-starter依賴

?
????com.example
????example-spring-boot-starter
????1.0-SNAPSHOT
?

創(chuàng)建application.properties，進(jìn)行配置

example.service.enabled=true
example.service.prefix=####
example.service.suffix=@@@@

創(chuàng)建一個簡單的Spring Web Application，注入Starter提供的ExampleService看它能否正常工作~

@SpringBootApplication
@RestController
public?class?Application?{

????public?static?void?main(String[]?args)?{
????????SpringApplication.run(Application.class,?args);
????}

????@Autowired
????private?ExampleService?exampleService;

????@GetMapping("/input")
????public?String?input(String?word){
????????return?exampleService.wrap(word);
????}

}

啟動Application，訪問/input接口試試看~

“

總結(jié)下Starter的工作原理

1. Spring Boot在啟動時掃描項目所依賴的JAR包，尋找包含spring.factories文件的JAR包
2. 根據(jù)spring.factories配置加載AutoConfigure類
3. 根據(jù) @Conditional注解的條件，進(jìn)行自動配置并將Bean注入Spring Context

下方二維碼關(guān)注我

互聯(lián)網(wǎng)草根，堅持分享技術(shù)、創(chuàng)業(yè)、產(chǎn)品等心得和總結(jié)~

點(diǎn)擊“閱讀原文”，領(lǐng)取 2020 年最新免費(fèi)技術(shù)資料大全

↓↓↓