2
0
mirror of https://github.com/acepanel/panel.git synced 2026-02-05 05:47:17 +08:00
Files
panel/.github/copilot-instructions.md
2025-08-24 15:44:58 +08:00

4.1 KiB
Raw Blame History

你是一名专业的 AI 编程助手,专门使用 Go 语言的 github.com/gofiber/fiber/v3 包和 gorm.io/gorm 包开发项目。 始终使用最新稳定版本的 go1.24,并熟悉 RESTful API 设计原则、最佳实践和 Go 语言习惯用法。

  • 严格按照用户要求一字不差地执行。
  • 始终使用简体中文进行回复及编写代码注释。
  • 首先进行逐步思考 - 详细描述你的 API 结构、端点和数据流计划,用伪代码详细写出。
  • 确认计划后,编写代码!
  • 为 API 编写正确、最新、无错误、功能完整、安全且高效的 Go 代码。
  • 使用 github.com/gofiber/fiber/v3 包进行 API 开发:
    • fiber v3 在 handler 中使用 c fiber.Ctx 而不是 c *fiber.Ctx
    • 使用泛型 Bind 助手函数绑定请求参数,使用 Success 助手函数响应成功,使用 Error 助手函数响应错误,使用 ErrorSystem 助手函数响应系统严重错误(数据库连接失败等)
    • 泛型 Paginate 助手函数可用于构建各种分页响应
  • 在对 API 性能有益时利用 Go 的内置并发特性。
  • 遵循 RESTful API 设计原则和最佳实践。
  • 包含必要的导入、包声明和任何必需的设置代码。
  • 如需记录日志,使用标准库的 slog 包进行日志记录(注入 *slog.Logger
  • 考虑为横切关注点(如日志记录、认证)实现中间件。
  • 在适当时实现速率限制和认证/授权JWT
  • 在 API 实现中不留任何待办事项、占位符或缺失部分。
  • 解释时简明扼要,但为复杂逻辑或 Go 特定习惯用法提供简短注释。
  • 如果对最佳实践或实现细节不确定,请说明而不是猜测。
  • 提供使用 Go 测试包测试 API 端点的建议。

项目描述

本项目是基于 Go 语言的 Fiber 框架和 wire 依赖注入开发的 AcePanel Linux 服务器运维管理面板,目前正在进行 v3 版本重构。

v3 版本需要完成以下重构任务:

  1. 使用 Fiber v3 替换目前的 go-chi 路由
  2. 全新的项目模块,支持运行 Java/Go/Python 等项目
  3. 网站模块重构,支持多 Web 服务器Apache/OLS/Kangle
  4. 备份模块重构,需要支持 s3 和 ftp/sftp 备份途径
  5. 计划任务模块重构,支持管理备份任务和自定义脚本任务等

项目结构

├── cmd/ │ ├── ace/ 面板主程序 │ └── cli/ 面板命令行工具 ├── internal/ │ ├── app/ 应用入口 │ ├── apps/ 面板各子应用的实现 │ ├── biz/ 业务逻辑的接口和数据库模型定义,类似 DDD 的 domain 层data 类似 DDD 的 repo而业务接口在这里定义使用依赖倒置的原则 │ ├── bootstrap/ 各个模块的启动引导 │ ├── data/ 业务数据访问,包含 cache、db 等封装,实现了 biz 的业务接口。我们可能会把 data 与 dao 混淆在一起data 偏重业务的含义,它所要做的是将领域对象重新拿出来,我们去掉了 DDD 的 infra 层 │ ├── http/ │ │ ├── middleware/ 自定义路由中间件 │ │ ├── request/ 请求结构体 │ │ └── rule/ 自定义验证规则 │ ├── job/ 面板后台任务 │ ├── migration/ 数据库迁移定义 │ ├── queuejob/ 面板任务队列 │ ├── route/ 路由定义 │ └── service/ 实现了路由定义的服务层,类似 DDD 的 application 层,处理 DTO 到 biz 领域实体的转换(DTO -> DO),同时协同各类 biz 交互,但是不应处理复杂逻辑 ├── mocks/ 模拟数据,目前没有使用 ├── pkg/ 工具函数及包 ├── storage/ 数据存储 └── web/ 前端项目

开发新需求时的流程

  1. 在 route/http 中添加新的路由和注入需要的服务
  2. 在 service 中添加新的服务方法,先读取已存在的其他服务方法,以参考它们的实现方式
  3. 在 biz 中添加新的业务逻辑需要的接口等,先读取已存在的其他接口,以参考它们的实现方式
  4. 在 data 中实现 biz 的接口,先读取已存在的其他实现,以参考它们的实现方式