关于springboot:手把手带你开发starter点对点带你讲解原理

京东物流 孔祥东

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

1. 为什么要用Starter?

• 当初咱们就来回顾一下，在还没有Spring-boot框架的时候，咱们应用Spring 开发我的项目，如果须要某一个框架，例如mybatis，咱们的步骤个别都是：

<!---->

• 到maven仓库去找须要引入的mybatis jar包，选取适合的版本（易发生冲突）

<!---->

• 到maven仓库去找mybatis-spring整合的jar包，选取适合的版本（易发生冲突）

<!---->

• 在spring的applicationContext.xml文件中配置dataSource和mybatis相干信息

<!---->

-

<!---->

• 如果所有工作都到位，个别能够零打碎敲；但很多时候都会花一堆工夫解决jar 抵触，配置项缺失，导致怎么都启动不起来等等，各种问题。

所以在2012 年 10 月，一个叫 Mike Youngstrom 的人在 Spring Jira 中创立了一个性能申请，要求在 Spring Framework 中反对无容器 Web 应用程序体系结构，提出了在主容器疏导 Spring 容器内配置 Web 容器服务；这件事件对 SpringBoot 的诞生应该说是起到了肯定的推动作用。

所以SpringBoot 设计的指标就是简化繁琐配置，疾速建设Spring 利用。

• 而后在开发Spring-boot 利用的是时候， 常常能够看到咱们的pom 文件中引入了spring-boot-starter-web、spring-boot-starter-data-redis、mybatis-spring-boot-starter 这样的依赖，而后简直不必任何配置就能够应用这些依赖的性能，真正的感触到了开箱即用的爽。

<!---->

• 上面咱们就先来尝试本人开发一个Starter。

2. 命名标准

在应用spring-boot-starter，会发现，有的项目名称是 XX-spring-boot-starter，有的是spring-boot-starter-XX，这个我的项目的名称有什么考究呢？从springboot官网文档摘录:

![]()

这段话的大略意思就是，麻烦大家恪守这个命名标准：

Srping官网命名格局为：spring-boot-starter-{name}

非Spring官网倡议命名格局：{name}-spring-boot-starter

3. 开发示例

上面我就以记录日志的一个组件为示例来讲述开发一个starter 的过程。

3.1 新建工程

首先新建一个maven 工程,名称定义为jd-log-spring-boot-starter

3.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.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 利用在各个模块提供自动化配置的作用；即退出对应 pom，就会有对应配置其作用；所以咱们想要主动拆卸性能，就须要引入这个依赖。

spring-boot-configuration-processor：将自定义的配置类生成配置元数据，所以在援用自定义STARTER的工程的YML文件中，给自定义配置初始化时，会有属性名的提醒；确保在应用@ConfigurationProperties注解时，能够优雅的读取配置信息，引入该依赖后，IDEA不会呈现“spring boot configuration annotation processor not configured”的谬误；编译之后会在META-INF 下生成一个spring-configuration-metadata.json 文件，大略内容就是定义的配置的元数据；成果如下截图。

spring-boot-starter-aop ：这个就不必解释了，因为示例是记录日志，咱们用到切面的性能，所以须要引入。

3.3 定义属性配置

