Back to Gin Vue Admin

插件开发约束

aiDoc/modules/plugin-development.md

2.9.2901 B
Original Source

插件开发约束

后端插件结构

后端插件推荐保持以下结构:

  • api/
  • config/
  • initialize/
  • model/
  • model/request/
  • router/
  • service/
  • plugin.go

前端插件结构

前端插件推荐保持以下结构:

  • api/
  • components/
  • view/
  • form/
  • config.js 或等价入口文件

插件入口约束

plugin.go 至少要承担以下职责:

  • 实现项目要求的插件接口
  • init() 中完成插件注册
  • 通过 Register 方法挂载路由
  • 通过 RouterPath 返回插件根路径

插件设计原则

  • 尽量自包含
  • 保持可配置
  • 预留扩展点
  • 与主系统保持一致的风格与约定

推荐开发流程

  1. 先明确插件边界与数据模型
  2. 先完成后端模型、服务、接口与初始化
  3. 再完成前端接口封装、页面与表单
  4. 最后完成菜单、权限、联调与测试