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

- 本文是《自定義spring boot starter三部曲》的第二篇，上一篇中我們透過學習spring cloud的starter，對spring boot的starter有了初步瞭解，也設計好了實戰內容，今天就來一起實現；

###  本章內容概述
1. 建立工程customizestarter；
2. 建立模組customizeapi；
3. 建立模組addservice；
4. 建立模組minusservice；
5. 建立模組customizeservicestarter；
6. 構建工程customizestarter，並安裝到本地maven倉庫；
7. 建立工程customizestartertestdemo；
8. 構建工程customizestartertestdemo，得到jar包；
9. 啟動customizestartertestdemo工程的jar包，並帶上一個啟動引數，驗證支援負數的減法服務；
10. 啟動customizestartertestdemo工程的jar包，驗證不支援服務的減法服務；

### 原始碼下載
- 您也可以選擇直接從GitHub下載customizestarter和customizestartertestdemo這兩個工程的原始碼，地址和連結資訊如下表所示：

| 名稱      |   連結 |   備註|
| :-------- | :----| :----|
| 專案主頁| https://github.com/zq2599/blog_demos | 該專案在GitHub上的主頁 |
| git倉庫地址(https)| https://github.com/zq2599/blog_demos.git | 該專案原始碼的倉庫地址，https協議 |
| git倉庫地址(ssh)| git@github.com:zq2599/blog_demos.git | 該專案原始碼的倉庫地址，ssh協議 |

- 這個git專案中有多個資料夾，本章原始碼分別在customizestarter和customizestartertestdemo這兩個資料夾下，如下圖紅框所示：

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

- 接下來開始開發吧；

### 建立工程customizestarter
- 建立一個名為customizestarter的maven工程，以**spring-boot-starter-parent作為父工程，同時自身又是後續幾個模組的父工程，pom.xml內容如下：

```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>
    <groupid>com.bolingcavalry</groupid>
    <artifactid>customizestarter</artifactid>
    <packaging>pom</packaging>
    <version>0.0.1-SNAPSHOT</version>

<parent>
        <groupid>org.springframework.boot</groupid>
        <artifactid>spring-boot-starter-parent</artifactid>
        <version>1.5.9.RELEASE</version>
        <relativepath></relativepath>
    </parent>

<modules>
        
        <module>addservice</module>
        
        <module>minusservice</module>
        
        <module>customizeapi</module>
        
        <module>customizeservicestarter</module>
    </modules>
</project>
```

### 建立模組customizeapi
- 在工程customizestarter下建立模組customizeapi，這是個java工程，裡面是加法和減法服務的介面，和一個業務異常的定義；
- customizeapi的pom.xml內容如下，很簡單，只有基本定義：

```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">
    <parent>
        <artifactid>customizestarter</artifactid>
        <groupid>com.bolingcavalry</groupid>
        <version>0.0.1-SNAPSHOT</version>
        <relativepath>../</relativepath>
    </parent>
    <modelversion>4.0.0</modelversion>
    <artifactid>customizeapi</artifactid>
</project>
```

- 異常定義類：

```java
package com.bolingcavalry.api.exception;

/**
 * @author wilzhao
 * @description 執行減法服務時丟擲的異常
 * @email zq2599@gmail.com
 * @time 2018/10/13 14:20
 */
public class MinusException extends Exception{
    public MinusException(String message) {
        super(message);
    }
}
```

- 加法服務的介面類AddService：

```java
package com.bolingcavalry.api.service;

/**
 * @author wilzhao
 * @description 加法服務對應的介面
 * @email zq2599@gmail.com
 * @time 2018/10/13 10:07
 */
public interface AddService {
    /**
     * 普通加法
     * @param a
     * @param b
     * @return
     */
    int add(int a, int b);
}
```

- 減法服務定義類，注意減法API宣告瞭異常丟擲，因為如果已經配置了不支援負數的減法服務，那麼被減數如果小於減數就丟擲異常：

