SpringBoot 自定义 Starter 实现

news2024/11/14 18:26:12

一、定义，什么是Starter

SpringBoot Starter 是”一站式服务（one-stop service）“的依赖 Jar 包：

包含 Spring 以及相关技术（比如Redis）的所有依赖
提供了自动配置的功能，开箱即用
提供了良好的依赖管理，避免了包遗漏、版本冲突等问题

旨在简化Spring Boot 项目的开发和配置过程。通过引入Starter依赖，开发者可以快速集成各种功能模块，例如Web应用程序、数据库访问、消息队列等。
具体来说，Starter的主要作用包括以下几个方面：

简化配置：Starter封装了特定技术或功能的所有必要依赖项和配置，使开发者能够快速将这些功能集成到Spring Boot项目中，而无需手动编写大量配置代码。
自动装配：Starter利用Spring Boot的自动装配机制，通过扫描类路径下的META-INF/spring.factories 文件中的EnableAutoConfiguration指定的所有自动配置类，并将其导入容器进行自动配置。
版本管理：Starter还维护了对相关Jar包版本的依赖关系，使得开发者不需要关心各个组件之间的版本兼容性问题。
约定优于配置：Spring Boot采用“约定优于配置”的策略，通过提供默认配置选项，让开发者在使用时只需少量的配置即可启动应用。

此外，Spring Boot官方提供了大量日常企业应用研发的各种场景的Starter依赖模块，如spring-boot-starter-web用于Web开发，spring-boot-starter-data-redis用于集成Redis等。这些Starter不仅方便了开发者快速搭建项目，还提高了开发效率和项目的可维护性。
总之，SpringBoot Starter是一种非常重要的机制，通过预打包的依赖和自动配置，极大地简化了Spring Boot项目的开发和部署过程，使开发者能够更专注于业务逻辑的实现。
Starter的结构如下图：
starter的结构.png

二、MyBatis starter的示例

mybatis starter 比 redis starter更规范

maven依赖：

<dependency>
  <groupId>org.mybatis.spring.boot</groupId>
  <artifactId>mybatis-spring-boot-starter</artifactId>
  <version>2.0.0</version>
</dependency>

查看starter类，里面依赖了Mybatis所需的jar包，除此之外，有一个负责自动配置的配置包；
通过查看spring.factories，其Mybatis的配置，
key：org.springframework.boot.autoconfigure.EnableAutoConfiguration
value是：org.mybatis.spring.boot.autoconfigure.MybatisAutoConfiguration
（values值多个以逗号（“,”）相隔，每个value为一个配置类）

@ConditionalOnClass 表示在类存在的情况下进行自动配置
@EnableConfigurationProperties，使@ConfigurationProperties注解生效，把 MybatisProperties注入入到 IOC 容器中。
@AutoConfigureAfter，完成自动配置后实例化这个 bean
通过查看 mybatis-spring-boot-starter，可以发现starter包很简单，没有class文件，只是把starter当做一个相对完整的模块的入口，通过pom文件引入其模块依赖的jar包和配置包，在项目上需要使用此模块时，只需引入这个依赖即可。