重头学 || SpringBoot 2.7 自定义 Starter 方法又变了

语言: CN / TW / HK
官方过期通知

springboot 2.7 已经标记 spring.factories 加载自动化配置方式为过期,springboot 3 中将完全移除原有方式,这也就意味着现有市面所有 spring-boot-starter 将无法适配 spring boot 3

一、 spring.factories 是啥

在 Spring 中也有一种类似 Java SPI 的加载机制。它在 META-INF/spring.factories 文件中配置接口的实现类名称,然后在程序中读取这些配置文件并实例化。

这种自定义的 SPI 机制是 Spring Boot Starter 实现的基础。即当你依赖了某个 Starter,那么该 Starter 就提供相关的类供加载,这些配置类负责特定的功能。如果你没有依赖某个 Starter,就不会加载相关的类。

pig seata 自定配置示例

二、新特性支持自动配置分片

2.1 为什么要支持配置分片

我们以 mybatis-plus-boot-starter 为例,如下图 spring.factories 配置很多几乎所有的 spring config bean 都可以往这里放,对于开发者维护造成困难。

  • ② 环境配置处理器

  • ③ 自动化配置类

2.2 如何使用自动配置分片功能

创建 org.springframework.boot.autoconfigure.AutoConfiguration.imports 文件

├── src
│ └── main
│ └── resources
│ ├── META-INF
│ │ └── spring
│ │ └── org.springframework.boot.autoconfigure.AutoConfiguration.imports
上文的common-seata 变更为此种方式

2.3 配置分片的源码分析

  • ① 兼容原来的 spring.factories 配置加载方式

  • ② 读取分片配置 加载相关的类

三、扩展属于自己的 Import SPI

  • pig [1] 定义 org.springframework.cloud.openfeign.FeignClient.imports 用于定义 feignclient (通过 SPI 机制注入 feignclient ,避免包规则不规范导致 feignclient 无法加载的问题)
  • 使用 ImportCandidates.load()

四、更优雅的处理配置分片 mica-auto

如果你不喜欢配置这种繁琐的 SPI 文件,可以来试验一下 mica-auto [2]

最新版本可以基于 @AutoConfiguration 注解自动生成并配置对应的

imports 文件

mica-auto最新版本已适配

参考资料

[1]

pig: https://github.com/pig-mesh/pig

[2]

mica-auto: https://github.com/lets-mica/mica-auto