### 歡迎訪問我的GitHub
> 這裡分類和彙總了欣宸的全部原創(含配套原始碼)：[https://github.com/zq2599/blog_demos](https://github.com/zq2599/blog_demos)

- 從本章開始，一起實戰一個自定義的spring boot starter，整個系列共三篇文章，內容如下：
1. 準備：瞭解基本概念、規劃實戰內容；
2. 實戰：開發自定義starter，並在demo工程中使用它；
3. 深入：從spring和spring boot原始碼層面分析starter的原理；

### 本章內容概覽
1. 檢視官方資料；
2. 設定實戰目標；
3. 學習spring cloud的starter，作為實戰參考；
4. 實戰內容的具體設計；

### 版本資訊
- 本次實戰的版本資訊：
1. java：1.8.0_144
2. spring boot：1.5.16.RELEASE
3. spring cloud：Edgware.RELEASE

### 官方資料
- 為了有個初始印象，我們從spring官方文件看起吧：

- 官網：https://spring.io/docs/reference ，點選下圖紅框位置：

![image.png](https://bbs-img.huaweicloud.com/blogs/img/20220712/1657639576793820703.png)

- 在彈出的列表中選擇1.5.16版本的reference，如下圖紅框：

![image.png](https://bbs-img.huaweicloud.com/blogs/img/20220712/1657639585296308654.png)

- 在開啟的文件目錄中很容易找到starter的章節，地址是：https://docs.spring.io/spring-boot/docs/1.5.16.RELEASE/reference/htmlsingle/#using-boot-starter ，內容如下圖：

![image.png](https://bbs-img.huaweicloud.com/blogs/img/20220712/1657639598958933713.png)

- 我的理解：
- 第一. 在應用中可以用starter將依賴庫問題變得簡單，如果你想依賴Spring和JPA，只需在應用中依賴spring-boot-starter-data-jpa即可；
- 第二. 常用庫的官方starter，其artifactId的格式類似"spring-boot-starter-*"， 對於非官方的starter，建議將業務名稱放在"spring-boot-starter"前面，例如"acme-spring-boot-starter"；
- 第三. 已列舉常用的官方starter，可用來參考；

### 設定實戰目標
- 本次實戰的目標如下：
1. A應用提供加法計算的服務；
2. B應用提供減法計算的服務；
3. C應用要使用加法計算和減法計算的服務，並且減法服務可以透過配置來實現是否支援負數；

### 學習spring cloud的starter
- 目標已定下，但是先不急著編碼，我們去看下spring cloud的設計，用來作為借鑑參考；

- 回顧一下我們使用Spring cloud的時候，如果要把一個應用作為Eureka client註冊到Eureka server，只需在應用的pom.xml中新增如下依賴：

```xml
<dependency>
	<groupid>org.springframework.cloud</groupid>
	<artifactid>spring-cloud-starter-netflix-eureka-client</artifactid>
</dependency>
```
- 註冊到Eureka server的工作，是由CloudEurekaClient類完成的，該類屬於模組spring-cloud-netflix-eureka-client，因此我們要弄清楚以下兩點：
1. 為什麼不需要應用的pom.xml中依賴spring-cloud-netflix-eureka-client？
2. 為什麼應用能自動註冊到Eureka sever？

### 如何建立對spring-cloud-netflix-eureka-client模組的依賴
- 開啟spring-cloud-starter-netflix-eureka-client模組的pom.xml檔案就一目瞭然了，如下圖，原來在這個pom.xml檔案中已經依賴了spring-cloud-netflix-eureka-client模組，因此，我們的應用只需依賴spring-cloud-starter-netflix-eureka-client模組，就能間接依賴到spring-cloud-netflix-eureka-client模組：

![image.png](https://bbs-img.huaweicloud.com/blogs/img/20220712/1657639618498870958.png)

- 再看看上圖中其他的依賴，可以發現的確如官方文件所說，starter處理了複雜的依賴關係，我們只需要依賴starter即可，官方文件中還有一段話需要注意，如下圖：

![image.png](https://bbs-img.huaweicloud.com/blogs/img/20220712/1657639627836205700.png)

- 上圖紅框中說明starter是個空的jar，其作用就是用來提供必要的模組依賴的，來看看spring-cloud-starter-netflix-eureka-client模組是否遵守此規則，如下圖，只有配置檔案，沒有任何class：

![image.png](https://bbs-img.huaweicloud.com/blogs/img/20220712/1657639636796630637.png)

### 為什麼應用能自動註冊到Eureka sever
- 作為Eureka client的應用，在啟動後就自動註冊到Eureka server了，作為應用開發者的我們除了在pom.xml中依賴spring-cloud-starter-netflix-eureka-client模組，沒有做其他設定，這是如何實現的呢？

- 註冊到Eureka server的工作，是CloudEurekaClient類在其父類的構造方法中完成的，搜尋原始碼發現此類的在EurekaClientAutoConfiguration中被註冊到spring容器，如下圖紅框所示：

![image.png](https://bbs-img.huaweicloud.com/blogs/img/20220712/1657639651871791946.png)

- 所以，現在問題就變成了**如何讓EurekaClientAutoConfiguration類被例項化**?

- 在spring-cloud-netflix-eureka-client模組的spring.factories檔案中，找到了EurekaClientAutoConfiguration：

![image.png](https://bbs-img.huaweicloud.com/blogs/img/20220712/1657639666081727477.png)

- 這是個spring boot的擴充套件配置，在此檔案中配置的bean都會被例項化，然後註冊到spring容器，具體的細節，我們會在第三章結合spring boot原始碼詳細分析，本章只要知道用法即可；

- 此處小結Eureka client自動註冊到Eureka server的過程：
- 第一、spring-cloud-netflix-eureka-client模組的spring.factories檔案中配置了EurekaClientAutoConfiguration，因此EurekaClientAutoConfiguration會被例項化並註冊到Spring容器中；
- 第二、EurekaClientAutoConfiguration中配置了CloudEurekaClient，因此CloudEurekaClient會例項化，在構造方法中執行了註冊；

### 實戰的設計
- 參考了spring cloud的starter設計後，接下來的實戰被設計成兩個maven工程：customizestarter和customizestartertestdemo；

- 工程customizestarter裡面包含了四個模組，每個模組功能如下所示：

| 模組名稱 | 作用 | 備註 |
|:--------|:-------------|:-------------|
| customizeapi| 包含 了介面和異常的定義 | 實現和呼叫服務時用到的介面和異常都在此工程中 |
| addservice| 提供加法服務 | 普通的maven工程，裡面加法介面的實現類 |
| minusservice| 提供減法服務 | 普通的maven工程，裡面有兩個減法介面的實現類，一個支援負數，另一個不支援 |
| customizeservicestarter| 自定義starter模組 | pom.xml中依賴了customizeapi、addservice、minusservice，自身有個Configuration類，透過@Bean註解向spring容器註冊AddService和MinusService的例項 |

- 工程customizestartertestdemo在pom.xml中依賴了上述的customizeservicestarter模組，提供的web服務會用到addservice和minusservice的服務，並且在應用啟動時設定環境變數來選擇使用的減法服務是否支援負數；

- 至此，準備工作已經完成了，對基本原理和開發設計都已經清楚，接下來的章節我們來一起開發上述五個工程；

### 歡迎關注ITpub：程式設計師欣宸
> [學習路上，你不孤單，欣宸原創一路相伴...](http://blog.itpub.net/70017844/)

自定義spring boot starter三部曲之一：準備工作

相關文章