快捷導(dǎo)航

SpringBoot自定義啟動(dòng)器Starter流程詳解

更新時(shí)間：2022年11月15日 11:22:39 作者：Decade0712

SpringBoot中的starter是一種非常重要的機(jī)制，能夠拋棄以前繁雜的配置，將其統(tǒng)一集成進(jìn)starter，應(yīng)用者只需要在maven中引入starter依賴(lài)，SpringBoot就能自動(dòng)掃描到要加載的信息并啟動(dòng)相應(yīng)的默認(rèn)配置。starter讓我們擺脫了各種依賴(lài)庫(kù)的處理，需要配置各種信息的困擾

一、背景

雖然Spring官方給我們提供了很多的啟動(dòng)器供我們使用

但有時(shí)候我們也會(huì)遇到某些特殊場(chǎng)景，這些啟動(dòng)器滿(mǎn)足不了

這個(gè)時(shí)候就需要自定義一個(gè)啟動(dòng)器供我們使用

二、自定義啟動(dòng)器

在之前學(xué)習(xí)Spring Boot的過(guò)程中，我們已經(jīng)對(duì)啟動(dòng)器有了一個(gè)大致的了解

Spring Boot實(shí)現(xiàn)某個(gè)功能，一般是引入對(duì)應(yīng)場(chǎng)景的啟動(dòng)器（一般不寫(xiě)代碼，只是聲明這個(gè)啟動(dòng)器需要引用哪些依賴(lài)），然后這個(gè)啟動(dòng)器又有對(duì)應(yīng)的自動(dòng)配置包

1、創(chuàng)建一個(gè)啟動(dòng)器的自動(dòng)配置模塊

先寫(xiě)和配置文件中配置項(xiàng)互相綁定的實(shí)體類(lèi)

package com.decade.autoConfigure.pojo;
import org.springframework.boot.context.properties.ConfigurationProperties;
// 將這個(gè)類(lèi)的屬性和系統(tǒng)配置文件中的屬性進(jìn)行綁定
@ConfigurationProperties(prefix = "team")
public class TeamInfo {
    private String winnerName;
    private String loserName;
    public String getWinnerName() {
        return winnerName;
    }
    public void setWinnerName(String winnerName) {
        this.winnerName = winnerName;
    }
    public String getLoserName() {
        return loserName;
    }
    public void setLoserName(String loserName) {
        this.loserName = loserName;
    }
}

再寫(xiě)自己要實(shí)現(xiàn)的業(yè)務(wù)邏輯

package com.decade.autoConfigure.service;
import com.decade.autofigure.pojo.TeamInfo;
import org.springframework.beans.factory.annotation.Autowired;
public class TestService {
	// 引入和yaml文件中配置項(xiàng)綁定的類(lèi)
    @Autowired
    private TeamInfo teamInfo;
    public String testMethod() {
        return teamInfo.getWinnerName() + "今天早上，絕殺了" + teamInfo.getLoserName();
    }
}

接著，寫(xiě)一個(gè)自動(dòng)配置類(lèi)，向容器中放入組件

package com.decade.autoConfigure.auto;
import com.decade.autofigure.pojo.TeamInfo;
import com.decade.autofigure.service.TestService;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
// 使得TeamInfo中的@ConfigurationProperties注解生效，將TeamInfo注冊(cè)到容器中
@EnableConfigurationProperties(TeamInfo.class)
@Configuration
public class AutoConfiguration {
    @Bean
    // 只有容器中不存在TestService這個(gè)類(lèi)型的bean時(shí)，才回去初始化這個(gè)bean
    @ConditionalOnMissingBean(TestService.class)
    public TestService testService() {
        TestService testService = new TestService();
        return testService;
    }
}

最后，在新版本的Spring Boot中為了確保框架啟動(dòng)時(shí)加載該配置類(lèi)

我們需要在這個(gè)模塊的resource文件下

新建/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports文件

然后在里面寫(xiě)自己之前創(chuàng)建的自動(dòng)配置類(lèi)

注意：老版可能是放在META-INF/spring.factories文件中

com.decade.autoConfigure.auto.AutoConfiguration

2、創(chuàng)建一個(gè)啟動(dòng)器模塊

不用寫(xiě)任何業(yè)務(wù)代碼，只需要在pom文件中，引用之前的創(chuàng)建的自動(dòng)配置模塊

3、在業(yè)務(wù)模塊中引入啟動(dòng)器

如圖，引入我們自己定義的啟動(dòng)器

然后在yaml文件中設(shè)置好綁定的配置項(xiàng)

再寫(xiě)一個(gè)測(cè)試方法進(jìn)行測(cè)試即可

package com.decade;
import com.decade.autoConfigure.service.TestService;
import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
@SpringBootTest
@Slf4j
class SpringbootWebApplicationTests {
    @Autowired
    private TestService testService;
    @Test
    public void testCustomStarter() {
        System.out.println(testService.testMethod());
    }
}

測(cè)試方法結(jié)果如下圖