徒手擼一個 Spring Boot 中的 Starter ，解密自動化配置黑魔法！

咱們使用 Spring Boot，基本上都是沉醉在它 Stater 的方便之中。Starter 爲咱們帶來了衆多的自動化配置，有了這些自動化配置，咱們能夠不費吹灰之力就能搭建一個生產級開發環境，有的小夥伴會以爲這個 Starter 好神奇呀！其實 Starter 也都是 Spring + SpringMVC 中的基礎知識點實現的，今天鬆哥就來帶你們本身來擼一個 Starter ，慢慢揭開 Starter 的神祕面紗！

核心知識

其實 Starter 的核心就是條件註解 @Conditional ，當 classpath 下存在某一個 Class 時，某個配置纔會生效，前面鬆哥已經帶你們學習過很多 Spring Boot 中的知識點，有的也涉及到源碼解讀，大夥可能也發現了源碼解讀時老是會出現條件註解，其實這就是 Starter 配置的核心之一，大夥有興趣能夠翻翻歷史記錄，看看鬆哥以前寫的關於 Spring Boot 的文章，這裏我就再也不重複介紹了。

定義本身的 Starter

定義

所謂的 Starter ，其實就是一個普通的 Maven 項目，所以咱們自定義 Starter ，須要首先建立一個普通的 Maven 項目，建立完成後，添加 Starter 的自動化配置類便可，以下：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-autoconfigure</artifactId>
    <version>2.1.4.RELEASE</version>
</dependency>
複製代碼

配置完成後，咱們首先建立一個 HelloProperties 類，用來接受 application.properties 中注入的值，以下：

@ConfigurationProperties(prefix = "javaboy")
public class HelloProperties {
    private static final String DEFAULT_NAME = "江南一點雨";
    private static final String DEFAULT_MSG = "牧碼小子";
    private String name = DEFAULT_NAME;
    private String msg = DEFAULT_MSG;
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public String getMsg() {
        return msg;
    }
    public void setMsg(String msg) {
        this.msg = msg;
    }
}
複製代碼

這個配置類很好理解，將 application.properties 中配置的屬性值直接注入到這個實例中， @ConfigurationProperties 類型安全的屬性注入，即將 application.properties 文件中前綴爲 javaboy 的屬性注入到這個類對應的屬性上， 最後使用時候，application.properties 中的配置文件，大概以下：

javaboy.name=zhangsan
javaboy.msg=java
複製代碼

關注類型安全的屬性注入，讀者能夠參考鬆哥以前的這篇文章：Spring Boot中的yaml配置簡介，這篇文章雖然是講 yaml 配置，可是關於類型安全的屬性注入和 properties 是同樣的。

配置完成 HelloProperties 後，接下來咱們來定義一個 HelloService ，而後定義一個簡單的 say 方法， HelloService 的定義以下：

public class HelloService {
    private String msg;
    private String name;
    public String sayHello() {
        return name + " say " + msg + " !";
    }
    public String getMsg() {
        return msg;
    }
    public void setMsg(String msg) {
        this.msg = msg;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
}
複製代碼

這個很簡單，沒啥好說的。

接下來就是咱們的重軸戲，自動配置類的定義，用了不少別人定義的自定義類以後，咱們也來本身定義一個自定義類。先來看代碼吧，一會鬆哥再慢慢解釋：

@Configuration
@EnableConfigurationProperties(HelloProperties.class)
@ConditionalOnClass(HelloService.class)
public class HelloServiceAutoConfiguration {
    @Autowired
    HelloProperties helloProperties;

