SpringBoot應用篇（一）：自定義starter

一、碼前必備知識

1、SpringBoot starter機制

　　SpringBoot中的starter是一種非常重要的機制，能夠拋棄以前繁雜的配置，將其統一整合進starter，應用者只需要在maven中引入starter依賴，SpringBoot就能自動掃描到要載入的資訊並啟動相應的預設配置。starter讓我們擺脫了各種依賴庫的處理，需要配置各種資訊的困擾。SpringBoot會自動通過classpath路徑下的類發現需要的Bean，並註冊進IOC容器。SpringBoot提供了針對日常企業應用研發各種場景的spring-boot-starter依賴模組。所有這些依賴模組都遵循著約定成俗的預設配置，並允許我們調整這些配置，即遵循“約定大於配置”的理念。

2、為什麼要自定義starter

　　在我們的日常開發工作中，經常會有一些獨立於業務之外的配置模組，我們經常將其放到一個特定的包下，然後如果另一個工程需要複用這塊功能的時候，需要將程式碼硬拷貝到另一個工程，重新整合一遍，麻煩至極。如果我們將這些可獨立於業務程式碼之外的功配置模組封裝成一個個starter，複用的時候只需要將其在pom中引用依賴即可，SpringBoot為我們完成自動裝配，簡直不要太爽。

3、自定義starter的案例

　　以下案例由筆者工作中遇到的部分場景

　　▲ 動態資料來源。

　　▲ 登入模組。

　　▲ 基於AOP技術實現日誌切面。

　　。。。。。。

4、自定義starter的命名規則

　　SpringBoot提供的starter以spring-boot-starter-xxx的方式命名的。官方建議自定義的starter使用xxx-spring-boot-starter命名規則。以區分SpringBoot生態提供的starter。

二、starter的實現方法

1、新建一個工程

　　命名為demo-spring-boot-starter

　　下圖為工程目錄結構

　　

2、pom依賴

<?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>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.4.RELEASE</version>
    </parent>
    <groupId>com.demo</groupId>
    <artifactId>demo-spring-boot-starter</artifactId>
    <version>0.0.1-RELEASE</version>
    <name>demo-spring-boot-starter</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
    </dependencies>
</project>

 

 

3、定義一個實體類對映配置資訊

 @ConfigurationProperties(prefix = "demo") 它可以把相同字首的配置資訊通過配置項名稱對映成實體類，比如我們這裡指定 prefix = "demo" 這樣，我們就能將以demo為字首的配置項拿到了。
ps：其實這個註解很強大，它不但能對映簡單的key-value的形式。還可以對映為List，Map等資料結構。

package com.demo.starter.properties;

import org.springframework.boot.context.properties.ConfigurationProperties;

/**
 * 描述：配置資訊 實體
 *
 * @Author shf
 * @Date 2019/5/7 22:08
 * @Version V1.0
 **/
@ConfigurationProperties(prefix = "demo")
public class DemoProperties {
    private String sayWhat;
    private String toWho;

    public String getSayWhat() {
        return sayWhat;
    }

    public void setSayWhat(String sayWhat) {
        this.sayWhat = sayWhat;
    }

    public String getToWho() {
        return toWho;
    }

    public void setToWho(String toWho) {
        this.toWho = toWho;
    }
}

 

 

4、定義一個Service

package com.demo.starter.service;

/**
 * 描述：隨便定義一個Service
 *
 * @Author shf
 * @Date 2019/5/7 21:59
 * @Version V1.0
 **/
public class DemoService {
    public String sayWhat;
    public String toWho;
    public DemoService(String sayWhat, String toWho){
        this.sayWhat = sayWhat;
        this.toWho = toWho;
    }
    public String say(){
        return this.sayWhat + "!  " + toWho;
    }
}

 

 

5，定義一個配置類

這裡，我們將DemoService類定義為一個Bean，交給Ioc容器。

▲  @Configuration 註解就不多說了。

▲  @EnableConfigurationProperties 註解。該註解是用來開啟對3步驟中 @ConfigurationProperties 註解配置Bean的支援。也就是@EnableConfigurationProperties註解告訴Spring Boot 能支援@ConfigurationProperties。

當然了，也可以在 @ConfigurationProperties 註解的類上新增 @Configuration 或者  @Component 註解

▲  @ConditionalOnProperty 註解控制 @Configuration 是否生效。簡單來說也就是我們可以通過在yml配置檔案中控制 @Configuration 註解的配置類是否生效。

 

package com.demo.starter.config;

import com.demo.starter.properties.DemoProperties;
import com.demo.starter.service.DemoService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * 描述：配置類
 *
 * @Author shf
 * @Date 2019/5/7 21:50
 * @Version V1.0
 **/
@Configuration
@EnableConfigurationProperties(DemoProperties.class)
@ConditionalOnProperty(
        prefix = "demo",
        name = "isopen",
        havingValue = "true"
)
public class DemoConfig {
    @Autowired
    private DemoProperties demoProperties;

    @Bean(name = "demo")
    public DemoService demoService(){
        return new DemoService(demoProperties.getSayWhat(), demoProperties.getToWho());
    }
}

 

 6、最重要的來了

如圖，新建META-INF資料夾，然後建立spring.factories檔案，

 在該檔案中加入如下配置，該配置指定上步驟中定義的配置類為自動裝配的配置。（筆者努力最近把自動裝配的部落格寫出來）

#-------starter自動裝配---------
org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.demo.starter.config.DemoConfig

 7、測試

在demo-spring-boot-starter工程中執行mvn clean install 一個自定義的starter新鮮出爐。

新建測試工程

引入starter依賴

        <dependency>
            <groupId>com.demo</groupId>
            <artifactId>demo-spring-boot-starter</artifactId>
            <version>0.0.1-RELEASE</version>
        </dependency>

 

配置檔案

demo.isopen=true
demo.say-what=hello
demo.to-who=shf

 

然後寫個測試類。

package com.example.test.controller;

import com.demo.starter.service.DemoService;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;

/**
 * 描述：
 *
 * @Author shf
 * @Description TODO
 * @Date 2019/5/13 15:52
 * @Version V1.0
 **/
@RestController
public class DemoController {
    @Resource(name = "demo")
    private DemoService demoService;

    @GetMapping("/say")
    public String sayWhat(){
        return demoService.say();
    }
    
}

 

 瀏覽器