```java
package com.bolingcavalry.api.service;

import com.bolingcavalry.api.exception.MinusException;

/**
 * @author wilzhao
 * @description 減法服務
 * @email zq2599@gmail.com
 * @time 2018/10/13 12:07
 */
public interface MinusService {
    /**
     * 普通減法
     * @param minuend 減數
     * @param subtraction 被減數
     * @return 差
     */
    int minus(int minuend, int subtraction) throws MinusException;
}
```

### 建立模組addservice

- 在工程customizestarter下建立模組addservice，這是個java工程，裡面包含了加法相服務的實現，pom.xml內容如下，注意由於要實現加法介面，因此需要依賴模組customizeapi：

```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">
    <parent>
        <artifactid>customizestarter</artifactid>
        <groupid>com.bolingcavalry</groupid>
        <version>0.0.1-SNAPSHOT</version>
        <relativepath>../</relativepath>
    </parent>
    <artifactid>addservice</artifactid>
    <modelversion>4.0.0</modelversion>

<dependencies>
        <dependency>
            <groupid>com.bolingcavalry</groupid>
            <artifactid>customizeapi</artifactid>
            <version>${project.version}</version>
        </dependency>
    </dependencies>
</project>
```

- 加法介面的實現類AddServiceImpl很簡單，如下：

```java
package com.bolingcavalry.addservice.service.impl;

import com.bolingcavalry.api.service.AddService;

/**
 * @author wilzhao
 * @description 加法服務的實現
 * @email zq2599@gmail.com
 * @time 2018/10/13 10:59
 */
public class AddServiceImpl implements AddService {
    public int add(int a, int b) {
        return a + b;
    }
}
```

### 建立模組minusservice

- 在工程customizestarter下建立模組minusservice，這是個java工程，裡面包含了減法相服務的實現，pom.xml內容如下，注意由於要實現減法介面，因此需要依賴模組customizeapi：

```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">
    <parent>
        <artifactid>customizestarter</artifactid>
        <groupid>com.bolingcavalry</groupid>
        <version>0.0.1-SNAPSHOT</version>
        <relativepath>../</relativepath>
    </parent>
    <modelversion>4.0.0</modelversion>
    <artifactid>minusservice</artifactid>
    <dependencies>
        <dependency>
            <groupid>com.bolingcavalry</groupid>
            <artifactid>customizeapi</artifactid>
            <version>${project.version}</version>
        </dependency>
    </dependencies>
</project>
```

- 一共有兩個減法介面的實現類，第一個不支援負數結果，如果被減數小於減數就丟擲異常MinusException：

```java
package com.bolingcavalry.minusservice.service.impl;

import com.bolingcavalry.api.exception.MinusException;
import com.bolingcavalry.api.service.MinusService;

/**
 * @author wilzhao
 * @description 減法服務的實現，不支援負數
 * @email zq2599@gmail.com
 * @time 2018/10/13 14:24
 */
public class MinusServiceNotSupportNegativeImpl implements MinusService {

/**
     * 減法運算，不支援負數結果，如果被減數小於減數，就跑出MinusException
     * @param minuend 被減數
     * @param subtraction 減數
     * @return
     * @throws MinusException
     */
    public int minus(int minuend, int subtraction) throws MinusException {
        if(subtraction>minuend){
            throw new MinusException("not support negative!");
        }

return minuend-subtraction;
    }
}
```

- 第二個減法介面的實現類支援負數返回：

```java
package com.bolingcavalry.minusservice.service.impl;

import com.bolingcavalry.api.exception.MinusException;
import com.bolingcavalry.api.service.MinusService;

/**
 * @author wilzhao
 * @description 支援負數結果的減法服務
 * @email zq2599@gmail.com
 * @time 2018/10/13 14:30
 */
public class MinusServiceSupportNegativeImpl implements MinusService {

/**
     * 減法實現，支援負數
     * @param minuend 減數
     * @param subtraction 被減數
     * @return
     * @throws MinusException
     */
    public int minus(int minuend, int subtraction) throws MinusException {
        return minuend - subtraction;
    }
}
```

### 建立模組customizeservicestarter

- 在工程customizestarter下建立模組customizeservicestarter，這是個java工程，裡面需要依賴spring boot配置相關的庫，由於要在配置中例項化加法和減法服務的實現，因此customizeapi、addservice、minusservice這些模組都要在pom.xml中宣告依賴，如下：