    @Bean
    HelloService helloService() {
        HelloService helloService = new HelloService();
        helloService.setName(helloProperties.getName());
        helloService.setMsg(helloProperties.getMsg());
        return helloService;
    }
}
複製代碼

關於這一段自動配置，解釋以下：

• 首先 @Configuration 註解代表這是一個配置類。
• @EnableConfigurationProperties 註解是使咱們以前配置的 @ConfigurationProperties 生效，讓配置的屬性成功的進入 Bean 中。
• @ConditionalOnClass 表示當項目當前 classpath 下存在 HelloService 時，後面的配置才生效。
• 自動配置類中首先注入 HelloProperties ，這個實例中含有咱們在 application.properties 中配置的相關數據。
• 提供一個 HelloService 的實例，將 HelloProperties 中的值注入進去。

作完這一步以後，咱們的自動化配置類就算是完成了，接下來還須要一個 spring.factories 文件，那麼這個文件是幹嗎的呢？你們知道咱們的 Spring Boot 項目的啓動類都有一個 @SpringBootApplication 註解，這個註解的定義以下：

@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(excludeFilters = {
		@Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
		@Filter(type = FilterType.CUSTOM,
				classes = AutoConfigurationExcludeFilter.class) })
public @interface SpringBootApplication {
}
複製代碼

你們看到這是一個組合註解，其中的一個組合項就是 @EnableAutoConfiguration ，這個註解是幹嗎的呢？

@EnableAutoConfiguration 表示啓用 Spring 應用程序上下文的自動配置，該註解會自動導入一個名爲 AutoConfigurationImportSelector 的類,而這個類會去讀取一個名爲 spring.factories 的文件, spring.factories 中則定義須要加載的自動化配置類，咱們打開任意一個框架的 Starter ，都能看到它有一個 spring.factories 文件，例如 MyBatis 的 Starter 以下：

那麼咱們自定義 Starter 固然也須要這樣一個文件，咱們首先在 Maven 項目的 resources 目錄下建立一個名爲 META-INF 的文件夾，而後在文件夾中建立一個名爲 spring.factories 的文件，文件內容以下：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=org.javaboy.mystarter.HelloServiceAutoConfiguration
複製代碼

在這裏指定咱們的自動化配置類的路徑便可。

如此以後咱們的自動化配置類就算完成了。

本地安裝

若是在公司裏，大夥可能須要將剛剛寫好的自動化配置類打包，而後上傳到 Maven 私服上，供其餘同事下載使用，我這裏就簡單一些，我就不上傳私服了，我將這個自動化配置類安裝到本地倉庫，而後在其餘項目中使用便可。安裝方式很簡單，在 IntelliJ IDEA 中，點擊右邊的 Maven Project ，而後選擇 Lifecycle 中的 install ，雙擊便可，以下：

雙擊完成後，這個 Starter 就安裝到咱們本地倉庫了，固然小夥伴也可使用 Maven 命令去安裝。

使用 Starter

接下來，咱們來新建一個普通的 Spring Boot 工程，這個 Spring Boot 建立成功以後，加入咱們自定義 Starter 的依賴，以下：

<dependency>
    <groupId>org.javaboy</groupId>
    <artifactId>mystarter</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>
複製代碼

此時咱們引入了上面自定義的 Starter ，也即咱們項目中如今有一個默認的 HelloService 實例可使用，並且關於這個實例的數據，咱們還能夠在 application.properties 中進行配置，以下：

javaboy.name=牧碼小子
javaboy.msg=java
複製代碼

配置完成後，方便起見，我這裏直接在單元測試方法中注入 HelloSerivce 實例來使用，代碼以下：

@RunWith(SpringRunner.class)
@SpringBootTest
public class UsemystarterApplicationTests {

    @Autowired
    HelloService helloService;
    @Test
    public void contextLoads() {
        System.out.println(helloService.sayHello());
    }
}
複製代碼

執行單元測試方法，打印日誌以下：

好了，一個簡單的自動化配置類咱們就算完成了，是否是很簡單！

總結

本文主要帶領小夥伴本身徒手擼一個 Starter ，使用這種方式幫助你們揭開 Starter 的神祕面紗！大夥有問題能夠留言討論。

本文的案例，鬆哥已經上傳到 GitHub上了，地址：github.com/lenve/javab… 。

關注公衆號【江南一點雨】，專一於 Spring Boot+微服務以及先後端分離等全棧技術，按期視頻教程分享，關注後回覆 Java ，領取鬆哥爲你精心準備的 Java 乾貨！