【自定义Spring-Boot-Starter及原理详解】

曾经终败给现在 2024-04-03 12:41 77阅读 0赞

### 定义 ###

首先阐述一下Spring-Boot-Starter的概念：

> Starter POMs are a set of convenient dependency descriptors that you can include in your application. You get a one-stop-shop for all the Spring and related technology that you need, without having to hunt through sample code and copy paste loads of dependency descriptors. For example, if you want to get started using Spring and JPA for database access, just include the spring-boot-starter-data-jpa dependency in your project, and you are good to go.

简单来说，就是指Starter是一组依赖的组合，类似于插件。

### 作用 ###

在传统的项目中，我们想使用MyBatis依赖，则必然要引入依赖、编写xml配置文件等等操作。在你开下一个项目时还是需要这样操作，尤其是复杂的xml。

而在引入Starter后，这些操作都可以舍弃，由Starter自主完成。当我们引入 mybatis-spring-boot-starter 依赖时，我们也只需要在配置文件中编写对应的配置，不需要什么其他操作，都由Starter完成。

简而言之，Starter是一个SpringBoot项目，里面集成了我们所需要的功能及依赖，很多操作在这个项目中已经完成，所以我们不需要自己实现功能，并且也可以解决依赖版本的问题，我们不需要关心每个依赖，全部统一进行管理。

并且，在Starter中，通常会通过@ConfigurationProperties注解使所有的配置属性集中到全局配置文件 application.yml 中，这样就使我们告别了各种各样的xml配置。

### 命名规范 ###

如果我们要自定义Starter，那么要遵循一定的规范，Spring为Starter制定了一些命名方面的规范（详情请看[Spring-Boot-Starter命名规范][Spring-Boot-Starter]）。

官方Starter命名为：

> spring-boot-starter-data-jpa

自定义Starter命名为：

> xxx-spring-boot-starter，例如 mybatis-spring-boot-starter

当然想自定义Starter，则了解SpringBoot自动配置原理必不可少。

### 自动配置原理 ###

首先，在启动类中的 @SpringBootApplication 注解中，存在着一个 @EnableAutoConfiguration 注解，而在这个注解里，又有一个 @Import(AutoConfigurationImportSelector.class) 注解，该注解表示将这个类引入进Spring容器中，原理就在这个类中。

![在这里插入图片描述][d07563d44a2a43dd981ac33e46f46f6b.png]

在这个类中，有一个 getCandidateConfigurations() 方法，用来获取所有的候选配置，其实就是扫描所有自动配置类，返回的是配置类全限定名的集合。

![在这里插入图片描述][5005a0d0f1b14afea31982746237490c.png]

点进 SpringFactoriesLoader.loadFactoryNames()方法，我们接着往下看：

![在这里插入图片描述][f11e435d38ae41e4a6499b1f6448d7ae.png]

在方法中的描述，我们可以看出，它负责从 META-INF/spring.factories 文件中加载自动配置类的全限定名。

而具体的实现却在 loadSpringFactories() 方法中：

![在这里插入图片描述][fe6b400c587649519520cebf1abcd000.png]

看，这不就相当于SPI机制吗，在Starter（**服务提供者**）引入进来后，SpringBoot（**服务发现者**）自动对其 META-INF/spring.factories 文件中的内容进行扫描，并根据全限定名进行加载。

而在将自动配置类加载进容器时，很多Starter通常会进行校验及Bean加载的先后顺序，也就是条件注解 @Condition，我们简单看一下MyBatis的：

![在这里插入图片描述][f9e37d45610c403d9dc8e3a16e5b62a3.png]

1.  首先是 @ConditionalOnClass 注解，他表示在其中指定的类必须存在，也就是说，mybatis-spring-boot-starter 依赖于 org.mybatis 这个Jar，如果该Jar (org.mybatis) 不存在，例如被我们在依赖管理中移除掉了，那么这个Starter的自动配置也不会生效。

@ConditionalOnClass({
        SqlSessionFactory.class, SqlSessionFactoryBean.class})

1.  @EnableConfigurationProperties 注解，该注解表示启用某个配置文件类，而配置文件类的作用是将全局配置文件的配置绑定到某一个类中，比如 MybatisProperties.class