```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">
    <parent>
        <artifactid>customizestarter</artifactid>
        <groupid>com.bolingcavalry</groupid>
        <version>0.0.1-SNAPSHOT</version>
        <relativepath>../</relativepath>
    </parent>
    <artifactid>customizeservicestarter</artifactid>
    <modelversion>4.0.0</modelversion>

<dependencies>
        <dependency>
            <groupid>org.springframework.boot</groupid>
            <artifactid>spring-boot-autoconfigure</artifactid>
            
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupid>com.bolingcavalry</groupid>
            <artifactid>customizeapi</artifactid>
            <version>${project.version}</version>
        </dependency>
        <dependency>
            <groupid>com.bolingcavalry</groupid>
            <artifactid>addservice</artifactid>
            <version>${project.version}</version>
        </dependency>
        <dependency>
            <groupid>com.bolingcavalry</groupid>
            <artifactid>minusservice</artifactid>
            <version>${project.version}</version>
        </dependency>
    </dependencies>
</project>
```

- 建立配置類CustomizeConfiguration，注意getSupportMinusService和getNotSupportMinusService這兩個方法上的註解配置，如果環境變數**com.bolingcavalry.supportnegative存在並且等於true，那麼getSupportMinusService方法就返回了MinusService介面的例項，如果當前環境沒有MinusService介面的例項，就由getNotSupportMinusService方法就返回一個，並且有會在控制檯列印建立了哪種實現：

```java
package com.bolingcavalry.customizeservicestarter;

import com.bolingcavalry.addservice.service.impl.AddServiceImpl;
import com.bolingcavalry.api.service.AddService;
import com.bolingcavalry.api.service.MinusService;
import com.bolingcavalry.minusservice.service.impl.MinusServiceNotSupportNegativeImpl;
import com.bolingcavalry.minusservice.service.impl.MinusServiceSupportNegativeImpl;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * @author wilzhao
 * @description 一句話介紹
 * @email zq2599@gmail.com
 * @time 2018/10/13 14:36
 */
@Configuration
public class CustomizeConfiguration {

@Bean
    public AddService getAddService(){
        System.out.println("create addService");
        return new AddServiceImpl();
    }

/**
     * 如果配置了com.bolingcavalry.supportnegative=true，
     * 就例項化MinusServiceSupportNegativeImpl
     * @return
     */
    @Bean
    @ConditionalOnProperty(prefix="com.bolingcavalry",name = "supportnegative", havingValue = "true")
    public MinusService getSupportMinusService(){
        System.out.println("create minusService support minus");
        return new MinusServiceSupportNegativeImpl();
    }

/**
     * 如果沒有配置com.bolingcavalry.supportnegative=true，
     * 就不會例項化MinusServiceSupportNegativeImpl，
     * 這裡的條件是如果沒有MinusService型別的bean，就在此例項化一個
     * @return
     */
    @Bean
    @ConditionalOnMissingBean(MinusService.class)
    public MinusService getNotSupportMinusService(){
        System.out.println("create minusService not support minus");
        return new MinusServiceNotSupportNegativeImpl();
    }
}
```

- 在src\main\resources目錄下建立一個目錄**META-INF，裡面建立一個檔案spring.factories，內容是如下，表示如果當前應用支援spring boot的自動配置，就會被spring boot框架例項化並註冊到spring容器內：

```properties
org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.bolingcavalry.customizeservicestarter.CustomizeConfiguration
```

### 構建工程customizestarter
- 到這裡customizestarter工程的編碼就結束了，在工程內pom.xml所在目錄（也就是customizestarter內的第一層目錄），執行以下命令可以編譯構建並安裝到本地maven倉庫：

```shell
mvn clean install -Dmaven.test.skip=true -U
```

- 如果編譯構建和安裝都成功了，可以看到類似如下輸出：

