# PluginSystem

**Repository Path**: inaugurator/plugin-system

## Basic Information

- **Project Name**: PluginSystem
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-05-19
- **Last Updated**: 2026-06-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Spring Boot 3 + Spring Cloud Alibaba + PF4J 插件系统演示

## 项目简介

这是一个基于 **Spring Boot 3**、**Spring Cloud Alibaba** 和 **PF4J**（Plugin Framework for Java）的插件化微服务演示项目。该项目展示了如何在 Spring Cloud 微服务架构中集成动态插件系统，实现运行时动态加载、启动、停止和卸载插件的功能。

### 核心特性

- ✅ **Spring Boot 3**：使用最新的 Spring Boot 3.x 版本
- ✅ **Spring Cloud Alibaba**：集成 Nacos 服务发现和配置中心
- ✅ **PF4J 插件框架**：支持运行时动态插件管理
- ✅ **多模块 Maven 项目**：清晰的项目结构
- ✅ **完整的 REST API**：提供插件管理和功能测试接口
- ✅ **中文注释和文档**：所有代码和文档均使用中文

## 技术栈

| 技术 | 版本 | 说明 |
|------|------|------|
| Java | 17+ | JDK 17 或更高版本 |
| Spring Boot | 3.2.0 | 应用框架 |
| Spring Cloud | 2023.0.0 | 微服务框架 |
| Spring Cloud Alibaba | 2023.0.0.0-RC1 | 阿里云微服务组件 |
| PF4J | 3.10.0 | Java 插件框架 |
| Maven | 3.6+ | 构建工具 |

## 项目结构

```
springboot-pf4j-demo/
├── pom.xml                          # 父 POM 文件
├── plugin-api/                      # 插件 API 模块
│   ├── pom.xml
│   └── src/main/java/com/example/plugin/api/
│       ├── GreetingPlugin.java      # 问候插件接口
│       └── CalculationPlugin.java   # 计算插件接口
├── sMDCService/                     # 主应用模块（插件宿主）
│   ├── pom.xml
│   └── src/main/
│       ├── java/com/example/pluginhost/
│       │   ├── PluginHostApplication.java    # 启动类
│       │   ├── config/
│       │   │   ├── Pf4jConfig.java           # PF4J 配置
│       │   │   └── PluginInitializer.java    # 插件初始化器
│       │   ├── service/
│       │   │   └── PluginManagementService.java  # 插件管理服务
│       │   └── controller/
│       │       └── PluginDemoController.java     # REST 控制器
│       └── resources/
│           └── application.yml        # 应用配置
└── plugins/                           # 插件目录
    ├── greeting-plugin/               # 正式问候插件
    │   ├── pom.xml
    │   └── src/main/java/...
    ├── casual-greeting-plugin/        # 随意问候插件
    │   ├── pom.xml
    │   └── src/main/java/...
    └── calculation-plugin/            # 标准计算插件
        ├── pom.xml
        └── src/main/java/...
```

## 快速开始

### 1. 环境要求

- JDK 17 或更高版本
- Maven 3.6 或更高版本
- （可选）Nacos Server 2.x（如需使用服务发现和配置中心）

### 2. 编译项目

在项目根目录执行：

```bash
mvn clean install
```

这将编译所有模块并生成插件 JAR 文件。

### 3. 准备插件目录

编译完成后，需要将插件 JAR 文件复制到主应用的插件目录：

```bash
# 创建插件目录
mkdir -p sMDCService/plugins

# 复制插件 JAR 文件
cp plugins/bOMC1001SMT-http-api-plugin/target/bOMC1001SMT-http-api-plugin-1.0.0.jar sMDCService/plugins/
cp plugins/bOMC1002SMT-http-api-plugin/target/bOMC1002SMT-http-api-plugin-1.0.0.jar sMDCService/plugins/
cp plugins/bOMC1003SMT-http-api-plugin/target/bOMC1003SMT-http-api-plugin-1.0.0.jar sMDCService/plugins/
```

### 4. 启动应用

进入主应用目录并启动：

```bash
cd sMDCService
mvn spring-boot:run
```

或者运行打包后的 JAR 文件：

```bash
cd sMDCService
mvn package
java -jar target/sMDCService-1.0.0.jar
```

### 5. 测试 API

应用启动后，可以通过以下 API 进行测试：

#### 5.1 获取所有插件列表

```bash
curl http://localhost:8080/api/plugins/list
```

响应示例：
```json
[
  {
    "pluginId": "greeting-plugin-formal",
    "pluginClass": "com.example.plugin.greeting.FormalGreetingPlugin",
    "version": "1.0.0",
    "provider": "Demo Team",
    "description": null,
    "state": "STARTED"
  },
  {
    "pluginId": "greeting-plugin-casual",
    "pluginClass": "com.example.plugin.greeting.CasualGreetingPlugin",
    "version": "1.0.0",
    "provider": "Demo Team",
    "description": null,
    "state": "STARTED"
  },
  {
    "pluginId": "calculation-plugin-standard",
    "pluginClass": "com.example.plugin.calculation.StandardCalculationPlugin",
    "version": "1.0.0",
    "provider": "Demo Team",
    "description": null,
    "state": "STARTED"
  }
]
```

#### 5.2 使用问候插件

