SpringCloud-Spring Boot Starter使用測試及問題小結

2022-07-01 18:03:28

Spring Boot Starter是什麼？

Spring Boot Starter 是在 SpringBoot 元件中被提出來的一種概念、簡化了很多煩瑣的設定、通過引入各種 Spring Boot Starter 包可以快速搭建出一個專案的腳手架。

比如我們經常用的一些：

spring-boot-starter-web：

spring-boot-starter-data-redis：

spring-boot-starter-data-mongodb：

spring-boot-starter-data-jpa：

spring-boot-starter-activemq：

總體來說就是 starter 是一種對依賴的合成。

以前傳統的做法

在沒有 starter 之前，傳統的SSM專案、假如我想要在 Spring 中使用 jpa，可能需要做以下操作：

首先在 Maven 中引入使用的資料庫的依賴>>然後引入 jpa 的依賴>>在xml中設定一些屬性資訊>>偵錯呼叫直到可以正常執行。

上面這樣的操作會有一些問題、比如：

如果過程比較繁瑣，這樣一步步操作會增加出錯的可能性。

在設定的時候也會劃掉大量的時間、對於新手和小白不太友好。

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

建立Spring Boot Starter步驟

建立starter 專案

建立ConfigurationProperties 用來儲存設定資訊

建立AutoConfiguration，參照定義好的設定資訊

在 AutoConfiguration 實現所有 starter 應該完成的操作，並且把這個類加入 spring.factories 組態檔中進行宣告

打包項在 SpringBoot 專案中引入該專案依賴，然後就可以使用該 starter 了

具體操作步驟：

在idea新建一個starter專案、直接執行下一步即可生成專案。

在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") 
@Getter
public class HttpProperties {
 
    // 如果組態檔中設定了http.url屬性，則該預設屬性會被覆蓋
    private String url = "https://blog.csdn.net/weixin_39709134?type=blog";
 
}

建立業務類：

@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。

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

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

最後使用 Maven 打包該專案。之後建立一個 SpringBoot 專案，在專案中新增我們之前打包的 starter 作為依賴，然後使用 SringBoot 來執行我們的 starter

測試如下：

@Component
public class RunIt {
 
    @Resource
    private HttpClient httpClient;
 
    public void hello() {
        System.out.println(httpClient.getHtml());
    }
 
}