```shell
[INFO] Installing C:\temp\201810\07\customizestarter\customizeservicestarter\pom.xml to C:\Users\12167\.m2\repositor
y\com\bolingcavalry\customizeservicestarter\0.0.1-SNAPSHOT\customizeservicestarter-0.0.1-SNAPSHOT.pom
[INFO] ------------------------------------------------------------------------
[INFO] Reactor Summary:
[INFO]
[INFO] customizestarter ................................... SUCCESS [  0.748 s]
[INFO] customizeapi ....................................... SUCCESS [  3.266 s]
[INFO] addservice ......................................... SUCCESS [  0.427 s]
[INFO] minusservice ....................................... SUCCESS [  0.344 s]
[INFO] customizeservicestarter ............................ SUCCESS [  0.495 s]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 5.954 s
[INFO] Finished at: 2018-10-14T00:17:46+08:00
[INFO] Final Memory: 29M/221M
[INFO] ------------------------------------------------------------------------
```

- 現在starter已經準備好了，我們做一個spring boot的web應用來驗證一下；

### 建立工程customizestartertestdemo

- 工程customizestartertestdemo是個簡單的spring boot應用，pom.xml如下，可見並無特別之處，只是多了customizeservicestarter的依賴：

```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>

<groupid>com.bolingcavalry</groupid>
    <artifactid>customizestartertestdemo</artifactid>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

<name>customizestartertestdemo</name>
    <description>Demo project for Spring Boot</description>

<parent>
        <groupid>org.springframework.boot</groupid>
        <artifactid>spring-boot-starter-parent</artifactid>
        <version>1.5.9.RELEASE</version>
        <relativepath></relativepath> 
    </parent>

<dependencies>
        <dependency>
            <groupid>org.springframework.boot</groupid>
            <artifactid>spring-boot-starter-web</artifactid>
        </dependency>

<dependency>
            <groupid>org.springframework.boot</groupid>
            <artifactid>spring-boot-starter-test</artifactid>
            <scope>test</scope>
        </dependency>

<dependency>
            <groupid>com.bolingcavalry</groupid>
            <artifactid>customizeservicestarter</artifactid>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>
    </dependencies>

<build>
        <plugins>
            <plugin>
                <groupid>org.springframework.boot</groupid>
                <artifactid>spring-boot-maven-plugin</artifactid>
            </plugin>
        </plugins>
    </build>
</project>
```

- 開發一個Controller類，用於呼叫AddService和MinusService對應的服務：

```java
package com.bolingcavalry.customizestartertestdemo.controller;

import com.bolingcavalry.api.exception.MinusException;
import com.bolingcavalry.api.service.AddService;
import com.bolingcavalry.api.service.MinusService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

/**
 * @author wilzhao
 * @description 呼叫加法和減法服務的測試類
 * @email zq2599@gmail.com
 * @time 2018/10/13 16:00
 */
@RestController
public class CalculateController {

@Autowired
    private AddService addService;

@Autowired
    private MinusService minusService;

@RequestMapping(value = "/add/{added}/{add}", method = RequestMethod.GET)
    public String add(@PathVariable("added") int added, @PathVariable("add") int add){
        return added + " 加 " + add + " 等於 : " + addService.add(added, add);
    }

@RequestMapping(value = "/minus/{minuend}/{subtraction}", method = RequestMethod.GET)
    public String minus(@PathVariable("minuend") int minuend, @PathVariable("subtraction") int subtraction) throws MinusException {
        return minuend + " 減 " + subtraction + " 等於 : " + minusService.minus(minuend, subtraction);
    }
}
```

- 啟動類如下:

```java
package com.bolingcavalry.customizestartertestdemo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class CustomizestartertestdemoApplication {

public static void main(String[] args) {
        SpringApplication.run(CustomizestartertestdemoApplication.class, args);
    }
}
```

### 構建工程customizestartertestdemo

- 在customizestartertestdemo工程的pom.xml所在目錄下執行以下命令即可構建成功：

```shell
mvn clean package -Dmaven.test.skip=true
```

- 命令執行成功後，即可在target目錄下見到customizestartertestdemo-0.0.1-SNAPSHOT.jar檔案，如下圖：

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

- 現在編碼和構建已經全部完成，我們可以來驗證了；

### 驗證支援負數的減法服務
- 在customizeapi模組的CustomizeConfiguration類中，有如下方法和註解：