@EnableConfigurationProperties({
        MybatisProperties.class})

MybatisProperties.class：  
![在这里插入图片描述][5d54880ad33d4cae866f572343defa74.png]

全局配置文件：  
![在这里插入图片描述][84db1b0760c64e81869bf3e101b3fbd0.png]

只要通过前缀，即可声明其配置，而配置文件类可以将属性绑定到该类中，但是必须要通过 @EnableConfigurationProperties 启用才能生效。

1.  @AutoConfigureAfter 注解，顾名思义，本类加载的顺序要比里面定义的类要靠后，这样做也是有目的的，比如说 MybatisAutoConfiguration 配置类中有一个成员是由 DataSourceAutoConfiguration 配置类注入到Spring容器的，而且前者使用的还是构造器注入，那么则需要约定顺序，先注入 DataSourceAutoConfiguration 和其中的Bean，再注入 MybatisAutoConfiguration 类。类似于 @DependsOn。

@AutoConfigureAfter({
        DataSourceAutoConfiguration.class})

既然已经讲清楚了这些，就来说说如何实现Spring-Boot-Starter。

### 实现 ###

1.  先创建一个项目，命名为 xxx-spring-boot-starter。

1.  在Pom文件中，添加两个依赖，分别是SpringBoot的核心启动器，以及配置文件类的配置描述（后面讲解）。

<?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>
        <artifactId>demo-spring-boot-starter</artifactId>
        <version>1.0-SNAPSHOT</version>
    
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starters</artifactId>
            <version>2.3.5.RELEASE</version>
        </parent>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter</artifactId>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-configuration-processor</artifactId>
                <optional>true</optional>
            </dependency>
        </dependencies>
    
    </project>

1.  随后，简单创建一个自动配置类（需要在自动配置类中将所有需要注入的Bean注入进来）

// 配置类
    @Configuration
    // 启用配置文件类
    @EnableConfigurationProperties(DemoProperties.class)
    public class DemoAutoConfiguration {
        
    
        private final DemoProperties demoProperties;
    
        public DemoAutoConfiguration(DemoProperties demoProperties) {
        
            this.demoProperties = demoProperties;
        }
    
        @Bean
        public DemoHandler demoHandler() {
        
            return new DemoHandler(demoProperties);
        }
    }

1.  配置文件类（Get Set方法要齐全，不然无法注入属性）

// 在这里规定该配置文件类的配置前缀
    @ConfigurationProperties(prefix = "student.info")
    public class DemoProperties {
        
    
        /**
         * 学生姓名
         */
        private String name;
    
        /**
         * 学生年龄
         */
        private Integer age;
    
        /**
         * 学生性别，男-true，女-false
         */
        private Boolean sex;
    }

1.  演示处理（不要贴@Component @Service等注解，非相同路径，Spring是不会扫描的）

public class DemoHandler {
        
    
        private static final Logger log = LoggerFactory.getLogger(DemoHandler.class);
    
        private final DemoProperties demoProperties;
    
        public DemoHandler(DemoProperties demoProperties) {
        
            this.demoProperties = demoProperties;
        }
    
        public void print() {
        
            log.info("学生姓名：{}, 学生年龄：{}, 学生性别：{}",
                    demoProperties.getName(), demoProperties.getAge(), demoProperties.getSex() ? "男" : "女");
        }
    }

1.  项目结构如下：

![在这里插入图片描述][440c42bdc76c4e05b70ec17ee5e81191.png]

**接下来，就可以在项目中引用 DemoHandler类进行执行了。**

![在这里插入图片描述][3ce4107fc8644eb8bd9bdf3a14209f68.png]

@SpringBootApplication
    public class Application {
        
        public static void main(String[] args) {
        
            SpringApplication.run(Application.class, args);
        }
    
        @Resource
        private DemoHandler demoHandler;
    
        @PostConstruct
        public void run() {
        
            demoHandler.print();
        }
    
    }

配置（可以看到，该配置是使用的 DemoProperties 类，包括注释也有提示）：

![在这里插入图片描述][0347561b64bb4fae8952047eaf61b2cf.png]

结果（确实是将DemoHandler类注入进容器中，并且将我们的配置也读取出来了）：

