学习自定义【Spring Boot Starter】这一篇就够了

1. starter介绍

我们知道Spring Boot大大简化了项目初始搭建以及开发过程，而这些都是通过Spring Boot提供的starter来完成的。

spring boot 在配置上相比spring要简单许多, 其核心在于spring-boot-starter, 在使用spring boot来搭建一个项目时, 只需要引入官方提供的starter, 就可以直接使用, 免去了各种配置。starter简单来讲就是引入了一些相关依赖和一些初始化的配置。

Spring官方提供了很多starter，第三方也可以定义starter。为了加以区分，starter从名称上进行了如下规范：

1. Spring官方提供的starter名称为：spring-boot-starter-xxx 例如：spring-boot-starter-web
2. 第三方提供的starter名称为：xxx-spring-boot-starter 例如：mybatis-spring-boot-starter

2. starter原理

Spring Boot之所以能够帮我们简化项目的搭建和开发过程，主要是基于它提供的起步依赖和自动配置。

2-1. 起步依赖

起步依赖，其实就是将具备某种功能的坐标打包到一起，可以简化依赖导入的过程。例如，我们导入spring-boot-starter-web这个starter，则和web开发相关的jar包都一起导入到项目中了。如下图所示：

2-2. 自动配置

自动配置，就是无须手动配置xml，自动配置并管理bean，可以简化开发过程。那么Spring Boot是如何完成自动配置的呢？

自动配置涉及到如下几个关键步骤：

• 基于Java代码的Bean配置
• 自动配置条件依赖
• Bean参数获取
• Bean的发现
• Bean的加载

我们可以通过一个实际的例子mybatis-spring-boot-starter来说明自动配置的实现过程。

基于Java代码的Bean配置

当我们在项目中导入了mybatis-spring-boot-starter这个jar后，可以看到它包括了很多相关的jar包，如下图：

其中在mybatis-spring-boot-autoconfigure这个jar包中有如下一个MybatisAutoConfiguration自动配置类：

打开这个类，截取的关键代码如下：

• @Configuration 注解的类可以看作是能生产让Spring IOC容器管理的Bean实例的工厂。

• @Bean 注解的方法返回的对象可以被注册到Spring容器中。

• @Configuration和 @Bean这两个注解一起使用就可以创建一个基于Java代码的配置类，可以用来替代传统的xml配置文件。

自动配置的条件依赖

从MybatisAutoConfiguration这个类中使用的注解可以看出，要完成自动配置是有依赖条件的。

所以要完成Mybatis的自动配置，需要在类路径中存在SqlSessionFactory.class、SqlSessionFactoryBean.class这两个类，同时需要存在DataSource这个bean且这个bean完成自动注册。

这些注解是spring boot特有的，常见的条件依赖注解有：

注解	功能说明
@ConditionalOnBean	仅在当前上下文中存在某个bean时，才会实例化这个Bean
@ConditionalOnClass	某个class位于类路径上，才会实例化这个Bean
@ConditionalOnExpression	当表达式为true的时候，才会实例化这个Bean
@ConditionalOnMissingBean	仅在当前上下文中不存在某个bean时，才会实例化这个Bean
@ConditionalOnMissingClass	某个class在类路径上不存在的时候，才会实例化这个Bean
@ConditionalOnNotWebApplication	不是web应用时才会实例化这个Bean
@AutoConfigureAfter	在某个bean完成自动配置后实例化这个bean
@AutoConfigureBefore	在某个bean完成自动配置前实例化这个bean

Bean参数获取

要完成mybatis的自动配置，需要我们在配置文件中提供数据源相关的配置参数，例如数据库驱动、连接url、数据库用户名、密码等。那么spring boot是如何读取yml或者properites配置文件的的属性来创建数据源对象的？

在我们导入mybatis-spring-boot-starter这个jar包后会传递过来一个spring-boot-autoconfigure包，在这个包中有一个自动配置类DataSourceAutoConfiguration，如下所示：

我们可以看到这个类上加入了EnableConfigurationProperties这个注解，继续跟踪源码DataSourceProperties这个类，如下：

可以看到这个类上加入了ConfigurationProperties注解，这个注解的作用就是把yml或者properties配置文件中的配置参数信息封装到ConfigurationProperties注解标注的bean(即DataSourceProperties)的相应属性上。

@EnableConfigurationProperties注解的作用是使@ConfigurationProperties注解生效。

Bean的发现

spring boot默认扫描启动类所在的包下的主类与子类的所有组件，但并没有包括依赖包中的类，那么依赖包中的bean是如何被发现和加载的？

我们需要从Spring Boot项目的启动类开始跟踪，在启动类上我们一般会加入SpringBootApplication注解，此注解的源码如下：

重点介绍如下三个注解：

• SpringBootConfiguration：作用就相当于Configuration注解，被注解的类将成为一个bean配置类

• ComponentScan：作用就是自动扫描并加载符合条件的组件，最终将这些bean加载到spring容器中

• EnableAutoConfiguration ：这个注解很重要，借助@Import的支持，收集和注册依赖包中相关的bean定义

继续跟踪EnableAutoConfiguration注解源码：

AutoConfigurationImportSelector类源码如下：

AutoConfigurationImportSelector类的getCandidateConfigurations方法中的调用了SpringFactoriesLoader类的loadFactoryNames方法，继续跟踪源码：

SpringFactoriesLoader的loadSpringFactories静态方法可以从所有的jar包中读取META-INF/spring.factories文件，而自动配置的类就在这个文件中进行配置：