**正式问候：**
```bash
curl "http://localhost:8080/api/plugins/greet?name=张三&type=formal"
```

响应：
```json
{
  "type": "formal",
  "message": "尊敬的 张三，您好！很高兴为您服务。",
  "pluginClass": "com.example.plugin.greeting.FormalGreetingPlugin$FormalGreeting"
}
```

**随意问候：**
```bash
curl "http://localhost:8080/api/plugins/greet?name=李四&type=casual"
```

响应：
```json
{
  "type": "casual",
  "message": "嘿，李四！最近怎么样？",
  "pluginClass": "com.example.plugin.greeting.CasualGreetingPlugin$CasualGreeting"
}
```

#### 5.3 使用计算插件

**加法运算：**
```bash
curl "http://localhost:8080/api/plugins/calculate/add?a=10&b=20"
```

响应：
```json
{
  "operation": "add",
  "operand1": 10,
  "operand2": 20,
  "result": 30,
  "calculator": "标准计算器"
}
```

**除法运算：**
```bash
curl "http://localhost:8080/api/plugins/calculate/divide?a=10&b=3"
```

响应：
```json
{
  "operation": "divide",
  "operand1": 10,
  "operand2": 3,
  "result": 3.3333333333,
  "calculator": "标准计算器"
}
```

#### 5.4 动态插件管理

**停止插件：**
```bash
curl -X POST http://localhost:8080/api/plugins/greeting-plugin-casual/stop
```

**启动插件：**
```bash
curl -X POST http://localhost:8080/api/plugins/greeting-plugin-casual/start
```

**重新加载插件：**
```bash
curl -X POST http://localhost:8080/api/plugins/greeting-plugin-formal/reload
```

**卸载插件：**
```bash
curl -X DELETE http://localhost:8080/api/plugins/greeting-plugin-casual
```

## 核心概念

### 1. PF4J 插件生命周期

PF4J 插件有以下状态：

- **CREATED**：插件已创建但未加载
- **LOADED**：插件已加载但未启动
- **STARTED**：插件已启动，可以使用
- **STOPPED**：插件已停止
- **RESOLVED**：插件依赖已解析
- **DISABLED**：插件被禁用

### 2. 插件扩展点

在本项目中定义了两个扩展点：

- **GreetingPlugin**：问候插件接口
  - `greet(String name)`：获取问候语
  - `getGreetingType()`：获取问候类型

- **CalculationPlugin**：计算插件接口
  - `add/subtract/multiply/divide`：四则运算
  - `getCalculatorName()`：获取计算器名称

### 3. 插件开发步骤

开发新插件的步骤：

1. 在 `plugin-api` 模块中定义扩展点接口（如果需要新的扩展点）
2. 创建新的插件模块，继承 `org.pf4j.Plugin` 类
3. 使用 `@Extension` 注解标记扩展实现
4. 在 `pom.xml` 中配置插件元数据（Plugin-Id、Plugin-Class 等）
5. 编译并将 JAR 文件放到插件目录
6. 重启应用或动态加载插件

## 与 Spring Cloud Alibaba 集成

本项目集成了 Spring Cloud Alibaba 的以下组件：

### 1. Nacos 服务发现

在 `application.yml` 中配置：

```yaml
spring:
  cloud:
    nacos:
      discovery:
        server-addr: 127.0.0.1:8848
        enabled: true  # 启用服务发现
```

启用后，应用会自动注册到 Nacos，其他微服务可以通过服务名调用此服务。

### 2. Nacos 配置中心

```yaml
spring:
  cloud:
    nacos:
      config:
        server-addr: 127.0.0.1:8848
        enabled: true  # 启用配置中心
        file-extension: yaml
```

启用后，可以从 Nacos 动态获取配置，支持配置热更新。

### 3. 插件系统与微服务的结合

在微服务架构中使用插件系统的优势：

- **动态扩展**：无需重启服务即可添加新功能
- **业务隔离**：不同业务逻辑可以封装为独立插件
- **灰度发布**：可以动态加载新版本插件进行测试
- **灵活部署**：不同实例可以加载不同的插件组合

## 常见问题

### Q1: 插件加载失败怎么办？

检查以下几点：
1. 插件 JAR 文件是否在正确的目录
2. 插件的 `pom.xml` 中是否正确配置了 Plugin-Id 和 Plugin-Class
3. 查看日志输出，确认错误信息

### Q2: 如何调试插件？

在开发阶段，可以将插件作为普通模块添加到 IDE 中进行调试。PF4J 也支持从 classpath 加载插件。

### Q3: 插件之间如何通信？

插件可以通过共享的 API 模块进行通信，也可以通过主应用的服务进行间接通信。

### Q4: 如何实现插件的热更新？

使用 `PluginManagementService.reloadPlugin()` 方法可以在不停止应用的情况下重新加载插件。

## 扩展阅读

- [PF4J 官方文档](https://pf4j.org/)
- [Spring Boot 3 官方文档](https://docs.spring.io/spring-boot/docs/3.2.0/reference/html/)
- [Spring Cloud Alibaba 官方文档](https://spring-cloud-alibaba-group.github.io/github-pages/hoxton/zh-cn/index.html)

## 许可证

本项目仅用于学习和演示目的。

## 联系方式

如有问题或建议，欢迎提出 Issue。

---

**祝您使用愉快！** 🎉