Appearance
2.1-5 SPI 机制:JDK SPI、Spring factories、Dubbo ExtensionLoader
所属:02 Java 运行时 / 2.1 Java 基础 分级:A 状态:◐ 初稿 关联:2.1-2、2.1-3、3.1-5、3.3-2
题型:原理 / 对比
一句话结论:SPI 是“接口由框架定义、实现由第三方提供、运行时按约定发现并装配”的扩展机制;JDK SPI 用
META-INF/services全量加载、无命名,Spring factories 用 key-value 按类型加载,Dubbo ExtensionLoader 在其上增加命名、默认值、自适应、激活和 IOC/AOP,是三者中能力最强的。分层要点:
- 要解决的问题:框架只定义接口,具体实现(JDBC 驱动、日志实现、协议、序列化)由使用方或第三方提供,编译期不依赖实现,运行时再发现。SPI 由三部分组成:扩展点接口、约定目录/格式、发现与装配机制。它和“依赖注入”不同:DI 关注对象怎么组装,SPI 关注“实现类从哪里来”。
- JDK SPI:
ServiceLoader.load(接口)读取META-INF/services/<接口全限定名>,文件每行一个实现类全限定名;实现类必须是public、有无参构造。ServiceLoader是懒加载的,迭代时才实例化,但不能按名字选,遍历会把所有实现都加载出来,顺序也不保证;某个实现初始化失败会抛ServiceConfigurationError。默认用线程上下文类加载器(TCCL),JDK 9+ 还支持模块系统里的uses/provides。典型:JDBC 4.0 的DriverManager、SLF4J 绑定。 - Spring factories:读取
META-INF/spring.factories,本质是 properties:key 是接口/抽象类,value 是实现类列表;SpringFactoriesLoader.loadFactories()/loadFactoryNames()按类型取出,再由 Spring 实例化和排序(@Order、Ordered、AnnotationAwareOrderComparator)。Spring Boot 2.x 的自动配置类就注册在spring.factories;Spring Boot 2.7 引入META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports,3.0 起自动配置不再从spring.factories读取,但EnvironmentPostProcessor等钩子仍用它。 - Dubbo ExtensionLoader:用
@SPI标记扩展点,可指定默认扩展名;配置放在META-INF/dubbo/internal/、META-INF/dubbo/、META-INF/services/,格式是name=class,因此可以getExtension("name")按名取。它还提供:getDefaultExtension()取默认实现;@Adaptive生成自适应扩展,运行时从 URL 参数里选实现;@Activate按 group/order 批量激活(Filter 常用);Wrapper 自动包一层实现 AOP;setter 注入完成扩展之间的依赖组装。ExtensionLoader和扩展实例都会缓存。 - 选型与边界:要遵循 JDK 标准、实现方零依赖 → JDK SPI;要在 Spring/Boot 里按类型装配、需要排序 → Spring factories /
AutoConfiguration.imports;要做 RPC 插件化、按 URL 动态选协议/序列化/过滤器 → Dubbo ExtensionLoader。共同坑是类加载器和打包:容器、插件化、shading 场景要确认 TCCL,合并META-INF/services时要 merge 而不是覆盖;静态缓存扩展实例也可能拖住 ClassLoader。
图/流程:
text
扩展点接口
├─ JDK SPI
│ META-INF/services/com.foo.X → 一行一个实现类
│ ServiceLoader.load(X) → 迭代 → 全部实例化
│
├─ Spring factories
│ META-INF/spring.factories → key=X, value=A,B
│ SpringFactoriesLoader → 按类型取 → 排序 → 实例化
│
└─ Dubbo ExtensionLoader
META-INF/dubbo/... → a=A, b=B
├─ getExtension("a") 按名取
├─ getAdaptiveExtension() URL 参数决定
└─ getActivateExtension() group/order 激活版本/源码锚点:
- JDK 6+:
java.util.ServiceLoader;JDK 9+:模块uses/provides、ServiceLoader.stream();JDK 17/21 延续。 - Spring Framework 6:
org.springframework.core.io.support.SpringFactoriesLoader。 - Spring Boot 2.7:引入
AutoConfiguration.imports;3.0 起自动配置不再从spring.factories读取。 - Dubbo 2.7/3.x:
org.apache.dubbo.common.extension.ExtensionLoader、@SPI、@Adaptive、@Activate。
- JDK 6+:
对比表:
| 维度 | JDK SPI | Spring factories | Dubbo ExtensionLoader |
|---|---|---|---|
| 配置文件 | META-INF/services/<接口全限定名> | META-INF/spring.factories | META-INF/dubbo/... |
| 格式 | 每行一个实现类 | key=value 列表 | name=class |
| 按名选择 | 不支持 | 不支持,按类型取 | 支持 getExtension(name) |
| 默认实现 | 无 | 无 | @SPI 指定默认名 |
| 排序/激活 | 无保证 | @Order / Ordered | @Activate 的 group/order |
| 懒加载 | 迭代时实例化 | 按需加载类 | 按需创建并缓存 |
| 增强能力 | 无 | 无 | Adaptive、Wrapper、IOC |
| 典型场景 | JDBC、SLF4J | Boot 自动配置、启动钩子 | Dubbo 协议/过滤器/序列化 |
追问链:
- JDK SPI 为什么不能按名获取? → 它的约定只有“实现类列表”,没有 key;
ServiceLoader只暴露迭代器。要按名选,得自己读配置或改用 Dubbo 的name=class格式。 ServiceLoader用哪个类加载器? → 默认用当前线程的上下文类加载器(TCCL);容器、插件、JDBC 驱动隔离场景要显式传 ClassLoader,否则可能加载不到实现,或把 ClassLoader 拖住。- JDK SPI 会一次性加载所有实现吗? → 迭代是懒的,但遍历会逐个实例化;没有“只加载一个”的能力,顺序也不保证,失败会抛
ServiceConfigurationError。 - Spring factories 和 JDK SPI 的核心区别? → Spring 是 key-value、按类型取、能排序、由 Spring 容器管理生命周期;JDK SPI 是标准 API、全量迭代、无排序、无命名。
- Spring Boot 3 为什么换自动配置文件? → 避免
spring.factories越来越臃肿,AutoConfiguration.imports只列自动配置类,语义更清晰、启动扫描更直接;老的spring.factories仍用于其他钩子。 - Dubbo 的
@Adaptive怎么工作? → 为扩展接口生成自适应类,调用时从 URL 里取@Adaptive指定的参数(如protocol、serialization)再选具体扩展;可以标在类上,也可以标在方法上。 - Dubbo 的 Wrapper 和
@Activate有什么用? → Wrapper 构造器接收扩展接口,自动包一层做 AOP,Filter 链常靠它;@Activate按 group/order 批量激活,适合“一组都要生效”的扩展。 - SPI 会不会导致类加载器泄漏? → 会;
ServiceLoader、ExtensionLoader、Spring 缓存都可能持有 ClassLoader 或扩展实例,热部署/插件卸载要清理,shading 时还要正确合并配置文件。 - 怎么保证多个扩展的执行顺序? → JDK SPI 不保证;Spring 用
@Order/Ordered;Dubbo 用@Activate(order=...)或 URL 里的顺序参数。
- JDK SPI 为什么不能按名获取? → 它的约定只有“实现类列表”,没有 key;
生产案例/取舍(示例,替换成你的项目):
- JDBC 4.0 之后
DriverManager通过ServiceLoader发现java.sql.Driver,所以很多场景可以不写Class.forName;但多驱动、类加载器隔离时仍要显式管理。 - SLF4J 在 classpath 上找绑定实现,出现多个绑定会告警;做 shaded jar 时要把
META-INF/services合并,否则某个实现会“消失”。 - 自定义 Spring Boot starter:2.x 把自动配置类写进
spring.factories,3.x 改写到AutoConfiguration.imports;写错位置的表现是“依赖引入了,但配置类没生效”。 - Dubbo 的 Protocol、Serialization、Filter 都是扩展点:
@SPI("dubbo")给默认协议,@Adaptive根据 URL 的protocol/serialization选实现,Filter 用@Activate(group=...)批量挂到调用链上。 - 取舍:JDK SPI 标准、简单,但能力弱;Spring factories 贴合容器、能排序,但没有命名;Dubbo 功能最全,但和 Dubbo 生态绑定,学习成本也最高。
- JDBC 4.0 之后
易错点:
- 实现类不是
public、没有无参构造,导致ServiceConfigurationError。 META-INF/services下的文件名不是接口全限定名,或包名写错。- 以为
ServiceLoader能按需只加载一个实现——它没有名字,遍历就是全量。 - 忽略 TCCL,在容器/插件环境里加载不到实现。
- Spring Boot 3 仍把自动配置写进
spring.factories,结果不生效。 - Dubbo
@SPI的默认名拼错,或@Adaptive方法没有 URL 参数,导致取不到扩展。 - shaded jar 直接覆盖
META-INF/services,没有 merge。 - 扩展实现有状态,却被
ExtensionLoader缓存复用,造成串数据。
- 实现类不是
30 秒口述稿:
SPI 是接口在框架、实现在第三方、运行时按约定发现。JDK SPI 用
META-INF/services/接口名,一行一个实现,ServiceLoader懒加载但没有名字、不能按名选,顺序也不保证;Spring factories 用META-INF/spring.factories的 key-value 按类型加载,能排序,Boot 2.x 自动配置用它,3.0 换成AutoConfiguration.imports;Dubbo 的 ExtensionLoader 用name=class,支持@SPI默认值、@Adaptive按 URL 自适应、@Activate分组激活,还有 Wrapper 和 IOC,能力最强。选型看你要标准、Spring 集成还是 RPC 插件化。
- 3 分钟展开顺序:问题(接口与实现解耦)→ JDK SPI 的约定、懒加载与三个限制 → Spring factories 的 key-value、排序、Boot 3 变化 → Dubbo 的命名、默认、Adaptive、Activate、Wrapper → 对比表与选型 → TCCL/打包/缓存等边界 → 生产案例。