这个文件里面的内容如下：

这样Spring Boot就可以加载到MybatisAutoConfiguration这个配置类了。

Bean的加载

在Spring Boot应用中要让一个普通类交给Spring容器管理，通常有以下方法：

1、使用 @Configuration与@Bean 注解

2、使用@Controller @Service @Repository @Component 注解标注该类并且启用@ComponentScan自动扫描

3、使用@Import 方法

其中Spring Boot实现自动配置使用的是@Import注解这种方式，AutoConfigurationImportSelector类的selectImports方法返回一组从META-INF/spring.factories文件中读取的bean的全类名，这样Spring Boot就可以加载到这些Bean并完成实例的创建工作。

自动配置总结

我们可以将自动配置的关键几步以及相应的注解总结如下：

1、@Configuration与@Bean：基于Java代码的bean配置

2、@Conditional：设置自动配置条件依赖

3、@EnableConfigurationProperties与@ConfigurationProperties：读取配置文件转换为bean

4、@EnableAutoConfiguration与@Import：实现bean发现与加载

3. 自定义starter案例

3-1. 开发starter

第一步：创建starter工程digest-spring-boot-starter并配置pom.xml文件

<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.0modelVersion>

    <groupId>com.itenggroupId>
    <artifactId>digest-spring-boot-starterartifactId>
    <version>1.0-SNAPSHOTversion>

    <properties>
        <maven.compiler.source>8maven.compiler.source>
        <maven.compiler.target>8maven.compiler.target>
        <project.build.sourceEncoding>UTF-8project.build.sourceEncoding>
    properties>

    <dependencies>
        
        <dependency>
            <groupId>org.springframework.bootgroupId>
            <artifactId>spring-boot-autoconfigureartifactId>
            <version>2.7.6version>
            <optional>trueoptional>      
        dependency>

        
        <dependency>
            <groupId>commons-codecgroupId>
            <artifactId>commons-codecartifactId>
            <version>1.15version>
        dependency>
    dependencies>

project>

第二步：创建配置属性类DigestProperty

package com.iteng.digest.config;

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

/*
 *读取配置文件转换为bean
 * */
@ConfigurationProperties(prefix = "digest")
public class DigestProperty {
    private String type;

    public String getType() {
        return type;
    }

    public void setType(String type) {
        this.type = type;
    }
}

第三步：创建业务类Digest 以及实现类Md5Digest、ShaDigest

service

public interface Digest {
    String digest(String raw);
}

impl

public class Md5Digest implements Digest {
    @Override
    public String digest(String raw) {
        System.out.println("Md5加密生成摘要");
        return DigestUtils.md5Hex(raw);
    }
}

public class ShaDigest implements Digest {
    @Override
    public String digest(String raw) {
        System.out.println("Sha加密生成摘要");
        return DigestUtils.sha256Hex(raw);
    }
}

第四步：创建自动配置类DigestAutoConfiguration

@Configuration
// 使@ConfigurationProperties注解生效
@EnableConfigurationProperties(DigestProperty.class)
// 只有类路径下有DigestUtils.class时，DigestConfiguration配置类才配置
@ConditionalOnClass(DigestUtils.class) 
public class DigestAutoConfiguration {

	private DigestProperty digestProperty;

    //通过构造方法注入配置属性对象DigestProperty, 也可以使用@Autowired注解注入
    public DigestAutoConfiguration(DigestProperty digestProperty) {
        this.digestProperty = digestProperty;
    }

    @Bean
    @ConditionalOnMissingBean // 没有Digest这个Beab时，才装配Digest Bean
    // 只有当yml中的digest.type == md5时，才装配Digest Bean。
    // matchIfMissing = true：表示yml没有写digest.type时，也装配Digest Bean
    @ConditionalOnProperty(prefix = "digest", name = "type", havingValue = "md5", matchIfMissing = true)
    public Digest md5Digest() {
        return new Md5Digest();
    }

    @Bean
    @ConditionalOnMissingBean
    @ConditionalOnProperty(prefix = "digest", name = "type", havingValue = "sha")
    public Digest shaDigest() {
        return new ShaDigest();
    }
}

第五步：(Spring Boot 2.7 及以上）在resources目录下创建META-INF文件夹，在META-INF文件夹里面创建一个spring文件夹。在spring文件夹中创建org.springframework.boot.autoconfigure.AutoConfiguration.imports的文件。文件内容写自动配置类的全限名

com.iteng.digest.config.DigestAutoConfiguration

(Spring Boot 2.7 以下）在resources目录下创建META-INF文件夹，在文件夹中创建spring.factories文件

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.iteng.digest.config.DigestAutoConfiguration

第六步：（可选）在resources的META-INF文件夹下创建spring-configuration-metadata.json文件。这个文件可以用来给使用者在进行yml文件时有提示

{
  "properties": [
    {
      "name": "digest.type",
      "type": "java.lang.String",
      "description": "算法类型"
    }
  ]
}

至此starter已经开发完成了，可以将当前starter安装到本地maven仓库供其他应用来使用。

3-2. 使用starter

第一步：导入自定义starter

<dependency>
    <groupId>com.itenggroupId>
    <artifactId>digest-spring-boot-starterartifactId>
    <version>1.0-SNAPSHOTversion>
dependency>

第二步：设置application.yml文件

digest:
  type: md5

第三步：测试

@Resource
private Digest md5Digest;

@Test
void contextLoads() {
    System.out.println(md5Digest.digest("iteng"));
}