點擊上方 IT牧場 ，選擇 置頂或者星標技術乾貨每日送達！
starter背景
Spring Boot目前已經變成了後端開發這必備技能之一，其中一個主要原因是Spring Boot中有個非常重要的機制（starter機制）。
starter能夠拋棄以前繁雜的配置，將其統一集成進starter，使用的時候只需要在maven中引入對應的starter依賴即可，Spring Boot就能自動掃描到要加載的信息並啓動相應的默認配置。
starter讓我們擺脫了各種依賴庫的處理，以及各種配置信息的煩惱。SpringBoot會自動通過classpath路徑下的類發現需要的Bean，並註冊進IOC容器。Spring Boot提供了針對日常企業應用研發各種場景的spring-boot-starter依賴模塊。所有這些依賴模塊都遵循着約定成俗的默認配置，並允許我們調整這些配置，即遵循“約定大於配置”的理念。
我們經常會看到或者使用到各種xxx-starter。比如下面幾種：
Spring Boot starter原理
從總體上來看，無非就是將Jar包作爲項目的依賴引入工程。而現在之所以增加了難度，是因爲我們引入的是Spring Boot Starter，所以我們需要去了解Spring Boot對Spring Boot Starter的Jar包是如何加載的？下面我簡單說一下。
SpringBoot 在啓動時會去依賴的 starter 包中尋找 /META-INF/spring.factories 文件，然後根據文件中配置的 Jar 包去掃描項目所依賴的 Jar 包，這類似於 Java 的 SPI 機制。
細節上可以使用@Conditional 系列註解實現更加精確的配置加載Bean的條件。
JavaSPI 實際上是“基於接口的編程＋策略模式＋配置文件”組合實現的動態加載機制。
自定義starter的條件
如果想自定義Starter，首選需要實現自動化配置，而要實現自動化配置需要滿足以下兩個條件：
-
能夠自動配置項目所需要的配置信息，也就是自動加載依賴環境； -
能夠根據項目提供的信息自動生成Bean，並且註冊到Bean管理容器中；
實現自定義starter
pom.xml依賴
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-autoconfigure</artifactId>
<version>2.0.0.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<version>2.0.0.RELEASE</version>
<optional>true</optional>
</dependency>
</dependencies>
根據需要自定義Starter的實現過程大致如下（以我定義的Starter爲例）：
定義XxxProperties類，屬性配置類，完成屬性配置相關的操作，比如設置屬性前綴，用於在application.properties中配置。
TianProperties代碼：
import org.springframework.boot.context.properties.ConfigurationProperties;
@ConfigurationProperties(prefix = "spring.tian")
public class TianProperties {
private String name;
private int age;
private String sex = "M";
//省略 get set 方法
}
創建XxxService類，完成相關的操作邏輯 。
TianService代碼：
public class TianService {
private TianProperties properties;
public TianService() {
}
public TianService(TianProperties userProperties) {
this.properties = userProperties;
}
public void sayHello(){
System.out.println("hi, 我叫: " + properties.getName() +
", 今年" + properties.getAge() + "歲"
+ ", 性別: " + properties.getSex());
}
}
定義XxxConfigurationProperties類，自動配置類，用於完成Bean創建等工作。
TianServiceAutoConfiguration代碼：
@Configuration
@EnableConfigurationProperties(TianProperties.class)
@ConditionalOnClass(TianService.class)
@ConditionalOnProperty(prefix = "spring.tian", value = "enabled", matchIfMissing = true)
public class TianServiceAutoConfiguration {
@Autowired
private TianProperties properties;
@Bean
@ConditionalOnMissingBean(TianService.class)
public TianService tianService() {
return new TianService(properties);
}
}
在resources下創建目錄META-INF，在 META-INF 目錄下創建 spring.factories，在SpringBoot啓動時會根據此文件來加載項目的自動化配置類。
「spring.factories中配置」
org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.tian.TianServiceAutoConfiguration
把上面這個starter工程打成jar包：
使用自定義starter
創建一個Spring Boot項目test，項目整體如下圖：
在項目中把自定義starter添加pom依賴
<dependency>
<groupId>com.tian</groupId>
<artifactId>spring-boot-tian-starter</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
TestApplication啓動類
@SpringBootApplication
@EnableEurekaServer
public class TestApplication {
public static void main(String[] args) {
SpringApplication.run(TestApplication.class, args);
}
}
application.properties中配置
spring.tian.name=tian
spring.tian.age=22
spring.tian.sex=M
寫一個TestController.java類
RestController
@RequestMapping("/my")
public class TestController {
@Resource
private TianService tianService;
@PostMapping("/starter")
public Object starter() {
tianService.sayHello();
return "ok";
}
}
把我們自定義的starter打成的jar依賴進來後，
可以看到其中多了一個json的文件。
最後啓動項目，輸入
http://localhost:9091/my/starter
controller成功返回ok，再看後臺打印
hi, 我叫: tian, 今年22歲, 性別: M
這就成功的現實了自定義的starter。
關鍵詞：開箱即用、減少大量的配置項、約定大於配置。
總結
-
Spring Boot在啓動時掃描項目所依賴的JAR包，尋找包含 spring.factories文件的JAR包， -
然後讀取 spring.factories文件獲取配置的自動配置類AutoConfiguration`， -
然後將自動配置類下滿足條件( @ConditionalOnXxx)的@Bean放入到Spring容器中(Spring Context) -
這樣使用者就可以直接用來注入，因爲該類已經在容器中了。
「只要我們的方向對了，就不怕路遠！」
乾貨分享
最近將個人學習筆記整理成冊，使用PDF分享。關注我，回覆如下代碼，即可獲得百度盤地址，無套路領取！
•001：《Java併發與高併發解決方案》學習筆記；•002：《深入JVM內核——原理、診斷與優化》學習筆記；•003：《Java面試寶典》•004：《Docker開源書》•005：《Kubernetes開源書》•006：《DDD速成（領域驅動設計速成）》•007：全部•008：加技術羣討論
近期熱文
•LinkedBlockingQueue vs ConcurrentLinkedQueue•解讀Java 8 中爲併發而生的 ConcurrentHashMap•Redis性能監控指標彙總•最全的DevOps工具集合，再也不怕選型了！•微服務架構下，解決數據庫跨庫查詢的一些思路•聊聊大廠面試官必問的 MySQL 鎖機制
關注我
喜歡就點個"在看"唄^_^
本文分享自微信公衆號 - IT牧場（itmuch_com）。
如有侵權，請聯繫 [email protected] 刪除。
本文參與“OSC源創計劃”，歡迎正在閱讀的你也加入，一起分享。