如何實現自己的Spring Boot Starter

Spring Boot Starter是在SpringBoot元件中被提出來的一種概念，stackoverflow上面已經有人概括了這個starter是什麼東西，想看完整的回答戳這裡

Starter POMs are a set of convenient dependency descriptors that you can include in your application. You get a one-stop-shop for all the Spring and related technology that you need, without having to hunt through sample code and copy paste loads of dependency descriptors. For example, if you want to get started using Spring and JPA for database access, just include the spring-boot-starter-data-jpa dependency in your project, and you are good to go.

大概意思就是說starter是一種對依賴的synthesize（合成），這是什麼意思呢？我可以舉個例子來說明。

傳統的做法

在沒有starter之前，假如我想要在Spring中使用jpa，那我可能需要做以下操作：

1. 在Maven中引入使用的資料庫的依賴（即JDBC的jar）
2. 引入jpa的依賴
3. 在xxx.xml中配置一些屬性資訊
4. 反覆的除錯直到可以正常執行

需要注意的是，這裡操作在我們每次新建一個需要用到jpa的專案的時候都需要重複的做一次。也許你在第一次自己建立專案的時候是在Google上自己搜尋了一番，花了半天時間解決掉了各種奇怪的問題之後，jpa終於能正常執行了。有些有經驗的人會在OneNote上面把這次建立專案的過程給記錄下來，包括操作的步驟以及需要用到的配置檔案的內容，在下一次再建立jpa專案的時候，就不需要再次去Google了，只需要照著筆記來，之後再把所有的配置檔案copy&paste就可以了。

像上面這樣的操作也不算不行，事實上我們在沒有starter之前都是這麼幹的，但是這樣做有幾個問題：

1. 如果過程比較繁瑣，這樣一步步操作會增加出錯的可能性
2. 不停地copy&paste不符合Don’t repeat yourself精神
3. 在第一次配置的時候（尤其如果開發者比較小白），需要花費掉大量的時間

使用Spring Boot Starter提升效率

starter的主要目的就是為了解決上面的這些問題。

starter的理念：starter會把所有用到的依賴都給包含進來，避免了開發者自己去引入依賴所帶來的麻煩。需要注意的是不同的starter是為了解決不同的依賴，所以它們內部的實現可能會有很大的差異，例如jpa的starter和Redis的starter可能實現就不一樣，這是因為starter的本質在於synthesize，這是一層在邏輯層面的抽象，也許這種理念有點類似於Docker，因為它們都是在做一個“包裝”的操作，如果你知道Docker是為了解決什麼問題的，也許你可以用Docker和starter做一個類比。

starter的實現：雖然不同的starter實現起來各有差異，但是他們基本上都會使用到兩個相同的內容：ConfigurationProperties和AutoConfiguration。因為Spring Boot堅信“約定大於配置”這一理念，所以我們使用ConfigurationProperties來儲存我們的配置，並且這些配置都可以有一個預設值，即在我們沒有主動覆寫原始配置的情況下，預設值就會生效，這在很多情況下是非常有用的。除此之外，starter的ConfigurationProperties還使得所有的配置屬性被聚集到一個檔案中（一般在resources目錄下的application.properties），這樣我們就告別了Spring專案中XML地獄。

starter的整體邏輯：

上面的starter依賴的jar和我們自己手動配置的時候依賴的jar並沒有什麼不同，所以我們可以認為starter其實是把這一些繁瑣的配置操作交給了自己，而把簡單交給了使用者。除了幫助使用者去除了繁瑣的構建操作，在“約定大於配置”的理念下，ConfigurationProperties還幫助使用者減少了無謂的配置操作。並且因為 application.properties 檔案的存在，即使需要自定義配置，所有的配置也只需要在一個檔案中進行，使用起來非常方便。

瞭解了starter其實就是幫助使用者簡化了配置的操作之後，要理解starter和被配置了starter的元件之間並不是競爭關係，而是輔助關係，即我們可以給一個元件建立一個starter來讓終端使用者在使用這個元件的時候更加的簡單方便。基於這種理念，我們可以給任意一個現有的元件建立一個starter來讓別人在使用這個元件的時候更加的簡單方便，事實上Spring Boot團隊已經幫助現有大部分的流行的元件建立好了它們的starter，你可以在這裡檢視這些starter的列表。

建立自己的Spring Boot Starter

如果你想要自己建立一個starter，那麼基本上包含以下幾步