![在这里插入图片描述][9c5a0d5258994d289fe3f79c2906a5a7.png]

回到刚刚说的一个问题：spring-boot-configuration-processor依赖是什么？

其实，我们在配置文件中，定义配置时，如果没有这个依赖，配置是不会有提示功能的。

![在这里插入图片描述][aa608ec1dd954ff496523a09f6fb9abc.png]

这个功能归功于这个文件，它属于META-INF\\spring-configuration-metadata.json，拥有这个文件，才能出现配置文件中的提示功能，在这个文件中约定了配置的类型、名称、描述以及所属的类，而我们如果自定义该文件，未免太过麻烦。因为如果你有很多配置，那么你就要写很多东西了，而这个依赖可以帮助我们生成该文件，避免我们手写。  
（详情可以看下这个 [spring-boot-configuration-processor][]）

![在这里插入图片描述][9975a6afcdd44f5b9058fec4f9d2095b.png]

问题：

1.  所有需要加载的类都需要在自动配置类中注入，因为只有spring.factories文件中定义的类才会被加载。
2.  如果你需要使用 mvn install安装到本地仓库，请不要在Pom文件中定义 packaging，会导致失败。  
    ![在这里插入图片描述][0fcff491aa9444948bd56a5b0b0b47b3.png]
3.  配置文件类中可以约定默认值，如果使用者不指定新值的话，默认使用该默认值。

### 总结 ###

每个Starter都描述一种或多种功能，它会将所有用到的依赖包含进来，首先避免了开发者手动导入依赖的情况。同时，我们可以在Starter中使用Spring的各种功能，例如切面，事件等，因为Starter严格来说就是一个SpringBoot项目。并且我们不需要再指定xml了，在Starter中，已经帮助我们自动做完了这些工作，我们只需要提供配置即可，同时，也不需要关心其如何实现。只需要像插件一样安装上去即可运行。easy~

另外，可以看看我简单实现的一个[canal-spring-boot-starter][]，基于Canal原生API实现，借鉴了一些开源项目的思路，也比较简单，希望对你有所帮助。

[Spring-Boot-Starter]: https://docs.spring.io/spring-boot/docs/2.0.0.M5/reference/htmlsingle/#boot-features-custom-starter-naming
[d07563d44a2a43dd981ac33e46f46f6b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/9da2cd0510cd41d59bf94a9421253fd8.png
[5005a0d0f1b14afea31982746237490c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/da85e9e88cf74270b94e126c450cf834.png
[f11e435d38ae41e4a6499b1f6448d7ae.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/a7b32b0de5e34bbf82419a7561678bdb.png
[fe6b400c587649519520cebf1abcd000.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/2745e2fcdc96496fbfefb09b99ffeed9.png
[f9e37d45610c403d9dc8e3a16e5b62a3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/fff86b0fb6a34804864048981ca03958.png
[5d54880ad33d4cae866f572343defa74.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/cc401c1a517a493c95d05f96fde6cc32.png
[84db1b0760c64e81869bf3e101b3fbd0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/4f658efbbf5b4545a5ffe2f5d5313f60.png
[440c42bdc76c4e05b70ec17ee5e81191.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/4cd2194d17d74cee962aea33c2dc5e1f.png
[3ce4107fc8644eb8bd9bdf3a14209f68.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/bbf23d65ca064f71be700d88e2cc15ca.png
[0347561b64bb4fae8952047eaf61b2cf.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/67bc184e1ddc46898c1ec4bd9e9880a1.png
[9c5a0d5258994d289fe3f79c2906a5a7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/08b898f1c8d142a49e1d2126c41ef074.png
[aa608ec1dd954ff496523a09f6fb9abc.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/2c8b7fa7a42e4fff8dc10a8669e5d34c.png
[spring-boot-configuration-processor]: https://blog.csdn.net/m0_37529488/article/details/122639916
[9975a6afcdd44f5b9058fec4f9d2095b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/6bf4c507daae4e03bccc26aee0efdeff.png
[0fcff491aa9444948bd56a5b0b0b47b3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/eea7779cc8174049a13d06bf03fa2cb4.png
[canal-spring-boot-starter]: https://gitee.com/summerjoyful/canal-spring-boot-starter