SpringCloud-Spring Boot Starter使用測試實例分析

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());
    }
 
}

之后可以在 application.properties中修改配置来进行测试证明 properties 中的数据确实被覆盖

以上是SpringCloud-Spring Boot Starter使用測試實例分析的詳細內容。更多資訊請關注PHP中文網其他相關文章！