1. 建立一個starter專案，關於專案的命名你可以參考這裡
2. 建立一個ConfigurationProperties用於儲存你的配置資訊（如果你的專案不使用配置資訊則可以跳過這一步，不過這種情況非常少見）
3. 建立一個AutoConfiguration，引用定義好的配置資訊；在AutoConfiguration中實現所有starter應該完成的操作，並且把這個類加入spring.factories配置檔案中進行宣告
4. 打包專案，之後在一個SpringBoot專案中引入該專案依賴，然後就可以使用該starter了

來看一個例子（例子的完整程式碼位於https://github.com/RitterHou/learn-spring-boot-starter）

首先新建一個Maven專案，設定 pom.xml 檔案如下：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <artifactId>http-starter</artifactId>
    <version>0.0.1-SNAPSHOT</version>

    <!-- 自定義starter都應該繼承自該依賴 -->
    <!-- 如果自定義starter本身需要繼承其它的依賴，可以參考 https://stackoverflow.com/a/21318359 解決 -->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starters</artifactId>
        <version>1.5.2.RELEASE</version>
    </parent>

    <dependencies>
        <!-- 自定義starter依賴此jar包 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <!-- lombok用於自動生成get、set方法 -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.16.10</version>
        </dependency>
    </dependencies>

</project>

建立proterties類來儲存配置資訊：

@ConfigurationProperties(prefix = "http") // 自動獲取配置檔案中字首為http的屬性，把值傳入物件引數
@Setter
@Getter
public class HttpProperties {

    // 如果配置檔案中配置了http.url屬性，則該預設屬性會被覆蓋
    private String url = "http://www.baidu.com/";

}

上面這個類就是定義了一個屬性，其預設值是 http://www.baidu.com/，我們可以通過在 application.properties 中新增配置 http.url=https://www.zhihu.com 來覆蓋引數的值。

建立業務類：

@Setter
@Getter
public class HttpClient {

    private String url;

    // 根據url獲取網頁資料
    public String getHtml() {
        try {
            URL url = new URL(this.url);
            URLConnection urlConnection = url.openConnection();
            BufferedReader br = new BufferedReader(new InputStreamReader(urlConnection.getInputStream(), "utf-8"));
            String line = null;
            StringBuilder sb = new StringBuilder();
            while ((line = br.readLine()) != null) {
                sb.append(line).append("\n");
            }
            return sb.toString();
        } catch (Exception e) {
            e.printStackTrace();
        }
        return "error";
    }

}

這個業務類的操作非常簡單，只包含了一個 url 屬性和一個 getHtml 方法，用於獲取一個網頁的HTML資料，讀者看看就懂了。

建立AutoConfiguration

@Configuration
@EnableConfigurationProperties(HttpProperties.class)
public class HttpAutoConfiguration {

    @Resource
    private HttpProperties properties; // 使用配置

    // 在Spring上下文中建立一個物件
    @Bean
    @ConditionalOnMissingBean
    public HttpClient init() {
        HttpClient client = new HttpClient();

        String url = properties.getUrl();
        client.setUrl(url);
        return client;
    }

}

在上面的AutoConfiguration中我們實現了自己要求：在Spring的上下文中建立了一個HttpClient類的bean，並且我們把properties中的一個引數賦給了該bean。
關於@ConditionalOnMissingBean 這個註解，它的意思是在該bean不存在的情況下此方法才會執行，這個相當於開關的角色，更多關於開關係列的註解可以參考這裡。

最後，我們在 resources 資料夾下新建目錄 META-INF，在目錄中新建 spring.factories 檔案，並且在 spring.factories 中配置AutoConfiguration：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.nosuchfield.httpstarter.HttpAutoConfiguration

到此，我們的starter已經建立完畢了，使用Maven打包該專案。之後建立一個SpringBoot專案，在專案中新增我們之前打包的starter作為依賴，然後使用SringBoot來執行我們的starter，程式碼如下：

@Component
public class RunIt {

    @Resource
    private HttpClient httpClient;

    public void hello() {
        System.out.println(httpClient.getHtml());
    }

}

正常情況下此方法的執行會列印出url http://www.baidu.com/ 的HTML內容，之後我們在application.properties中加入配置：

http.url=https://www.zhihu.com/

再次執行程式，此時列印的結果應該是知乎首頁的HTML了，證明properties中的資料確實被覆蓋了。

參考：Spring Boot Starters 御阪研究所