如何自定义一个starter？

码炫课堂-码哥

于 2025-01-07 07:52:50 发布

阅读量1.2k

点赞数 38

分类专栏： java面试题文章标签： spring springboot 面试

本文链接：https://blog.csdn.net/smart_an/article/details/144976681

版权

java面试题专栏收录该内容

168 篇文章

订阅专栏

作者简介：大家好，我是码炫码哥，前中兴通讯、美团架构师，现任某互联网公司CTO，兼职码炫课堂主讲源码系列专题

代表作：《jdk源码&多线程&高并发》，《深入tomcat源码解析》，《深入netty源码解析》，《深入dubbo源码解析》，《深入springboot源码解析》，《深入spring源码解析》，《深入redis源码解析》等

联系qq：184480602，加我进群，大家一起学习，一起进步，一起对抗互联网寒冬。码炫课堂的个人空间-码炫码哥个人主页-面试，源码等

回答

在 Spring Boot 中定义一个 starter 主要包括如下几个步骤：

创建一个项目：创建一个独立的 Maven 或者 Gradle 项目，作为 Starter 的基本框架，并添加 spring-boot-autoconfigure 依赖
编写自动配置类：编写一个自动配置类，这个类通过 @Configuration 注解来封装你要自动装配的 Bean。
配置 spring.factories 文件：在 src/main/resources/META-INF 目录下创建 spring.factories 文件，声明需要自动装配的配置类。关于是使用 spring.factories 还是 spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports
发布 starter：将自定义 Starter 构建成 JAR 包，并发布到 Maven 仓库，其他项目直接用用即可。

详解

starter 的实现原理

自定义 starter 的案例网上有很多，码哥就不演示了，这里重点讲 start 的实现原理。

自定义 starter 的核心原理在于自动配置机制和条件话装配：

自动配置机制：Spring Boot 通过 @EnableAutoConfiguration 和 spring.factories 文件，自动配置应用需要的 Bean 和功能。
条件化话装配：使用 @ConditionalOnClass、@ConditionalOnProperty 等注解，根据环境或配置条件，决定是否加载和装配某些功能。

这里以 mybatis-plus-boot-starter 为例。

我们找对应的配置文件：

Spring Boot 在启动的时候会去扫描应用中的spring.factories 或者 spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports 文件内容，加载里面生命的自动配置类，并根据条件装配相对应的 Bean。文件内容如下：

com.baomidou.mybatisplus.autoconfigure.IdentifierGeneratorAutoConfiguration
com.baomidou.mybatisplus.autoconfigure.MybatisPlusLanguageDriverAutoConfiguration
com.baomidou.mybatisplus.autoconfigure.MybatisPlusAutoConfiguration

IdentifierGeneratorAutoConfiguration

IdentifierGeneratorAutoConfiguration 是 MyBatis-plus 中用于自动配置标识符生成器的类，它的主要作用是自动为 MyBatis-Plus 配置一个 ID 生成器，通常用于数据库表的主键生成策略：

@Lazy
@ConditionalOnClass(InetUtils.class)
@ConditionalOnBean(InetUtils.class)
@Configuration(proxyBeanMethods = false)
public class IdentifierGeneratorAutoConfiguration {

    @Bean
    @ConditionalOnMissingBean
    public IdentifierGenerator identifierGenerator(InetUtils inetUtils) {
        return new DefaultIdentifierGenerator(inetUtils.findFirstNonLoopbackAddress());
    }
}

@Lazy：表明 IdentifierGeneratorAutoConfiguration 的加载是懒加载，并不随 Spring 容器启动就立刻加载，而是等到用的时候才会被加载。在有些时候我们可能确实是不需要 MyBatis-plus 的 id 生成器。
@ConditionalOnClass(InetUtils.class) 和 @ConditionalOnBean(InetUtils.class)，表明 IdentifierGeneratorAutoConfiguration 需要当前类路径下存在 InetUtils 这个 Bean 才会被加载。
@Configuration(proxyBeanMethods = false)：表明 Spring 不能为 IdentifierGeneratorAutoConfiguration 创建代理对象。

当容器中不存在 IdentifierGenerator 对应的 bean 时就会执行 identifierGenerator() 创建 IdentifierGenerator Bean 并完成注册：

    @Bean
    @ConditionalOnMissingBean
    public IdentifierGenerator identifierGenerator(InetUtils inetUtils) {
        return new DefaultIdentifierGenerator(inetUtils.findFirstNonLoopbackAddress());
    }

InetUtils 是 Spring 中的一个工具类，用于提供与网络相关的操作，其 findFirstNonLoopbackAddress() 会返回第一个非回环地址（即非 127.0.0.1），该地址被传递给 DefaultIdentifierGenerator 的构造函数用来初始化 ID 生成器：

    public DefaultIdentifierGenerator(InetAddress inetAddress) {
        this.sequence = new Sequence(inetAddress);
    }

Sequence 是 MyBatis-plus 中的数据库序列，他是一种用于生成唯一标识的机制。DefaultIdentifierGenerator 是 MyBatis-plus 中默认的 id 生成器器，内部通过调用 Sequence 的 nextId() 来生成唯一 id。

MybatisPlusLanguageDriverAutoConfiguration

MybatisPlusLanguageDriverAutoConfiguration 是 MyBatis-Plus 的核心组件，主要用于配置和启用 MyBatis-Plus 的 SQL 自定义语法解析器（也叫做语言驱动）。

在 MyBatis-Plus 中，语言驱动负责解析特定的 SQL 语法，尤其是对 MyBatis-Plus 扩展的一些功能（如乐观锁、自动分页等），它提供了更高效的 SQL 生成和处理能力。定义如下：

@Lazy
@Configuration(proxyBeanMethods = false)
@ConditionalOnClass(LanguageDriver.class)
public class MybatisPlusLanguageDriverAutoConfiguration {
  //...
}

LanguageDriver 是 MyBatis 中的核心接口，它负责将 SQL 语句映射到 MyBatis 的执行引擎。在 MyBatis 中，SQL 语句不仅仅是数据库的操作指令，还可能包含动态 SQL、参数映射等。LanguageDriver 就是负责将这些 SQL 转换为 MyBatis 可执行的语句的组件。它主要执行如下任务：

将 XML 中的 SQL 语句、注解中定义的 SQL 语句以及 MyBatis 动态 SQL 标签（如 <if>、<choose> 等）转换为 MyBatis 可以处理的 SQL 语句。
支持自定义 SQL 语法扩展。MyBatis 允许通过自定义 LanguageDriver 来处理一些特殊的 SQL 语法或数据库特性，MyBatis Plus 就通过扩展 LanguageDriver 来支持分页、乐观锁等功能。

而 MybatisPlusLanguageDriverAutoConfiguration 则就是负责初始化和配置 MyBatis-Plus 的 LanguageDriver，从而使 MyBatis 能够处理 MyBatis Plus 提供的增强功能。MybatisPlusLanguageDriverAutoConfiguration 会将 MyBatis Plus 的 LanguageDriver 配置到 MyBatis 的上下文中，从而允许 MyBatis 使用 MyBatis-Plus 提供的特殊 SQL 解析功能。

MybatisPlusAutoConfiguration 就不介绍了，有兴趣的小伙伴可以自己去研究下！