概述与快速开始

XYGo Admin 2026-04-22 139 次阅读

扩展架构概述、脚手架创建、CLI命令

概述

XYGo Admin 采用物理隔离的扩展架构,扩展代码与系统核心代码完全分离:

  • 后端代码存放在 server/addons/{扩展名}/

  • 前端代码存放在 web/src/addons/{扩展名}/

  • 系统升级永远不会覆盖扩展目录

扩展通过 Go 的 init() 机制自动注册,无需修改任何核心代码即可挂载路由、注册事件。


快速开始

使用脚手架创建扩展

bash 复制代码
cd server

go run tools.go addon create

按提示输入:

| 提示 | 说明 | 示例 |

|------|------|------|

| 扩展标识 | 英文小写,全局唯一 | shop |

| 扩展名称 | 中文展示名 | 商城管理 |

| 作者 | 开发者名称 | 张三 |

| 描述 | 一句话描述 | 在线商城功能 |

| 是否有独立前台 | 双控制器模式,y/N | N |

| 示例表名 | 留空跳过,填写则生成完整 CRUD | shop_order |

关于「独立前台」选项:如果你的扩展除了平台后台管理页面之外,还需要提供独立的用户端(如租户管理端、供应商端),选择 y。脚手架会额外生成 middleware.go(自定义鉴权中间件)和双路由组的 module.go,控制器也会拆分为 AdminControllerV1(平台管理端)和 ControllerV1(扩展自身端)。大多数扩展选 N 即可。

CLI 命令

bash 复制代码
go run tools.go addon install <name>     # 安装扩展(从 ZIP)

go run tools.go addon uninstall <name>   # 卸载扩展

go run tools.go addon pack <name>        # 打包扩展为 ZIP

go run tools.go addon create             # 创建扩展骨架