Springboot系列-自定義starter

前言：用過(guò)springboot的各位應(yīng)該都知道，Springboot相對(duì)于Spring/SpringMVC要方便的多，為什么呢？這主要還是歸功于Starter，其實(shí)Starter也是基于Spring/SpringMVC基礎(chǔ)上實(shí)現(xiàn)的，因?yàn)镾tarter帶來(lái)了許多的自動(dòng)化配置，所以在我們開發(fā)的時(shí)候省了不少力

理解Starter

那么Starter是基于什么才能夠?qū)崿F(xiàn)眾多自動(dòng)化配置的呢？其實(shí)Starter的核心注解就是@Conditional，當(dāng)classpath下面存在某一個(gè)class時(shí)，這個(gè)配置才會(huì)生效

---

自定義Starter

定義Starter

1.首先創(chuàng)建一個(gè)普通的新的maven項(xiàng)目，創(chuàng)建完成之后添加Starter的自動(dòng)化配置類如下：

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-autoconfigure</artifactId><version>2.1.8.RELEASE</version> </dependency>

配置完之后其實(shí)我們可以通過(guò)源碼看到，好多自動(dòng)化配置已經(jīng)引入進(jìn)來(lái)了

2.配置完成之后創(chuàng)建一個(gè)DemoProperties類，用來(lái)接收application.properties中注入的值，如下：

@ConfigurationProperties(prefix = "test") public class DemoProperties {private String name = "王先森";private String hobby = "Coding";public String getName() {return name;}public void setName(String name) {this.name = name;}public String getHobby() {return hobby;}public void setHobby(String hobby) {this.hobby = hobby;} }

以上這個(gè)DemoProperties配置類的意思就是直接將application.properties里面的屬性值注入到該實(shí)例中，@ConfigurationProperties 類型安全的屬性注入，即將 application.properties 文件中前綴為 javaboy 的屬性注入到這個(gè)類對(duì)應(yīng)的屬性上

application.prpoerties配置文件內(nèi)容如下：

test.name = wxy test.hobby = basketball

3.配置完DemoProperties之后，在定義一個(gè)DemoService類并定義個(gè)方法如下：

public class DemoService {private String name;private String hobby;public String doSomething() {return name + " do " + hobby + " !";}public String getName() {return name;}public void setName(String name) {this.name = name;}public String getHobby() {return hobby;}public void setHobby(String hobby) {this.hobby = hobby;} }

上面這個(gè)DemoService意思就是很簡(jiǎn)單的一個(gè)類，添加了個(gè)doSomething方法，之后再對(duì)應(yīng)文件將該類注入之后，傳入屬性值調(diào)用該方法

4.接下來(lái)要做的是非常關(guān)鍵，就是關(guān)于自動(dòng)配置的定義，因?yàn)橹拔覀兛赡苡玫亩际莿e人定義的，所以這次需要自己去定義

@Configuration @EnableConfigurationProperties（DemoProperties.class） @ConditionalOnClass(DemoService.class) public class DemoServiceAutoConfiguration {@AutowiredDemoProperties demoProperties;@BeanDemoService demoService(){DemoService demoService = new DemoService();demoService.setName(demoProperties.getName());demoService.setHobby(demoProperties.getHobby());return demoService;} }

針對(duì)以上一段自動(dòng)配置，解釋如下：

• Configuration：表示這是一個(gè)配置類
• EnableConfigurationProperties：此注解是為了使之前配置的@ConfigurationProperties 生效
• @ConditionalOnClass ：表示項(xiàng)目當(dāng)前classpath下存在DemoService時(shí)，后面的配置才會(huì)生效
• 自動(dòng)配置類中首先注入 DemoProperties ，該實(shí)例中有在 application.properties 中配置的相關(guān)數(shù)據(jù)
• 提供一個(gè) DemoService 的實(shí)例，將 DemoProperties 中的值注入進(jìn)去

5.自動(dòng)化配置類基本完成，接下來(lái)還需要一個(gè) spring.factories 文件，那么這個(gè)文件是干什么用的呢？我們知道Springboot項(xiàng)目中有一個(gè)啟動(dòng)類，該啟動(dòng)類包含了@SpringBootApplication 注解，這個(gè)注解的定義如下：

