_____            _             ____              _   
  / ____|          (_)           |  _ \            | |  
 | (___  _ __  _ __ _ _ __   __ _| |_) | ___   ___ | |_ 
  \___ \| '_ \| '__| | '_ \ / _` |  _ < / _ \ / _ \| __|
  ____) | |_) | |  | | | | | (_| | |_) | (_) | (_) | |_ 
 |_____/| .__/|_|  |_|_| |_|\__, |____/ \___/ \___/ \__|
        | |                  __/ |                      
        |_|                 |___/                       

為什么要用Starter?

現(xiàn)在我們就來回憶一下，在還沒有Spring-boot框架的時候，我們使用Spring 開發(fā)項目，如果需要某一個框架，例如mybatis，我們的步驟一般都是：

到maven倉庫去找需要引入的mybatis jar包，選取合適的版本（易發(fā)生沖突）

到maven倉庫去找mybatis-spring整合的jar包，選取合適的版本（易發(fā)生沖突）

在spring的applicationContext.xml文件中配置dataSource和mybatis相關(guān)信息

假如所有工作都到位，一般可以一氣呵成；但很多時候都會花一堆時間解決jar 沖突，配置項缺失，導(dǎo)致怎么都啟動不起來等等，各種問題。

所以在2012 年 10 月，一個叫 Mike Youngstrom 的人在 Spring Jira 中創(chuàng)建了一個功能請求，要求在 Spring Framework 中支持無容器 Web 應(yīng)用程序體系結(jié)構(gòu)，提出了在主容器引導(dǎo) Spring 容器內(nèi)配置 Web 容器服務(wù)；這件事情對 SpringBoot 的誕生應(yīng)該說是起到了一定的推動作用。

所以SpringBoot 設(shè)計的目標(biāo)就是簡化繁瑣配置，快速建立Spring 應(yīng)用。

然后在開發(fā)Spring-boot 應(yīng)用的是時候， 經(jīng)常可以看到我們的pom 文件中引入了spring-boot-starter-web、spring-boot-starter-data-redis、mybatis-spring-boot-starter 這樣的依賴，然后幾乎不用任何配置就可以使用這些依賴的功能，真正的感受到了開箱即用的爽。

下面我們就先來嘗試自己開發(fā)一個Starter。

1. 命名規(guī)范

在使用spring-boot-starter，會發(fā)現(xiàn)，有的項目名稱是 XX-spring-boot-starter，有的是spring-boot-starter-XX，這個項目的名稱有什么講究呢？從springboot官方文檔摘錄:

這段話的大概意思就是，麻煩大家遵守這個命名規(guī)范：

Srping官方命名格式為：spring-boot-starter-{name}

非Spring官方建議命名格式：{name}-spring-boot-starter

1. 開發(fā)示例

下面我就以記錄日志的一個組件為示例來講述開發(fā)一個starter 的過程。

1. 新建工程

首先新建一個maven 工程,名稱定義為
jd-log-spring-boot-starter

1. Pom 引入依賴

<?xml versinotallow="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.5.13</version>
    <relativePath/> <!-- lookup parent from repository -->
  </parent>
  <groupId>com.jd</groupId>
  <artifactId>jd-log-spring-boot-starter</artifactId>
  <version>1.0-SNAPSHOT</version>
  <name>jd-log-spring-boot-starter</name>
  <url>http://www.example.com</url>
  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <maven.compiler.source>1.8</maven.compiler.source>
    <maven.compiler.target>1.8</maven.compiler.target>
  </properties>


  <dependencies>
    <!-- 提供了自動裝配功能-->
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-autoconfigure</artifactId>
    </dependency>
    <!-- 在編譯時會自動收集配置類的條件，寫到一個META-INF/spring-autoconfigure-metadata.json中-->
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-configuration-processor</artifactId>
    </dependency>
    <!--記錄日志會用到切面，所以需要引入-->
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-aop</artifactId>
    </dependency>
    <dependency>
      <groupId>org.projectlombok</groupId>
      <artifactId>lombok</artifactId>
    </dependency>
  </dependencies>
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-source-plugin</artifactId>
        <version>2.2.1</version>
        <executions>
          <execution>
            <id>attach-sources</id>
            <goals>
              <goal>jar-no-fork</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>
</project>

