Files
gin-vue-admin/aiDoc/examples/plugin/full-plugin-example.md
T
15e6e7685c update:发布2.9.2版本 (#2211)
* feat: 调整AI工作模式,更符合harness基准

* feat: 添加BusinessDB字段到PluginInitializeGorm结构体,并增加相关测试用例

* [middleware/jwt.go]: fix #2192 issues bug

* docs: add auto plugin design spec

* chore: ignore worktrees directory

* feat: 调整代码辅助能力至插件

* feat: 添加警告条组件,提示授权用户访问限制

* fix: 修正商业用途版权声明链接

* feat: 调整agent.md 更加节省token

* fix: 修改casbin版本为v3

* feat: 更新JSONMap和JSONSlice类型,优化GORM数据类型处理

* feat: 添加数据库就绪通知机制,优化插件注册流程

* feat: 重构API路径和描述,优化代码生成器和模板配置分组

* feat: 优化 person 页面的 css 作用域限制

* feat: 更新 vite 至 vite8

* 新增:MCP工具为指定URL的角色ID授权

* fix: 增加文件名合法性检查,拒绝包含非法字符的文件写入

* chore: 更新CI配置,升级Node.js和Go版本,调整checkout和setup动作版本

* feat: 为数据库连接增加最大复用时间配置

* feat: 为各数据库连接配置增加最大连接生命周期设置

* feat: 更新插件注册逻辑并优化API和菜单组件的标签显示

* feat: 更新版本号至v2.9.2并添加新插件路径信息

---------

Co-authored-by: taincheng <zhangtc@gmail.com>
Co-authored-by: Azir-11 <2075125282@qq.com>
Co-authored-by: lanxi <1220lanxi@gmail.com>
2026-05-11 13:48:18 +08:00

1.7 KiB

完整插件示例

这个文件负责什么

这个示例用于说明:当一个能力需要以插件方式存在时,前后端目录、初始化入口和接口组织应该如何落位。

推荐目录结构

server/plugin/order/
├── api/
│   ├── enter.go
│   └── order.go
├── config/
│   └── config.go
├── initialize/
│   ├── api.go
│   ├── gorm.go
│   ├── menu.go
│   ├── router.go
│   └── viper.go
├── model/
│   ├── order.go
│   └── request/order.go
├── router/
│   ├── enter.go
│   └── order.go
├── service/
│   ├── enter.go
│   └── order.go
└── plugin.go

web/src/plugin/order/
├── api/
│   └── order.js
├── components/
├── form/
├── view/
│   └── index.vue
└── config.js

推荐实现顺序

  1. 先定义 model 和 request
  2. 再写 service
  3. 再写 api 和 router
  4. 再补 initialize/
  5. 再补 plugin.go
  6. 最后接前端 api/view/form

为什么这样写

  • 前后端插件结构保持对称,更容易被 AI 和开发者理解
  • 初始化逻辑集中在 initialize/,避免入口文件过重
  • plugin.go 只做注册与调度,不承担业务细节

常见错误

  • 插件目录缺少 enter.go,导致聚合方式不统一
  • 后端插件已拆层,前端插件却把所有逻辑塞进一个页面
  • 插件入口和初始化逻辑耦合过深,后续难以维护

真实参考文件

  • server/plugin/announcement/plugin.go
  • server/plugin/announcement/initialize/router.go
  • server/plugin/announcement/api/enter.go
  • server/plugin/announcement/service/enter.go
  • web/src/plugin/announcement/api/info.js