讲师中心 微信公众号
AI工具推荐 视频效率加速

如何利用 ServiceLoader 与 SPI 机制在 Spring Boot 体系外实现模块化的插件加载与替换

胖宇小哥_2232

胖宇小哥_2232

发布时间:2026-04-16 20:43:05

|

459人浏览过

|

来源于php中文网

原创

ServiceLoader.load()返回空迭代器却不报错,主因是类加载器隔离或路径错误:检查META-INF/services/接口全限定名文件是否在jar根路径、文件名无.class后缀、内容无空格/BOM、实现类public且含public无参构造器,并显式传入匹配的ClassLoader。

如何利用 serviceloader 与 spi 机制在 spring boot 体系外实现模块化的插件加载与替换

ServiceLoader.load() 返回空迭代器却不报错,怎么排查?

这是最常卡住人的第一步:调用 ServiceLoader.load(YourInterface.class) 后遍历发现没任何实现,控制台也无异常。根本原因几乎总是类加载器隔离或路径错误。

检查要点:

  • 确认 META-INF/services/com.example.YourInterface 文件真实存在于 jar 包根路径(不是源码路径、不是 resources 子目录下);文件名必须是接口全限定名,**不能带 .class 后缀**
  • 文件内容每行一个实现类全限定名,**末尾不能有空格、制表符或 Windows 回车符(\r\n)**,# 不被识别为注释,会直接导致 NoClassDefFoundError
  • 实现类必须是 public、非泛型、非内部类,且声明了 public YourServiceImpl() 无参构造器
  • 显式传入类加载器:ServiceLoader.load(YourInterface.class, YourInterface.class.getClassLoader()) —— 默认用线程上下文类加载器(Thread.currentThread().getContextClassLoader()),在 fat-jar、OSGi 或自定义 classloader 场景下极易失效

为什么 forEachRemaining() 会漏掉部分插件实例?

ServiceLoader 的 Iterator 是延迟加载 + 单次遍历的。调用 forEachRemaining() 或 stream().forEach() 时,一旦某个实现类加载失败(比如 NoClassDefFoundError、IllegalAccessException),整个迭代器立即进入失效状态,后续所有未加载项都会被跳过,且不抛出任何可捕获异常。

安全做法是手动遍历并逐个处理:

<pre class="brush:php;toolbar:false;">ServiceLoader<Plugin> loader = ServiceLoader.load(Plugin.class, Plugin.class.getClassLoader());
for (Plugin plugin : loader) {
    try {
        plugin.init();
    } catch (ServiceConfigurationError | Throwable e) {
        // 记录具体哪个类加载失败,不影响其他插件
        log.warn("Failed to init plugin: {}", plugin.getClass(), e);
    }
}

注意:ServiceConfigurationError 是 SPI 专属异常,涵盖配置格式错误、类找不到、构造器不可访问等;普通 <code>Throwable 也要捕获,因为插件自身 init() 可能抛运行时异常。

多个插件 jar 同时存在时,加载顺序怎么控制?

ServiceLoader **不保证加载顺序**。它按 ClassLoader.getResources() 返回的 URL 列表顺序扫描 META-INF/services/ 文件,而该顺序取决于 jar 包在 classpath 中的排列位置 —— 这在不同构建工具(Maven vs Gradle)、不同打包方式(fat-jar vs exploded)、不同 JVM 启动参数下都可能变化。

若需确定顺序,必须自行干预:

  • 在插件实现类中增加 int getOrder() 方法或 @Order 注解(自己定义),加载后手动排序
  • 避免依赖隐式顺序,把“谁先执行”逻辑下沉到插件协议里(例如定义 Plugin.before(Plugin other) 接口)
  • 完全放弃顺序假设,改用事件驱动模型(如发布 PluginLoadedEvent,由监听器协调)

别试图靠 jar 文件名排序或 META-INF/MANIFEST.MF 添加顺序字段 —— ServiceLoader 不读这些。

如何让插件感知 Spring 容器但不引入 Spring Boot 依赖?

纯 ServiceLoader 无法做依赖注入,插件拿到的是裸对象。如果插件需要访问 DataSource、RestTemplate 等 Spring 托管 Bean,又不想让插件模块编译期依赖 spring-boot-starter,可行方案只有两种:

  • 插件接口定义回调方法,如 void setApplicationContext(ApplicationContext ctx),主程序在加载后主动调用,插件自行从中 getBean() —— 插件只依赖 spring-context(非 starter),体积小,解耦干净
  • 主程序提供一个轻量级服务注册中心(如 ServiceRegistry.put("config", configMap)),插件通过静态方法或全局单例获取所需资源 —— 完全避开 Spring,适合极简场景

不要在插件里写 @Autowired 或 @Component —— 没有 Spring 容器扫描,它们只是无效注解。

真正难的不是写几行 ServiceLoader.load(),而是当 7 个插件 jar 同时扔进 lib/ 目录、其中两个依赖冲突、一个构造器私有、一个配置文件用了 UTF-8 BOM、还有一个在 static 目录下误放了同名 META-INF —— 这些细节不会报错,只会让插件静默消失。

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

热门AI工具

更多
二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

10837

2023.06.15

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

7962

2023.07.05

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

6912

2023.07.31

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

1164

2023.08.01

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

948

2023.08.02

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

1416

2023.08.02

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2849

2023.08.02

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

20151

2023.08.03

OpenJDK JVM参数怎么调优
OpenJDK JVM参数怎么调优

Java应用运行缓慢,如何调整JVM参数?本专题介绍OpenJDK JVM性能调优的基本流程,涵盖性能指标确认、运行数据采集、内存配置和垃圾回收分析,帮助你先定位瓶颈,再通过对照测试验证效果,避免直接套用参数而影响应用稳定性。

80

2026.10.16

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn