javascript
SpringBoot自定义Starter(自动配置类)
前言
SpringBoot其實(shí)從誕生以來圍繞的核心就是快速構(gòu)建項(xiàng)目,快速構(gòu)建的前提是有人幫你做好輪子,開發(fā)者只要拿來即用就好了,而造好輪子的人就是SpringBoot的開發(fā)者,引入自動配置的形式幫助開發(fā)者快速創(chuàng)建項(xiàng)目,而自動配置采用的是一種starter模塊形式,比如web模塊就引入spring-boot-starter-web。而且SpringBoot依舊支持第三方組件融入到SpringBoot的生態(tài)圈中,比如Mybatis的組件模塊名:mybatis-spring-boot-starter。今天就來分享一下第三方組件是如何引入SpringBoot里面來的。
介紹
自定義starter看懂了之后其實(shí)也不是很難,就拿最近我的一個開源框架做示例吧,正好也要開發(fā)一個支持SpringBoot的小功能。
iagent:一個采用接口動態(tài)代理的形式封裝HTTP請求小組件(快速跳轉(zhuǎn)),不過最近打算重構(gòu)了。
本想著開發(fā)這個就是能夠在項(xiàng)目中統(tǒng)一一下調(diào)用其他廠商HTTP的接口,免得太亂的本質(zhì)想法開發(fā)的,但是自從我接觸到微服務(wù)之后才發(fā)現(xiàn)原來有個Ribbon + Fegin框架,只能說博主的老東家太過傳統(tǒng),自身接觸不到這塊的東西。
創(chuàng)建
首先需要引入SpringBoot自動配置組件
spring-boot-autoconfigure:自定義starter必備引入jar包
spring-boot-configuration-processor:該組件是用來在properties或者yml文件當(dāng)中給予提示的。
<dependencies><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></dependencies>然后需要一個對應(yīng)的實(shí)體類用來保存properties或yml文件中的環(huán)境變量,使用@ConfigurationProperties映射前綴
?然后還需要一個自動配置的類
?一般自動配置類命名方式為?XXXXAutoConfiguration?表示改類為自動配置類
@Configuration:這個注解不多介紹了,就是表示為配置類
@EnableConfigurationProperties:該注解是用來開啟配置參數(shù)的注解的,將配置文件中的變量加載到Properties的配置類對象當(dāng)中,并注入到容器當(dāng)中
并且SpringBoot還提供了一些@Conditional注解:
@ConditionalOnBean:當(dāng)SpringIoc容器內(nèi)存在指定Bean的條件
@ConditionalOnClass:當(dāng)SpringIoc容器內(nèi)存在指定Class的條件
@ConditionalOnExpression:基于SpEL表達(dá)式作為判斷條件
@ConditionalOnJava:基于JVM版本作為判斷條件
@ConditionalOnMissingBean:當(dāng)SpringIoc容器內(nèi)不存在指定Bean的條件
@ConditionalOnMissingClass:當(dāng)SpringIoc容器內(nèi)不存在指定Class的條件
@ConditionalOnNotWebApplication:當(dāng)前項(xiàng)目不是Web項(xiàng)目的條件
@ConditionalOnProperty:指定的屬性是否有指定的值
@ConditionalOnResource:類路徑是否有指定的值
@ConditionalOnSingleCandidate:當(dāng)指定Bean在SpringIoc容器內(nèi)只有一個,或者雖然有多個但是指定首選的Bean
@ConditionalOnWebApplication:當(dāng)前項(xiàng)目是Web項(xiàng)目的條件以上注解都是元注解@Conditional演變而來的,根據(jù)不用的條件對應(yīng)創(chuàng)建以上的具體條件注解。
接下來就是加載配置文件了,根據(jù)SpringBoot的自動配置原理,SpringBoot會自動加載META-INF/spring.factories文件中的數(shù)據(jù)
所以還需要加一個配置,這樣SpringBoot才能掃描到這個自動配置類。
?
org.springframework.boot.autoconfigure.EnableAutoConfiguration表示自動配置類。這樣自定義starter就好了,我們可以寫個測試用例試一下。
說明自定義starter已經(jīng)開發(fā)好啦
總結(jié)
以上是生活随笔為你收集整理的SpringBoot自定义Starter(自动配置类)的全部內(nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 设置zookeeper开机自启动
- 下一篇: gradle和maven区别