快捷導(dǎo)航

SpringCloud-Spring?Boot?Starter使用測試及問題小結(jié)

更新時間：2022年07月01日 11:51:47 作者：java李楊勇

Spring?Boot?Starter?是在?SpringBoot?組件中被提出來的一種概念、簡化了很多煩瑣的配置、通過引入各種?Spring?Boot?Starter?包可以快速搭建出一個項目的腳手架，這篇文章主要介紹了SpringCloud-Spring?Boot?Starter使用測試,需要的朋友可以參考下

Spring Boot Starter是什么？

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

比如我們經(jīng)常用的一些：

spring-boot-starter-web：

spring-boot-starter-data-redis：

spring-boot-starter-data-mongodb：

spring-boot-starter-data-jpa：

spring-boot-starter-activemq：

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

以前傳統(tǒng)的做法

在沒有 starter 之前，傳統(tǒng)的SSM項目、假如我想要在 Spring 中使用 jpa，可能需要做以下操作：

首先在 Maven 中引入使用的數(shù)據(jù)庫的依賴>>然后引入 jpa 的依賴>>在xml中配置一些屬性信息>>調(diào)試調(diào)用直到可以正常運行。

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

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

在配置的時候也會劃掉大量的時間、對于新手和小白不太友好。

使用 Spring Boot Starter 之后

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

starter 的理念：

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

starter 的實現(xiàn)：

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

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

創(chuàng)建Spring Boot Starter步驟

創(chuàng)建starter 項目

創(chuàng)建ConfigurationProperties 用來保存配置信息

創(chuàng)建AutoConfiguration，引用定義好的配置信息

在 AutoConfiguration 實現(xiàn)所有 starter 應(yīng)該完成的操作，并且把這個類加入 spring.factories 配置文件中進行聲明

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

具體操作步驟：

在idea新建一個starter項目、直接執(zhí)行下一步即可生成項目。

在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都應(yīng)該繼承自該依賴 -->
    <!-- 如果自定義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>

創(chuàng)建 proterties 類來保存配置信息

@ConfigurationProperties(prefix = "http") 
@Getter
public class HttpProperties {
 
    // 如果配置文件中配置了http.url屬性，則該默認屬性會被覆蓋
    private String url = "https://blog.csdn.net/weixin_39709134?type=blog";
 
}

創(chuàng)建業(yè)務(wù)類：

@Setter
@Getter
public class HttpClient {
 
    private String url;
 
    // 根據(jù)url獲取網(wǎng)頁數(shù)據(jù)
    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";
    }
 
}

這個業(yè)務(wù)類包含了url屬性和一個getHtml方法，用于獲取一個網(wǎng)頁HTML 數(shù)據(jù)

創(chuàng)建 AutoConfiguration

@Configuration
@EnableConfigurationProperties(HttpProperties.class)
public class HttpAutoConfiguration {
 
    @Resource
    private HttpProperties properties; // 使用配置
 
    // 在Spring上下文中創(chuàng)建一個對象
    @Bean
    @ConditionalOnMissingBean
    public HttpClient init() {
        HttpClient client = new HttpClient();
 
        String url = properties.getUrl();
        client.setUrl(url);
        return client;
    }
 
}

在上面的 AutoConfiguration 中我們實現(xiàn)了自己要求：在 Spring 的上下文中創(chuàng)建了一個 HttpClient 類的 bean，并且我們把 properties 中的一個參數(shù)賦給了該 bean。

最后，我們在resources文件夾下新建目錄META-INF，在目錄中新建spring.factories文件，并且在spring.factories中配置 AutoConfiguration：

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

最后使用 Maven 打包該項目。之后創(chuàng)建一個 SpringBoot 項目，在項目中添加我們之前打包的 starter 作為依賴，然后使用 SringBoot 來運行我們的 starter

測試如下：

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

之后可以在 application.properties中修改配置來進行測試證明 properties 中的數(shù)據(jù)確實被覆蓋

到此這篇關(guān)于SpringCloud-SpringBootStarter使用測試的文章就介紹到這了,更多相關(guān)SpringCloudSpringBootStarter使用內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: