建站
咨詢(xún)
售后
建站咨詢(xún)
新聞中心
[[380163]]
創(chuàng)新互聯(lián)專(zhuān)業(yè)為企業(yè)提供隴縣網(wǎng)站建設(shè)、隴縣做網(wǎng)站、隴縣網(wǎng)站設(shè)計(jì)、隴縣網(wǎng)站制作等企業(yè)網(wǎng)站建設(shè)、網(wǎng)頁(yè)設(shè)計(jì)與制作、隴縣企業(yè)網(wǎng)站模板建站服務(wù)，10多年隴縣做網(wǎng)站經(jīng)驗(yàn)，不只是建網(wǎng)站，更提供有價(jià)值的思路和整體網(wǎng)絡(luò)服務(wù)。
starter背景
Spring Boot目前已經(jīng)變成了后端開(kāi)發(fā)這必備技能之一，其中一個(gè)主要原因是Spring Boot中有個(gè)非常重要的機(jī)制(starter機(jī)制)。
starter能夠拋棄以前繁雜的配置，將其統(tǒng)一集成進(jìn)starter，使用的時(shí)候只需要在maven中引入對(duì)應(yīng)的starter依賴(lài)即可，Spring Boot就能自動(dòng)掃描到要加載的信息并啟動(dòng)相應(yīng)的默認(rèn)配置。
starter讓我們擺脫了各種依賴(lài)庫(kù)的處理，以及各種配置信息的煩惱。SpringBoot會(huì)自動(dòng)通過(guò)classpath路徑下的類(lèi)發(fā)現(xiàn)需要的Bean，并注冊(cè)進(jìn)IOC容器。Spring Boot提供了針對(duì)日常企業(yè)應(yīng)用研發(fā)各種場(chǎng)景的spring-boot-starter依賴(lài)模塊。所有這些依賴(lài)模塊都遵循著約定成俗的默認(rèn)配置，并允許我們調(diào)整這些配置，即遵循“約定大于配置”的理念。
我們經(jīng)常會(huì)看到或者使用到各種xxx-starter。比如下面幾種：
Spring Boot starter原理
從總體上來(lái)看，無(wú)非就是將Jar包作為項(xiàng)目的依賴(lài)引入工程。而現(xiàn)在之所以增加了難度，是因?yàn)槲覀円氲氖荢pring Boot Starter，所以我們需要去了解Spring Boot對(duì)Spring Boot Starter的Jar包是如何加載的?下面我簡(jiǎn)單說(shuō)一下。
SpringBoot 在啟動(dòng)時(shí)會(huì)去依賴(lài)的 starter 包中尋找 /META-INF/spring.factories 文件，然后根據(jù)文件中配置的 Jar 包去掃描項(xiàng)目所依賴(lài)的 Jar 包，這類(lèi)似于 Java 的 SPI 機(jī)制。
細(xì)節(jié)上可以使用@Conditional 系列注解實(shí)現(xiàn)更加精確的配置加載Bean的條件。
JavaSPI 實(shí)際上是“基于接口的編程+策略模式+配置文件”組合實(shí)現(xiàn)的動(dòng)態(tài)加載機(jī)制。
自定義starter的條件
如果想自定義Starter，首選需要實(shí)現(xiàn)自動(dòng)化配置，而要實(shí)現(xiàn)自動(dòng)化配置需要滿(mǎn)足以下兩個(gè)條件：
- 能夠自動(dòng)配置項(xiàng)目所需要的配置信息，也就是自動(dòng)加載依賴(lài)環(huán)境;
- 能夠根據(jù)項(xiàng)目提供的信息自動(dòng)生成Bean，并且注冊(cè)到Bean管理容器中;
實(shí)現(xiàn)自定義starter
org.springframework.boot spring-boot-autoconfigure 2.0.0.RELEASE org.springframework.boot spring-boot-configuration-processor 2.0.0.RELEASE true
根據(jù)需要自定義Starter的實(shí)現(xiàn)過(guò)程大致如下(以我定義的Starter為例)：
定義XxxProperties類(lèi)，屬性配置類(lèi)，完成屬性配置相關(guān)的操作，比如設(shè)置屬性前綴，用于在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 方法
- }
創(chuàng)建XxxService類(lèi)，完成相關(guān)的操作邏輯 。
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類(lèi)，自動(dòng)配置類(lèi)，用于完成Bean創(chuàng)建等工作。
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下創(chuàng)建目錄META-INF，在 META-INF 目錄下創(chuàng)建 spring.factories，在SpringBoot啟動(dòng)時(shí)會(huì)根據(jù)此文件來(lái)加載項(xiàng)目的自動(dòng)化配置類(lèi)。
「spring.factories中配置」
- org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.tian.TianServiceAutoConfiguration
把上面這個(gè)starter工程打成jar包：
使用自定義starter
創(chuàng)建一個(gè)Spring Boot項(xiàng)目test，項(xiàng)目整體如下圖：
在項(xiàng)目中把自定義starter添加pom依賴(lài)
com.tian spring-boot-tian-starter 1.0-SNAPSHOT
TestApplication啟動(dòng)類(lèi)
- @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
寫(xiě)一個(gè)TestController.java類(lèi)
- RestController
- @RequestMapping("/my")
- public class TestController {
- @Resource
- private TianService tianService;
- @PostMapping("/starter")
- public Object starter() {
- tianService.sayHello();
- return "ok";
- }
- }
把我們自定義的starter打成的jar依賴(lài)進(jìn)來(lái)后，
可以看到其中多了一個(gè)json的文件。
最后啟動(dòng)項(xiàng)目，輸入
http://localhost:9091/my/starter
controller成功返回ok，再看后臺(tái)打印
- hi, 我叫: tian, 今年22歲, 性別: M
這就成功的現(xiàn)實(shí)了自定義的starter。
關(guān)鍵詞：開(kāi)箱即用、減少大量的配置項(xiàng)、約定大于配置。
總結(jié)
- Spring Boot在啟動(dòng)時(shí)掃描項(xiàng)目所依賴(lài)的JAR包，尋找包含spring.factories文件的JAR包，
- 然后讀取spring.factories文件獲取配置的自動(dòng)配置類(lèi)AutoConfiguration`，
- 然后將自動(dòng)配置類(lèi)下滿(mǎn)足條件(@ConditionalOnXxx)的@Bean放入到Spring容器中(Spring Context)
- 這樣使用者就可以直接用來(lái)注入，因?yàn)樵擃?lèi)已經(jīng)在容器中了。
本文轉(zhuǎn)載自微信公眾號(hào)「Java后端技術(shù)全?！?，可以通過(guò)以下二維碼關(guān)注。轉(zhuǎn)載本文請(qǐng)聯(lián)系Java后端技術(shù)全棧公眾號(hào)。
本文標(biāo)題：徒手?jǐn)]一個(gè)SpringBoot中的starter，解密自動(dòng)化配置
分享鏈接：http://m.fisionsoft.com.cn/article/coojsgj.html