@Target({ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) @Documented @Inherited @SpringBootConfiguration @EnableAutoConfiguration @ComponentScan(excludeFilters = {@Filter(type = FilterType.CUSTOM,classes = {TypeExcludeFilter.class} ), @Filter(type = FilterType.CUSTOM,classes = {AutoConfigurationExcludeFilter.class} )} ) public @interface SpringBootApplication {}

根據(jù)上面我們可以看出其實(shí)SpringBootApplication 是一個(gè)組合注解，它包含了如上注解，其最重要和關(guān)鍵的三個(gè)注解并解釋如下：

• @SpringBootConfiguration：此注解為Springboot配置注解，如下又在該注解中又包含如下注解：

@Target({ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) @Documented @Configuration public @interface SpringBootConfiguration { }

• @EnableAutoConfiguration：開啟自動(dòng)配置注解，只有開啟了這個(gè)自動(dòng)配置之后自動(dòng)配置才會(huì)生效，其注解又包含如下注解：

@Target({ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) @Documented @Inherited @AutoConfigurationPackage @Import({AutoConfigurationImportSelector.class}) public @interface EnableAutoConfiguration {

• @ComponentScan：這個(gè)注解在有一個(gè)主要的功能就是配置注解掃描，可以自定義去配置掃描的范圍

6.在 Maven 項(xiàng)目的 resources 目錄下創(chuàng)建一個(gè)名為 META-INF 的文件夾，然后在文件夾中創(chuàng)建一個(gè)名為 spring.factories 的文件，文件內(nèi)容如下：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.wxy.entity.DemoServiceAutoConfiguration

動(dòng)化配置類的路徑配置完成，如此之后我們的自動(dòng)化配置類就算完成了

本地安裝

我們將我們寫好的Starter項(xiàng)目進(jìn)行打包，如下：

雙擊完成后，這個(gè) Starter 就安裝到我們本地倉(cāng)庫(kù)了，其實(shí)這個(gè)時(shí)候我們從該路徑可以發(fā)現(xiàn)他打包成了一個(gè)jar包，如下：

那么如何使用它呢？

---

使用Starter

新建一個(gè)普通的 Spring Boot 工程，創(chuàng)建成功之后，加入自定義 Starter 的依賴，如下:

<dependency><groupId>com.example</groupId><artifactId>emptyMavenProject</artifactId><version>1.0-SNAPSHOT</version> </dependency>

此時(shí)我們引入了上面自定義的 Starter ，也就是說(shuō)項(xiàng)目中現(xiàn)在有一個(gè)默認(rèn)的 DemoService 實(shí)例可以使用，關(guān)于此實(shí)例的數(shù)據(jù)，可以在 application.properties 中進(jìn)行配置，如下：

test.name = Wang sir test.hobby = Coding

配置完成后，可選擇在單元測(cè)試方法中注入 DemoSerivce 實(shí)例來(lái)使用，代碼如下：

@SpringBootTest(classes = App.class) class TeststarterApplicationTests {@AutowiredDemoService demoService;@Testpublic void contextLoads() {System.out.println(demoService.doSomething());} }

執(zhí)行運(yùn)行結(jié)果如下：

. ____ _ __ _ _/\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \ ( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \\\/ ___)| |_)| | | | | || (_| | ) ) ) )' |____| .__|_| |_|_| |_\__, | / / / /=========|_|==============|___/=/_/_/_/:: Spring Boot :: (v2.2.1.RELEASE) 2019-12-03 15:16:57.423 INFO 19712 --- [ main] c.e.t.TeststarterApplicationTests : Starting TeststarterApplicationTests on Wangxinyao with PID 19712 (started by Administrator in E:\IDEAWorkSpace\teststarter) 2019-12-03 15:16:57.430 INFO 19712 --- [ main] c.e.t.TeststarterApplicationTests : No active profile set, falling back to default profiles: default 2019-12-03 15:17:00.216 INFO 19712 --- [ main] o.s.s.concurrent.ThreadPoolTaskExecutor : Initializing ExecutorService 'applicationTaskExecutor' 2019-12-03 15:17:00.754 INFO 19712 --- [ main] c.e.t.TeststarterApplicationTests : Started TeststarterApplicationTests in 4.157 seconds (JVM running for 6.18) Wang sir do Coding ! 2019-12-03 15:17:01.054 INFO 19712 --- [extShutdownHook] o.s.s.concurrent.ThreadPoolTaskExecutor : Shutting down ExecutorService 'applicationTaskExecutor'

結(jié)語(yǔ)：基本上對(duì)于自定義Starter配置的講解就到這里了，通過(guò)自定義Starter，可以把之前的項(xiàng)目通過(guò)打包注入到新的項(xiàng)目中，便捷開發(fā)

總結(jié)

以上是生活随笔為你收集整理的Springboot系列-自定义starter的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。