Spring Boot 集成 PF4J 模块化架构设计思考

2.2 步骤一：搭建主应用 (Host)

1. 引入 SBP 依赖 在 pom.xml 中添加 SBP Starter：

<dependency>
    <groupId>org.laxture</groupId>
    <artifactId>sbp-spring-boot-starter</artifactId>
    <version>3.5.27</version>
    <!-- 请根据 Spring Boot 版本选用兼容版本 -->
</dependency>

*注意：SBP v18 及以上版本仅支持 Spring Boot 3.x。

2. 配置文件 在 application.yml 中启用 SBP，并指定插件目录：

spring:
  sbp:
    enabled: true
# 开发模式：直接从 classes 目录加载，便于调试
# 生产模式：改为 DEPLOYMENT，从 JAR 文件加载
runtime-mode: development
plugin-path: ./plugins # 插件存放目录

3. 定义扩展点 (SDK) 创建一个独立的模块，定义核心接口：

// 扩展点必须继承 ExtensionPoint 接口
public interface NotifierExtension extends ExtensionPoint {
    /**
     * 通知类型标识，如 "email", "sms"
     */
    String getType();

    /**
     * 发送通知
     * @param content 内容
     * @param receiver 接收者
     * @return 发送结果
     */
    String send(String content, String receiver);
}

将这个模块打成 JAR 包，后续主应用和插件都需要依赖它。

4. 主应用调用插件 在主应用中，注入 PluginManager，并编写业务逻辑调用插件：

@RestController
@RequestMapping("/api/notify")
public class NotifyController {
    @Autowired
    private PluginManager pluginManager;

    @PostMapping("/send")
    public String sendNotification(
            @RequestParam String type,
            @RequestParam String content,
            @RequestParam String receiver) {
        // 获取所有实现了 NotifierExtension 的扩展点实例
        List<NotifierExtension> notifiers = pluginManager.getExtensions(NotifierExtension.class);
        for (NotifierExtension notifier : notifiers) {
            if (type.equalsIgnoreCase(notifier.getType())) {
                return notifier.send(content, receiver);
            }
        }
        return "No suitable notifier plugin found for type: " + type;
    }
}

2.3 步骤二：开发插件（以邮件插件为例）

1. 创建插件项目 在 plugins/email-plugin 目录下创建一个新的 Spring Boot 项目（或不含启动类的 Maven 模块）。依赖包含：sbp-core 和上述定义的 SDK。

2. 定义插件属性 在插件项目的 resources 目录下创建 plugin.properties 文件，这是 SBP 识别插件的关键：

plugin.id=email-notifier-plugin
plugin.class=com.example.email.EmailPlugin
plugin.version=1.0.0
plugin.provider=YourCompany
plugin.dependencies=
# 如果有依赖其他插件，填写插件ID

3. 创建插件入口类 插件类需要继承 SBP 的 SpringBootPlugin，它将为这个插件创建一个独立的 Spring ApplicationContext。

package com.example.email;

import org.laxture.sbp.SpringBootPlugin;
import org.laxture.sbp.spring.boot.SpringBootstrap;
import org.pf4j.PluginWrapper;

public class EmailPlugin extends SpringBootPlugin {
    public EmailPlugin(PluginWrapper wrapper) {
        super(wrapper);
    }

    @Override
    protected SpringBootstrap createSpringBootstrap() {
        // 返回一个 SpringBootstrap，告知 SBP 需要扫描哪些配置类
        // EmailPluginConfiguration 是插件内部的 Spring 配置类
        return new SpringBootstrap(this, EmailPluginConfiguration.class);
    }
}

4. 实现扩展点 创建业务类，实现 SDK 中定义的接口，并用 @Extension 和 @Component 注解标记。

package com.example.email;

import com.example.sdk.NotifierExtension;
import org.pf4j.Extension;
import org.springframework.stereotype.Component;

@Extension // PF4J 注解，表明这是一个扩展实现
@Component // Spring 注解，让该 Bean 被插件的 Spring 容器管理
public class EmailNotifier implements NotifierExtension {
    @Override
    public String getType() {
        return "email";
    }

    @Override
    public String send(String content, String receiver) {
        // 这里可以注入 Spring 管理的其他 Bean，如 JavaMailSender
        String result = String.format("[Email Plugin] Sent '%s' to %s", content, receiver);
        System.out.println(result);
        return result;
    }
}

5. 定义插件配置类 为了让 Spring 扫描到 EmailNotifier，需要一个配置类：

package com.example.email;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;

@Configuration
@ComponentScan("com.example.email") // 扫描当前包
public class EmailPluginConfiguration {}

6. 打包插件 使用 Maven 将插件项目打包成 JAR 文件（email-plugin-1.0.0.jar）。

2.4 步骤三：运行与动态管理

1. 启动主应用。
2. 部署插件：将打包好的 email-plugin-1.0.0.jar 复制到主应用的 ./plugins 目录下。
3. 验证：SBP 会自动扫描并加载新插件。访问 http://localhost:8080/api/notify/send?type=email&content=Hello&[email protected]，你将看到插件成功执行的返回信息。

进阶：动态操作 SBP 默认提供了 PluginController，你可以通过 HTTP 请求来动态管理插件：

• GET /api/plugins : 列出所有插件
• POST /api/plugins/{pluginId}/start : 启动指定插件
• POST /api/plugins/{pluginId}/stop : 停止指定插件
• DELETE /api/plugins/{pluginId} : 卸载指定插件

这意味着你可以在不停机的情况下，上传一个新的短信插件 JAR 包，然后通过 API 启用它，系统立即具备短信发送能力。

三、进阶思考与最佳实践

3.1 类加载器与上下文隔离

SBP 的精髓在于父子容器模式：

• 父容器：主应用的 Spring Context，管理核心服务（如 DataSource、RestTemplate）。
• 子容器：每个插件拥有独立的 Spring Context，可以访问父容器的 Bean，但父容器无法访问插件内部的 Bean。

这种设计确保了插件的独立性。插件 A 可以使用 commons-lang3-3.12.0，插件 B 可以使用 commons-lang3-3.13.0，两者互不干扰。

3.2 复杂插件：支持 Controller 和 MyBatis

SBP 的强大之处在于，你的插件完全可以像一个迷你 Spring Boot 应用。你可以在插件中：

• 定义 @RestController：插件的接口会自动注册到主应用的 DispatcherServlet，实现功能粒度的接口分离。
• 定义 MyBatis Mapper：如果插件需要操作数据库，可以在插件内部定义 Mapper 接口和 XML 文件，并独立管理自己的数据源或使用主应用的 DataSource。

3.3 Swagger/OpenAPI 集成

对于动态注册的插件 Controller，如果想让其接口显示在 Swagger 文档中，需要进行特殊处理。一种常见的方案是在主应用中预留 GroupedOpenApi 的注册机制，插件启动时动态创建基于插件包扫描的 GroupedOpenApi Bean 并注册到主容器。

结语

通过 Spring Boot 与 PF4J（特别是 SBP 框架）的结合，我们成功地将一个传统的单体应用转变为一个具备动态扩展、技术隔离、独立演进能力的插件化平台。这不仅提升了应对需求变更的敏捷性，也为大型复杂项目的分治管理提供了切实可行的路径。

插件化不是银弹，但对于需要高扩展性、多租户定制或支持第三方生态的系统而言，它无疑是构建可持续架构的关键一招。希望本文的设计思考与案例能为你在模块化架构的探索之路上提供一些启发。