這邊稍微解釋一下這幾個依賴:

spring-boot-autoconfigure :提供自動化裝配功能，是為了Spring Boot 應(yīng)用在各個模塊提供自動化配置的作用；即加入對應(yīng) pom，就會有對應(yīng)配置其作用；所以我們想要自動裝配功能，就需要引入這個依賴。

spring-boot-configuration-processor：將自定義的配置類生成配置元數(shù)據(jù)，所以在引用自定義STARTER的工程的YML文件中，給自定義配置初始化時，會有屬性名的提示；確保在使用@ConfigurationProperties注解時，可以優(yōu)雅的讀取配置信息，引入該依賴后，IDEA不會出現(xiàn)“spring boot configuration annotation processor not configured”的錯誤；編譯之后會在META-INF 下生成一個
spring-configuration-metadata.json 文件，大概內(nèi)容就是定義的配置的元數(shù)據(jù)；效果如下截圖。

spring-boot-starter-aop ：這個就不用解釋了，因為示例是記錄日志，我們用到切面的功能，所以需要引入。

1. 定義屬性配置

/**
 * @author kongxiangdong2
 * @Title: LogProperties
 * @ProjectName jd-log-spring-boot-starter
 * @Description: TODO
 * @date
@ConfigurationProperties(prefix = "jd")
@Data
public class LogProperties {


    /**
     * 是否開啟日志
     */
    private boolean enable;


    /**
     * 平臺：不同服務(wù)使用的區(qū)分，默認(rèn)取 spring.application.name
     */
    @Value("${spring.application.name:#{null}}")
    private String platform;

@ConfigurationProperties：該注解和@Value 注解作用類似，用于獲取配置文件中屬性定義并綁定到Java Bean 或者屬性中；換句話來說就是將配置文件中的配置封裝到JAVA 實體對象，方便使用和管理。

這邊我們定義兩個屬性，一個是是否開啟日志的開關(guān)，一個是標(biāo)識平臺的名稱。

1. 定義自動配置類

/**
 * @author kongxiangdong2
 * @Title: JdLogAutoConfiguration
 * @ProjectName jd-log-spring-boot-starter
 * @Description: TODO
 * @date 2022/9/110:06
 */
@Configuration
@ComponentScan("com.jd")
@ConditionalOnProperty(prefix = "jd",name = "enable",havingValue = "true",matchIfMissing = false)
@EnableConfigurationProperties({LogProperties.class})
public class JdLogAutoConfiguration {


   //
}

這個類最關(guān)鍵了，它是整個starter 最重要的類，它就是將配置自動裝載進(jìn)spring-boot的；具體是怎么實現(xiàn)的，下面在講解原理的時候會再詳細(xì)說說，這里先完成示例。

@Configuration ：這個就是聲明這個類是一個配置類

@ConditionalOnProperty：作用是可以指定prefix.name 配置文件中的屬性值來判定configuration是否被注入到Spring,就拿上面代碼的來說，會根據(jù)配置文件中是否配置jd.enable 來判斷是否需要加載JdLogAutoConfiguration 類，如果配置文件中不存在或者配置的是等于false 都不會進(jìn)行加載，如果配置成true 則會加載；指定了havingValue，要把配置項的值與havingValue對比，一致則加載Bean;配置文件缺少配置，但配置了matchIfMissing = true，加載Bean，否則不加載。

在這里稍微擴(kuò)展一下經(jīng)常使用的Condition

@
EnableConfigurationProperties使@ConfigurationProperties 注解的類生效。

1. 配置EnableAutoConfiguration

在resources/META-INF/ 目錄新建spring.factories 文件，配置內(nèi)容如下；

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.jd.JdLogAutoConfiguration

好了，至此自定義Starter 大體框架已經(jīng)好了，下面就是我們記錄日志的功能。

1. 業(yè)務(wù)功能實現(xiàn)

首先我們先定義一個注解Jdlog