/** * @author kongxiangdong2 * @Title: LogProperties * @ProjectName jd-log-spring-boot-starter * @Description: TODO * @date 2022/9/110:04 */@ConfigurationProperties(prefix = "jd")@Datapublic class LogProperties {    /**     * 是否开启日志     */    private boolean enable;    /**     * 平台：不同服务应用的辨别，默认取 spring.application.name     */    @Value("${spring.application.name:#{null}}")    private String platform;

@ConfigurationProperties：该注解和@Value 注解作用相似，用于获取配置文件中属性定义并绑定到Java Bean 或者属性中；换句话来说就是将配置文件中的配置封装到JAVA 实体对象，方便使用和治理。

这边咱们定义两个属性，一个是是否开启日志的开关，一个是标识平台的名称。

3.4 定义主动配置类

/** * @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 {   //}

这个类最要害了，它是整个starter 最重要的类，它就是将配置主动装载进spring-boot的；具体是怎么实现的，上面在解说原理的时候会再具体说说，这里先实现示例。

@Configuration ：这个就是申明这个类是一个配置类

@ConditionalOnProperty：作用是能够指定prefix.name 配置文件中的属性值来断定configuration是否被注入到Spring,就拿下面代码的来说，会依据配置文件中是否配置jd.enable 来判断是否须要加载JdLogAutoConfiguration 类，如果配置文件中不存在或者配置的是等于false 都不会进行加载，如果配置成true 则会加载；指定了havingValue，要把配置项的值与havingValue比照，统一则加载Bean;配置文件短少配置，但配置了matchIfMissing = true，加载Bean，否则不加载。

在这里略微扩大一下常常应用的Condition

@EnableConfigurationProperties使@ConfigurationProperties 注解的类失效。

3.5 配置EnableAutoConfiguration

在resources/META-INF/ 目录新建spring.factories 文件，配置内容如下；

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

好了，至此自定义Starter 大体框架曾经好了，上面就是咱们记录日志的性能。

3.6 业务性能实现

首先咱们先定义一个注解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 {}

定义切面执行逻辑，这边就简略的打印一下配置文件的属性值+指标执行办法+耗时。

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 2022/9/111:12 */@Aspect@Component@Slf4j@AllArgsConstructorpublic class LogAspectjProcess {    LogProperties logProperties;    /**     * 定义切点     */    @Pointcut("@annotation(com.jd.annotation.Jdlog)")    public void pointCut(){}    /**     * 盘绕告诉     *     * @param thisJoinPoint     * @param jdlog     * @return     */    @Around("pointCut() && @annotation(jdlog)")    public Object around(ProceedingJoinPoint thisJoinPoint, Jdlog jdlog){        //执行办法名称        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;    

整体我的项目构造就是这样子

好了，当初就能够打包编译装置

3.7 测试应用

而后就能够在其余我的项目中引入应用了；上面以一个简略的spring-boot web 我的项目做个测试，在pom 中引入上面的依赖配置。

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

减少一个http 拜访的办法，标注上@Jdlog 注解

application.yaml 文件中配置

jd:  enable: true  platform: "测试项目"

启动测试，拜访地址http://localhost:8080/test/me...，控制台打印如下：

咋样，自定义的Starter是不是特地的简略啊，快入手试试吧！

下面咱们讲的都是怎么去开发一个starter,然而到底为什么要这样，spring-boot 是如何去实现的？是不是还不晓得？那上面咱们就来说说；

代码示例地址：https://coding.jd.com/kongxia...

4. 原理解说

咱们下面曾经看到一个starter,只须要引入到pom 文件中，再配置一下(其实都能够不配置)jd.enable=true，就能够间接应用记录日志的性能了，Spring-boot 是怎么做到的？

在开始的时候说过，Spring-boot 的益处就是能够主动拆卸。那上面我就来说说主动拆卸的原理。

相比于传统Spring 利用，咱们搭建一个SpringBoot 利用，咱们只须要引入一个注解（前提：引入springBoot y依赖）@SpringBootApplication，就能够间接运行；所以咱们就从这个注解开始动手，看看这个注解到底做了写什么？

SpringBootApplication 注解

点开@SpringBootApplication注解能够看到蕴含了@SpringBootConfiguration,@EnableAutoConfiguration,@ComponentScan三个注解。

后面的四个注解就不必过多叙述了，是定义注解最根本的，关键在于前面的三个注解:@SpringBootConfiguration，@EnableAutoConfiguration，@ComponentScan,其实也就是说在启动类上如果不应用@SpringBootApplication 这个复合注解，间接使用者三个注解一样能够达到雷同的成果。

@SpringBootConfiguration 注解：咱们再次点进去看这个注解，其实它就是一个@Configuration 注解。

@ComponentScan 注解

@ComponentScan 注解：配置包扫描定义的扫描门路，把合乎扫描规定的类拆卸到spring容器

@EnableAutoConfiguration 注解

@EnableAutoConfiguration 关上主动拆卸(主动配置着重来看该注解)

咱们再次点击@EnableAutoConfiguration进入查看，它是一个由 @AutoConfigurationPackage 和 @Import 注解组成的复合注解；

首先咱们先来看@Import 这个注解，这个是比拟要害的一个注解；

在说这个注解之前咱们先举个例子，如果咱们有一个类Demo,它是一个不在启动配置类目录之下的，也就意味着它不会被扫描到，Spring 也无奈感知到它的存在，那么如果须要能将它被扫描到，是不是咱们能够通过加@Import 注解来导入Demo 类，相似如下代码

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

所以，咱们能够晓得@Import 注解其实就是为了去导入一个类。所以这里@Import({AutoConfigurationImportSelector.class}) 就是为了导入AutoConfigurationImportSelector 类，那咱们持续来看这个类，AutoConfigurationImportSelector实现的是DeferredImportSelector接口，这是一个提早导入的类；再细看会有一个办法比拟显眼，依据注解元数据来抉择导入组件，当注解元数据空，间接返回一个空数组；否则就调用getAutoConfigurationEntry ，办法中会应用AutoConfigurationEntry的getConfigurations(),configurations是一个List<String>,那么咱们看下AutoConfigurationEntry是怎么生成的。

进入到getAutoConfigurationEntry 办法中能够看到次要是getCandidateConfigurations 来获取候选的 Bean，并将其存为一个汇合；后续的办法都是在去重，校验等一系列的操作。

咱们持续往getCandidateConfigurations 办法里看，最终通过SpringFactoriesLoader.loadFactoryNames来获取最终的configurations，并且能够通过断言发现会应用到META-INF/spring.factories文件，那么咱们再进入SpringFactoriesLoader.loadFactoryNames()中来看下最终的实现。

SpringFactoriesLoader.loadFactoryNames()办法会读取META-INF/spring.factories文件下的内容到Map中，再联合传入的factoryType=EnableAutoConfiguration.class,因而会拿到 org.springframework.boot.autoconfigure.EnableAutoConfiguration为key对应的各个XXAutoConfiguration的值，而后springboot在联合各个starter中的代码实现对于XXAutoConfiguration中的Bean的加载动作。

这边再扩大一下这个内容，通过 SpringFactoriesLoader 来读取配置文件 spring.factories 中的配置文件的这种形式是一种 SPI 的思维。

@AutoConfigurationPackage 注解

进入这个注解看，其实它就是导入了Registrar 这个类

再进入这个类查看，它其实是一个外部类，看代码的大略意思就是读取到咱们在最外层的 @SpringBootApplication 注解中配置的扫描门路（没有配置则默认以后包下），而后把扫描门路上面的Bean注册到容器中；

总结

好了，当初咱们大略来理一下整个主动拆卸的流程：

1. 启动类中通过应用@SpringBootApplication实现主动拆卸的性能；

<!---->

1. 理论注解@SpringBootApplication是借助注解@EnableAutoConfiguration的性能。

<!---->

1. 在注解@EnableAutoConfiguration中又有两个注解，@AutoConfigurationPackage，@EnableAutoConfiguration。

<!---->

1. 通过@AutoConfigurationPackage实现对于以后我的项目中Bean的进行加载；

<!---->

1. @EnableAutoConfiguration通过@Import({AutoConfigurationImportSelector.class})实现对于Pom引入的start中的XXAutoConfiguration的加载；

<!---->

1. @AutoConfigurationImportSelector类中通过SpringFactoriesLoader读取 META-INF/spring.factories中key为org.springframework.boot.autoconfigure.EnableAutoConfiguration对应的各个XXAutoConfiguration的值，而后springboot在联合各个start中的代码实现对于XXAutoConfiguration中的Bean的加载动作；

到这里是不是曾经能够很了然对咱们之前开发starter中的定义了啊，连忙试试吧