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