```java
@Bean
    @ConditionalOnProperty(prefix="com.bolingcavalry",name = "supportnegative", havingValue = "true")
    public MinusService getSupportMinusService(){
        System.out.println("create minusService support minus");
        return new MinusServiceSupportNegativeImpl();
    }
```
- 從上述程式碼可見，只要環境變數"com.bolingcavalry.supportnegative"等於true，註冊到spring容器的就是MinusServiceSupportNegativeImpl類的例項；

- customizestartertestdemo-0.0.1-SNAPSHOT.jar檔案所在目錄下，執行以下命令啟動應用：

```shell
java -Dcom.bolingcavalry.supportnegative=true -jar customizestartertestdemo-0.0.1-SNAPSHOT.jar
```

- 在控制檯中可以看見**create minusService support minus，表示註冊到spring容器的是MinusServiceSupportNegativeImpl類的例項，如下所示：
```shell
2018-10-14 12:04:54.233  INFO 16588 --- [ost-startStop-1] o.s.b.w.servlet.FilterRegistrationBean   : Mapping filter: 'requestContextFilter' to: [/*]
create addService
create minusService support minus
2018-10-14 12:04:54.845  INFO 16588 --- [           main] s.w.s.m.m.a.RequestMappingHandlerAdapter : Looking for @ControllerAdvice: org.springframework.boot.context.embedded.AnnotationConfigEmbeddedWebApplicationContext@443b7951: startup date [Sun Oct 14 12:04:50 CST 2018]; root of context hierarchy
```

- 在瀏覽器訪問http://localhost:8080/minus/1/2，可見返回計算結果為負數：

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

### 驗證不支援負數的減法服務
- 前面已經分析過，CustomizeConfiguration類的getNotSupportMinusService方法執行的條件是環境變數"com.bolingcavalry.supportnegative"等於true，如果沒有這個環境變數，getNotSupportMinusService方法就不會執行，spring容器中就沒有MinusService介面的例項；

- CustomizeConfiguration類中，有如下方法和註解：

```java
    @Bean
    @ConditionalOnMissingBean(MinusService.class)
    public MinusService getNotSupportMinusService(){
        System.out.println("create minusService not support minus");
        return new MinusServiceNotSupportNegativeImpl();
    }
```
- 從上述程式碼可見，spring容器中如果沒有MinusService介面的例項，getNotSupportMinusService方法就會被執行，在spring容器中註冊MinusServiceNotSupportNegativeImpl例項；

- 因此接下來的我們啟動的應用如果沒有環境變數"com.bolingcavalry.supportnegative"，就可以使用到不支援負數的減法服務了；
- 停掉之前啟動的應用，然後執行以下命令啟動應用：

```shell
java -jar customizestartertestdemo-0.0.1-SNAPSHOT.jar
```

- 在控制檯中可以看見**create minusService not support minus，表示註冊到spring容器的是MinusServiceNotSupportNegativeImpl類的例項，如下所示：

```shell
2018-10-14 12:15:05.994  INFO 16608 --- [ost-startStop-1] o.s.b.w.servlet.FilterRegistrationBean   : Mapping filter: 'requestContextFilter' to: [/*]
create addService
create minusService not support minus
2018-10-14 12:15:06.592  INFO 16608 --- [           main] s.w.s.m.m.a.RequestMappingHandlerAdapter : Looking for @ControllerAdvice: org.springframework.boot.context.embedded.AnnotationConfigEmbeddedWebApplicationContext@443b7951: startup date [Sun Oct 14 12:15:02 CST 2018]; root of context hierarchy
```

- 在瀏覽器訪問http://localhost:8080/minus/1/2，由於MinusServiceNotSupportNegativeImpl例項不支援負數減法，會直接丟擲異常，如下圖：

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

- 至此，自定義spring boot starter的編碼實戰就完成了，希望本篇可以給您用來作參考，助您做出自己所需的starter；

- 下一篇我們一起去看看spring boot的原始碼，對這個高效的擴充套件功能做更深入的瞭解；

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

自定義spring boot starter三部曲之二：實戰開發

相關文章

最新文章