📚 已完成的内容
- 📂 目录结构
docs/module_plugin_course/
├── README_zh.md # 📖 教程索引(入口文档)
├── 01_QUICK_START_zh.md # 🚀 快速开始指南
├── 02_PLUGIN_DEVELOPMENT_zh.md # 🔌 插件开发教程
├── 03_BUILTIN_DEVELOPMENT_zh.md # 🏠 内置模块开发教程
├── 04_ARCHITECTURE_zh.md # 🏗️ 架构原理说明
└── create-all-test-plugins.sh # 🛠️ 自动生成脚本
- 📖 教程文档
✅ README_zh.md(12KB)
- 完整的教程导航
- 三种学习路径推荐
- 核心概念速查
- 快速开始指南
✅ 01_QUICK_START_zh.md(8KB)
- 5分钟快速上手
- 自动化脚本使用
- Plugin vs Built-in 概念
- 常见问题解答
✅ 02_PLUGIN_DEVELOPMENT_zh.md(20KB)
- FastBaseTemplate 方式(附完整代码)
- IModuleLoader 方式(附完整代码)
- 编译、打包、安装流程
- 进阶技巧和调试方法
✅ 03_BUILTIN_DEVELOPMENT_zh.md(12KB)
- Built-in 模式详解
- Plugin ↔ Built-in 转换
- 优势和适用场景
- 决策指南
✅ 04_ARCHITECTURE_zh.md(19KB)
- 模块系统架构
- 接口和基类设计
- ModuleDiscoveryService 原理
- ClassLoader 机制
- 扩展点说明
- 🛠️ 自动化脚本
✅ create-all-test-plugins.sh(16KB)
功能:
- ✅ 自动生成两种类型的示例插件
- ✅ 编译、打包、输出到 plug_dist 目录
- ✅ 生成详细的安装说明(README.txt)
生成内容:
plug_dist/
├── fastbase-plugin.jar # 4.0KB - FastBaseTemplate 示例
├── direct-plugin.jar # 5.3KB - IModuleLoader 示例
└── README.txt # 3.5KB - 安装说明
测试结果:✅ 脚本运行成功,已生成示例插件!
- 🎯 关键特性
🌟 教程亮点
- 渐进式学习:从快速开始到深入架构
- 完整示例:所有代码都可以直接运行
- 实用工具:一键生成示例插件
- 清晰对比:详细说明两种开发方式和部署模式
- 原理深入:架构设计和技术实现细节
🎨 核心理念
文档强调了一个关键概念:
Plugin 模式和 Built-in 模式本质上完全相同!
唯一区别是 JAR 文件的存放位置:
- ~/.egps2/config/plugin/ → Plugin 模式
- dependency-egps/ → Built-in 模式
代码、JAR 结构、接口实现完全一样,可以自由转换!
📊 文档统计
| 文档 |
大小 |
主要内容 |
预计阅读时间 |
| README |
12KB |
导航索引 |
10 分钟 |
| 快速开始 |
8KB |
入门指南 |
5-10 分钟 |
| 插件开发 |
20KB |
详细教程 |
30-60 分钟 |
| 内置模块 |
12KB |
部署方式 |
20-30 分钟 |
| 架构原理 |
19KB |
深入理解 |
60-90 分钟 |
| 总计 |
71KB |
完整体系 |
2-3 小时 |
🚀 使用方法
对于用户
-
快速上手:
cd /path/to/egps-main.gui
bash docs/module_plugin_course/create-all-test-plugins.sh
cp plug_dist/.jar ~/.egps2/config/plugin/
java -cp "./out/production/egps-main.gui:dependency-egps/" egps2.Launcher
-
学习教程:
从 docs/module_plugin_course/README_zh.md 开始
对于开发者
教程涵盖了:
- ✅ 两种开发方式(FastBaseTemplate vs IModuleLoader)
- ✅ 两种部署模式(Plugin vs Built-in)
- ✅ 完整的开发流程
- ✅ 架构原理和扩展点
✨ 总结
你现在拥有了:
- 📚 完整的教程体系 - 从入门到精通
- 🛠️ 自动化工具 - 快速生成示例
- 📖 详细的文档 - 代码示例和原理说明
- 🎯 清晰的指导 - Plugin vs Built-in 的本质和区别
所有文档都是中文编写,适合闭源项目的内部培训和参考!
📚 已完成的内容
docs/module_plugin_course/
├── README_zh.md # 📖 教程索引(入口文档)
├── 01_QUICK_START_zh.md # 🚀 快速开始指南
├── 02_PLUGIN_DEVELOPMENT_zh.md # 🔌 插件开发教程
├── 03_BUILTIN_DEVELOPMENT_zh.md # 🏠 内置模块开发教程
├── 04_ARCHITECTURE_zh.md # 🏗️ 架构原理说明
└── create-all-test-plugins.sh # 🛠️ 自动生成脚本
✅ README_zh.md(12KB)
✅ 01_QUICK_START_zh.md(8KB)
✅ 02_PLUGIN_DEVELOPMENT_zh.md(20KB)
✅ 03_BUILTIN_DEVELOPMENT_zh.md(12KB)
✅ 04_ARCHITECTURE_zh.md(19KB)
✅ create-all-test-plugins.sh(16KB)
功能:
生成内容:
plug_dist/
├── fastbase-plugin.jar # 4.0KB - FastBaseTemplate 示例
├── direct-plugin.jar # 5.3KB - IModuleLoader 示例
└── README.txt # 3.5KB - 安装说明
测试结果:✅ 脚本运行成功,已生成示例插件!
🌟 教程亮点
🎨 核心理念
文档强调了一个关键概念:
Plugin 模式和 Built-in 模式本质上完全相同!
唯一区别是 JAR 文件的存放位置:
- ~/.egps2/config/plugin/ → Plugin 模式
- dependency-egps/ → Built-in 模式
代码、JAR 结构、接口实现完全一样,可以自由转换!
📊 文档统计
🚀 使用方法
对于用户
快速上手:
cd /path/to/egps-main.gui
bash docs/module_plugin_course/create-all-test-plugins.sh
cp plug_dist/.jar ~/.egps2/config/plugin/
java -cp "./out/production/egps-main.gui:dependency-egps/" egps2.Launcher
学习教程:
从 docs/module_plugin_course/README_zh.md 开始
对于开发者
教程涵盖了:
✨ 总结
你现在拥有了:
所有文档都是中文编写,适合闭源项目的内部培训和参考!