/**
 * @author kongxiangdong2
 * @Title: Jdlog
 * @ProjectName jd-log-spring-boot-starter
 * @Description: TODO
 * @date 2022/9/110:04
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Jdlog {
}

定義切面執(zhí)行邏輯，這邊就簡單的打印一下配置文件的屬性值+目標(biāo)執(zhí)行方法+耗時。

import com.jd.annotation.Jdlog;
import com.jd.config.LogProperties;
import lombok.AllArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.stereotype.Component;


/**
 * @author kongxiangdong2
 * @Title: LogAspectjProcess
 * @ProjectName jd-log-spring-boot-starter
 * @Description: TODO
 * @date
@Aspect
@Component
@Slf4j
@AllArgsConstructor
public class LogAspectjProcess {


    LogProperties logProperties;


    /**
     * 定義切點
     */
    @Pointcut("@annotation(com.jd.annotation.Jdlog)")
    public void pointCut(){}


    /**
     * 環(huán)繞通知
     *
     * @param thisJoinPoint
     * @param jdlog
     * @return
    @Around("pointCut() && @annotation(jdlog)")
    public Object around(ProceedingJoinPoint thisJoinPoint, Jdlog jdlog){


        //執(zhí)行方法名稱
        String taskName = thisJoinPoint.getSignature()
                .toString().substring(
                        thisJoinPoint.getSignature()
                                .toString().indexOf(" "),
                        thisJoinPoint.getSignature().toString().indexOf("("));
        taskName = taskName.trim();
        long time = System.currentTimeMillis();
        Object result = null;
        try {
            result = thisJoinPoint.proceed();
        } catch (Throwable throwable) {
            throwable.printStackTrace();
        }
        log.info("{} -- method:{} run :{} ms",logProperties.getPlatform(), taskName,
                (System.currentTimeMillis() - time));
        return result;


    

整體項目結(jié)構(gòu)就是這樣子

好了，現(xiàn)在就可以打包編譯安裝

1. 測試使用

然后就可以在其他項目中引入使用了；下面以一個簡單的spring-boot web 項目做個測試，在pom 中引入下面的依賴配置。

  <dependency>
      <groupId>com.jd</groupId>
      <artifactId>jd-log-spring-boot-starter</artifactId>
      <version>1.0-SNAPSHOT</version>
    </dependency>

增加一個http 訪問的方法，標(biāo)注上@Jdlog 注解

application.yaml 文件中配置

jd:
  enable: true
  platform: "測試項目"

啟動測試，訪問地址http://localhost:8080/test/method1，控制臺打印如下：

咋樣，自定義的Starter是不是特別的簡單啊，快動手試試吧！

上面我們講的都是怎么去開發(fā)一個starter,但是到底為什么要這樣，spring-boot 是如何去實現(xiàn)的？是不是還不知道？那下面我們就來說說；

1. 原理講解

我們上面已經(jīng)看到一個starter,只需要引入到pom 文件中，再配置一下(其實都可以不配置)jd.enable=true，就可以直接使用記錄日志的功能了，Spring-boot 是怎么做到的？

在開始的時候說過，Spring-boot 的好處就是可以自動裝配。那下面我就來說說自動裝配的原理。

相比于傳統(tǒng)Spring 應(yīng)用，我們搭建一個SpringBoot 應(yīng)用，我們只需要引入一個注解（前提：引入springBoot y依賴）@SpringBootApplication，就可以直接運行；所以我們就從這個注解開始入手，看看這個注解到底做了寫什么？

SpringBootApplication 注解

點開@SpringBootApplication注解可以看到包含了@SpringBootConfiguration,@EnableAutoConfiguration,@ComponentScan三個注解。

前面的四個注解就不用過多敘述了，是定義注解最基本的，關(guān)鍵在于后面的三個注解:@SpringBootConfiguration，@EnableAutoConfiguration，@ComponentScan,其實也就是說在啟動類上如果不使用@SpringBootApplication 這個復(fù)合注解，直接使用者三個注解一樣可以達(dá)到相同的效果。

@SpringBootConfiguration 注解：我們再次點進(jìn)去看這個注解，其實它就是一個@Configuration 注解。

@ComponentScan 注解

@ComponentScan 注解：配置包掃描定義的掃描路徑，把符合掃描規(guī)則的類裝配到spring容器

@EnableAutoConfiguration 注解

@EnableAutoConfiguration 打開自動裝配(自動配置著重來看該注解)

我們再次點擊@EnableAutoConfiguration進(jìn)入查看，它是一個由 @AutoConfigurationPackage 和 @Import 注解組成的復(fù)合注解；

首先我們先來看@Import 這個注解，這個是比較關(guān)鍵的一個注解；

在說這個注解之前我們先舉個例子，假如我們有一個類Demo,它是一個不在啟動配置類目錄之下的，也就意味著它不會被掃描到，Spring 也無法感知到它的存在，那么如果需要能將它被掃描到，是不是我們可以通過加@Import 注解來導(dǎo)入Demo 類，類似如下代碼

@Configuration
@Import(Demo.class)
public class MyConfiguration {
}

所以，我們可以知道@Import 注解其實就是為了去導(dǎo)入一個類。所以這里@Import({
AutoConfigurationImportSelector.class}) 就是為了導(dǎo)入AutoConfigurationImportSelector 類，那我們繼續(xù)來看這個類，AutoConfigurationImportSelector實現(xiàn)的是DeferredImportSelector接口，這是一個延遲導(dǎo)入的類；再細(xì)看會有一個方法比較顯眼，根據(jù)注解元數(shù)據(jù)來選擇導(dǎo)入組件，當(dāng)注解元數(shù)據(jù)空，直接返回一個空數(shù)組；否則就調(diào)用getAutoConfigurationEntry ，方法中會使用AutoConfigurationEntry的getConfigurations(),configurations是一個List<String>,那么我們看下AutoConfigurationEntry是怎么生成的。

進(jìn)入到getAutoConfigurationEntry 方法中可以看到主要是getCandidateConfigurations 來獲取候選的 Bean，并將其存為一個集合；后續(xù)的方法都是在去重，校驗等一系列的操作。

我們繼續(xù)往
getCandidateConfigurations 方法里看，最終通過SpringFactoriesLoader.loadFactoryNames來獲取最終的configurations，并且可以通過斷言發(fā)現(xiàn)會使用到META-INF/spring.factories文件，那么我們再進(jìn)入SpringFactoriesLoader.loadFactoryNames()中來看下最終的實現(xiàn)。

SpringFactoriesLoader.loadFactoryNames()方法會讀取META-INF/spring.factories文件下的內(nèi)容到Map中，再結(jié)合傳入的factoryType=EnableAutoConfiguration.class,因此會拿到 org.springframework.boot.autoconfigure.EnableAutoConfiguration為key對應(yīng)的各個XXAutoConfiguration的值，然后springboot在結(jié)合各個starter中的代碼完成對于XXAutoConfiguration中的Bean的加載動作。

這邊再擴(kuò)展一下這個內(nèi)容，通過 SpringFactoriesLoader 來讀取配置文件 spring.factories 中的配置文件的這種方式是一種 SPI 的思想。

@AutoConfigurationPackage 注解

進(jìn)入這個注解看，其實它就是導(dǎo)入了Registrar 這個類

再進(jìn)入這個類查看，它其實是一個內(nèi)部類，看代碼的大概意思就是讀取到我們在最外層的 @SpringBootApplication 注解中配置的掃描路徑（沒有配置則默認(rèn)當(dāng)前包下），然后把掃描路徑下面的Bean注冊到容器中；

總結(jié)

好了，現(xiàn)在我們大概來理一下整個自動裝配的流程：

1. 啟動類中通過使用@SpringBootApplication實現(xiàn)自動裝配的功能；
2. 實際注解@SpringBootApplication是借助注解@EnableAutoConfiguration的功能。
3. 在注解@EnableAutoConfiguration中又有兩個注解，@AutoConfigurationPackage，@EnableAutoConfiguration。
4. 通過@AutoConfigurationPackage實現(xiàn)對于當(dāng)前項目中Bean的進(jìn)行加載；
5. @EnableAutoConfiguration通過@Import({AutoConfigurationImportSelector.class})實現(xiàn)對于Pom引入的start中的XXAutoConfiguration的加載；
6. @AutoConfigurationImportSelector類中通過SpringFactoriesLoader讀取 META-INF/spring.factories中key為org.springframework.boot.autoconfigure.EnableAutoConfiguration對應(yīng)的各個XXAutoConfiguration的值，然后springboot在結(jié)合各個start中的代碼完成對于XXAutoConfiguration中的Bean的加載動作；

到這里是不是已經(jīng)可以很了然對我們之前開發(fā)starter中的定義了啊，趕緊試試吧