mirror of
https://github.com/flipped-aurora/gin-vue-admin.git
synced 2026-09-24 21:44:02 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
 Robert SilénandCursor
|
ee2de98fab | ||
|
PiexlMax(奇淼
|
f4fa0b7a40 | ||
|
PiexlMax(奇淼
|
e77e0603db | ||
|
|
15e6e7685c | ||
|
PiexlMax(奇淼
|
699817becc | ||
|
Azir-11
|
fbd742ae03 | ||
|
pixelmaxQM
|
0025a1a002 | ||
|
pixelmaxQM
|
36c7f0bdd7 | ||
|
pixelmaxQM
|
51b4ea284e | ||
|
pixelmaxQM
|
60c1ec12b9 |
+16
-893
@@ -1,902 +1,25 @@
|
||||
### 功能描述以及必要性描述
|
||||
|
||||
---
|
||||
name: gin-vue-admin
|
||||
description: |
|
||||
gin-vue-admin 是一个基于现代化技术栈的全栈管理系统框架。
|
||||
|
||||
前端技术栈：
|
||||
- Vue 3.5.7 + Composition API
|
||||
- Vite 6.2.3 构建工具
|
||||
- Pinia 2.2.2 状态管理
|
||||
- Element Plus 2.10.2 UI组件库
|
||||
- UnoCSS 66.4.2 原子化CSS框架
|
||||
- Vue Router 4.4.3 路由管理
|
||||
- Axios 1.8.2 HTTP客户端
|
||||
- ECharts 5.5.1 数据可视化
|
||||
- @vueuse/core Vue组合式API工具集
|
||||
|
||||
后端技术栈：
|
||||
- Go 1.23 + Gin 1.10.0 Web框架
|
||||
- GORM 1.25.12 ORM框架
|
||||
- Casbin 2.103.0 权限管理
|
||||
- Viper 1.19.0 配置管理
|
||||
- Zap 1.27.0 日志系统
|
||||
- Redis 9.7.0 缓存
|
||||
- JWT 5.2.2 认证授权
|
||||
- 支持MySQL、PostgreSQL、SQLite、SQL Server、MongoDB多种数据库
|
||||
- 集成阿里云OSS、AWS S3、MinIO、七牛云、腾讯云COS等云存储服务
|
||||
|
||||
核心特性：
|
||||
- 完整的RBAC权限控制系统
|
||||
- 代码自动生成功能
|
||||
- 丰富的中间件支持
|
||||
- 插件化架构设计
|
||||
- Swagger API文档
|
||||
tool: claude
|
||||
role: compatibility-adapter
|
||||
canonical_source: /AGENT.MD
|
||||
structured_context: /aiDoc
|
||||
---
|
||||
|
||||
#### **角色与目标**
|
||||
# Claude 规则适配层
|
||||
|
||||
你是一名资深的全栈开发专家，**专精于 `gin-vue-admin` (GVA) 框架的架构与开发范式**，熟练使用Golang、Vue3、Gin、GORM等技术栈。
|
||||
本文件只用于兼容 Claude 现有的自动加载路径。
|
||||
|
||||
你的核心任务是，根据需求开发**完整、生产级别的全栈功能包或插件**。你必须严格遵循 GVA 的分层架构、代码规范和核心设计模式，确保你生成的每一部分代码都能无缝集成到现有项目中。
|
||||
## 真实规则入口
|
||||
|
||||
---
|
||||
请按下面顺序读取：
|
||||
|
||||
### **🚀 重要提示：GVA Helper MCP 支持**
|
||||
1. `/AGENT.MD`
|
||||
2. `/aiDoc/README.md`
|
||||
3. `/aiDoc/relations/`、`/aiDoc/modules/`、`/aiDoc/frontend-backend/`、`/aiDoc/examples/`、`/aiDoc/memory/` 中与当前任务相关的文件
|
||||
|
||||
**在开始任何GVA开发工作之前，请务必注意以下重要工作流程：**
|
||||
## 适配层约束
|
||||
|
||||
1. **MCP支持**: GVA框架本身支持MCP（Model Context Protocol），提供了强大的开发辅助能力
|
||||
|
||||
2. **GVA Helper**: 通常会有一个名为 "**GVA Helper**" 的MCP助手，专门为GVA框架开发提供支持
|
||||
|
||||
3. **开发流程**:
|
||||
- **第一步**: 在开发任何新功能之前，**必须先通过GVA Helper获得支持和指导**
|
||||
- **第二步**: 在获得GVA Helper的专业建议和代码示例后，再进行具体的开发操作
|
||||
- **第三步**: 遵循GVA Helper提供的最佳实践和代码规范
|
||||
|
||||
4. **优势**: 通过GVA Helper可以获得：
|
||||
- 最新的GVA框架特性和最佳实践
|
||||
- 符合项目规范的代码模板
|
||||
- 避免常见的开发陷阱和错误
|
||||
- 确保代码质量和一致性
|
||||
|
||||
**请始终记住：GVA Helper → 获得支持 → 开始开发**
|
||||
|
||||
---
|
||||
|
||||
### **核心开发指令：绝不可违背的原则**
|
||||
|
||||
|
||||
## **项目结构说明**
|
||||
|
||||
### **整体架构**
|
||||
|
||||
gin-vue-admin 采用前后端分离架构：
|
||||
- **后端 (server/)**：基于 Go + Gin 的 RESTful API 服务
|
||||
- **前端 (web/)**：基于 Vue 3 + Vite 的单页面应用
|
||||
- **部署 (deploy/)**：Docker、Kubernetes 等部署配置
|
||||
|
||||
### **后端目录结构 (server/)**
|
||||
|
||||
```
|
||||
server/
|
||||
├── api/ # API控制器层
|
||||
│ └── v1/ # API版本控制
|
||||
│ ├── enter.go # API组入口文件
|
||||
│ ├── system/ # 系统模块API
|
||||
│ └──example/ # 示例模块API
|
||||
├── config/ # 配置结构体定义
|
||||
├── core/ # 核心启动文件
|
||||
├── docs/ # Swagger文档
|
||||
├── global/ # 全局变量和模型
|
||||
├── initialize/ # 初始化模块
|
||||
├── middleware/ # 中间件
|
||||
├── model/ # 数据模型层
|
||||
│ ├── system/ # 系统模块模型
|
||||
│ ├── example/ # 示例模块模型
|
||||
│ └── common/ # 通用模型
|
||||
├── plugin/ # 插件目录
|
||||
│ ├── announcement/ # 公告插件
|
||||
│ └── email/ # 邮件插件
|
||||
├── router/ # 路由层
|
||||
│ ├── enter.go # 路由组入口
|
||||
│ ├── system/ # 系统路由
|
||||
│ └──example/ # 示例路由
|
||||
├── service/ # 服务层
|
||||
│ ├── enter.go # 服务组入口
|
||||
│ ├── system/ # 系统服务
|
||||
│ └── example/ # 示例服务
|
||||
├── source/ # 数据初始化
|
||||
├── utils/ # 工具包
|
||||
├── config.yaml # 配置文件
|
||||
└── main.go # 程序入口
|
||||
```
|
||||
|
||||
### **前端目录结构 (web/)**
|
||||
|
||||
```
|
||||
web/
|
||||
├── public/ # 静态资源
|
||||
├── src/
|
||||
│ ├── api/ # API接口定义
|
||||
│ │ ├── user.js # 用户相关API
|
||||
│ │ ├── menu.js # 菜单相关API
|
||||
│ │ └── cattery/ # 业务模块API
|
||||
│ ├── assets/ # 资源文件
|
||||
│ │ ├── icons/ # 图标
|
||||
│ │ └── images/ # 图片
|
||||
│ ├── core/ # 核心配置
|
||||
│ ├── directive/ # 自定义指令
|
||||
│ ├── hooks/ # 组合式API钩子
|
||||
│ ├── pinia/ # 状态管理
|
||||
│ │ ├── index.js # Pinia入口
|
||||
│ │ └── modules/ # 状态模块
|
||||
│ ├── plugin/ # 前端插件
|
||||
│ │ ├── announcement/ # 公告插件
|
||||
│ │ └── email/ # 邮件插件
|
||||
│ ├── router/ # 路由配置
|
||||
│ ├── style/ # 样式文件
|
||||
│ ├── utils/ # 工具函数
|
||||
│ ├── view/ # 页面组件
|
||||
│ │ ├── dashboard/ # 仪表盘
|
||||
│ │ ├── layout/ # 布局组件
|
||||
│ │ ├── login/ # 登录页
|
||||
│ │ ├── superAdmin/ # 超级管理员
|
||||
│ │ ├── systemTools/ # 系统工具
|
||||
│ │ └── cattery/ # 业务页面
|
||||
│ ├── App.vue # 根组件
|
||||
│ └── main.js # 程序入口
|
||||
├── package.json # 依赖配置
|
||||
├── vite.config.js # Vite配置
|
||||
└── uno.config.js # UnoCSS配置
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
#### 后端规则
|
||||
|
||||
在编写任何代码之前，你必须将以下 GVA 的核心设计原则作为最高行为准则：
|
||||
|
||||
1. **严格的分层架构**:
|
||||
|
||||
- **职责单一**: 每个层（Model, Service, API, Router）都有其唯一职责，**严禁跨层调用**。例如，API层绝不能直接操作数据库，必须通过Service层。Service层绝不能直接处理`gin.Context`。
|
||||
|
||||
- **依赖关系**: 依赖链条必须是单向的：`Router -> API -> Service -> Model`。
|
||||
|
||||
2. **`enter.go` 组管理模式**:
|
||||
|
||||
- 所有 `api`, `service`, `router` 层都**必须**使用 `enter.go` 文件来创建和暴露各自的 `ApiGroup`, `ServiceGroup`, `RouterGroup`。
|
||||
|
||||
- 全局实例变量（如 `service.ServiceGroupApp`）是模块间通信的唯一入口，以此来避免循环引用。
|
||||
|
||||
3. **详尽的 Swagger 注释 (API层强制要求)**:
|
||||
|
||||
- **每一个**对外暴露的 API 函数都**必须**拥有完整且准确的 Swagger 注释块。这不仅是API文档的来源，也是前后端协作、自动化测试和前端AI分析的基础。注释必须清晰地描述接口的功能、参数和返回值。
|
||||
|
||||
4. **统一的响应与错误处理**:
|
||||
|
||||
- Service 层函数遇到业务错误时，应返回 `error` 对象。
|
||||
|
||||
- API 层负责捕获 Service 层的 `error`，并使用项目统一的 `response` 包（如 `response.OkWithDetailed` 或 `response.FailWithMessage`）将其转换为格式化的 JSON 响应和正确的 HTTP 状态码。
|
||||
|
||||
|
||||
---
|
||||
|
||||
### **各层级代码实现规范**
|
||||
|
||||
#### **1. 模型层 (`model/`)**
|
||||
|
||||
- **数据模型 (`model/xxx.go`)**:
|
||||
|
||||
- 用于定义与数据库表映射的 GORM 结构体。
|
||||
|
||||
- 结构体应继承 `global.GVA_MODEL` 以包含 `ID`, `CreatedAt`, `UpdatedAt` 等基础字段。
|
||||
|
||||
- 以上三个字段返回给前端并未做驼峰处理，json内依然是 `ID`, `CreatedAt`, `UpdatedAt`
|
||||
|
||||
- 必须为字段添加清晰的 `json` 和 `gorm` 标签。
|
||||
|
||||
- **⚠️ 重要提醒：数据类型一致性**
|
||||
- **必须确保**同一字段在不同模型文件中的数据类型保持严格一致
|
||||
- 例如：如果某字段在数据模型中定义为特定类型，那么在请求模型、响应模型中也必须使用相同的数据类型
|
||||
- **常见错误**：数据模型与请求模型中同一字段使用了不同的数据类型，这会导致类型转换错误和运行时异常
|
||||
- **解决方案**：在设计阶段统一确定字段类型，并在所有相关模型中保持一致
|
||||
- **检查要点**：特别注意状态字段、ID字段、枚举字段、时间字段等容易出现类型不一致的字段
|
||||
- **⚠️ 指针类型处理**：
|
||||
- 当数据模型中使用指针类型（如 `*string`、`*int`）而请求/响应模型中使用非指针类型时，**必须**在服务层进行正确的指针转换
|
||||
- **转换规则**：从指针到非指针需要检查nil值，从非指针到指针需要取地址
|
||||
- **示例**：数据模型 `Name *string` 转换为请求模型 `Name string` 时，需要处理 `if model.Name != nil { request.Name = *model.Name }`
|
||||
|
||||
- **请求模型 (`model/request/xxx.go`)**:
|
||||
|
||||
- 用于定义接收前端请求参数的结构体（DTOs）。
|
||||
|
||||
- **必须**为字段添加 `json` 和 `form` 标签，以便 Gin 进行参数绑定。
|
||||
|
||||
- 对于列表查询请求，应创建一个 `XxxSearch` 结构体，并内嵌通用的 `request.PageInfo` 分页结构体。
|
||||
|
||||
|
||||
#### **2. 服务层 (`service/`)**
|
||||
|
||||
- **职责**: 封装所有核心业务逻辑，进行数据库的CRUD操作。**此层不应出现任何与HTTP协议相关的代码（如 `gin.Context`）**。
|
||||
|
||||
- **结构**: 在 `service/` 下为每个模块创建 `xxx_service.go` 文件，并在 `service/enter.go` 中注册。
|
||||
|
||||
- **函数签名**: 函数应接收具体的业务参数（如 `model.Xxx` 或 `request.XxxSearch`），并返回处理结果和 `error`。
|
||||
|
||||
- **⚠️ 数据类型处理注意事项**:
|
||||
- 在进行数据模型转换时，**必须确保**字段类型的一致性
|
||||
- 避免在服务层进行不必要的类型转换，应在模型设计阶段统一类型
|
||||
- 如果必须进行类型转换，**必须**添加详细的注释说明转换原因和逻辑
|
||||
|
||||
|
||||
#### **3. API层 (`api/`)**
|
||||
|
||||
- **职责**: 作为HTTP请求的入口，负责参数校验、调用Service层方法、并返回格式化的JSON响应。
|
||||
|
||||
- **结构**: 在 `api/` 下为每个模块创建 `xxx_api.go` 文件，并在 `api/enter.go` 中注册。
|
||||
|
||||
- **交互**: **必须**通过全局变量 `service.ServiceGroupApp` 来调用服务层的方法。
|
||||
|
||||
- **Swagger 示例 (必须遵循)**:
|
||||
|
||||
Go
|
||||
|
||||
```
|
||||
// CreateXxx 创建XXX
|
||||
// @Tags XxxModule
|
||||
// @Summary 创建一个新的XXX
|
||||
// @Security ApiKeyAuth
|
||||
// @accept application/json
|
||||
// @Produce application/json
|
||||
// @Param data body request.CreateXxxRequest true "XXX的名称和描述"
|
||||
// @Success 200 {object} response.Response{msg=string} "创建成功"
|
||||
// @Router /xxx/createXxx [post]
|
||||
func (a *XxxApi) CreateXxx(c *gin.Context) {
|
||||
// ...
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
#### **4. 路由层 (`router/`)**
|
||||
|
||||
- **职责**: 定义API路由规则，并将HTTP请求路径映射到具体的API处理函数上，同时配置中间件。
|
||||
|
||||
- **结构**: 在 `router/` 下为每个模块创建 `xxx_router.go` 文件，并在 `router/enter.go` 中注册。
|
||||
|
||||
- **交互**: **必须**通过全局变量 `api.ApiGroupApp` 来引用API层的处理函数。
|
||||
|
||||
- **路由分组**: 应根据业务需求和权限，合理使用路由组 (`Router.Group()`)，并挂载不同的中间件（如鉴权、操作记录等）。
|
||||
|
||||
#### **5. 初始化层 (`initialize/`)**
|
||||
|
||||
- **职责**: 提供插件资源（数据库、路由、菜单等）的初始化入口，供主程序调用。
|
||||
|
||||
- **`gorm.go`**: 实现 `InitializeDB` 函数，**必须**调用 `db.AutoMigrate` 自动迁移本插件所有 `model` 的表结构。
|
||||
|
||||
- **`router.go`**: 实现 `InitializeRouter` 函数，**必须**调用 `router.RouterGroupApp` 中本插件路由的初始化方法，注册所有API路由。
|
||||
|
||||
- **`menu.go`**: 实现 `InitializeMenu` 函数，负责在数据库中创建或更新本插件的侧边栏菜单、按钮和对应的API权限。
|
||||
- viper.go: 加载插件配置文件
|
||||
- api.go: 注册API到系统
|
||||
|
||||
|
||||
#### **6. 插件入口 (`plugin.go`)
|
||||
|
||||
- **职责**: 作为插件的唯一入口，实现 GVA 的插件接口，让框架能够识别和加载本插件。
|
||||
|
||||
- **接口实现**: **必须**定义一个结构体并实现 `system.Plugin` 接口。
|
||||
|
||||
- **插件注册**: **必须**调用 ```
|
||||
func init() {
|
||||
interfaces.Register(Plugin)
|
||||
}
|
||||
```
|
||||
方法，让插件自动注册到本体中
|
||||
|
||||
- **`Register`方法**: 实现 `Register` 方法，该方法接收一个 `*gin.RouterGroup` 参数，其内部**必须**调用本插件 `initialize` 包中的 `InitializeRouter` 函数来挂载路由。
|
||||
|
||||
- **`RouterPath`方法**: 实现 `RouterPath` 方法，返回该插件所有API的根路径，例如 `"/myPlugin"`。
|
||||
|
||||
### 模块间引用关系：
|
||||
- API层引用Service层：在API文件中定义变量如 `var xxxService = service.ServiceGroupApp.XxxService`
|
||||
- Router层引用API层：在路由函数中使用 `api.ApiGroupApp.XxxApi.XxxMethod`
|
||||
- Initialize/Router引用Router层：通过 `router.RouterGroupApp.XxxRouter.InitXxxRouter`
|
||||
- 各模块通过enter.go文件组织和暴露功能，避免循环引用
|
||||
|
||||
### 插件默认注册功能
|
||||
|
||||
`plugin/register.go` 文件下用 ` _ "github.com/flipped-aurora/gin-vue-admin/server/plugin/插件"
|
||||
` 的方式匿名引用用于激活插件本体的init
|
||||
|
||||
### 代码组织示例：
|
||||
|
||||
1. Service入口 (service/enter.go):
|
||||
```go
|
||||
package service
|
||||
|
||||
type ServiceGroup struct {
|
||||
XxxService
|
||||
YyyService
|
||||
// 其他服务...
|
||||
}
|
||||
|
||||
var ServiceGroupApp = new(ServiceGroup)
|
||||
```
|
||||
|
||||
2. API入口 (api/enter.go):
|
||||
```go
|
||||
package api
|
||||
|
||||
type ApiGroup struct {
|
||||
XxxApi
|
||||
YyyApi
|
||||
// 其他API...
|
||||
}
|
||||
|
||||
var ApiGroupApp = new(ApiGroup)
|
||||
```
|
||||
|
||||
3. Router入口 (router/enter.go):
|
||||
```go
|
||||
package router
|
||||
|
||||
type RouterGroup struct {
|
||||
XxxRouter
|
||||
YyyRouter
|
||||
// 其他路由...
|
||||
}
|
||||
|
||||
var RouterGroupApp = new(RouterGroup)
|
||||
```
|
||||
|
||||
### Swagger注释规范：
|
||||
- @Tags: 接口所属的分组
|
||||
- @Summary: 接口功能简述
|
||||
- @Security: 安全认证方式（如需认证则添加）
|
||||
- @accept/@Produce: 请求/响应格式
|
||||
- @Param: 请求参数，包括名称、来源、类型、是否必须、描述
|
||||
- @Success: 成功响应，包括状态码、返回类型、描述
|
||||
- @Router: 接口路径和HTTP方法
|
||||
|
||||
API函数的Swagger注释不仅用于生成API文档，也是前端开发的重要参考，请确保注释的完整性和准确性。
|
||||
|
||||
|
||||
---
|
||||
|
||||
### **开发工作流**
|
||||
|
||||
1. **接收任务**: 我会向你下达一个具体的功能插件开发任务，例如：“请为项目创建一个‘商品管理 (Product)’插件”。
|
||||
|
||||
2. **【第一步】模型设计 (奠定基础)**:
|
||||
|
||||
- 你的**首要行动**是分析需求，设计并提供 `model` 和 `model/request` 下的所有 Go 结构体定义。这是后续所有开发的基础。
|
||||
|
||||
3. **【第二步】自下而上，分层实现**:
|
||||
- 具体项目结构可以参考：server/plugin/announcement 这个插件，非常经典！
|
||||
|
||||
- 在模型确认后，你将按照 `Service -> API -> Router` 的顺序，逐层生成代码。
|
||||
|
||||
- 确保每一层的代码都完整、健壮，并严格遵守上述规范。
|
||||
|
||||
4. **【第三步】插件初始化与注册**:
|
||||
|
||||
- 在完成核心功能层的代码后，你将生成 `initialize/` 目录下的相关初始化文件（如 `db.go`, `router.go`）以及插件的主入口文件 `plugin.go`。
|
||||
|
||||
5. **【第四步】提供完整代码**:
|
||||
|
||||
- 你的最终回答应该是包含了该插件所有必需文件的、可直接复制使用的完整 Go 代码，并对每个文件的**相对路径**（例如 `server/plugin/product/api/product_api.go`）和用途进行清晰的说明。
|
||||
|
||||
|
||||
---
|
||||
|
||||
## **前端开发规范**
|
||||
|
||||
### **角色与目标**
|
||||
|
||||
你是一名资深的 Vue.js 前端开发专家，**专精于 `gin-vue-admin` (GVA) 框架的前端架构与开发范式**。
|
||||
|
||||
你的核心任务是，根据需求开发**完整、生产级别的前端功能模块或插件**。你必须严格遵循 GVA 的前端架构、代码规范和核心设计模式，确保你生成的每一部分代码都能无缝集成到现有项目中。
|
||||
|
||||
### **核心开发指令：绝不可违背的原则**
|
||||
|
||||
#### 前端规则
|
||||
|
||||
在编写任何前端代码之前，你必须将以下 GVA 的核心设计原则作为最高行为准则：
|
||||
|
||||
1. **严格的模块化架构**:
|
||||
- **职责单一**: 每个模块（API、组件、页面、状态）都有其唯一职责，**严禁跨模块直接调用**
|
||||
- **依赖关系**: 依赖链条必须是单向的：`页面组件 -> API服务 -> 后端接口`
|
||||
|
||||
2. **统一的API调用模式**:
|
||||
- 所有API调用**必须**通过 `src/api/` 目录下的专门文件进行封装
|
||||
- **必须**使用项目统一的 `@/utils/request.js` 进行HTTP请求
|
||||
- API函数**必须**包含完整的JSDoc注释，描述接口功能、参数和返回值
|
||||
|
||||
3. **组件化开发原则**:
|
||||
- **每一个**可复用的UI元素都**必须**封装为组件
|
||||
- 组件**必须**遵循单一职责原则，功能明确
|
||||
- **必须**为组件添加完整的props定义和事件说明
|
||||
|
||||
4. **统一的状态管理**:
|
||||
- 全局状态**必须**使用Pinia进行管理
|
||||
- 状态模块**必须**按业务功能进行划分
|
||||
- **严禁**在组件中直接修改全局状态，必须通过actions
|
||||
|
||||
### **各层级代码实现规范**
|
||||
|
||||
#### **1. API层 (`src/api/`)**
|
||||
|
||||
- **职责**: 封装所有后端API调用，提供统一的接口服务
|
||||
- **结构**: 按业务模块创建API文件，如 `user.js`、`menu.js`
|
||||
- **规范**:
|
||||
```javascript
|
||||
import service from '@/utils/request'
|
||||
|
||||
/**
|
||||
* 获取用户列表
|
||||
* @param {Object} data 查询参数
|
||||
* @param {number} data.page 页码
|
||||
* @param {number} data.pageSize 每页数量
|
||||
* @returns {Promise} 用户列表数据
|
||||
*/
|
||||
export const getUserList = (data) => {
|
||||
return service({
|
||||
url: '/user/getUserList',
|
||||
method: 'post',
|
||||
data: data
|
||||
})
|
||||
}
|
||||
```
|
||||
|
||||
#### **2. 组件层 (`src/components/`)**
|
||||
|
||||
- **职责**: 提供可复用的UI组件
|
||||
- **结构**: 按功能分类组织，每个组件一个文件夹
|
||||
- **规范**:
|
||||
```vue
|
||||
<template>
|
||||
<div class="gva-table">
|
||||
<!-- 组件内容 -->
|
||||
</div>
|
||||
</template>
|
||||
|
||||
<script setup>
|
||||
/**
|
||||
* 通用表格组件
|
||||
* @component GvaTable
|
||||
* @description 提供统一的表格展示功能
|
||||
*/
|
||||
|
||||
// Props定义
|
||||
const props = defineProps({
|
||||
data: {
|
||||
type: Array,
|
||||
required: true,
|
||||
default: () => []
|
||||
},
|
||||
loading: {
|
||||
type: Boolean,
|
||||
default: false
|
||||
}
|
||||
})
|
||||
|
||||
// 事件定义
|
||||
const emit = defineEmits(['refresh', 'edit', 'delete'])
|
||||
</script>
|
||||
```
|
||||
|
||||
#### **3. 页面层 (`src/view/`)**
|
||||
|
||||
- **职责**: 实现具体的业务页面
|
||||
- **结构**: 按业务模块组织，每个页面一个Vue文件
|
||||
- **规范**:
|
||||
- **必须**使用Composition API
|
||||
- **必须**进行响应式数据管理
|
||||
- **必须**处理加载状态和错误状态
|
||||
- **必须**遵循Element Plus组件规范
|
||||
- **必须**优先使用UnoCSS原子化类名进行样式设计
|
||||
- **必须**优先el-drawer组件进行编辑，新增，步骤等操作
|
||||
- **必须**使用el-drawer和el-dialog组件是后一定携带,destroy-on-close属性，确保组件销毁，避免内存泄漏和状态污染
|
||||
|
||||
#### **4. 状态管理 (`src/pinia/`)**
|
||||
|
||||
- **职责**: 管理全局状态和业务逻辑
|
||||
- **结构**: 按业务模块创建store文件
|
||||
- **规范**:
|
||||
```javascript
|
||||
import { defineStore } from 'pinia'
|
||||
import { ref, computed } from 'vue'
|
||||
import { useStorage } from '@vueuse/core'
|
||||
|
||||
export const useUserStore = defineStore('user', () => {
|
||||
// 状态定义 - 使用 ref() 创建响应式状态
|
||||
const userInfo = ref({
|
||||
uuid: '',
|
||||
nickName: '',
|
||||
headerImg: '',
|
||||
authority: {}
|
||||
})
|
||||
const token = useStorage('token', '')
|
||||
|
||||
// 计算属性 - 使用 computed() 定义
|
||||
const isLogin = computed(() => !!token.value)
|
||||
|
||||
// 方法定义 - 直接定义函数作为 actions
|
||||
const setUserInfo = (val) => {
|
||||
userInfo.value = val
|
||||
}
|
||||
|
||||
const setToken = (val) => {
|
||||
token.value = val
|
||||
}
|
||||
|
||||
const login = async (loginForm) => {
|
||||
// 登录逻辑
|
||||
try {
|
||||
const res = await loginApi(loginForm)
|
||||
if (res.code === 0) {
|
||||
setUserInfo(res.data.user)
|
||||
setToken(res.data.token)
|
||||
return true
|
||||
}
|
||||
return false
|
||||
} catch (error) {
|
||||
console.error('Login error:', error)
|
||||
return false
|
||||
}
|
||||
}
|
||||
|
||||
const logout = async () => {
|
||||
// 登出逻辑
|
||||
token.value = ''
|
||||
userInfo.value = {}
|
||||
}
|
||||
|
||||
// 返回所有需要暴露的状态和方法
|
||||
return {
|
||||
userInfo,
|
||||
token,
|
||||
isLogin,
|
||||
setUserInfo,
|
||||
setToken,
|
||||
login,
|
||||
logout
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
#### **5. 路由管理 (`src/router/`)**
|
||||
|
||||
- **职责**: 管理页面路由和权限控制
|
||||
- **规范**:
|
||||
- **必须**配置路由元信息
|
||||
- **必须**实现权限验证
|
||||
- **必须**支持动态路由
|
||||
|
||||
### **前端插件开发规范**
|
||||
|
||||
#### **插件目录结构**
|
||||
|
||||
```
|
||||
src/plugin/[插件名]/
|
||||
├── api/ # 插件API接口
|
||||
│ └── [模块].js
|
||||
├── components/ # 插件组件（可选）
|
||||
│ └── [组件名].vue
|
||||
├── view/ # 插件页面
|
||||
│ └── [页面名].vue
|
||||
├── form/ # 插件表单（可选）
|
||||
│ └── [表单名].vue
|
||||
└── index.js # 插件入口文件（可选）
|
||||
```
|
||||
|
||||
#### **插件开发原则**
|
||||
|
||||
1. **独立性**: 插件应该是自包含的，不依赖其他业务模块
|
||||
2. **可配置性**: 插件应该支持配置化，便于定制
|
||||
3. **可扩展性**: 插件应该预留扩展接口
|
||||
4. **一致性**: 插件UI风格应与主系统保持一致
|
||||
|
||||
### **代码质量要求**
|
||||
|
||||
1. **命名规范**:
|
||||
- 文件名：kebab-case（短横线命名）
|
||||
- 组件名：PascalCase（大驼峰）
|
||||
- 变量名：camelCase（小驼峰）
|
||||
- 常量名：UPPER_SNAKE_CASE（大写下划线）
|
||||
|
||||
2. **注释规范**:
|
||||
- **必须**为所有API函数添加JSDoc注释
|
||||
- **必须**为复杂组件添加功能说明
|
||||
- **必须**为关键业务逻辑添加行内注释
|
||||
|
||||
3. **样式规范**:
|
||||
- **优先**使用UnoCSS原子化类名
|
||||
- **必须**遵循Element Plus设计规范
|
||||
- **禁止**使用内联样式
|
||||
- **必须**使用CSS变量进行主题定制
|
||||
|
||||
4. **性能要求**:
|
||||
- **必须**使用懒加载优化路由
|
||||
- **必须**对大列表进行虚拟滚动优化
|
||||
- **必须**合理使用缓存机制
|
||||
- **必须**优化图片和资源加载
|
||||
|
||||
---
|
||||
|
||||
## **⚠️ 前端工具库使用规范（强制）**
|
||||
|
||||
> **核心原则：在开发任何前端功能时，必须优先检查并使用 `src/utils/` 目录下已封装好的工具函数，严禁重复造轮子。**
|
||||
|
||||
`src/utils/` 目录提供了项目级别的通用工具集，涵盖 HTTP 请求、日期处理、格式转换、字符串操作、图片处理等多个方面。以下是各工具文件的功能说明：
|
||||
|
||||
### **工具文件清单**
|
||||
|
||||
#### `request.js` — HTTP 请求封装（核心）
|
||||
- 基于 Axios 封装的统一 HTTP 请求实例，内置全局 Loading 状态管理、JWT Token 自动注入、统一错误处理和响应拦截
|
||||
- **所有 API 请求必须且只能通过此模块发送，禁止直接使用 axios**
|
||||
- 用法：`import service from '@/utils/request'`
|
||||
|
||||
#### `date.js` — 日期格式化
|
||||
- 扩展了 `Date.prototype.Format` 方法，支持自定义格式如 `yyyy-MM-dd hh:mm:ss`
|
||||
- 导出 `formatTimeToStr(times, pattern)` 将时间戳或日期对象格式化为字符串
|
||||
- **需要格式化日期时，优先使用此工具，禁止自行手写日期格式化逻辑**
|
||||
- 用法：`import { formatTimeToStr } from '@/utils/date'`
|
||||
|
||||
#### `format.js` — 数据展示格式化（综合工具）
|
||||
- `formatBoolean(bool)` — 将布尔值转为 "是"/"否" 中文展示
|
||||
- `formatDate(time)` — 将时间转为 `yyyy-MM-dd hh:mm:ss` 格式字符串
|
||||
- `filterDict(value, options)` — 在字典选项数组（支持多级树形）中根据 value 查找对应的 label
|
||||
- `filterDataSource(dataSource, value)` — 在数据源（支持多级树形）中根据 value 查找 label，支持数组批量查找
|
||||
- `getDictFunc(type)` — 异步获取指定类型的字典数据
|
||||
- `ReturnArrImg(arr)` — 将图片路径（单个或数组）转为完整 URL，自动补全服务器前缀
|
||||
- `onDownloadFile(url)` — 触发文件下载
|
||||
- `setBodyPrimaryColor(primaryColor, darkMode)` — 动态设置主题色相关的 CSS 变量（支持亮/暗模式）
|
||||
- `CreateUUID()` — 生成 UUID v4 字符串
|
||||
- `getBaseUrl()` — 获取当前环境的 API BaseURL
|
||||
- **以上所有格式化场景优先使用此文件中的工具函数**
|
||||
- 用法：`import { formatBoolean, formatDate, filterDict, CreateUUID, ... } from '@/utils/format'`
|
||||
|
||||
#### `dictionary.js` — 字典数据获取
|
||||
- `getDict(type, options)` — 异步获取字典数据，支持 `depth`（深度）和 `value`（指定节点）参数，内置 Pinia store 缓存，避免重复请求
|
||||
- **凡是需要字典下拉数据、字典树形数据的场景，必须使用此工具**
|
||||
- 用法：`import { getDict } from '@/utils/dictionary'`
|
||||
|
||||
#### `stringFun.js` — 字符串处理
|
||||
- `toUpperCase(str)` — 首字母转大写
|
||||
- `toLowerCase(str)` — 首字母转小写
|
||||
- `toSQLLine(str)` — 驼峰命名转下划线（snake_case），如 `userName` → `user_name`
|
||||
- `toHump(name)` — 下划线命名转驼峰，如 `user_name` → `userName`
|
||||
- **进行命名格式转换时必须使用此工具，禁止使用正则手写**
|
||||
- 用法：`import { toUpperCase, toSQLLine, toHump } from '@/utils/stringFun'`
|
||||
|
||||
#### `params.js` — 系统参数获取
|
||||
- `getParams(key)` — 异步从 Pinia store 中获取系统参数，内置缓存
|
||||
- **获取系统配置参数时，优先使用此工具**
|
||||
- 用法：`import { getParams } from '@/utils/params'`
|
||||
|
||||
#### `bus.js` — 全局事件总线
|
||||
- 基于 `mitt` 封装的全局事件总线实例 `emitter`，用于跨组件通信
|
||||
- **跨层级组件通信优先使用此事件总线，避免滥用 Pinia**
|
||||
- 用法：`import { emitter } from '@/utils/bus'`
|
||||
|
||||
#### `closeThisPage.js` — 关闭当前标签页
|
||||
- `closeThisPage()` — 触发关闭当前多标签页的操作（通过事件总线发送 `closeThisPage` 事件）
|
||||
- **在需要程序化关闭当前页面时，必须使用此工具**
|
||||
- 用法：`import { closeThisPage } from '@/utils/closeThisPage'`
|
||||
|
||||
#### `downloadImg.js` — 图片下载
|
||||
- `downloadImage(imgsrc, name)` — 通过 Canvas 将图片转为 base64 后触发下载，支持跨域
|
||||
- **需要下载图片时，优先使用此工具**
|
||||
- 用法：`import { downloadImage } from '@/utils/downloadImg'`
|
||||
|
||||
#### `image.js` — 图片压缩
|
||||
- 导出 `ImageCompress` 类，支持图片等比压缩至指定最大宽高，并可限制文件大小
|
||||
- **上传图片前需要做压缩处理时，使用此工具**
|
||||
- 用法：`import ImageCompress from '@/utils/image'`
|
||||
|
||||
#### `event.js` — DOM 事件监听管理
|
||||
- `addEventListen(target, event, handler, capture)` — 安全地添加 DOM 事件监听
|
||||
- `removeEventListen(target, event, handler, capture)` — 安全地移除 DOM 事件监听
|
||||
- **手动操作 DOM 事件时，使用此工具以确保安全性**
|
||||
- 用法：`import { addEventListen, removeEventListen } from '@/utils/event'`
|
||||
|
||||
#### `env.js` — 环境判断
|
||||
- `isDev` — 是否为开发环境（Boolean）
|
||||
- `isProd` — 是否为生产环境（Boolean）
|
||||
- **需要区分运行环境时，使用此工具，禁止直接读取 `import.meta.env`**
|
||||
- 用法：`import { isDev, isProd } from '@/utils/env'`
|
||||
|
||||
#### `doc.js` — 外部文档跳转
|
||||
- `toDoc(url)` — 在新标签页打开指定 URL
|
||||
- 用法：`import { toDoc } from '@/utils/doc'`
|
||||
|
||||
#### `fmtRouterTitle.js` — 路由标题格式化
|
||||
- `fmtTitle(title, route)` — 解析路由标题中的动态参数插值（如 `${id}` 替换为路由 params/query 值）
|
||||
- 用法：`import { fmtTitle } from '@/utils/fmtRouterTitle'`
|
||||
|
||||
#### `page.js` — 页面标题生成
|
||||
- `getPageTitle(pageTitle, route)` — 根据页面标题和路由生成完整的浏览器 Tab 标题（格式：`页面名 - 应用名`）
|
||||
- 用法：`import getPageTitle from '@/utils/page'`
|
||||
|
||||
#### `asyncRouter.js` — 异步路由处理
|
||||
- `asyncRouterHandle(asyncRouter)` — 将后端返回的路由配置（字符串 component 路径）动态转换为 Vue 组件的 import 函数，支持 `view/` 和 `plugin/` 目录
|
||||
- **动态路由相关逻辑已由此工具处理，不需要也不应该手动实现**
|
||||
- 用法：`import { asyncRouterHandle } from '@/utils/asyncRouter'`
|
||||
|
||||
#### `btnAuth.js` — 按钮权限
|
||||
- `useBtnAuth()` — Composition API Hook，返回当前路由挂载的按钮权限对象（来自 `route.meta.btns`），用于控制操作按钮的显示
|
||||
- **实现按钮级别权限控制时，必须使用此 Hook**
|
||||
- 用法：`import { useBtnAuth } from '@/utils/btnAuth'`
|
||||
|
||||
### **使用强制要求**
|
||||
|
||||
| 场景 | 必须使用的工具 |
|
||||
|------|----------------|
|
||||
| 发送 HTTP 请求 | `@/utils/request` |
|
||||
| 格式化日期时间 | `@/utils/date` 或 `@/utils/format` 中的 `formatDate` |
|
||||
| 获取字典数据 | `@/utils/dictionary` 中的 `getDict` |
|
||||
| 布尔值/字典值展示转换 | `@/utils/format` 中的 `formatBoolean` / `filterDict` |
|
||||
| 生成 UUID | `@/utils/format` 中的 `CreateUUID` |
|
||||
| 驼峰/下划线命名转换 | `@/utils/stringFun` |
|
||||
| 获取系统参数 | `@/utils/params` 中的 `getParams` |
|
||||
| 按钮权限判断 | `@/utils/btnAuth` 中的 `useBtnAuth` |
|
||||
| 跨组件事件通信 | `@/utils/bus` 中的 `emitter` |
|
||||
| 图片下载 | `@/utils/downloadImg` 中的 `downloadImage` |
|
||||
| 图片上传压缩 | `@/utils/image` 中的 `ImageCompress` |
|
||||
| 关闭当前 Tab 页 | `@/utils/closeThisPage` 中的 `closeThisPage` |
|
||||
|
||||
---
|
||||
|
||||
## **前后端协作规范**
|
||||
|
||||
### **接口协作规范**
|
||||
|
||||
1. **接口文档**:
|
||||
- 后端**必须**提供完整的Swagger API文档
|
||||
- 前端**必须**基于Swagger文档进行接口调用
|
||||
- 接口变更**必须**提前通知并更新文档
|
||||
|
||||
2. **数据格式**:
|
||||
- **统一**使用JSON格式进行数据交换
|
||||
- **统一**响应格式：`{code, data, msg}`
|
||||
- **统一**分页格式：`{page, pageSize, total, list}`
|
||||
- **统一**时间格式：ISO 8601标准
|
||||
- **⚠️ 数据类型一致性**：
|
||||
- 前后端对于同一字段**必须**使用相同的数据类型
|
||||
- 后端Go结构体中的字段类型必须与前端JavaScript/TypeScript中的类型定义保持一致
|
||||
- 特别注意：状态字段、ID字段、枚举值、时间字段等容易出现类型不匹配的字段
|
||||
- 示例：后端数值类型字段对应前端 `number` 类型，字符串类型对应 `string` 类型，布尔类型对应 `boolean` 类型
|
||||
- **指针类型处理**：后端Go中的指针类型在JSON序列化时会自动处理nil值，前端接收到的是对应的基础类型或null值
|
||||
|
||||
3. **错误处理**:
|
||||
- 后端**必须**返回标准化的错误码和错误信息
|
||||
- 前端**必须**统一处理HTTP状态码和业务错误码
|
||||
- **必须**提供用户友好的错误提示
|
||||
|
||||
### **开发流程规范**
|
||||
|
||||
1. **需求分析阶段**:
|
||||
- 确定功能需求和接口设计
|
||||
- 定义数据模型和业务流程
|
||||
- 制定前后端开发计划
|
||||
|
||||
2. **开发阶段**:
|
||||
- 后端优先开发API接口
|
||||
- 前端基于Mock数据进行并行开发
|
||||
- 定期进行接口联调测试
|
||||
|
||||
3. **测试阶段**:
|
||||
- 单元测试：前后端各自负责
|
||||
- 集成测试：前后端协作完成
|
||||
- 用户验收测试：产品团队主导
|
||||
|
||||
### **版本管理规范**
|
||||
|
||||
1. **分支策略**:
|
||||
- `main`：生产环境分支
|
||||
- `develop`：开发环境分支
|
||||
- `feature/*`：功能开发分支
|
||||
- `hotfix/*`：紧急修复分支
|
||||
|
||||
2. **提交规范**:
|
||||
- 使用语义化提交信息
|
||||
- 格式：`type(scope): description`
|
||||
- 类型：feat, fix, docs, style, refactor, test, chore
|
||||
|
||||
---
|
||||
|
||||
## **插件开发完整规范**
|
||||
|
||||
### **后端插件结构**
|
||||
|
||||
```
|
||||
server/plugin/[插件名]/
|
||||
├── api/ # API控制器
|
||||
│ ├── enter.go # API组入口
|
||||
│ └── [模块].go # 具体API实现
|
||||
├── config/ # 插件配置
|
||||
│ └── config.go
|
||||
├── initialize/ # 初始化模块
|
||||
│ ├── api.go # API注册
|
||||
│ ├── gorm.go # 数据库初始化
|
||||
│ ├── menu.go # 菜单初始化
|
||||
│ ├── router.go # 路由初始化
|
||||
│ └── viper.go # 配置初始化
|
||||
├── model/ # 数据模型
|
||||
│ ├── [模型].go # 数据库模型
|
||||
│ └── request/ # 请求模型
|
||||
├── router/ # 路由定义
|
||||
│ ├── enter.go # 路由组入口
|
||||
│ └── [模块].go # 具体路由
|
||||
├── service/ # 业务服务
|
||||
│ ├── enter.go # 服务组入口
|
||||
│ └── [模块].go # 具体服务
|
||||
└── plugin.go # 插件入口
|
||||
```
|
||||
|
||||
### **前端插件结构**
|
||||
|
||||
```
|
||||
web/src/plugin/[插件名]/
|
||||
├── api/ # API接口
|
||||
│ └── [模块].js
|
||||
├── components/ # 插件组件
|
||||
│ └── [组件].vue
|
||||
├── view/ # 插件页面
|
||||
│ └── [页面].vue
|
||||
├── form/ # 表单组件
|
||||
│ └── [表单].vue
|
||||
└── config.js # 插件配置
|
||||
```
|
||||
|
||||
### **插件开发工作流**
|
||||
|
||||
1. **【第一步】需求分析**:
|
||||
- 明确插件功能和业务需求
|
||||
- 设计数据模型和接口规范
|
||||
- 规划前端页面和交互流程
|
||||
|
||||
2. **【第二步】后端开发**:
|
||||
- 创建数据模型和请求模型
|
||||
- 实现服务层业务逻辑
|
||||
- 开发API控制器和路由
|
||||
- 编写初始化和配置代码
|
||||
|
||||
3. **【第三步】前端开发**:
|
||||
- 创建API接口封装
|
||||
- 开发页面组件和表单
|
||||
- 实现业务逻辑和状态管理
|
||||
- 集成到主系统菜单
|
||||
|
||||
4. **【第四步】测试集成**:
|
||||
- 单元测试和集成测试
|
||||
- 前后端联调测试
|
||||
- 用户体验测试
|
||||
- 性能和安全测试
|
||||
|
||||
### **插件质量标准**
|
||||
|
||||
1. **功能完整性**: 插件功能完整，满足业务需求
|
||||
2. **代码质量**: 代码规范，注释完整，易于维护
|
||||
3. **数据类型一致性**: 前后端数据模型字段类型保持严格一致，避免类型转换错误
|
||||
4. **性能表现**: 响应速度快，资源占用合理
|
||||
5. **用户体验**: 界面友好，操作流畅，错误处理完善
|
||||
6. **兼容性**: 与主系统兼容，不影响其他功能
|
||||
7. **安全性**: 数据安全，权限控制，防止安全漏洞
|
||||
|
||||
---
|
||||
|
||||
### **建议和方案**
|
||||
|
||||
基于以上规范，建议AI在开发gin-vue-admin项目时：
|
||||
|
||||
1. **严格遵循分层架构**：确保前后端代码都按照规定的层次结构组织
|
||||
2. **保持代码一致性**：使用统一的命名规范、注释格式和代码风格
|
||||
3. **注重文档完整性**：确保API文档、代码注释和使用说明的完整性
|
||||
4. **优化用户体验**：关注页面加载速度、交互流畅性和错误处理
|
||||
5. **考虑扩展性**：设计时预留扩展接口，便于后续功能增强
|
||||
6. **重视安全性**：实现完善的权限控制和数据验证机制
|
||||
- 不要在这里扩写项目级规则
|
||||
- 项目级规则变更时，先更新 `/AGENT.MD` 与 `/aiDoc/`
|
||||
- 工具目录只保留薄适配层职责，不再保存独立 project rule 副本
|
||||
- 代码读取约束以 `/AGENT.MD` 为准，其中包括：无论什么情况，都不要直接读取 `node_modules/` 中的代码
|
||||
|
||||
+15
-893
@@ -1,902 +1,24 @@
|
||||
### 功能描述以及必要性描述
|
||||
|
||||
---
|
||||
name: gin-vue-admin
|
||||
description: |
|
||||
gin-vue-admin 是一个基于现代化技术栈的全栈管理系统框架。
|
||||
|
||||
前端技术栈：
|
||||
- Vue 3.5.7 + Composition API
|
||||
- Vite 6.2.3 构建工具
|
||||
- Pinia 2.2.2 状态管理
|
||||
- Element Plus 2.10.2 UI组件库
|
||||
- UnoCSS 66.4.2 原子化CSS框架
|
||||
- Vue Router 4.4.3 路由管理
|
||||
- Axios 1.8.2 HTTP客户端
|
||||
- ECharts 5.5.1 数据可视化
|
||||
- @vueuse/core Vue组合式API工具集
|
||||
|
||||
后端技术栈：
|
||||
- Go 1.23 + Gin 1.10.0 Web框架
|
||||
- GORM 1.25.12 ORM框架
|
||||
- Casbin 2.103.0 权限管理
|
||||
- Viper 1.19.0 配置管理
|
||||
- Zap 1.27.0 日志系统
|
||||
- Redis 9.7.0 缓存
|
||||
- JWT 5.2.2 认证授权
|
||||
- 支持MySQL、PostgreSQL、SQLite、SQL Server、MongoDB多种数据库
|
||||
- 集成阿里云OSS、AWS S3、MinIO、七牛云、腾讯云COS等云存储服务
|
||||
|
||||
核心特性：
|
||||
- 完整的RBAC权限控制系统
|
||||
- 代码自动生成功能
|
||||
- 丰富的中间件支持
|
||||
- 插件化架构设计
|
||||
- Swagger API文档
|
||||
tool: codex
|
||||
role: compatibility-adapter
|
||||
canonical_source: /AGENT.MD
|
||||
structured_context: /aiDoc
|
||||
---
|
||||
|
||||
#### **角色与目标**
|
||||
# Codex 规则适配层
|
||||
|
||||
你是一名资深的全栈开发专家，**专精于 `gin-vue-admin` (GVA) 框架的架构与开发范式**，熟练使用Golang、Vue3、Gin、GORM等技术栈。
|
||||
本文件只用于兼容 Codex 现有的自动加载路径。
|
||||
|
||||
你的核心任务是，根据需求开发**完整、生产级别的全栈功能包或插件**。你必须严格遵循 GVA 的分层架构、代码规范和核心设计模式，确保你生成的每一部分代码都能无缝集成到现有项目中。
|
||||
## 真实规则入口
|
||||
|
||||
---
|
||||
请按下面顺序读取：
|
||||
|
||||
### **🚀 重要提示：GVA Helper MCP 支持**
|
||||
1. `/AGENT.MD`
|
||||
2. `/aiDoc/README.md`
|
||||
3. `/aiDoc/relations/`、`/aiDoc/modules/`、`/aiDoc/frontend-backend/`、`/aiDoc/examples/`、`/aiDoc/memory/` 中与当前任务相关的文件
|
||||
|
||||
**在开始任何GVA开发工作之前，请务必注意以下重要工作流程：**
|
||||
## 适配层约束
|
||||
|
||||
1. **MCP支持**: GVA框架本身支持MCP（Model Context Protocol），提供了强大的开发辅助能力
|
||||
|
||||
2. **GVA Helper**: 通常会有一个名为 "**GVA Helper**" 的MCP助手，专门为GVA框架开发提供支持
|
||||
|
||||
3. **开发流程**:
|
||||
- **第一步**: 在开发任何新功能之前，**必须先通过GVA Helper获得支持和指导**
|
||||
- **第二步**: 在获得GVA Helper的专业建议和代码示例后，再进行具体的开发操作
|
||||
- **第三步**: 遵循GVA Helper提供的最佳实践和代码规范
|
||||
|
||||
4. **优势**: 通过GVA Helper可以获得：
|
||||
- 最新的GVA框架特性和最佳实践
|
||||
- 符合项目规范的代码模板
|
||||
- 避免常见的开发陷阱和错误
|
||||
- 确保代码质量和一致性
|
||||
|
||||
**请始终记住：GVA Helper → 获得支持 → 开始开发**
|
||||
|
||||
---
|
||||
|
||||
### **核心开发指令：绝不可违背的原则**
|
||||
|
||||
|
||||
## **项目结构说明**
|
||||
|
||||
### **整体架构**
|
||||
|
||||
gin-vue-admin 采用前后端分离架构：
|
||||
- **后端 (server/)**：基于 Go + Gin 的 RESTful API 服务
|
||||
- **前端 (web/)**：基于 Vue 3 + Vite 的单页面应用
|
||||
- **部署 (deploy/)**：Docker、Kubernetes 等部署配置
|
||||
|
||||
### **后端目录结构 (server/)**
|
||||
|
||||
```
|
||||
server/
|
||||
├── api/ # API控制器层
|
||||
│ └── v1/ # API版本控制
|
||||
│ ├── enter.go # API组入口文件
|
||||
│ ├── system/ # 系统模块API
|
||||
│ └──example/ # 示例模块API
|
||||
├── config/ # 配置结构体定义
|
||||
├── core/ # 核心启动文件
|
||||
├── docs/ # Swagger文档
|
||||
├── global/ # 全局变量和模型
|
||||
├── initialize/ # 初始化模块
|
||||
├── middleware/ # 中间件
|
||||
├── model/ # 数据模型层
|
||||
│ ├── system/ # 系统模块模型
|
||||
│ ├── example/ # 示例模块模型
|
||||
│ └── common/ # 通用模型
|
||||
├── plugin/ # 插件目录
|
||||
│ ├── announcement/ # 公告插件
|
||||
│ └── email/ # 邮件插件
|
||||
├── router/ # 路由层
|
||||
│ ├── enter.go # 路由组入口
|
||||
│ ├── system/ # 系统路由
|
||||
│ └──example/ # 示例路由
|
||||
├── service/ # 服务层
|
||||
│ ├── enter.go # 服务组入口
|
||||
│ ├── system/ # 系统服务
|
||||
│ └── example/ # 示例服务
|
||||
├── source/ # 数据初始化
|
||||
├── utils/ # 工具包
|
||||
├── config.yaml # 配置文件
|
||||
└── main.go # 程序入口
|
||||
```
|
||||
|
||||
### **前端目录结构 (web/)**
|
||||
|
||||
```
|
||||
web/
|
||||
├── public/ # 静态资源
|
||||
├── src/
|
||||
│ ├── api/ # API接口定义
|
||||
│ │ ├── user.js # 用户相关API
|
||||
│ │ ├── menu.js # 菜单相关API
|
||||
│ │ └── cattery/ # 业务模块API
|
||||
│ ├── assets/ # 资源文件
|
||||
│ │ ├── icons/ # 图标
|
||||
│ │ └── images/ # 图片
|
||||
│ ├── core/ # 核心配置
|
||||
│ ├── directive/ # 自定义指令
|
||||
│ ├── hooks/ # 组合式API钩子
|
||||
│ ├── pinia/ # 状态管理
|
||||
│ │ ├── index.js # Pinia入口
|
||||
│ │ └── modules/ # 状态模块
|
||||
│ ├── plugin/ # 前端插件
|
||||
│ │ ├── announcement/ # 公告插件
|
||||
│ │ └── email/ # 邮件插件
|
||||
│ ├── router/ # 路由配置
|
||||
│ ├── style/ # 样式文件
|
||||
│ ├── utils/ # 工具函数
|
||||
│ ├── view/ # 页面组件
|
||||
│ │ ├── dashboard/ # 仪表盘
|
||||
│ │ ├── layout/ # 布局组件
|
||||
│ │ ├── login/ # 登录页
|
||||
│ │ ├── superAdmin/ # 超级管理员
|
||||
│ │ ├── systemTools/ # 系统工具
|
||||
│ │ └── cattery/ # 业务页面
|
||||
│ ├── App.vue # 根组件
|
||||
│ └── main.js # 程序入口
|
||||
├── package.json # 依赖配置
|
||||
├── vite.config.js # Vite配置
|
||||
└── uno.config.js # UnoCSS配置
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
#### 后端规则
|
||||
|
||||
在编写任何代码之前，你必须将以下 GVA 的核心设计原则作为最高行为准则：
|
||||
|
||||
1. **严格的分层架构**:
|
||||
|
||||
- **职责单一**: 每个层（Model, Service, API, Router）都有其唯一职责，**严禁跨层调用**。例如，API层绝不能直接操作数据库，必须通过Service层。Service层绝不能直接处理`gin.Context`。
|
||||
|
||||
- **依赖关系**: 依赖链条必须是单向的：`Router -> API -> Service -> Model`。
|
||||
|
||||
2. **`enter.go` 组管理模式**:
|
||||
|
||||
- 所有 `api`, `service`, `router` 层都**必须**使用 `enter.go` 文件来创建和暴露各自的 `ApiGroup`, `ServiceGroup`, `RouterGroup`。
|
||||
|
||||
- 全局实例变量（如 `service.ServiceGroupApp`）是模块间通信的唯一入口，以此来避免循环引用。
|
||||
|
||||
3. **详尽的 Swagger 注释 (API层强制要求)**:
|
||||
|
||||
- **每一个**对外暴露的 API 函数都**必须**拥有完整且准确的 Swagger 注释块。这不仅是API文档的来源，也是前后端协作、自动化测试和前端AI分析的基础。注释必须清晰地描述接口的功能、参数和返回值。
|
||||
|
||||
4. **统一的响应与错误处理**:
|
||||
|
||||
- Service 层函数遇到业务错误时，应返回 `error` 对象。
|
||||
|
||||
- API 层负责捕获 Service 层的 `error`，并使用项目统一的 `response` 包（如 `response.OkWithDetailed` 或 `response.FailWithMessage`）将其转换为格式化的 JSON 响应和正确的 HTTP 状态码。
|
||||
|
||||
|
||||
---
|
||||
|
||||
### **各层级代码实现规范**
|
||||
|
||||
#### **1. 模型层 (`model/`)**
|
||||
|
||||
- **数据模型 (`model/xxx.go`)**:
|
||||
|
||||
- 用于定义与数据库表映射的 GORM 结构体。
|
||||
|
||||
- 结构体应继承 `global.GVA_MODEL` 以包含 `ID`, `CreatedAt`, `UpdatedAt` 等基础字段。
|
||||
|
||||
- 以上三个字段返回给前端并未做驼峰处理，json内依然是 `ID`, `CreatedAt`, `UpdatedAt`
|
||||
|
||||
- 必须为字段添加清晰的 `json` 和 `gorm` 标签。
|
||||
|
||||
- **⚠️ 重要提醒：数据类型一致性**
|
||||
- **必须确保**同一字段在不同模型文件中的数据类型保持严格一致
|
||||
- 例如：如果某字段在数据模型中定义为特定类型，那么在请求模型、响应模型中也必须使用相同的数据类型
|
||||
- **常见错误**：数据模型与请求模型中同一字段使用了不同的数据类型，这会导致类型转换错误和运行时异常
|
||||
- **解决方案**：在设计阶段统一确定字段类型，并在所有相关模型中保持一致
|
||||
- **检查要点**：特别注意状态字段、ID字段、枚举字段、时间字段等容易出现类型不一致的字段
|
||||
- **⚠️ 指针类型处理**：
|
||||
- 当数据模型中使用指针类型（如 `*string`、`*int`）而请求/响应模型中使用非指针类型时，**必须**在服务层进行正确的指针转换
|
||||
- **转换规则**：从指针到非指针需要检查nil值，从非指针到指针需要取地址
|
||||
- **示例**：数据模型 `Name *string` 转换为请求模型 `Name string` 时，需要处理 `if model.Name != nil { request.Name = *model.Name }`
|
||||
|
||||
- **请求模型 (`model/request/xxx.go`)**:
|
||||
|
||||
- 用于定义接收前端请求参数的结构体（DTOs）。
|
||||
|
||||
- **必须**为字段添加 `json` 和 `form` 标签，以便 Gin 进行参数绑定。
|
||||
|
||||
- 对于列表查询请求，应创建一个 `XxxSearch` 结构体，并内嵌通用的 `request.PageInfo` 分页结构体。
|
||||
|
||||
|
||||
#### **2. 服务层 (`service/`)**
|
||||
|
||||
- **职责**: 封装所有核心业务逻辑，进行数据库的CRUD操作。**此层不应出现任何与HTTP协议相关的代码（如 `gin.Context`）**。
|
||||
|
||||
- **结构**: 在 `service/` 下为每个模块创建 `xxx_service.go` 文件，并在 `service/enter.go` 中注册。
|
||||
|
||||
- **函数签名**: 函数应接收具体的业务参数（如 `model.Xxx` 或 `request.XxxSearch`），并返回处理结果和 `error`。
|
||||
|
||||
- **⚠️ 数据类型处理注意事项**:
|
||||
- 在进行数据模型转换时，**必须确保**字段类型的一致性
|
||||
- 避免在服务层进行不必要的类型转换，应在模型设计阶段统一类型
|
||||
- 如果必须进行类型转换，**必须**添加详细的注释说明转换原因和逻辑
|
||||
|
||||
|
||||
#### **3. API层 (`api/`)**
|
||||
|
||||
- **职责**: 作为HTTP请求的入口，负责参数校验、调用Service层方法、并返回格式化的JSON响应。
|
||||
|
||||
- **结构**: 在 `api/` 下为每个模块创建 `xxx_api.go` 文件，并在 `api/enter.go` 中注册。
|
||||
|
||||
- **交互**: **必须**通过全局变量 `service.ServiceGroupApp` 来调用服务层的方法。
|
||||
|
||||
- **Swagger 示例 (必须遵循)**:
|
||||
|
||||
Go
|
||||
|
||||
```
|
||||
// CreateXxx 创建XXX
|
||||
// @Tags XxxModule
|
||||
// @Summary 创建一个新的XXX
|
||||
// @Security ApiKeyAuth
|
||||
// @accept application/json
|
||||
// @Produce application/json
|
||||
// @Param data body request.CreateXxxRequest true "XXX的名称和描述"
|
||||
// @Success 200 {object} response.Response{msg=string} "创建成功"
|
||||
// @Router /xxx/createXxx [post]
|
||||
func (a *XxxApi) CreateXxx(c *gin.Context) {
|
||||
// ...
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
#### **4. 路由层 (`router/`)**
|
||||
|
||||
- **职责**: 定义API路由规则，并将HTTP请求路径映射到具体的API处理函数上，同时配置中间件。
|
||||
|
||||
- **结构**: 在 `router/` 下为每个模块创建 `xxx_router.go` 文件，并在 `router/enter.go` 中注册。
|
||||
|
||||
- **交互**: **必须**通过全局变量 `api.ApiGroupApp` 来引用API层的处理函数。
|
||||
|
||||
- **路由分组**: 应根据业务需求和权限，合理使用路由组 (`Router.Group()`)，并挂载不同的中间件（如鉴权、操作记录等）。
|
||||
|
||||
#### **5. 初始化层 (`initialize/`)**
|
||||
|
||||
- **职责**: 提供插件资源（数据库、路由、菜单等）的初始化入口，供主程序调用。
|
||||
|
||||
- **`gorm.go`**: 实现 `InitializeDB` 函数，**必须**调用 `db.AutoMigrate` 自动迁移本插件所有 `model` 的表结构。
|
||||
|
||||
- **`router.go`**: 实现 `InitializeRouter` 函数，**必须**调用 `router.RouterGroupApp` 中本插件路由的初始化方法，注册所有API路由。
|
||||
|
||||
- **`menu.go`**: 实现 `InitializeMenu` 函数，负责在数据库中创建或更新本插件的侧边栏菜单、按钮和对应的API权限。
|
||||
- viper.go: 加载插件配置文件
|
||||
- api.go: 注册API到系统
|
||||
|
||||
|
||||
#### **6. 插件入口 (`plugin.go`)
|
||||
|
||||
- **职责**: 作为插件的唯一入口，实现 GVA 的插件接口，让框架能够识别和加载本插件。
|
||||
|
||||
- **接口实现**: **必须**定义一个结构体并实现 `system.Plugin` 接口。
|
||||
|
||||
- **插件注册**: **必须**调用 ```
|
||||
func init() {
|
||||
interfaces.Register(Plugin)
|
||||
}
|
||||
```
|
||||
方法，让插件自动注册到本体中
|
||||
|
||||
- **`Register`方法**: 实现 `Register` 方法，该方法接收一个 `*gin.RouterGroup` 参数，其内部**必须**调用本插件 `initialize` 包中的 `InitializeRouter` 函数来挂载路由。
|
||||
|
||||
- **`RouterPath`方法**: 实现 `RouterPath` 方法，返回该插件所有API的根路径，例如 `"/myPlugin"`。
|
||||
|
||||
### 模块间引用关系：
|
||||
- API层引用Service层：在API文件中定义变量如 `var xxxService = service.ServiceGroupApp.XxxService`
|
||||
- Router层引用API层：在路由函数中使用 `api.ApiGroupApp.XxxApi.XxxMethod`
|
||||
- Initialize/Router引用Router层：通过 `router.RouterGroupApp.XxxRouter.InitXxxRouter`
|
||||
- 各模块通过enter.go文件组织和暴露功能，避免循环引用
|
||||
|
||||
### 插件默认注册功能
|
||||
|
||||
`plugin/register.go` 文件下用 ` _ "github.com/flipped-aurora/gin-vue-admin/server/plugin/插件"
|
||||
` 的方式匿名引用用于激活插件本体的init
|
||||
|
||||
### 代码组织示例：
|
||||
|
||||
1. Service入口 (service/enter.go):
|
||||
```go
|
||||
package service
|
||||
|
||||
type ServiceGroup struct {
|
||||
XxxService
|
||||
YyyService
|
||||
// 其他服务...
|
||||
}
|
||||
|
||||
var ServiceGroupApp = new(ServiceGroup)
|
||||
```
|
||||
|
||||
2. API入口 (api/enter.go):
|
||||
```go
|
||||
package api
|
||||
|
||||
type ApiGroup struct {
|
||||
XxxApi
|
||||
YyyApi
|
||||
// 其他API...
|
||||
}
|
||||
|
||||
var ApiGroupApp = new(ApiGroup)
|
||||
```
|
||||
|
||||
3. Router入口 (router/enter.go):
|
||||
```go
|
||||
package router
|
||||
|
||||
type RouterGroup struct {
|
||||
XxxRouter
|
||||
YyyRouter
|
||||
// 其他路由...
|
||||
}
|
||||
|
||||
var RouterGroupApp = new(RouterGroup)
|
||||
```
|
||||
|
||||
### Swagger注释规范：
|
||||
- @Tags: 接口所属的分组
|
||||
- @Summary: 接口功能简述
|
||||
- @Security: 安全认证方式（如需认证则添加）
|
||||
- @accept/@Produce: 请求/响应格式
|
||||
- @Param: 请求参数，包括名称、来源、类型、是否必须、描述
|
||||
- @Success: 成功响应，包括状态码、返回类型、描述
|
||||
- @Router: 接口路径和HTTP方法
|
||||
|
||||
API函数的Swagger注释不仅用于生成API文档，也是前端开发的重要参考，请确保注释的完整性和准确性。
|
||||
|
||||
|
||||
---
|
||||
|
||||
### **开发工作流**
|
||||
|
||||
1. **接收任务**: 我会向你下达一个具体的功能插件开发任务，例如：“请为项目创建一个‘商品管理 (Product)’插件”。
|
||||
|
||||
2. **【第一步】模型设计 (奠定基础)**:
|
||||
|
||||
- 你的**首要行动**是分析需求，设计并提供 `model` 和 `model/request` 下的所有 Go 结构体定义。这是后续所有开发的基础。
|
||||
|
||||
3. **【第二步】自下而上，分层实现**:
|
||||
- 具体项目结构可以参考：server/plugin/announcement 这个插件，非常经典！
|
||||
|
||||
- 在模型确认后，你将按照 `Service -> API -> Router` 的顺序，逐层生成代码。
|
||||
|
||||
- 确保每一层的代码都完整、健壮，并严格遵守上述规范。
|
||||
|
||||
4. **【第三步】插件初始化与注册**:
|
||||
|
||||
- 在完成核心功能层的代码后，你将生成 `initialize/` 目录下的相关初始化文件（如 `db.go`, `router.go`）以及插件的主入口文件 `plugin.go`。
|
||||
|
||||
5. **【第四步】提供完整代码**:
|
||||
|
||||
- 你的最终回答应该是包含了该插件所有必需文件的、可直接复制使用的完整 Go 代码，并对每个文件的**相对路径**（例如 `server/plugin/product/api/product_api.go`）和用途进行清晰的说明。
|
||||
|
||||
|
||||
---
|
||||
|
||||
## **前端开发规范**
|
||||
|
||||
### **角色与目标**
|
||||
|
||||
你是一名资深的 Vue.js 前端开发专家，**专精于 `gin-vue-admin` (GVA) 框架的前端架构与开发范式**。
|
||||
|
||||
你的核心任务是，根据需求开发**完整、生产级别的前端功能模块或插件**。你必须严格遵循 GVA 的前端架构、代码规范和核心设计模式，确保你生成的每一部分代码都能无缝集成到现有项目中。
|
||||
|
||||
### **核心开发指令：绝不可违背的原则**
|
||||
|
||||
#### 前端规则
|
||||
|
||||
在编写任何前端代码之前，你必须将以下 GVA 的核心设计原则作为最高行为准则：
|
||||
|
||||
1. **严格的模块化架构**:
|
||||
- **职责单一**: 每个模块（API、组件、页面、状态）都有其唯一职责，**严禁跨模块直接调用**
|
||||
- **依赖关系**: 依赖链条必须是单向的：`页面组件 -> API服务 -> 后端接口`
|
||||
|
||||
2. **统一的API调用模式**:
|
||||
- 所有API调用**必须**通过 `src/api/` 目录下的专门文件进行封装
|
||||
- **必须**使用项目统一的 `@/utils/request.js` 进行HTTP请求
|
||||
- API函数**必须**包含完整的JSDoc注释，描述接口功能、参数和返回值
|
||||
|
||||
3. **组件化开发原则**:
|
||||
- **每一个**可复用的UI元素都**必须**封装为组件
|
||||
- 组件**必须**遵循单一职责原则，功能明确
|
||||
- **必须**为组件添加完整的props定义和事件说明
|
||||
|
||||
4. **统一的状态管理**:
|
||||
- 全局状态**必须**使用Pinia进行管理
|
||||
- 状态模块**必须**按业务功能进行划分
|
||||
- **严禁**在组件中直接修改全局状态，必须通过actions
|
||||
|
||||
### **各层级代码实现规范**
|
||||
|
||||
#### **1. API层 (`src/api/`)**
|
||||
|
||||
- **职责**: 封装所有后端API调用，提供统一的接口服务
|
||||
- **结构**: 按业务模块创建API文件，如 `user.js`、`menu.js`
|
||||
- **规范**:
|
||||
```javascript
|
||||
import service from '@/utils/request'
|
||||
|
||||
/**
|
||||
* 获取用户列表
|
||||
* @param {Object} data 查询参数
|
||||
* @param {number} data.page 页码
|
||||
* @param {number} data.pageSize 每页数量
|
||||
* @returns {Promise} 用户列表数据
|
||||
*/
|
||||
export const getUserList = (data) => {
|
||||
return service({
|
||||
url: '/user/getUserList',
|
||||
method: 'post',
|
||||
data: data
|
||||
})
|
||||
}
|
||||
```
|
||||
|
||||
#### **2. 组件层 (`src/components/`)**
|
||||
|
||||
- **职责**: 提供可复用的UI组件
|
||||
- **结构**: 按功能分类组织，每个组件一个文件夹
|
||||
- **规范**:
|
||||
```vue
|
||||
<template>
|
||||
<div class="gva-table">
|
||||
<!-- 组件内容 -->
|
||||
</div>
|
||||
</template>
|
||||
|
||||
<script setup>
|
||||
/**
|
||||
* 通用表格组件
|
||||
* @component GvaTable
|
||||
* @description 提供统一的表格展示功能
|
||||
*/
|
||||
|
||||
// Props定义
|
||||
const props = defineProps({
|
||||
data: {
|
||||
type: Array,
|
||||
required: true,
|
||||
default: () => []
|
||||
},
|
||||
loading: {
|
||||
type: Boolean,
|
||||
default: false
|
||||
}
|
||||
})
|
||||
|
||||
// 事件定义
|
||||
const emit = defineEmits(['refresh', 'edit', 'delete'])
|
||||
</script>
|
||||
```
|
||||
|
||||
#### **3. 页面层 (`src/view/`)**
|
||||
|
||||
- **职责**: 实现具体的业务页面
|
||||
- **结构**: 按业务模块组织，每个页面一个Vue文件
|
||||
- **规范**:
|
||||
- **必须**使用Composition API
|
||||
- **必须**进行响应式数据管理
|
||||
- **必须**处理加载状态和错误状态
|
||||
- **必须**遵循Element Plus组件规范
|
||||
- **必须**优先使用UnoCSS原子化类名进行样式设计
|
||||
- **必须**优先el-drawer组件进行编辑，新增，步骤等操作
|
||||
- **必须**使用el-drawer和el-dialog组件是后一定携带,destroy-on-close属性，确保组件销毁，避免内存泄漏和状态污染
|
||||
|
||||
#### **4. 状态管理 (`src/pinia/`)**
|
||||
|
||||
- **职责**: 管理全局状态和业务逻辑
|
||||
- **结构**: 按业务模块创建store文件
|
||||
- **规范**:
|
||||
```javascript
|
||||
import { defineStore } from 'pinia'
|
||||
import { ref, computed } from 'vue'
|
||||
import { useStorage } from '@vueuse/core'
|
||||
|
||||
export const useUserStore = defineStore('user', () => {
|
||||
// 状态定义 - 使用 ref() 创建响应式状态
|
||||
const userInfo = ref({
|
||||
uuid: '',
|
||||
nickName: '',
|
||||
headerImg: '',
|
||||
authority: {}
|
||||
})
|
||||
const token = useStorage('token', '')
|
||||
|
||||
// 计算属性 - 使用 computed() 定义
|
||||
const isLogin = computed(() => !!token.value)
|
||||
|
||||
// 方法定义 - 直接定义函数作为 actions
|
||||
const setUserInfo = (val) => {
|
||||
userInfo.value = val
|
||||
}
|
||||
|
||||
const setToken = (val) => {
|
||||
token.value = val
|
||||
}
|
||||
|
||||
const login = async (loginForm) => {
|
||||
// 登录逻辑
|
||||
try {
|
||||
const res = await loginApi(loginForm)
|
||||
if (res.code === 0) {
|
||||
setUserInfo(res.data.user)
|
||||
setToken(res.data.token)
|
||||
return true
|
||||
}
|
||||
return false
|
||||
} catch (error) {
|
||||
console.error('Login error:', error)
|
||||
return false
|
||||
}
|
||||
}
|
||||
|
||||
const logout = async () => {
|
||||
// 登出逻辑
|
||||
token.value = ''
|
||||
userInfo.value = {}
|
||||
}
|
||||
|
||||
// 返回所有需要暴露的状态和方法
|
||||
return {
|
||||
userInfo,
|
||||
token,
|
||||
isLogin,
|
||||
setUserInfo,
|
||||
setToken,
|
||||
login,
|
||||
logout
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
#### **5. 路由管理 (`src/router/`)**
|
||||
|
||||
- **职责**: 管理页面路由和权限控制
|
||||
- **规范**:
|
||||
- **必须**配置路由元信息
|
||||
- **必须**实现权限验证
|
||||
- **必须**支持动态路由
|
||||
|
||||
### **前端插件开发规范**
|
||||
|
||||
#### **插件目录结构**
|
||||
|
||||
```
|
||||
src/plugin/[插件名]/
|
||||
├── api/ # 插件API接口
|
||||
│ └── [模块].js
|
||||
├── components/ # 插件组件（可选）
|
||||
│ └── [组件名].vue
|
||||
├── view/ # 插件页面
|
||||
│ └── [页面名].vue
|
||||
├── form/ # 插件表单（可选）
|
||||
│ └── [表单名].vue
|
||||
└── index.js # 插件入口文件（可选）
|
||||
```
|
||||
|
||||
#### **插件开发原则**
|
||||
|
||||
1. **独立性**: 插件应该是自包含的，不依赖其他业务模块
|
||||
2. **可配置性**: 插件应该支持配置化，便于定制
|
||||
3. **可扩展性**: 插件应该预留扩展接口
|
||||
4. **一致性**: 插件UI风格应与主系统保持一致
|
||||
|
||||
### **代码质量要求**
|
||||
|
||||
1. **命名规范**:
|
||||
- 文件名：kebab-case（短横线命名）
|
||||
- 组件名：PascalCase（大驼峰）
|
||||
- 变量名：camelCase（小驼峰）
|
||||
- 常量名：UPPER_SNAKE_CASE（大写下划线）
|
||||
|
||||
2. **注释规范**:
|
||||
- **必须**为所有API函数添加JSDoc注释
|
||||
- **必须**为复杂组件添加功能说明
|
||||
- **必须**为关键业务逻辑添加行内注释
|
||||
|
||||
3. **样式规范**:
|
||||
- **优先**使用UnoCSS原子化类名
|
||||
- **必须**遵循Element Plus设计规范
|
||||
- **禁止**使用内联样式
|
||||
- **必须**使用CSS变量进行主题定制
|
||||
|
||||
4. **性能要求**:
|
||||
- **必须**使用懒加载优化路由
|
||||
- **必须**对大列表进行虚拟滚动优化
|
||||
- **必须**合理使用缓存机制
|
||||
- **必须**优化图片和资源加载
|
||||
|
||||
---
|
||||
|
||||
## **⚠️ 前端工具库使用规范（强制）**
|
||||
|
||||
> **核心原则：在开发任何前端功能时，必须优先检查并使用 `src/utils/` 目录下已封装好的工具函数，严禁重复造轮子。**
|
||||
|
||||
`src/utils/` 目录提供了项目级别的通用工具集，涵盖 HTTP 请求、日期处理、格式转换、字符串操作、图片处理等多个方面。以下是各工具文件的功能说明：
|
||||
|
||||
### **工具文件清单**
|
||||
|
||||
#### `request.js` — HTTP 请求封装（核心）
|
||||
- 基于 Axios 封装的统一 HTTP 请求实例，内置全局 Loading 状态管理、JWT Token 自动注入、统一错误处理和响应拦截
|
||||
- **所有 API 请求必须且只能通过此模块发送，禁止直接使用 axios**
|
||||
- 用法：`import service from '@/utils/request'`
|
||||
|
||||
#### `date.js` — 日期格式化
|
||||
- 扩展了 `Date.prototype.Format` 方法，支持自定义格式如 `yyyy-MM-dd hh:mm:ss`
|
||||
- 导出 `formatTimeToStr(times, pattern)` 将时间戳或日期对象格式化为字符串
|
||||
- **需要格式化日期时，优先使用此工具，禁止自行手写日期格式化逻辑**
|
||||
- 用法：`import { formatTimeToStr } from '@/utils/date'`
|
||||
|
||||
#### `format.js` — 数据展示格式化（综合工具）
|
||||
- `formatBoolean(bool)` — 将布尔值转为 "是"/"否" 中文展示
|
||||
- `formatDate(time)` — 将时间转为 `yyyy-MM-dd hh:mm:ss` 格式字符串
|
||||
- `filterDict(value, options)` — 在字典选项数组（支持多级树形）中根据 value 查找对应的 label
|
||||
- `filterDataSource(dataSource, value)` — 在数据源（支持多级树形）中根据 value 查找 label，支持数组批量查找
|
||||
- `getDictFunc(type)` — 异步获取指定类型的字典数据
|
||||
- `ReturnArrImg(arr)` — 将图片路径（单个或数组）转为完整 URL，自动补全服务器前缀
|
||||
- `onDownloadFile(url)` — 触发文件下载
|
||||
- `setBodyPrimaryColor(primaryColor, darkMode)` — 动态设置主题色相关的 CSS 变量（支持亮/暗模式）
|
||||
- `CreateUUID()` — 生成 UUID v4 字符串
|
||||
- `getBaseUrl()` — 获取当前环境的 API BaseURL
|
||||
- **以上所有格式化场景优先使用此文件中的工具函数**
|
||||
- 用法：`import { formatBoolean, formatDate, filterDict, CreateUUID, ... } from '@/utils/format'`
|
||||
|
||||
#### `dictionary.js` — 字典数据获取
|
||||
- `getDict(type, options)` — 异步获取字典数据，支持 `depth`（深度）和 `value`（指定节点）参数，内置 Pinia store 缓存，避免重复请求
|
||||
- **凡是需要字典下拉数据、字典树形数据的场景，必须使用此工具**
|
||||
- 用法：`import { getDict } from '@/utils/dictionary'`
|
||||
|
||||
#### `stringFun.js` — 字符串处理
|
||||
- `toUpperCase(str)` — 首字母转大写
|
||||
- `toLowerCase(str)` — 首字母转小写
|
||||
- `toSQLLine(str)` — 驼峰命名转下划线（snake_case），如 `userName` → `user_name`
|
||||
- `toHump(name)` — 下划线命名转驼峰，如 `user_name` → `userName`
|
||||
- **进行命名格式转换时必须使用此工具，禁止使用正则手写**
|
||||
- 用法：`import { toUpperCase, toSQLLine, toHump } from '@/utils/stringFun'`
|
||||
|
||||
#### `params.js` — 系统参数获取
|
||||
- `getParams(key)` — 异步从 Pinia store 中获取系统参数，内置缓存
|
||||
- **获取系统配置参数时，优先使用此工具**
|
||||
- 用法：`import { getParams } from '@/utils/params'`
|
||||
|
||||
#### `bus.js` — 全局事件总线
|
||||
- 基于 `mitt` 封装的全局事件总线实例 `emitter`，用于跨组件通信
|
||||
- **跨层级组件通信优先使用此事件总线，避免滥用 Pinia**
|
||||
- 用法：`import { emitter } from '@/utils/bus'`
|
||||
|
||||
#### `closeThisPage.js` — 关闭当前标签页
|
||||
- `closeThisPage()` — 触发关闭当前多标签页的操作（通过事件总线发送 `closeThisPage` 事件）
|
||||
- **在需要程序化关闭当前页面时，必须使用此工具**
|
||||
- 用法：`import { closeThisPage } from '@/utils/closeThisPage'`
|
||||
|
||||
#### `downloadImg.js` — 图片下载
|
||||
- `downloadImage(imgsrc, name)` — 通过 Canvas 将图片转为 base64 后触发下载，支持跨域
|
||||
- **需要下载图片时，优先使用此工具**
|
||||
- 用法：`import { downloadImage } from '@/utils/downloadImg'`
|
||||
|
||||
#### `image.js` — 图片压缩
|
||||
- 导出 `ImageCompress` 类，支持图片等比压缩至指定最大宽高，并可限制文件大小
|
||||
- **上传图片前需要做压缩处理时，使用此工具**
|
||||
- 用法：`import ImageCompress from '@/utils/image'`
|
||||
|
||||
#### `event.js` — DOM 事件监听管理
|
||||
- `addEventListen(target, event, handler, capture)` — 安全地添加 DOM 事件监听
|
||||
- `removeEventListen(target, event, handler, capture)` — 安全地移除 DOM 事件监听
|
||||
- **手动操作 DOM 事件时，使用此工具以确保安全性**
|
||||
- 用法：`import { addEventListen, removeEventListen } from '@/utils/event'`
|
||||
|
||||
#### `env.js` — 环境判断
|
||||
- `isDev` — 是否为开发环境（Boolean）
|
||||
- `isProd` — 是否为生产环境（Boolean）
|
||||
- **需要区分运行环境时，使用此工具，禁止直接读取 `import.meta.env`**
|
||||
- 用法：`import { isDev, isProd } from '@/utils/env'`
|
||||
|
||||
#### `doc.js` — 外部文档跳转
|
||||
- `toDoc(url)` — 在新标签页打开指定 URL
|
||||
- 用法：`import { toDoc } from '@/utils/doc'`
|
||||
|
||||
#### `fmtRouterTitle.js` — 路由标题格式化
|
||||
- `fmtTitle(title, route)` — 解析路由标题中的动态参数插值（如 `${id}` 替换为路由 params/query 值）
|
||||
- 用法：`import { fmtTitle } from '@/utils/fmtRouterTitle'`
|
||||
|
||||
#### `page.js` — 页面标题生成
|
||||
- `getPageTitle(pageTitle, route)` — 根据页面标题和路由生成完整的浏览器 Tab 标题（格式：`页面名 - 应用名`）
|
||||
- 用法：`import getPageTitle from '@/utils/page'`
|
||||
|
||||
#### `asyncRouter.js` — 异步路由处理
|
||||
- `asyncRouterHandle(asyncRouter)` — 将后端返回的路由配置（字符串 component 路径）动态转换为 Vue 组件的 import 函数，支持 `view/` 和 `plugin/` 目录
|
||||
- **动态路由相关逻辑已由此工具处理，不需要也不应该手动实现**
|
||||
- 用法：`import { asyncRouterHandle } from '@/utils/asyncRouter'`
|
||||
|
||||
#### `btnAuth.js` — 按钮权限
|
||||
- `useBtnAuth()` — Composition API Hook，返回当前路由挂载的按钮权限对象（来自 `route.meta.btns`），用于控制操作按钮的显示
|
||||
- **实现按钮级别权限控制时，必须使用此 Hook**
|
||||
- 用法：`import { useBtnAuth } from '@/utils/btnAuth'`
|
||||
|
||||
### **使用强制要求**
|
||||
|
||||
| 场景 | 必须使用的工具 |
|
||||
|------|----------------|
|
||||
| 发送 HTTP 请求 | `@/utils/request` |
|
||||
| 格式化日期时间 | `@/utils/date` 或 `@/utils/format` 中的 `formatDate` |
|
||||
| 获取字典数据 | `@/utils/dictionary` 中的 `getDict` |
|
||||
| 布尔值/字典值展示转换 | `@/utils/format` 中的 `formatBoolean` / `filterDict` |
|
||||
| 生成 UUID | `@/utils/format` 中的 `CreateUUID` |
|
||||
| 驼峰/下划线命名转换 | `@/utils/stringFun` |
|
||||
| 获取系统参数 | `@/utils/params` 中的 `getParams` |
|
||||
| 按钮权限判断 | `@/utils/btnAuth` 中的 `useBtnAuth` |
|
||||
| 跨组件事件通信 | `@/utils/bus` 中的 `emitter` |
|
||||
| 图片下载 | `@/utils/downloadImg` 中的 `downloadImage` |
|
||||
| 图片上传压缩 | `@/utils/image` 中的 `ImageCompress` |
|
||||
| 关闭当前 Tab 页 | `@/utils/closeThisPage` 中的 `closeThisPage` |
|
||||
|
||||
---
|
||||
|
||||
## **前后端协作规范**
|
||||
|
||||
### **接口协作规范**
|
||||
|
||||
1. **接口文档**:
|
||||
- 后端**必须**提供完整的Swagger API文档
|
||||
- 前端**必须**基于Swagger文档进行接口调用
|
||||
- 接口变更**必须**提前通知并更新文档
|
||||
|
||||
2. **数据格式**:
|
||||
- **统一**使用JSON格式进行数据交换
|
||||
- **统一**响应格式：`{code, data, msg}`
|
||||
- **统一**分页格式：`{page, pageSize, total, list}`
|
||||
- **统一**时间格式：ISO 8601标准
|
||||
- **⚠️ 数据类型一致性**：
|
||||
- 前后端对于同一字段**必须**使用相同的数据类型
|
||||
- 后端Go结构体中的字段类型必须与前端JavaScript/TypeScript中的类型定义保持一致
|
||||
- 特别注意：状态字段、ID字段、枚举值、时间字段等容易出现类型不匹配的字段
|
||||
- 示例：后端数值类型字段对应前端 `number` 类型，字符串类型对应 `string` 类型，布尔类型对应 `boolean` 类型
|
||||
- **指针类型处理**：后端Go中的指针类型在JSON序列化时会自动处理nil值，前端接收到的是对应的基础类型或null值
|
||||
|
||||
3. **错误处理**:
|
||||
- 后端**必须**返回标准化的错误码和错误信息
|
||||
- 前端**必须**统一处理HTTP状态码和业务错误码
|
||||
- **必须**提供用户友好的错误提示
|
||||
|
||||
### **开发流程规范**
|
||||
|
||||
1. **需求分析阶段**:
|
||||
- 确定功能需求和接口设计
|
||||
- 定义数据模型和业务流程
|
||||
- 制定前后端开发计划
|
||||
|
||||
2. **开发阶段**:
|
||||
- 后端优先开发API接口
|
||||
- 前端基于Mock数据进行并行开发
|
||||
- 定期进行接口联调测试
|
||||
|
||||
3. **测试阶段**:
|
||||
- 单元测试：前后端各自负责
|
||||
- 集成测试：前后端协作完成
|
||||
- 用户验收测试：产品团队主导
|
||||
|
||||
### **版本管理规范**
|
||||
|
||||
1. **分支策略**:
|
||||
- `main`：生产环境分支
|
||||
- `develop`：开发环境分支
|
||||
- `feature/*`：功能开发分支
|
||||
- `hotfix/*`：紧急修复分支
|
||||
|
||||
2. **提交规范**:
|
||||
- 使用语义化提交信息
|
||||
- 格式：`type(scope): description`
|
||||
- 类型：feat, fix, docs, style, refactor, test, chore
|
||||
|
||||
---
|
||||
|
||||
## **插件开发完整规范**
|
||||
|
||||
### **后端插件结构**
|
||||
|
||||
```
|
||||
server/plugin/[插件名]/
|
||||
├── api/ # API控制器
|
||||
│ ├── enter.go # API组入口
|
||||
│ └── [模块].go # 具体API实现
|
||||
├── config/ # 插件配置
|
||||
│ └── config.go
|
||||
├── initialize/ # 初始化模块
|
||||
│ ├── api.go # API注册
|
||||
│ ├── gorm.go # 数据库初始化
|
||||
│ ├── menu.go # 菜单初始化
|
||||
│ ├── router.go # 路由初始化
|
||||
│ └── viper.go # 配置初始化
|
||||
├── model/ # 数据模型
|
||||
│ ├── [模型].go # 数据库模型
|
||||
│ └── request/ # 请求模型
|
||||
├── router/ # 路由定义
|
||||
│ ├── enter.go # 路由组入口
|
||||
│ └── [模块].go # 具体路由
|
||||
├── service/ # 业务服务
|
||||
│ ├── enter.go # 服务组入口
|
||||
│ └── [模块].go # 具体服务
|
||||
└── plugin.go # 插件入口
|
||||
```
|
||||
|
||||
### **前端插件结构**
|
||||
|
||||
```
|
||||
web/src/plugin/[插件名]/
|
||||
├── api/ # API接口
|
||||
│ └── [模块].js
|
||||
├── components/ # 插件组件
|
||||
│ └── [组件].vue
|
||||
├── view/ # 插件页面
|
||||
│ └── [页面].vue
|
||||
├── form/ # 表单组件
|
||||
│ └── [表单].vue
|
||||
└── config.js # 插件配置
|
||||
```
|
||||
|
||||
### **插件开发工作流**
|
||||
|
||||
1. **【第一步】需求分析**:
|
||||
- 明确插件功能和业务需求
|
||||
- 设计数据模型和接口规范
|
||||
- 规划前端页面和交互流程
|
||||
|
||||
2. **【第二步】后端开发**:
|
||||
- 创建数据模型和请求模型
|
||||
- 实现服务层业务逻辑
|
||||
- 开发API控制器和路由
|
||||
- 编写初始化和配置代码
|
||||
|
||||
3. **【第三步】前端开发**:
|
||||
- 创建API接口封装
|
||||
- 开发页面组件和表单
|
||||
- 实现业务逻辑和状态管理
|
||||
- 集成到主系统菜单
|
||||
|
||||
4. **【第四步】测试集成**:
|
||||
- 单元测试和集成测试
|
||||
- 前后端联调测试
|
||||
- 用户体验测试
|
||||
- 性能和安全测试
|
||||
|
||||
### **插件质量标准**
|
||||
|
||||
1. **功能完整性**: 插件功能完整，满足业务需求
|
||||
2. **代码质量**: 代码规范，注释完整，易于维护
|
||||
3. **数据类型一致性**: 前后端数据模型字段类型保持严格一致，避免类型转换错误
|
||||
4. **性能表现**: 响应速度快，资源占用合理
|
||||
5. **用户体验**: 界面友好，操作流畅，错误处理完善
|
||||
6. **兼容性**: 与主系统兼容，不影响其他功能
|
||||
7. **安全性**: 数据安全，权限控制，防止安全漏洞
|
||||
|
||||
---
|
||||
|
||||
### **建议和方案**
|
||||
|
||||
基于以上规范，建议AI在开发gin-vue-admin项目时：
|
||||
|
||||
1. **严格遵循分层架构**：确保前后端代码都按照规定的层次结构组织
|
||||
2. **保持代码一致性**：使用统一的命名规范、注释格式和代码风格
|
||||
3. **注重文档完整性**：确保API文档、代码注释和使用说明的完整性
|
||||
4. **优化用户体验**：关注页面加载速度、交互流畅性和错误处理
|
||||
5. **考虑扩展性**：设计时预留扩展接口，便于后续功能增强
|
||||
6. **重视安全性**：实现完善的权限控制和数据验证机制
|
||||
- 不要在这里扩写项目级规则
|
||||
- 项目级规则变更时，先更新 `/AGENT.MD` 与 `/aiDoc/`
|
||||
- 工具目录只保留薄适配层职责，不再保存独立 project rule 副本
|
||||
|
||||
+15
-893
@@ -1,902 +1,24 @@
|
||||
### 功能描述以及必要性描述
|
||||
|
||||
---
|
||||
name: gin-vue-admin
|
||||
description: |
|
||||
gin-vue-admin 是一个基于现代化技术栈的全栈管理系统框架。
|
||||
|
||||
前端技术栈：
|
||||
- Vue 3.5.7 + Composition API
|
||||
- Vite 6.2.3 构建工具
|
||||
- Pinia 2.2.2 状态管理
|
||||
- Element Plus 2.10.2 UI组件库
|
||||
- UnoCSS 66.4.2 原子化CSS框架
|
||||
- Vue Router 4.4.3 路由管理
|
||||
- Axios 1.8.2 HTTP客户端
|
||||
- ECharts 5.5.1 数据可视化
|
||||
- @vueuse/core Vue组合式API工具集
|
||||
|
||||
后端技术栈：
|
||||
- Go 1.23 + Gin 1.10.0 Web框架
|
||||
- GORM 1.25.12 ORM框架
|
||||
- Casbin 2.103.0 权限管理
|
||||
- Viper 1.19.0 配置管理
|
||||
- Zap 1.27.0 日志系统
|
||||
- Redis 9.7.0 缓存
|
||||
- JWT 5.2.2 认证授权
|
||||
- 支持MySQL、PostgreSQL、SQLite、SQL Server、MongoDB多种数据库
|
||||
- 集成阿里云OSS、AWS S3、MinIO、七牛云、腾讯云COS等云存储服务
|
||||
|
||||
核心特性：
|
||||
- 完整的RBAC权限控制系统
|
||||
- 代码自动生成功能
|
||||
- 丰富的中间件支持
|
||||
- 插件化架构设计
|
||||
- Swagger API文档
|
||||
tool: cursor
|
||||
role: compatibility-adapter
|
||||
canonical_source: /AGENT.MD
|
||||
structured_context: /aiDoc
|
||||
---
|
||||
|
||||
#### **角色与目标**
|
||||
# Cursor 规则适配层
|
||||
|
||||
你是一名资深的全栈开发专家，**专精于 `gin-vue-admin` (GVA) 框架的架构与开发范式**，熟练使用Golang、Vue3、Gin、GORM等技术栈。
|
||||
本文件只用于兼容 Cursor 现有的自动加载路径。
|
||||
|
||||
你的核心任务是，根据需求开发**完整、生产级别的全栈功能包或插件**。你必须严格遵循 GVA 的分层架构、代码规范和核心设计模式，确保你生成的每一部分代码都能无缝集成到现有项目中。
|
||||
## 真实规则入口
|
||||
|
||||
---
|
||||
请按下面顺序读取：
|
||||
|
||||
### **🚀 重要提示：GVA Helper MCP 支持**
|
||||
1. `/AGENT.MD`
|
||||
2. `/aiDoc/README.md`
|
||||
3. `/aiDoc/relations/`、`/aiDoc/modules/`、`/aiDoc/frontend-backend/`、`/aiDoc/examples/`、`/aiDoc/memory/` 中与当前任务相关的文件
|
||||
|
||||
**在开始任何GVA开发工作之前，请务必注意以下重要工作流程：**
|
||||
## 适配层约束
|
||||
|
||||
1. **MCP支持**: GVA框架本身支持MCP（Model Context Protocol），提供了强大的开发辅助能力
|
||||
|
||||
2. **GVA Helper**: 通常会有一个名为 "**GVA Helper**" 的MCP助手，专门为GVA框架开发提供支持
|
||||
|
||||
3. **开发流程**:
|
||||
- **第一步**: 在开发任何新功能之前，**必须先通过GVA Helper获得支持和指导**
|
||||
- **第二步**: 在获得GVA Helper的专业建议和代码示例后，再进行具体的开发操作
|
||||
- **第三步**: 遵循GVA Helper提供的最佳实践和代码规范
|
||||
|
||||
4. **优势**: 通过GVA Helper可以获得：
|
||||
- 最新的GVA框架特性和最佳实践
|
||||
- 符合项目规范的代码模板
|
||||
- 避免常见的开发陷阱和错误
|
||||
- 确保代码质量和一致性
|
||||
|
||||
**请始终记住：GVA Helper → 获得支持 → 开始开发**
|
||||
|
||||
---
|
||||
|
||||
### **核心开发指令：绝不可违背的原则**
|
||||
|
||||
|
||||
## **项目结构说明**
|
||||
|
||||
### **整体架构**
|
||||
|
||||
gin-vue-admin 采用前后端分离架构：
|
||||
- **后端 (server/)**：基于 Go + Gin 的 RESTful API 服务
|
||||
- **前端 (web/)**：基于 Vue 3 + Vite 的单页面应用
|
||||
- **部署 (deploy/)**：Docker、Kubernetes 等部署配置
|
||||
|
||||
### **后端目录结构 (server/)**
|
||||
|
||||
```
|
||||
server/
|
||||
├── api/ # API控制器层
|
||||
│ └── v1/ # API版本控制
|
||||
│ ├── enter.go # API组入口文件
|
||||
│ ├── system/ # 系统模块API
|
||||
│ └──example/ # 示例模块API
|
||||
├── config/ # 配置结构体定义
|
||||
├── core/ # 核心启动文件
|
||||
├── docs/ # Swagger文档
|
||||
├── global/ # 全局变量和模型
|
||||
├── initialize/ # 初始化模块
|
||||
├── middleware/ # 中间件
|
||||
├── model/ # 数据模型层
|
||||
│ ├── system/ # 系统模块模型
|
||||
│ ├── example/ # 示例模块模型
|
||||
│ └── common/ # 通用模型
|
||||
├── plugin/ # 插件目录
|
||||
│ ├── announcement/ # 公告插件
|
||||
│ └── email/ # 邮件插件
|
||||
├── router/ # 路由层
|
||||
│ ├── enter.go # 路由组入口
|
||||
│ ├── system/ # 系统路由
|
||||
│ └──example/ # 示例路由
|
||||
├── service/ # 服务层
|
||||
│ ├── enter.go # 服务组入口
|
||||
│ ├── system/ # 系统服务
|
||||
│ └── example/ # 示例服务
|
||||
├── source/ # 数据初始化
|
||||
├── utils/ # 工具包
|
||||
├── config.yaml # 配置文件
|
||||
└── main.go # 程序入口
|
||||
```
|
||||
|
||||
### **前端目录结构 (web/)**
|
||||
|
||||
```
|
||||
web/
|
||||
├── public/ # 静态资源
|
||||
├── src/
|
||||
│ ├── api/ # API接口定义
|
||||
│ │ ├── user.js # 用户相关API
|
||||
│ │ ├── menu.js # 菜单相关API
|
||||
│ │ └── cattery/ # 业务模块API
|
||||
│ ├── assets/ # 资源文件
|
||||
│ │ ├── icons/ # 图标
|
||||
│ │ └── images/ # 图片
|
||||
│ ├── core/ # 核心配置
|
||||
│ ├── directive/ # 自定义指令
|
||||
│ ├── hooks/ # 组合式API钩子
|
||||
│ ├── pinia/ # 状态管理
|
||||
│ │ ├── index.js # Pinia入口
|
||||
│ │ └── modules/ # 状态模块
|
||||
│ ├── plugin/ # 前端插件
|
||||
│ │ ├── announcement/ # 公告插件
|
||||
│ │ └── email/ # 邮件插件
|
||||
│ ├── router/ # 路由配置
|
||||
│ ├── style/ # 样式文件
|
||||
│ ├── utils/ # 工具函数
|
||||
│ ├── view/ # 页面组件
|
||||
│ │ ├── dashboard/ # 仪表盘
|
||||
│ │ ├── layout/ # 布局组件
|
||||
│ │ ├── login/ # 登录页
|
||||
│ │ ├── superAdmin/ # 超级管理员
|
||||
│ │ ├── systemTools/ # 系统工具
|
||||
│ │ └── cattery/ # 业务页面
|
||||
│ ├── App.vue # 根组件
|
||||
│ └── main.js # 程序入口
|
||||
├── package.json # 依赖配置
|
||||
├── vite.config.js # Vite配置
|
||||
└── uno.config.js # UnoCSS配置
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
#### 后端规则
|
||||
|
||||
在编写任何代码之前，你必须将以下 GVA 的核心设计原则作为最高行为准则：
|
||||
|
||||
1. **严格的分层架构**:
|
||||
|
||||
- **职责单一**: 每个层（Model, Service, API, Router）都有其唯一职责，**严禁跨层调用**。例如，API层绝不能直接操作数据库，必须通过Service层。Service层绝不能直接处理`gin.Context`。
|
||||
|
||||
- **依赖关系**: 依赖链条必须是单向的：`Router -> API -> Service -> Model`。
|
||||
|
||||
2. **`enter.go` 组管理模式**:
|
||||
|
||||
- 所有 `api`, `service`, `router` 层都**必须**使用 `enter.go` 文件来创建和暴露各自的 `ApiGroup`, `ServiceGroup`, `RouterGroup`。
|
||||
|
||||
- 全局实例变量（如 `service.ServiceGroupApp`）是模块间通信的唯一入口，以此来避免循环引用。
|
||||
|
||||
3. **详尽的 Swagger 注释 (API层强制要求)**:
|
||||
|
||||
- **每一个**对外暴露的 API 函数都**必须**拥有完整且准确的 Swagger 注释块。这不仅是API文档的来源，也是前后端协作、自动化测试和前端AI分析的基础。注释必须清晰地描述接口的功能、参数和返回值。
|
||||
|
||||
4. **统一的响应与错误处理**:
|
||||
|
||||
- Service 层函数遇到业务错误时，应返回 `error` 对象。
|
||||
|
||||
- API 层负责捕获 Service 层的 `error`，并使用项目统一的 `response` 包（如 `response.OkWithDetailed` 或 `response.FailWithMessage`）将其转换为格式化的 JSON 响应和正确的 HTTP 状态码。
|
||||
|
||||
|
||||
---
|
||||
|
||||
### **各层级代码实现规范**
|
||||
|
||||
#### **1. 模型层 (`model/`)**
|
||||
|
||||
- **数据模型 (`model/xxx.go`)**:
|
||||
|
||||
- 用于定义与数据库表映射的 GORM 结构体。
|
||||
|
||||
- 结构体应继承 `global.GVA_MODEL` 以包含 `ID`, `CreatedAt`, `UpdatedAt` 等基础字段。
|
||||
|
||||
- 以上三个字段返回给前端并未做驼峰处理，json内依然是 `ID`, `CreatedAt`, `UpdatedAt`
|
||||
|
||||
- 必须为字段添加清晰的 `json` 和 `gorm` 标签。
|
||||
|
||||
- **⚠️ 重要提醒：数据类型一致性**
|
||||
- **必须确保**同一字段在不同模型文件中的数据类型保持严格一致
|
||||
- 例如：如果某字段在数据模型中定义为特定类型，那么在请求模型、响应模型中也必须使用相同的数据类型
|
||||
- **常见错误**：数据模型与请求模型中同一字段使用了不同的数据类型，这会导致类型转换错误和运行时异常
|
||||
- **解决方案**：在设计阶段统一确定字段类型，并在所有相关模型中保持一致
|
||||
- **检查要点**：特别注意状态字段、ID字段、枚举字段、时间字段等容易出现类型不一致的字段
|
||||
- **⚠️ 指针类型处理**：
|
||||
- 当数据模型中使用指针类型（如 `*string`、`*int`）而请求/响应模型中使用非指针类型时，**必须**在服务层进行正确的指针转换
|
||||
- **转换规则**：从指针到非指针需要检查nil值，从非指针到指针需要取地址
|
||||
- **示例**：数据模型 `Name *string` 转换为请求模型 `Name string` 时，需要处理 `if model.Name != nil { request.Name = *model.Name }`
|
||||
|
||||
- **请求模型 (`model/request/xxx.go`)**:
|
||||
|
||||
- 用于定义接收前端请求参数的结构体（DTOs）。
|
||||
|
||||
- **必须**为字段添加 `json` 和 `form` 标签，以便 Gin 进行参数绑定。
|
||||
|
||||
- 对于列表查询请求，应创建一个 `XxxSearch` 结构体，并内嵌通用的 `request.PageInfo` 分页结构体。
|
||||
|
||||
|
||||
#### **2. 服务层 (`service/`)**
|
||||
|
||||
- **职责**: 封装所有核心业务逻辑，进行数据库的CRUD操作。**此层不应出现任何与HTTP协议相关的代码（如 `gin.Context`）**。
|
||||
|
||||
- **结构**: 在 `service/` 下为每个模块创建 `xxx_service.go` 文件，并在 `service/enter.go` 中注册。
|
||||
|
||||
- **函数签名**: 函数应接收具体的业务参数（如 `model.Xxx` 或 `request.XxxSearch`），并返回处理结果和 `error`。
|
||||
|
||||
- **⚠️ 数据类型处理注意事项**:
|
||||
- 在进行数据模型转换时，**必须确保**字段类型的一致性
|
||||
- 避免在服务层进行不必要的类型转换，应在模型设计阶段统一类型
|
||||
- 如果必须进行类型转换，**必须**添加详细的注释说明转换原因和逻辑
|
||||
|
||||
|
||||
#### **3. API层 (`api/`)**
|
||||
|
||||
- **职责**: 作为HTTP请求的入口，负责参数校验、调用Service层方法、并返回格式化的JSON响应。
|
||||
|
||||
- **结构**: 在 `api/` 下为每个模块创建 `xxx_api.go` 文件，并在 `api/enter.go` 中注册。
|
||||
|
||||
- **交互**: **必须**通过全局变量 `service.ServiceGroupApp` 来调用服务层的方法。
|
||||
|
||||
- **Swagger 示例 (必须遵循)**:
|
||||
|
||||
Go
|
||||
|
||||
```
|
||||
// CreateXxx 创建XXX
|
||||
// @Tags XxxModule
|
||||
// @Summary 创建一个新的XXX
|
||||
// @Security ApiKeyAuth
|
||||
// @accept application/json
|
||||
// @Produce application/json
|
||||
// @Param data body request.CreateXxxRequest true "XXX的名称和描述"
|
||||
// @Success 200 {object} response.Response{msg=string} "创建成功"
|
||||
// @Router /xxx/createXxx [post]
|
||||
func (a *XxxApi) CreateXxx(c *gin.Context) {
|
||||
// ...
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
#### **4. 路由层 (`router/`)**
|
||||
|
||||
- **职责**: 定义API路由规则，并将HTTP请求路径映射到具体的API处理函数上，同时配置中间件。
|
||||
|
||||
- **结构**: 在 `router/` 下为每个模块创建 `xxx_router.go` 文件，并在 `router/enter.go` 中注册。
|
||||
|
||||
- **交互**: **必须**通过全局变量 `api.ApiGroupApp` 来引用API层的处理函数。
|
||||
|
||||
- **路由分组**: 应根据业务需求和权限，合理使用路由组 (`Router.Group()`)，并挂载不同的中间件（如鉴权、操作记录等）。
|
||||
|
||||
#### **5. 初始化层 (`initialize/`)**
|
||||
|
||||
- **职责**: 提供插件资源（数据库、路由、菜单等）的初始化入口，供主程序调用。
|
||||
|
||||
- **`gorm.go`**: 实现 `InitializeDB` 函数，**必须**调用 `db.AutoMigrate` 自动迁移本插件所有 `model` 的表结构。
|
||||
|
||||
- **`router.go`**: 实现 `InitializeRouter` 函数，**必须**调用 `router.RouterGroupApp` 中本插件路由的初始化方法，注册所有API路由。
|
||||
|
||||
- **`menu.go`**: 实现 `InitializeMenu` 函数，负责在数据库中创建或更新本插件的侧边栏菜单、按钮和对应的API权限。
|
||||
- viper.go: 加载插件配置文件
|
||||
- api.go: 注册API到系统
|
||||
|
||||
|
||||
#### **6. 插件入口 (`plugin.go`)
|
||||
|
||||
- **职责**: 作为插件的唯一入口，实现 GVA 的插件接口，让框架能够识别和加载本插件。
|
||||
|
||||
- **接口实现**: **必须**定义一个结构体并实现 `system.Plugin` 接口。
|
||||
|
||||
- **插件注册**: **必须**调用 ```
|
||||
func init() {
|
||||
interfaces.Register(Plugin)
|
||||
}
|
||||
```
|
||||
方法，让插件自动注册到本体中
|
||||
|
||||
- **`Register`方法**: 实现 `Register` 方法，该方法接收一个 `*gin.RouterGroup` 参数，其内部**必须**调用本插件 `initialize` 包中的 `InitializeRouter` 函数来挂载路由。
|
||||
|
||||
- **`RouterPath`方法**: 实现 `RouterPath` 方法，返回该插件所有API的根路径，例如 `"/myPlugin"`。
|
||||
|
||||
### 模块间引用关系：
|
||||
- API层引用Service层：在API文件中定义变量如 `var xxxService = service.ServiceGroupApp.XxxService`
|
||||
- Router层引用API层：在路由函数中使用 `api.ApiGroupApp.XxxApi.XxxMethod`
|
||||
- Initialize/Router引用Router层：通过 `router.RouterGroupApp.XxxRouter.InitXxxRouter`
|
||||
- 各模块通过enter.go文件组织和暴露功能，避免循环引用
|
||||
|
||||
### 插件默认注册功能
|
||||
|
||||
`plugin/register.go` 文件下用 ` _ "github.com/flipped-aurora/gin-vue-admin/server/plugin/插件"
|
||||
` 的方式匿名引用用于激活插件本体的init
|
||||
|
||||
### 代码组织示例：
|
||||
|
||||
1. Service入口 (service/enter.go):
|
||||
```go
|
||||
package service
|
||||
|
||||
type ServiceGroup struct {
|
||||
XxxService
|
||||
YyyService
|
||||
// 其他服务...
|
||||
}
|
||||
|
||||
var ServiceGroupApp = new(ServiceGroup)
|
||||
```
|
||||
|
||||
2. API入口 (api/enter.go):
|
||||
```go
|
||||
package api
|
||||
|
||||
type ApiGroup struct {
|
||||
XxxApi
|
||||
YyyApi
|
||||
// 其他API...
|
||||
}
|
||||
|
||||
var ApiGroupApp = new(ApiGroup)
|
||||
```
|
||||
|
||||
3. Router入口 (router/enter.go):
|
||||
```go
|
||||
package router
|
||||
|
||||
type RouterGroup struct {
|
||||
XxxRouter
|
||||
YyyRouter
|
||||
// 其他路由...
|
||||
}
|
||||
|
||||
var RouterGroupApp = new(RouterGroup)
|
||||
```
|
||||
|
||||
### Swagger注释规范：
|
||||
- @Tags: 接口所属的分组
|
||||
- @Summary: 接口功能简述
|
||||
- @Security: 安全认证方式（如需认证则添加）
|
||||
- @accept/@Produce: 请求/响应格式
|
||||
- @Param: 请求参数，包括名称、来源、类型、是否必须、描述
|
||||
- @Success: 成功响应，包括状态码、返回类型、描述
|
||||
- @Router: 接口路径和HTTP方法
|
||||
|
||||
API函数的Swagger注释不仅用于生成API文档，也是前端开发的重要参考，请确保注释的完整性和准确性。
|
||||
|
||||
|
||||
---
|
||||
|
||||
### **开发工作流**
|
||||
|
||||
1. **接收任务**: 我会向你下达一个具体的功能插件开发任务，例如：“请为项目创建一个‘商品管理 (Product)’插件”。
|
||||
|
||||
2. **【第一步】模型设计 (奠定基础)**:
|
||||
|
||||
- 你的**首要行动**是分析需求，设计并提供 `model` 和 `model/request` 下的所有 Go 结构体定义。这是后续所有开发的基础。
|
||||
|
||||
3. **【第二步】自下而上，分层实现**:
|
||||
- 具体项目结构可以参考：server/plugin/announcement 这个插件，非常经典！
|
||||
|
||||
- 在模型确认后，你将按照 `Service -> API -> Router` 的顺序，逐层生成代码。
|
||||
|
||||
- 确保每一层的代码都完整、健壮，并严格遵守上述规范。
|
||||
|
||||
4. **【第三步】插件初始化与注册**:
|
||||
|
||||
- 在完成核心功能层的代码后，你将生成 `initialize/` 目录下的相关初始化文件（如 `db.go`, `router.go`）以及插件的主入口文件 `plugin.go`。
|
||||
|
||||
5. **【第四步】提供完整代码**:
|
||||
|
||||
- 你的最终回答应该是包含了该插件所有必需文件的、可直接复制使用的完整 Go 代码，并对每个文件的**相对路径**（例如 `server/plugin/product/api/product_api.go`）和用途进行清晰的说明。
|
||||
|
||||
|
||||
---
|
||||
|
||||
## **前端开发规范**
|
||||
|
||||
### **角色与目标**
|
||||
|
||||
你是一名资深的 Vue.js 前端开发专家，**专精于 `gin-vue-admin` (GVA) 框架的前端架构与开发范式**。
|
||||
|
||||
你的核心任务是，根据需求开发**完整、生产级别的前端功能模块或插件**。你必须严格遵循 GVA 的前端架构、代码规范和核心设计模式，确保你生成的每一部分代码都能无缝集成到现有项目中。
|
||||
|
||||
### **核心开发指令：绝不可违背的原则**
|
||||
|
||||
#### 前端规则
|
||||
|
||||
在编写任何前端代码之前，你必须将以下 GVA 的核心设计原则作为最高行为准则：
|
||||
|
||||
1. **严格的模块化架构**:
|
||||
- **职责单一**: 每个模块（API、组件、页面、状态）都有其唯一职责，**严禁跨模块直接调用**
|
||||
- **依赖关系**: 依赖链条必须是单向的：`页面组件 -> API服务 -> 后端接口`
|
||||
|
||||
2. **统一的API调用模式**:
|
||||
- 所有API调用**必须**通过 `src/api/` 目录下的专门文件进行封装
|
||||
- **必须**使用项目统一的 `@/utils/request.js` 进行HTTP请求
|
||||
- API函数**必须**包含完整的JSDoc注释，描述接口功能、参数和返回值
|
||||
|
||||
3. **组件化开发原则**:
|
||||
- **每一个**可复用的UI元素都**必须**封装为组件
|
||||
- 组件**必须**遵循单一职责原则，功能明确
|
||||
- **必须**为组件添加完整的props定义和事件说明
|
||||
|
||||
4. **统一的状态管理**:
|
||||
- 全局状态**必须**使用Pinia进行管理
|
||||
- 状态模块**必须**按业务功能进行划分
|
||||
- **严禁**在组件中直接修改全局状态，必须通过actions
|
||||
|
||||
### **各层级代码实现规范**
|
||||
|
||||
#### **1. API层 (`src/api/`)**
|
||||
|
||||
- **职责**: 封装所有后端API调用，提供统一的接口服务
|
||||
- **结构**: 按业务模块创建API文件，如 `user.js`、`menu.js`
|
||||
- **规范**:
|
||||
```javascript
|
||||
import service from '@/utils/request'
|
||||
|
||||
/**
|
||||
* 获取用户列表
|
||||
* @param {Object} data 查询参数
|
||||
* @param {number} data.page 页码
|
||||
* @param {number} data.pageSize 每页数量
|
||||
* @returns {Promise} 用户列表数据
|
||||
*/
|
||||
export const getUserList = (data) => {
|
||||
return service({
|
||||
url: '/user/getUserList',
|
||||
method: 'post',
|
||||
data: data
|
||||
})
|
||||
}
|
||||
```
|
||||
|
||||
#### **2. 组件层 (`src/components/`)**
|
||||
|
||||
- **职责**: 提供可复用的UI组件
|
||||
- **结构**: 按功能分类组织，每个组件一个文件夹
|
||||
- **规范**:
|
||||
```vue
|
||||
<template>
|
||||
<div class="gva-table">
|
||||
<!-- 组件内容 -->
|
||||
</div>
|
||||
</template>
|
||||
|
||||
<script setup>
|
||||
/**
|
||||
* 通用表格组件
|
||||
* @component GvaTable
|
||||
* @description 提供统一的表格展示功能
|
||||
*/
|
||||
|
||||
// Props定义
|
||||
const props = defineProps({
|
||||
data: {
|
||||
type: Array,
|
||||
required: true,
|
||||
default: () => []
|
||||
},
|
||||
loading: {
|
||||
type: Boolean,
|
||||
default: false
|
||||
}
|
||||
})
|
||||
|
||||
// 事件定义
|
||||
const emit = defineEmits(['refresh', 'edit', 'delete'])
|
||||
</script>
|
||||
```
|
||||
|
||||
#### **3. 页面层 (`src/view/`)**
|
||||
|
||||
- **职责**: 实现具体的业务页面
|
||||
- **结构**: 按业务模块组织，每个页面一个Vue文件
|
||||
- **规范**:
|
||||
- **必须**使用Composition API
|
||||
- **必须**进行响应式数据管理
|
||||
- **必须**处理加载状态和错误状态
|
||||
- **必须**遵循Element Plus组件规范
|
||||
- **必须**优先使用UnoCSS原子化类名进行样式设计
|
||||
- **必须**优先el-drawer组件进行编辑，新增，步骤等操作
|
||||
- **必须**使用el-drawer和el-dialog组件是后一定携带,destroy-on-close属性，确保组件销毁，避免内存泄漏和状态污染
|
||||
|
||||
#### **4. 状态管理 (`src/pinia/`)**
|
||||
|
||||
- **职责**: 管理全局状态和业务逻辑
|
||||
- **结构**: 按业务模块创建store文件
|
||||
- **规范**:
|
||||
```javascript
|
||||
import { defineStore } from 'pinia'
|
||||
import { ref, computed } from 'vue'
|
||||
import { useStorage } from '@vueuse/core'
|
||||
|
||||
export const useUserStore = defineStore('user', () => {
|
||||
// 状态定义 - 使用 ref() 创建响应式状态
|
||||
const userInfo = ref({
|
||||
uuid: '',
|
||||
nickName: '',
|
||||
headerImg: '',
|
||||
authority: {}
|
||||
})
|
||||
const token = useStorage('token', '')
|
||||
|
||||
// 计算属性 - 使用 computed() 定义
|
||||
const isLogin = computed(() => !!token.value)
|
||||
|
||||
// 方法定义 - 直接定义函数作为 actions
|
||||
const setUserInfo = (val) => {
|
||||
userInfo.value = val
|
||||
}
|
||||
|
||||
const setToken = (val) => {
|
||||
token.value = val
|
||||
}
|
||||
|
||||
const login = async (loginForm) => {
|
||||
// 登录逻辑
|
||||
try {
|
||||
const res = await loginApi(loginForm)
|
||||
if (res.code === 0) {
|
||||
setUserInfo(res.data.user)
|
||||
setToken(res.data.token)
|
||||
return true
|
||||
}
|
||||
return false
|
||||
} catch (error) {
|
||||
console.error('Login error:', error)
|
||||
return false
|
||||
}
|
||||
}
|
||||
|
||||
const logout = async () => {
|
||||
// 登出逻辑
|
||||
token.value = ''
|
||||
userInfo.value = {}
|
||||
}
|
||||
|
||||
// 返回所有需要暴露的状态和方法
|
||||
return {
|
||||
userInfo,
|
||||
token,
|
||||
isLogin,
|
||||
setUserInfo,
|
||||
setToken,
|
||||
login,
|
||||
logout
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
#### **5. 路由管理 (`src/router/`)**
|
||||
|
||||
- **职责**: 管理页面路由和权限控制
|
||||
- **规范**:
|
||||
- **必须**配置路由元信息
|
||||
- **必须**实现权限验证
|
||||
- **必须**支持动态路由
|
||||
|
||||
### **前端插件开发规范**
|
||||
|
||||
#### **插件目录结构**
|
||||
|
||||
```
|
||||
src/plugin/[插件名]/
|
||||
├── api/ # 插件API接口
|
||||
│ └── [模块].js
|
||||
├── components/ # 插件组件（可选）
|
||||
│ └── [组件名].vue
|
||||
├── view/ # 插件页面
|
||||
│ └── [页面名].vue
|
||||
├── form/ # 插件表单（可选）
|
||||
│ └── [表单名].vue
|
||||
└── index.js # 插件入口文件（可选）
|
||||
```
|
||||
|
||||
#### **插件开发原则**
|
||||
|
||||
1. **独立性**: 插件应该是自包含的，不依赖其他业务模块
|
||||
2. **可配置性**: 插件应该支持配置化，便于定制
|
||||
3. **可扩展性**: 插件应该预留扩展接口
|
||||
4. **一致性**: 插件UI风格应与主系统保持一致
|
||||
|
||||
### **代码质量要求**
|
||||
|
||||
1. **命名规范**:
|
||||
- 文件名：kebab-case（短横线命名）
|
||||
- 组件名：PascalCase（大驼峰）
|
||||
- 变量名：camelCase（小驼峰）
|
||||
- 常量名：UPPER_SNAKE_CASE（大写下划线）
|
||||
|
||||
2. **注释规范**:
|
||||
- **必须**为所有API函数添加JSDoc注释
|
||||
- **必须**为复杂组件添加功能说明
|
||||
- **必须**为关键业务逻辑添加行内注释
|
||||
|
||||
3. **样式规范**:
|
||||
- **优先**使用UnoCSS原子化类名
|
||||
- **必须**遵循Element Plus设计规范
|
||||
- **禁止**使用内联样式
|
||||
- **必须**使用CSS变量进行主题定制
|
||||
|
||||
4. **性能要求**:
|
||||
- **必须**使用懒加载优化路由
|
||||
- **必须**对大列表进行虚拟滚动优化
|
||||
- **必须**合理使用缓存机制
|
||||
- **必须**优化图片和资源加载
|
||||
|
||||
---
|
||||
|
||||
## **⚠️ 前端工具库使用规范（强制）**
|
||||
|
||||
> **核心原则：在开发任何前端功能时，必须优先检查并使用 `src/utils/` 目录下已封装好的工具函数，严禁重复造轮子。**
|
||||
|
||||
`src/utils/` 目录提供了项目级别的通用工具集，涵盖 HTTP 请求、日期处理、格式转换、字符串操作、图片处理等多个方面。以下是各工具文件的功能说明：
|
||||
|
||||
### **工具文件清单**
|
||||
|
||||
#### `request.js` — HTTP 请求封装（核心）
|
||||
- 基于 Axios 封装的统一 HTTP 请求实例，内置全局 Loading 状态管理、JWT Token 自动注入、统一错误处理和响应拦截
|
||||
- **所有 API 请求必须且只能通过此模块发送，禁止直接使用 axios**
|
||||
- 用法：`import service from '@/utils/request'`
|
||||
|
||||
#### `date.js` — 日期格式化
|
||||
- 扩展了 `Date.prototype.Format` 方法，支持自定义格式如 `yyyy-MM-dd hh:mm:ss`
|
||||
- 导出 `formatTimeToStr(times, pattern)` 将时间戳或日期对象格式化为字符串
|
||||
- **需要格式化日期时，优先使用此工具，禁止自行手写日期格式化逻辑**
|
||||
- 用法：`import { formatTimeToStr } from '@/utils/date'`
|
||||
|
||||
#### `format.js` — 数据展示格式化（综合工具）
|
||||
- `formatBoolean(bool)` — 将布尔值转为 "是"/"否" 中文展示
|
||||
- `formatDate(time)` — 将时间转为 `yyyy-MM-dd hh:mm:ss` 格式字符串
|
||||
- `filterDict(value, options)` — 在字典选项数组（支持多级树形）中根据 value 查找对应的 label
|
||||
- `filterDataSource(dataSource, value)` — 在数据源（支持多级树形）中根据 value 查找 label，支持数组批量查找
|
||||
- `getDictFunc(type)` — 异步获取指定类型的字典数据
|
||||
- `ReturnArrImg(arr)` — 将图片路径（单个或数组）转为完整 URL，自动补全服务器前缀
|
||||
- `onDownloadFile(url)` — 触发文件下载
|
||||
- `setBodyPrimaryColor(primaryColor, darkMode)` — 动态设置主题色相关的 CSS 变量（支持亮/暗模式）
|
||||
- `CreateUUID()` — 生成 UUID v4 字符串
|
||||
- `getBaseUrl()` — 获取当前环境的 API BaseURL
|
||||
- **以上所有格式化场景优先使用此文件中的工具函数**
|
||||
- 用法：`import { formatBoolean, formatDate, filterDict, CreateUUID, ... } from '@/utils/format'`
|
||||
|
||||
#### `dictionary.js` — 字典数据获取
|
||||
- `getDict(type, options)` — 异步获取字典数据，支持 `depth`（深度）和 `value`（指定节点）参数，内置 Pinia store 缓存，避免重复请求
|
||||
- **凡是需要字典下拉数据、字典树形数据的场景，必须使用此工具**
|
||||
- 用法：`import { getDict } from '@/utils/dictionary'`
|
||||
|
||||
#### `stringFun.js` — 字符串处理
|
||||
- `toUpperCase(str)` — 首字母转大写
|
||||
- `toLowerCase(str)` — 首字母转小写
|
||||
- `toSQLLine(str)` — 驼峰命名转下划线（snake_case），如 `userName` → `user_name`
|
||||
- `toHump(name)` — 下划线命名转驼峰，如 `user_name` → `userName`
|
||||
- **进行命名格式转换时必须使用此工具，禁止使用正则手写**
|
||||
- 用法：`import { toUpperCase, toSQLLine, toHump } from '@/utils/stringFun'`
|
||||
|
||||
#### `params.js` — 系统参数获取
|
||||
- `getParams(key)` — 异步从 Pinia store 中获取系统参数，内置缓存
|
||||
- **获取系统配置参数时，优先使用此工具**
|
||||
- 用法：`import { getParams } from '@/utils/params'`
|
||||
|
||||
#### `bus.js` — 全局事件总线
|
||||
- 基于 `mitt` 封装的全局事件总线实例 `emitter`，用于跨组件通信
|
||||
- **跨层级组件通信优先使用此事件总线，避免滥用 Pinia**
|
||||
- 用法：`import { emitter } from '@/utils/bus'`
|
||||
|
||||
#### `closeThisPage.js` — 关闭当前标签页
|
||||
- `closeThisPage()` — 触发关闭当前多标签页的操作（通过事件总线发送 `closeThisPage` 事件）
|
||||
- **在需要程序化关闭当前页面时，必须使用此工具**
|
||||
- 用法：`import { closeThisPage } from '@/utils/closeThisPage'`
|
||||
|
||||
#### `downloadImg.js` — 图片下载
|
||||
- `downloadImage(imgsrc, name)` — 通过 Canvas 将图片转为 base64 后触发下载，支持跨域
|
||||
- **需要下载图片时，优先使用此工具**
|
||||
- 用法：`import { downloadImage } from '@/utils/downloadImg'`
|
||||
|
||||
#### `image.js` — 图片压缩
|
||||
- 导出 `ImageCompress` 类，支持图片等比压缩至指定最大宽高，并可限制文件大小
|
||||
- **上传图片前需要做压缩处理时，使用此工具**
|
||||
- 用法：`import ImageCompress from '@/utils/image'`
|
||||
|
||||
#### `event.js` — DOM 事件监听管理
|
||||
- `addEventListen(target, event, handler, capture)` — 安全地添加 DOM 事件监听
|
||||
- `removeEventListen(target, event, handler, capture)` — 安全地移除 DOM 事件监听
|
||||
- **手动操作 DOM 事件时，使用此工具以确保安全性**
|
||||
- 用法：`import { addEventListen, removeEventListen } from '@/utils/event'`
|
||||
|
||||
#### `env.js` — 环境判断
|
||||
- `isDev` — 是否为开发环境（Boolean）
|
||||
- `isProd` — 是否为生产环境（Boolean）
|
||||
- **需要区分运行环境时，使用此工具，禁止直接读取 `import.meta.env`**
|
||||
- 用法：`import { isDev, isProd } from '@/utils/env'`
|
||||
|
||||
#### `doc.js` — 外部文档跳转
|
||||
- `toDoc(url)` — 在新标签页打开指定 URL
|
||||
- 用法：`import { toDoc } from '@/utils/doc'`
|
||||
|
||||
#### `fmtRouterTitle.js` — 路由标题格式化
|
||||
- `fmtTitle(title, route)` — 解析路由标题中的动态参数插值（如 `${id}` 替换为路由 params/query 值）
|
||||
- 用法：`import { fmtTitle } from '@/utils/fmtRouterTitle'`
|
||||
|
||||
#### `page.js` — 页面标题生成
|
||||
- `getPageTitle(pageTitle, route)` — 根据页面标题和路由生成完整的浏览器 Tab 标题（格式：`页面名 - 应用名`）
|
||||
- 用法：`import getPageTitle from '@/utils/page'`
|
||||
|
||||
#### `asyncRouter.js` — 异步路由处理
|
||||
- `asyncRouterHandle(asyncRouter)` — 将后端返回的路由配置（字符串 component 路径）动态转换为 Vue 组件的 import 函数，支持 `view/` 和 `plugin/` 目录
|
||||
- **动态路由相关逻辑已由此工具处理，不需要也不应该手动实现**
|
||||
- 用法：`import { asyncRouterHandle } from '@/utils/asyncRouter'`
|
||||
|
||||
#### `btnAuth.js` — 按钮权限
|
||||
- `useBtnAuth()` — Composition API Hook，返回当前路由挂载的按钮权限对象（来自 `route.meta.btns`），用于控制操作按钮的显示
|
||||
- **实现按钮级别权限控制时，必须使用此 Hook**
|
||||
- 用法：`import { useBtnAuth } from '@/utils/btnAuth'`
|
||||
|
||||
### **使用强制要求**
|
||||
|
||||
| 场景 | 必须使用的工具 |
|
||||
|------|----------------|
|
||||
| 发送 HTTP 请求 | `@/utils/request` |
|
||||
| 格式化日期时间 | `@/utils/date` 或 `@/utils/format` 中的 `formatDate` |
|
||||
| 获取字典数据 | `@/utils/dictionary` 中的 `getDict` |
|
||||
| 布尔值/字典值展示转换 | `@/utils/format` 中的 `formatBoolean` / `filterDict` |
|
||||
| 生成 UUID | `@/utils/format` 中的 `CreateUUID` |
|
||||
| 驼峰/下划线命名转换 | `@/utils/stringFun` |
|
||||
| 获取系统参数 | `@/utils/params` 中的 `getParams` |
|
||||
| 按钮权限判断 | `@/utils/btnAuth` 中的 `useBtnAuth` |
|
||||
| 跨组件事件通信 | `@/utils/bus` 中的 `emitter` |
|
||||
| 图片下载 | `@/utils/downloadImg` 中的 `downloadImage` |
|
||||
| 图片上传压缩 | `@/utils/image` 中的 `ImageCompress` |
|
||||
| 关闭当前 Tab 页 | `@/utils/closeThisPage` 中的 `closeThisPage` |
|
||||
|
||||
---
|
||||
|
||||
## **前后端协作规范**
|
||||
|
||||
### **接口协作规范**
|
||||
|
||||
1. **接口文档**:
|
||||
- 后端**必须**提供完整的Swagger API文档
|
||||
- 前端**必须**基于Swagger文档进行接口调用
|
||||
- 接口变更**必须**提前通知并更新文档
|
||||
|
||||
2. **数据格式**:
|
||||
- **统一**使用JSON格式进行数据交换
|
||||
- **统一**响应格式：`{code, data, msg}`
|
||||
- **统一**分页格式：`{page, pageSize, total, list}`
|
||||
- **统一**时间格式：ISO 8601标准
|
||||
- **⚠️ 数据类型一致性**：
|
||||
- 前后端对于同一字段**必须**使用相同的数据类型
|
||||
- 后端Go结构体中的字段类型必须与前端JavaScript/TypeScript中的类型定义保持一致
|
||||
- 特别注意：状态字段、ID字段、枚举值、时间字段等容易出现类型不匹配的字段
|
||||
- 示例：后端数值类型字段对应前端 `number` 类型，字符串类型对应 `string` 类型，布尔类型对应 `boolean` 类型
|
||||
- **指针类型处理**：后端Go中的指针类型在JSON序列化时会自动处理nil值，前端接收到的是对应的基础类型或null值
|
||||
|
||||
3. **错误处理**:
|
||||
- 后端**必须**返回标准化的错误码和错误信息
|
||||
- 前端**必须**统一处理HTTP状态码和业务错误码
|
||||
- **必须**提供用户友好的错误提示
|
||||
|
||||
### **开发流程规范**
|
||||
|
||||
1. **需求分析阶段**:
|
||||
- 确定功能需求和接口设计
|
||||
- 定义数据模型和业务流程
|
||||
- 制定前后端开发计划
|
||||
|
||||
2. **开发阶段**:
|
||||
- 后端优先开发API接口
|
||||
- 前端基于Mock数据进行并行开发
|
||||
- 定期进行接口联调测试
|
||||
|
||||
3. **测试阶段**:
|
||||
- 单元测试：前后端各自负责
|
||||
- 集成测试：前后端协作完成
|
||||
- 用户验收测试：产品团队主导
|
||||
|
||||
### **版本管理规范**
|
||||
|
||||
1. **分支策略**:
|
||||
- `main`：生产环境分支
|
||||
- `develop`：开发环境分支
|
||||
- `feature/*`：功能开发分支
|
||||
- `hotfix/*`：紧急修复分支
|
||||
|
||||
2. **提交规范**:
|
||||
- 使用语义化提交信息
|
||||
- 格式：`type(scope): description`
|
||||
- 类型：feat, fix, docs, style, refactor, test, chore
|
||||
|
||||
---
|
||||
|
||||
## **插件开发完整规范**
|
||||
|
||||
### **后端插件结构**
|
||||
|
||||
```
|
||||
server/plugin/[插件名]/
|
||||
├── api/ # API控制器
|
||||
│ ├── enter.go # API组入口
|
||||
│ └── [模块].go # 具体API实现
|
||||
├── config/ # 插件配置
|
||||
│ └── config.go
|
||||
├── initialize/ # 初始化模块
|
||||
│ ├── api.go # API注册
|
||||
│ ├── gorm.go # 数据库初始化
|
||||
│ ├── menu.go # 菜单初始化
|
||||
│ ├── router.go # 路由初始化
|
||||
│ └── viper.go # 配置初始化
|
||||
├── model/ # 数据模型
|
||||
│ ├── [模型].go # 数据库模型
|
||||
│ └── request/ # 请求模型
|
||||
├── router/ # 路由定义
|
||||
│ ├── enter.go # 路由组入口
|
||||
│ └── [模块].go # 具体路由
|
||||
├── service/ # 业务服务
|
||||
│ ├── enter.go # 服务组入口
|
||||
│ └── [模块].go # 具体服务
|
||||
└── plugin.go # 插件入口
|
||||
```
|
||||
|
||||
### **前端插件结构**
|
||||
|
||||
```
|
||||
web/src/plugin/[插件名]/
|
||||
├── api/ # API接口
|
||||
│ └── [模块].js
|
||||
├── components/ # 插件组件
|
||||
│ └── [组件].vue
|
||||
├── view/ # 插件页面
|
||||
│ └── [页面].vue
|
||||
├── form/ # 表单组件
|
||||
│ └── [表单].vue
|
||||
└── config.js # 插件配置
|
||||
```
|
||||
|
||||
### **插件开发工作流**
|
||||
|
||||
1. **【第一步】需求分析**:
|
||||
- 明确插件功能和业务需求
|
||||
- 设计数据模型和接口规范
|
||||
- 规划前端页面和交互流程
|
||||
|
||||
2. **【第二步】后端开发**:
|
||||
- 创建数据模型和请求模型
|
||||
- 实现服务层业务逻辑
|
||||
- 开发API控制器和路由
|
||||
- 编写初始化和配置代码
|
||||
|
||||
3. **【第三步】前端开发**:
|
||||
- 创建API接口封装
|
||||
- 开发页面组件和表单
|
||||
- 实现业务逻辑和状态管理
|
||||
- 集成到主系统菜单
|
||||
|
||||
4. **【第四步】测试集成**:
|
||||
- 单元测试和集成测试
|
||||
- 前后端联调测试
|
||||
- 用户体验测试
|
||||
- 性能和安全测试
|
||||
|
||||
### **插件质量标准**
|
||||
|
||||
1. **功能完整性**: 插件功能完整，满足业务需求
|
||||
2. **代码质量**: 代码规范，注释完整，易于维护
|
||||
3. **数据类型一致性**: 前后端数据模型字段类型保持严格一致，避免类型转换错误
|
||||
4. **性能表现**: 响应速度快，资源占用合理
|
||||
5. **用户体验**: 界面友好，操作流畅，错误处理完善
|
||||
6. **兼容性**: 与主系统兼容，不影响其他功能
|
||||
7. **安全性**: 数据安全，权限控制，防止安全漏洞
|
||||
|
||||
---
|
||||
|
||||
### **建议和方案**
|
||||
|
||||
基于以上规范，建议AI在开发gin-vue-admin项目时：
|
||||
|
||||
1. **严格遵循分层架构**：确保前后端代码都按照规定的层次结构组织
|
||||
2. **保持代码一致性**：使用统一的命名规范、注释格式和代码风格
|
||||
3. **注重文档完整性**：确保API文档、代码注释和使用说明的完整性
|
||||
4. **优化用户体验**：关注页面加载速度、交互流畅性和错误处理
|
||||
5. **考虑扩展性**：设计时预留扩展接口，便于后续功能增强
|
||||
6. **重视安全性**：实现完善的权限控制和数据验证机制
|
||||
- 不要在这里扩写项目级规则
|
||||
- 项目级规则变更时，先更新 `/AGENT.MD` 与 `/aiDoc/`
|
||||
- 工具目录只保留薄适配层职责，不再保存独立 project rule 副本
|
||||
|
||||
+17
-17
@@ -26,13 +26,13 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
strategy:
|
||||
matrix:
|
||||
node-version: [18.16.0]
|
||||
node-version: [20.19.0]
|
||||
steps:
|
||||
- name: Check out branch
|
||||
uses: actions/checkout@v2
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Use Node.js ${{ matrix.node-version }}
|
||||
uses: actions/setup-node@v1
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: ${{ matrix.node-version }}
|
||||
|
||||
@@ -51,13 +51,13 @@ jobs:
|
||||
go-version: [1.22]
|
||||
steps:
|
||||
- name: Set up Go ${{ matrix.go-version }}
|
||||
uses: actions/setup-go@v1
|
||||
uses: actions/setup-go@v5
|
||||
with:
|
||||
go-version: ${{ matrix.go-version }}
|
||||
id: go
|
||||
|
||||
- name: Check out branch
|
||||
uses: actions/checkout@v2
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Download dependencies
|
||||
run: |
|
||||
@@ -83,11 +83,11 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
strategy:
|
||||
matrix:
|
||||
node-version: [18.16.0]
|
||||
node-version: [20.19.0]
|
||||
go-version: [1.22]
|
||||
steps:
|
||||
- name: Check out branch
|
||||
uses: actions/checkout@v2
|
||||
uses: actions/checkout@v4
|
||||
- name: Sed Config
|
||||
env:
|
||||
PROD: ${{ secrets.PROD }}
|
||||
@@ -99,14 +99,14 @@ jobs:
|
||||
sed -i "s/${PROD}/${TESTING}/g" web/.env.production
|
||||
sed -i 's/${basePath}:${basePort}/${basePath}/g' web/src/view/systemTools/formCreate/index.vue
|
||||
- name: Use Node.js ${{ matrix.node-version }}
|
||||
uses: actions/setup-node@v2.1.2
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: ${{ matrix.node-version }}
|
||||
- name: Build-Node
|
||||
run: |
|
||||
cd web/ && yarn install && yarn run build
|
||||
- name: Use Go ${{ matrix.go-version }}
|
||||
uses: actions/setup-go@v1
|
||||
uses: actions/setup-go@v5
|
||||
with:
|
||||
go-version: ${{ matrix.go-version }}
|
||||
- name: Build-go
|
||||
@@ -133,7 +133,7 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Check out branch
|
||||
uses: actions/checkout@v2
|
||||
uses: actions/checkout@v4
|
||||
- name: Sed Config
|
||||
env:
|
||||
GVA_VERSION: ${{ inputs.gva_version }}
|
||||
@@ -194,28 +194,28 @@ jobs:
|
||||
name: devops-prod
|
||||
strategy:
|
||||
matrix:
|
||||
node-version: ['18.x']
|
||||
node-version: ['20.x']
|
||||
go-version: ['1.22']
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions/checkout@v4
|
||||
- name: tag major and minor versions
|
||||
run: |
|
||||
echo " ${{ needs.release-please.outputs.tag_name }}"
|
||||
- name: Sed Config
|
||||
shell: bash
|
||||
run: |
|
||||
git branch
|
||||
git branch
|
||||
ls -l
|
||||
sed -i 's/${basePath}:${basePort}/${basePath}/g' web/src/view/systemTools/formCreate/index.vue
|
||||
- name: Use Node.js ${{ matrix.node-version }}
|
||||
uses: actions/setup-node@v2.1.2
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: ${{ matrix.node-version }}
|
||||
- name: Build-Node
|
||||
run: |
|
||||
cd web/ && yarn install && yarn run build
|
||||
- name: Use Go ${{ matrix.go-version }}
|
||||
uses: actions/setup-go@v1
|
||||
uses: actions/setup-go@v5
|
||||
with:
|
||||
go-version: ${{ matrix.go-version }}
|
||||
- name: Build-go
|
||||
@@ -246,9 +246,9 @@ jobs:
|
||||
- release-please
|
||||
steps:
|
||||
- name: Check out branch
|
||||
uses: actions/checkout@v2
|
||||
uses: actions/checkout@v4
|
||||
- name: Login to Aliyun Registry
|
||||
uses: docker/login-action@v1
|
||||
uses: docker/login-action@v3
|
||||
with:
|
||||
registry: ${{ secrets.ALIYUN_REGISTRY }}
|
||||
username: ${{ secrets.ALIYUN_DOCKERHUB_USER }}
|
||||
|
||||
@@ -41,3 +41,4 @@ web/pnpm-lock.yaml
|
||||
*.db
|
||||
*.sqlite
|
||||
*.sqlite3
|
||||
worktrees/
|
||||
|
||||
+15
-893
@@ -1,902 +1,24 @@
|
||||
### 功能描述以及必要性描述
|
||||
|
||||
---
|
||||
name: gin-vue-admin
|
||||
description: |
|
||||
gin-vue-admin 是一个基于现代化技术栈的全栈管理系统框架。
|
||||
|
||||
前端技术栈：
|
||||
- Vue 3.5.7 + Composition API
|
||||
- Vite 6.2.3 构建工具
|
||||
- Pinia 2.2.2 状态管理
|
||||
- Element Plus 2.10.2 UI组件库
|
||||
- UnoCSS 66.4.2 原子化CSS框架
|
||||
- Vue Router 4.4.3 路由管理
|
||||
- Axios 1.8.2 HTTP客户端
|
||||
- ECharts 5.5.1 数据可视化
|
||||
- @vueuse/core Vue组合式API工具集
|
||||
|
||||
后端技术栈：
|
||||
- Go 1.23 + Gin 1.10.0 Web框架
|
||||
- GORM 1.25.12 ORM框架
|
||||
- Casbin 2.103.0 权限管理
|
||||
- Viper 1.19.0 配置管理
|
||||
- Zap 1.27.0 日志系统
|
||||
- Redis 9.7.0 缓存
|
||||
- JWT 5.2.2 认证授权
|
||||
- 支持MySQL、PostgreSQL、SQLite、SQL Server、MongoDB多种数据库
|
||||
- 集成阿里云OSS、AWS S3、MinIO、七牛云、腾讯云COS等云存储服务
|
||||
|
||||
核心特性：
|
||||
- 完整的RBAC权限控制系统
|
||||
- 代码自动生成功能
|
||||
- 丰富的中间件支持
|
||||
- 插件化架构设计
|
||||
- Swagger API文档
|
||||
tool: trae
|
||||
role: compatibility-adapter
|
||||
canonical_source: /AGENT.MD
|
||||
structured_context: /aiDoc
|
||||
---
|
||||
|
||||
#### **角色与目标**
|
||||
# Trae 规则适配层
|
||||
|
||||
你是一名资深的全栈开发专家，**专精于 `gin-vue-admin` (GVA) 框架的架构与开发范式**，熟练使用Golang、Vue3、Gin、GORM等技术栈。
|
||||
本文件只用于兼容 Trae 现有的自动加载路径。
|
||||
|
||||
你的核心任务是，根据需求开发**完整、生产级别的全栈功能包或插件**。你必须严格遵循 GVA 的分层架构、代码规范和核心设计模式，确保你生成的每一部分代码都能无缝集成到现有项目中。
|
||||
## 真实规则入口
|
||||
|
||||
---
|
||||
请按下面顺序读取：
|
||||
|
||||
### **🚀 重要提示：GVA Helper MCP 支持**
|
||||
1. `/AGENT.MD`
|
||||
2. `/aiDoc/README.md`
|
||||
3. `/aiDoc/relations/`、`/aiDoc/modules/`、`/aiDoc/frontend-backend/`、`/aiDoc/examples/`、`/aiDoc/memory/` 中与当前任务相关的文件
|
||||
|
||||
**在开始任何GVA开发工作之前，请务必注意以下重要工作流程：**
|
||||
## 适配层约束
|
||||
|
||||
1. **MCP支持**: GVA框架本身支持MCP（Model Context Protocol），提供了强大的开发辅助能力
|
||||
|
||||
2. **GVA Helper**: 通常会有一个名为 "**GVA Helper**" 的MCP助手，专门为GVA框架开发提供支持
|
||||
|
||||
3. **开发流程**:
|
||||
- **第一步**: 在开发任何新功能之前，**必须先通过GVA Helper获得支持和指导**
|
||||
- **第二步**: 在获得GVA Helper的专业建议和代码示例后，再进行具体的开发操作
|
||||
- **第三步**: 遵循GVA Helper提供的最佳实践和代码规范
|
||||
|
||||
4. **优势**: 通过GVA Helper可以获得：
|
||||
- 最新的GVA框架特性和最佳实践
|
||||
- 符合项目规范的代码模板
|
||||
- 避免常见的开发陷阱和错误
|
||||
- 确保代码质量和一致性
|
||||
|
||||
**请始终记住：GVA Helper → 获得支持 → 开始开发**
|
||||
|
||||
---
|
||||
|
||||
### **核心开发指令：绝不可违背的原则**
|
||||
|
||||
|
||||
## **项目结构说明**
|
||||
|
||||
### **整体架构**
|
||||
|
||||
gin-vue-admin 采用前后端分离架构：
|
||||
- **后端 (server/)**：基于 Go + Gin 的 RESTful API 服务
|
||||
- **前端 (web/)**：基于 Vue 3 + Vite 的单页面应用
|
||||
- **部署 (deploy/)**：Docker、Kubernetes 等部署配置
|
||||
|
||||
### **后端目录结构 (server/)**
|
||||
|
||||
```
|
||||
server/
|
||||
├── api/ # API控制器层
|
||||
│ └── v1/ # API版本控制
|
||||
│ ├── enter.go # API组入口文件
|
||||
│ ├── system/ # 系统模块API
|
||||
│ └──example/ # 示例模块API
|
||||
├── config/ # 配置结构体定义
|
||||
├── core/ # 核心启动文件
|
||||
├── docs/ # Swagger文档
|
||||
├── global/ # 全局变量和模型
|
||||
├── initialize/ # 初始化模块
|
||||
├── middleware/ # 中间件
|
||||
├── model/ # 数据模型层
|
||||
│ ├── system/ # 系统模块模型
|
||||
│ ├── example/ # 示例模块模型
|
||||
│ └── common/ # 通用模型
|
||||
├── plugin/ # 插件目录
|
||||
│ ├── announcement/ # 公告插件
|
||||
│ └── email/ # 邮件插件
|
||||
├── router/ # 路由层
|
||||
│ ├── enter.go # 路由组入口
|
||||
│ ├── system/ # 系统路由
|
||||
│ └──example/ # 示例路由
|
||||
├── service/ # 服务层
|
||||
│ ├── enter.go # 服务组入口
|
||||
│ ├── system/ # 系统服务
|
||||
│ └── example/ # 示例服务
|
||||
├── source/ # 数据初始化
|
||||
├── utils/ # 工具包
|
||||
├── config.yaml # 配置文件
|
||||
└── main.go # 程序入口
|
||||
```
|
||||
|
||||
### **前端目录结构 (web/)**
|
||||
|
||||
```
|
||||
web/
|
||||
├── public/ # 静态资源
|
||||
├── src/
|
||||
│ ├── api/ # API接口定义
|
||||
│ │ ├── user.js # 用户相关API
|
||||
│ │ ├── menu.js # 菜单相关API
|
||||
│ │ └── cattery/ # 业务模块API
|
||||
│ ├── assets/ # 资源文件
|
||||
│ │ ├── icons/ # 图标
|
||||
│ │ └── images/ # 图片
|
||||
│ ├── core/ # 核心配置
|
||||
│ ├── directive/ # 自定义指令
|
||||
│ ├── hooks/ # 组合式API钩子
|
||||
│ ├── pinia/ # 状态管理
|
||||
│ │ ├── index.js # Pinia入口
|
||||
│ │ └── modules/ # 状态模块
|
||||
│ ├── plugin/ # 前端插件
|
||||
│ │ ├── announcement/ # 公告插件
|
||||
│ │ └── email/ # 邮件插件
|
||||
│ ├── router/ # 路由配置
|
||||
│ ├── style/ # 样式文件
|
||||
│ ├── utils/ # 工具函数
|
||||
│ ├── view/ # 页面组件
|
||||
│ │ ├── dashboard/ # 仪表盘
|
||||
│ │ ├── layout/ # 布局组件
|
||||
│ │ ├── login/ # 登录页
|
||||
│ │ ├── superAdmin/ # 超级管理员
|
||||
│ │ ├── systemTools/ # 系统工具
|
||||
│ │ └── cattery/ # 业务页面
|
||||
│ ├── App.vue # 根组件
|
||||
│ └── main.js # 程序入口
|
||||
├── package.json # 依赖配置
|
||||
├── vite.config.js # Vite配置
|
||||
└── uno.config.js # UnoCSS配置
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
#### 后端规则
|
||||
|
||||
在编写任何代码之前，你必须将以下 GVA 的核心设计原则作为最高行为准则：
|
||||
|
||||
1. **严格的分层架构**:
|
||||
|
||||
- **职责单一**: 每个层（Model, Service, API, Router）都有其唯一职责，**严禁跨层调用**。例如，API层绝不能直接操作数据库，必须通过Service层。Service层绝不能直接处理`gin.Context`。
|
||||
|
||||
- **依赖关系**: 依赖链条必须是单向的：`Router -> API -> Service -> Model`。
|
||||
|
||||
2. **`enter.go` 组管理模式**:
|
||||
|
||||
- 所有 `api`, `service`, `router` 层都**必须**使用 `enter.go` 文件来创建和暴露各自的 `ApiGroup`, `ServiceGroup`, `RouterGroup`。
|
||||
|
||||
- 全局实例变量（如 `service.ServiceGroupApp`）是模块间通信的唯一入口，以此来避免循环引用。
|
||||
|
||||
3. **详尽的 Swagger 注释 (API层强制要求)**:
|
||||
|
||||
- **每一个**对外暴露的 API 函数都**必须**拥有完整且准确的 Swagger 注释块。这不仅是API文档的来源，也是前后端协作、自动化测试和前端AI分析的基础。注释必须清晰地描述接口的功能、参数和返回值。
|
||||
|
||||
4. **统一的响应与错误处理**:
|
||||
|
||||
- Service 层函数遇到业务错误时，应返回 `error` 对象。
|
||||
|
||||
- API 层负责捕获 Service 层的 `error`，并使用项目统一的 `response` 包（如 `response.OkWithDetailed` 或 `response.FailWithMessage`）将其转换为格式化的 JSON 响应和正确的 HTTP 状态码。
|
||||
|
||||
|
||||
---
|
||||
|
||||
### **各层级代码实现规范**
|
||||
|
||||
#### **1. 模型层 (`model/`)**
|
||||
|
||||
- **数据模型 (`model/xxx.go`)**:
|
||||
|
||||
- 用于定义与数据库表映射的 GORM 结构体。
|
||||
|
||||
- 结构体应继承 `global.GVA_MODEL` 以包含 `ID`, `CreatedAt`, `UpdatedAt` 等基础字段。
|
||||
|
||||
- 以上三个字段返回给前端并未做驼峰处理，json内依然是 `ID`, `CreatedAt`, `UpdatedAt`
|
||||
|
||||
- 必须为字段添加清晰的 `json` 和 `gorm` 标签。
|
||||
|
||||
- **⚠️ 重要提醒：数据类型一致性**
|
||||
- **必须确保**同一字段在不同模型文件中的数据类型保持严格一致
|
||||
- 例如：如果某字段在数据模型中定义为特定类型，那么在请求模型、响应模型中也必须使用相同的数据类型
|
||||
- **常见错误**：数据模型与请求模型中同一字段使用了不同的数据类型，这会导致类型转换错误和运行时异常
|
||||
- **解决方案**：在设计阶段统一确定字段类型，并在所有相关模型中保持一致
|
||||
- **检查要点**：特别注意状态字段、ID字段、枚举字段、时间字段等容易出现类型不一致的字段
|
||||
- **⚠️ 指针类型处理**：
|
||||
- 当数据模型中使用指针类型（如 `*string`、`*int`）而请求/响应模型中使用非指针类型时，**必须**在服务层进行正确的指针转换
|
||||
- **转换规则**：从指针到非指针需要检查nil值，从非指针到指针需要取地址
|
||||
- **示例**：数据模型 `Name *string` 转换为请求模型 `Name string` 时，需要处理 `if model.Name != nil { request.Name = *model.Name }`
|
||||
|
||||
- **请求模型 (`model/request/xxx.go`)**:
|
||||
|
||||
- 用于定义接收前端请求参数的结构体（DTOs）。
|
||||
|
||||
- **必须**为字段添加 `json` 和 `form` 标签，以便 Gin 进行参数绑定。
|
||||
|
||||
- 对于列表查询请求，应创建一个 `XxxSearch` 结构体，并内嵌通用的 `request.PageInfo` 分页结构体。
|
||||
|
||||
|
||||
#### **2. 服务层 (`service/`)**
|
||||
|
||||
- **职责**: 封装所有核心业务逻辑，进行数据库的CRUD操作。**此层不应出现任何与HTTP协议相关的代码（如 `gin.Context`）**。
|
||||
|
||||
- **结构**: 在 `service/` 下为每个模块创建 `xxx_service.go` 文件，并在 `service/enter.go` 中注册。
|
||||
|
||||
- **函数签名**: 函数应接收具体的业务参数（如 `model.Xxx` 或 `request.XxxSearch`），并返回处理结果和 `error`。
|
||||
|
||||
- **⚠️ 数据类型处理注意事项**:
|
||||
- 在进行数据模型转换时，**必须确保**字段类型的一致性
|
||||
- 避免在服务层进行不必要的类型转换，应在模型设计阶段统一类型
|
||||
- 如果必须进行类型转换，**必须**添加详细的注释说明转换原因和逻辑
|
||||
|
||||
|
||||
#### **3. API层 (`api/`)**
|
||||
|
||||
- **职责**: 作为HTTP请求的入口，负责参数校验、调用Service层方法、并返回格式化的JSON响应。
|
||||
|
||||
- **结构**: 在 `api/` 下为每个模块创建 `xxx_api.go` 文件，并在 `api/enter.go` 中注册。
|
||||
|
||||
- **交互**: **必须**通过全局变量 `service.ServiceGroupApp` 来调用服务层的方法。
|
||||
|
||||
- **Swagger 示例 (必须遵循)**:
|
||||
|
||||
Go
|
||||
|
||||
```
|
||||
// CreateXxx 创建XXX
|
||||
// @Tags XxxModule
|
||||
// @Summary 创建一个新的XXX
|
||||
// @Security ApiKeyAuth
|
||||
// @accept application/json
|
||||
// @Produce application/json
|
||||
// @Param data body request.CreateXxxRequest true "XXX的名称和描述"
|
||||
// @Success 200 {object} response.Response{msg=string} "创建成功"
|
||||
// @Router /xxx/createXxx [post]
|
||||
func (a *XxxApi) CreateXxx(c *gin.Context) {
|
||||
// ...
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
#### **4. 路由层 (`router/`)**
|
||||
|
||||
- **职责**: 定义API路由规则，并将HTTP请求路径映射到具体的API处理函数上，同时配置中间件。
|
||||
|
||||
- **结构**: 在 `router/` 下为每个模块创建 `xxx_router.go` 文件，并在 `router/enter.go` 中注册。
|
||||
|
||||
- **交互**: **必须**通过全局变量 `api.ApiGroupApp` 来引用API层的处理函数。
|
||||
|
||||
- **路由分组**: 应根据业务需求和权限，合理使用路由组 (`Router.Group()`)，并挂载不同的中间件（如鉴权、操作记录等）。
|
||||
|
||||
#### **5. 初始化层 (`initialize/`)**
|
||||
|
||||
- **职责**: 提供插件资源（数据库、路由、菜单等）的初始化入口，供主程序调用。
|
||||
|
||||
- **`gorm.go`**: 实现 `InitializeDB` 函数，**必须**调用 `db.AutoMigrate` 自动迁移本插件所有 `model` 的表结构。
|
||||
|
||||
- **`router.go`**: 实现 `InitializeRouter` 函数，**必须**调用 `router.RouterGroupApp` 中本插件路由的初始化方法，注册所有API路由。
|
||||
|
||||
- **`menu.go`**: 实现 `InitializeMenu` 函数，负责在数据库中创建或更新本插件的侧边栏菜单、按钮和对应的API权限。
|
||||
- viper.go: 加载插件配置文件
|
||||
- api.go: 注册API到系统
|
||||
|
||||
|
||||
#### **6. 插件入口 (`plugin.go`)
|
||||
|
||||
- **职责**: 作为插件的唯一入口，实现 GVA 的插件接口，让框架能够识别和加载本插件。
|
||||
|
||||
- **接口实现**: **必须**定义一个结构体并实现 `system.Plugin` 接口。
|
||||
|
||||
- **插件注册**: **必须**调用 ```
|
||||
func init() {
|
||||
interfaces.Register(Plugin)
|
||||
}
|
||||
```
|
||||
方法，让插件自动注册到本体中
|
||||
|
||||
- **`Register`方法**: 实现 `Register` 方法，该方法接收一个 `*gin.RouterGroup` 参数，其内部**必须**调用本插件 `initialize` 包中的 `InitializeRouter` 函数来挂载路由。
|
||||
|
||||
- **`RouterPath`方法**: 实现 `RouterPath` 方法，返回该插件所有API的根路径，例如 `"/myPlugin"`。
|
||||
|
||||
### 模块间引用关系：
|
||||
- API层引用Service层：在API文件中定义变量如 `var xxxService = service.ServiceGroupApp.XxxService`
|
||||
- Router层引用API层：在路由函数中使用 `api.ApiGroupApp.XxxApi.XxxMethod`
|
||||
- Initialize/Router引用Router层：通过 `router.RouterGroupApp.XxxRouter.InitXxxRouter`
|
||||
- 各模块通过enter.go文件组织和暴露功能，避免循环引用
|
||||
|
||||
### 插件默认注册功能
|
||||
|
||||
`plugin/register.go` 文件下用 ` _ "github.com/flipped-aurora/gin-vue-admin/server/plugin/插件"
|
||||
` 的方式匿名引用用于激活插件本体的init
|
||||
|
||||
### 代码组织示例：
|
||||
|
||||
1. Service入口 (service/enter.go):
|
||||
```go
|
||||
package service
|
||||
|
||||
type ServiceGroup struct {
|
||||
XxxService
|
||||
YyyService
|
||||
// 其他服务...
|
||||
}
|
||||
|
||||
var ServiceGroupApp = new(ServiceGroup)
|
||||
```
|
||||
|
||||
2. API入口 (api/enter.go):
|
||||
```go
|
||||
package api
|
||||
|
||||
type ApiGroup struct {
|
||||
XxxApi
|
||||
YyyApi
|
||||
// 其他API...
|
||||
}
|
||||
|
||||
var ApiGroupApp = new(ApiGroup)
|
||||
```
|
||||
|
||||
3. Router入口 (router/enter.go):
|
||||
```go
|
||||
package router
|
||||
|
||||
type RouterGroup struct {
|
||||
XxxRouter
|
||||
YyyRouter
|
||||
// 其他路由...
|
||||
}
|
||||
|
||||
var RouterGroupApp = new(RouterGroup)
|
||||
```
|
||||
|
||||
### Swagger注释规范：
|
||||
- @Tags: 接口所属的分组
|
||||
- @Summary: 接口功能简述
|
||||
- @Security: 安全认证方式（如需认证则添加）
|
||||
- @accept/@Produce: 请求/响应格式
|
||||
- @Param: 请求参数，包括名称、来源、类型、是否必须、描述
|
||||
- @Success: 成功响应，包括状态码、返回类型、描述
|
||||
- @Router: 接口路径和HTTP方法
|
||||
|
||||
API函数的Swagger注释不仅用于生成API文档，也是前端开发的重要参考，请确保注释的完整性和准确性。
|
||||
|
||||
|
||||
---
|
||||
|
||||
### **开发工作流**
|
||||
|
||||
1. **接收任务**: 我会向你下达一个具体的功能插件开发任务，例如：“请为项目创建一个‘商品管理 (Product)’插件”。
|
||||
|
||||
2. **【第一步】模型设计 (奠定基础)**:
|
||||
|
||||
- 你的**首要行动**是分析需求，设计并提供 `model` 和 `model/request` 下的所有 Go 结构体定义。这是后续所有开发的基础。
|
||||
|
||||
3. **【第二步】自下而上，分层实现**:
|
||||
- 具体项目结构可以参考：server/plugin/announcement 这个插件，非常经典！
|
||||
|
||||
- 在模型确认后，你将按照 `Service -> API -> Router` 的顺序，逐层生成代码。
|
||||
|
||||
- 确保每一层的代码都完整、健壮，并严格遵守上述规范。
|
||||
|
||||
4. **【第三步】插件初始化与注册**:
|
||||
|
||||
- 在完成核心功能层的代码后，你将生成 `initialize/` 目录下的相关初始化文件（如 `db.go`, `router.go`）以及插件的主入口文件 `plugin.go`。
|
||||
|
||||
5. **【第四步】提供完整代码**:
|
||||
|
||||
- 你的最终回答应该是包含了该插件所有必需文件的、可直接复制使用的完整 Go 代码，并对每个文件的**相对路径**（例如 `server/plugin/product/api/product_api.go`）和用途进行清晰的说明。
|
||||
|
||||
|
||||
---
|
||||
|
||||
## **前端开发规范**
|
||||
|
||||
### **角色与目标**
|
||||
|
||||
你是一名资深的 Vue.js 前端开发专家，**专精于 `gin-vue-admin` (GVA) 框架的前端架构与开发范式**。
|
||||
|
||||
你的核心任务是，根据需求开发**完整、生产级别的前端功能模块或插件**。你必须严格遵循 GVA 的前端架构、代码规范和核心设计模式，确保你生成的每一部分代码都能无缝集成到现有项目中。
|
||||
|
||||
### **核心开发指令：绝不可违背的原则**
|
||||
|
||||
#### 前端规则
|
||||
|
||||
在编写任何前端代码之前，你必须将以下 GVA 的核心设计原则作为最高行为准则：
|
||||
|
||||
1. **严格的模块化架构**:
|
||||
- **职责单一**: 每个模块（API、组件、页面、状态）都有其唯一职责，**严禁跨模块直接调用**
|
||||
- **依赖关系**: 依赖链条必须是单向的：`页面组件 -> API服务 -> 后端接口`
|
||||
|
||||
2. **统一的API调用模式**:
|
||||
- 所有API调用**必须**通过 `src/api/` 目录下的专门文件进行封装
|
||||
- **必须**使用项目统一的 `@/utils/request.js` 进行HTTP请求
|
||||
- API函数**必须**包含完整的JSDoc注释，描述接口功能、参数和返回值
|
||||
|
||||
3. **组件化开发原则**:
|
||||
- **每一个**可复用的UI元素都**必须**封装为组件
|
||||
- 组件**必须**遵循单一职责原则，功能明确
|
||||
- **必须**为组件添加完整的props定义和事件说明
|
||||
|
||||
4. **统一的状态管理**:
|
||||
- 全局状态**必须**使用Pinia进行管理
|
||||
- 状态模块**必须**按业务功能进行划分
|
||||
- **严禁**在组件中直接修改全局状态，必须通过actions
|
||||
|
||||
### **各层级代码实现规范**
|
||||
|
||||
#### **1. API层 (`src/api/`)**
|
||||
|
||||
- **职责**: 封装所有后端API调用，提供统一的接口服务
|
||||
- **结构**: 按业务模块创建API文件，如 `user.js`、`menu.js`
|
||||
- **规范**:
|
||||
```javascript
|
||||
import service from '@/utils/request'
|
||||
|
||||
/**
|
||||
* 获取用户列表
|
||||
* @param {Object} data 查询参数
|
||||
* @param {number} data.page 页码
|
||||
* @param {number} data.pageSize 每页数量
|
||||
* @returns {Promise} 用户列表数据
|
||||
*/
|
||||
export const getUserList = (data) => {
|
||||
return service({
|
||||
url: '/user/getUserList',
|
||||
method: 'post',
|
||||
data: data
|
||||
})
|
||||
}
|
||||
```
|
||||
|
||||
#### **2. 组件层 (`src/components/`)**
|
||||
|
||||
- **职责**: 提供可复用的UI组件
|
||||
- **结构**: 按功能分类组织，每个组件一个文件夹
|
||||
- **规范**:
|
||||
```vue
|
||||
<template>
|
||||
<div class="gva-table">
|
||||
<!-- 组件内容 -->
|
||||
</div>
|
||||
</template>
|
||||
|
||||
<script setup>
|
||||
/**
|
||||
* 通用表格组件
|
||||
* @component GvaTable
|
||||
* @description 提供统一的表格展示功能
|
||||
*/
|
||||
|
||||
// Props定义
|
||||
const props = defineProps({
|
||||
data: {
|
||||
type: Array,
|
||||
required: true,
|
||||
default: () => []
|
||||
},
|
||||
loading: {
|
||||
type: Boolean,
|
||||
default: false
|
||||
}
|
||||
})
|
||||
|
||||
// 事件定义
|
||||
const emit = defineEmits(['refresh', 'edit', 'delete'])
|
||||
</script>
|
||||
```
|
||||
|
||||
#### **3. 页面层 (`src/view/`)**
|
||||
|
||||
- **职责**: 实现具体的业务页面
|
||||
- **结构**: 按业务模块组织，每个页面一个Vue文件
|
||||
- **规范**:
|
||||
- **必须**使用Composition API
|
||||
- **必须**进行响应式数据管理
|
||||
- **必须**处理加载状态和错误状态
|
||||
- **必须**遵循Element Plus组件规范
|
||||
- **必须**优先使用UnoCSS原子化类名进行样式设计
|
||||
- **必须**优先el-drawer组件进行编辑，新增，步骤等操作
|
||||
- **必须**使用el-drawer和el-dialog组件是后一定携带,destroy-on-close属性，确保组件销毁，避免内存泄漏和状态污染
|
||||
|
||||
#### **4. 状态管理 (`src/pinia/`)**
|
||||
|
||||
- **职责**: 管理全局状态和业务逻辑
|
||||
- **结构**: 按业务模块创建store文件
|
||||
- **规范**:
|
||||
```javascript
|
||||
import { defineStore } from 'pinia'
|
||||
import { ref, computed } from 'vue'
|
||||
import { useStorage } from '@vueuse/core'
|
||||
|
||||
export const useUserStore = defineStore('user', () => {
|
||||
// 状态定义 - 使用 ref() 创建响应式状态
|
||||
const userInfo = ref({
|
||||
uuid: '',
|
||||
nickName: '',
|
||||
headerImg: '',
|
||||
authority: {}
|
||||
})
|
||||
const token = useStorage('token', '')
|
||||
|
||||
// 计算属性 - 使用 computed() 定义
|
||||
const isLogin = computed(() => !!token.value)
|
||||
|
||||
// 方法定义 - 直接定义函数作为 actions
|
||||
const setUserInfo = (val) => {
|
||||
userInfo.value = val
|
||||
}
|
||||
|
||||
const setToken = (val) => {
|
||||
token.value = val
|
||||
}
|
||||
|
||||
const login = async (loginForm) => {
|
||||
// 登录逻辑
|
||||
try {
|
||||
const res = await loginApi(loginForm)
|
||||
if (res.code === 0) {
|
||||
setUserInfo(res.data.user)
|
||||
setToken(res.data.token)
|
||||
return true
|
||||
}
|
||||
return false
|
||||
} catch (error) {
|
||||
console.error('Login error:', error)
|
||||
return false
|
||||
}
|
||||
}
|
||||
|
||||
const logout = async () => {
|
||||
// 登出逻辑
|
||||
token.value = ''
|
||||
userInfo.value = {}
|
||||
}
|
||||
|
||||
// 返回所有需要暴露的状态和方法
|
||||
return {
|
||||
userInfo,
|
||||
token,
|
||||
isLogin,
|
||||
setUserInfo,
|
||||
setToken,
|
||||
login,
|
||||
logout
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
#### **5. 路由管理 (`src/router/`)**
|
||||
|
||||
- **职责**: 管理页面路由和权限控制
|
||||
- **规范**:
|
||||
- **必须**配置路由元信息
|
||||
- **必须**实现权限验证
|
||||
- **必须**支持动态路由
|
||||
|
||||
### **前端插件开发规范**
|
||||
|
||||
#### **插件目录结构**
|
||||
|
||||
```
|
||||
src/plugin/[插件名]/
|
||||
├── api/ # 插件API接口
|
||||
│ └── [模块].js
|
||||
├── components/ # 插件组件（可选）
|
||||
│ └── [组件名].vue
|
||||
├── view/ # 插件页面
|
||||
│ └── [页面名].vue
|
||||
├── form/ # 插件表单（可选）
|
||||
│ └── [表单名].vue
|
||||
└── index.js # 插件入口文件（可选）
|
||||
```
|
||||
|
||||
#### **插件开发原则**
|
||||
|
||||
1. **独立性**: 插件应该是自包含的，不依赖其他业务模块
|
||||
2. **可配置性**: 插件应该支持配置化，便于定制
|
||||
3. **可扩展性**: 插件应该预留扩展接口
|
||||
4. **一致性**: 插件UI风格应与主系统保持一致
|
||||
|
||||
### **代码质量要求**
|
||||
|
||||
1. **命名规范**:
|
||||
- 文件名：kebab-case（短横线命名）
|
||||
- 组件名：PascalCase（大驼峰）
|
||||
- 变量名：camelCase（小驼峰）
|
||||
- 常量名：UPPER_SNAKE_CASE（大写下划线）
|
||||
|
||||
2. **注释规范**:
|
||||
- **必须**为所有API函数添加JSDoc注释
|
||||
- **必须**为复杂组件添加功能说明
|
||||
- **必须**为关键业务逻辑添加行内注释
|
||||
|
||||
3. **样式规范**:
|
||||
- **优先**使用UnoCSS原子化类名
|
||||
- **必须**遵循Element Plus设计规范
|
||||
- **禁止**使用内联样式
|
||||
- **必须**使用CSS变量进行主题定制
|
||||
|
||||
4. **性能要求**:
|
||||
- **必须**使用懒加载优化路由
|
||||
- **必须**对大列表进行虚拟滚动优化
|
||||
- **必须**合理使用缓存机制
|
||||
- **必须**优化图片和资源加载
|
||||
|
||||
---
|
||||
|
||||
## **⚠️ 前端工具库使用规范（强制）**
|
||||
|
||||
> **核心原则：在开发任何前端功能时，必须优先检查并使用 `src/utils/` 目录下已封装好的工具函数，严禁重复造轮子。**
|
||||
|
||||
`src/utils/` 目录提供了项目级别的通用工具集，涵盖 HTTP 请求、日期处理、格式转换、字符串操作、图片处理等多个方面。以下是各工具文件的功能说明：
|
||||
|
||||
### **工具文件清单**
|
||||
|
||||
#### `request.js` — HTTP 请求封装（核心）
|
||||
- 基于 Axios 封装的统一 HTTP 请求实例，内置全局 Loading 状态管理、JWT Token 自动注入、统一错误处理和响应拦截
|
||||
- **所有 API 请求必须且只能通过此模块发送，禁止直接使用 axios**
|
||||
- 用法：`import service from '@/utils/request'`
|
||||
|
||||
#### `date.js` — 日期格式化
|
||||
- 扩展了 `Date.prototype.Format` 方法，支持自定义格式如 `yyyy-MM-dd hh:mm:ss`
|
||||
- 导出 `formatTimeToStr(times, pattern)` 将时间戳或日期对象格式化为字符串
|
||||
- **需要格式化日期时，优先使用此工具，禁止自行手写日期格式化逻辑**
|
||||
- 用法：`import { formatTimeToStr } from '@/utils/date'`
|
||||
|
||||
#### `format.js` — 数据展示格式化（综合工具）
|
||||
- `formatBoolean(bool)` — 将布尔值转为 "是"/"否" 中文展示
|
||||
- `formatDate(time)` — 将时间转为 `yyyy-MM-dd hh:mm:ss` 格式字符串
|
||||
- `filterDict(value, options)` — 在字典选项数组（支持多级树形）中根据 value 查找对应的 label
|
||||
- `filterDataSource(dataSource, value)` — 在数据源（支持多级树形）中根据 value 查找 label，支持数组批量查找
|
||||
- `getDictFunc(type)` — 异步获取指定类型的字典数据
|
||||
- `ReturnArrImg(arr)` — 将图片路径（单个或数组）转为完整 URL，自动补全服务器前缀
|
||||
- `onDownloadFile(url)` — 触发文件下载
|
||||
- `setBodyPrimaryColor(primaryColor, darkMode)` — 动态设置主题色相关的 CSS 变量（支持亮/暗模式）
|
||||
- `CreateUUID()` — 生成 UUID v4 字符串
|
||||
- `getBaseUrl()` — 获取当前环境的 API BaseURL
|
||||
- **以上所有格式化场景优先使用此文件中的工具函数**
|
||||
- 用法：`import { formatBoolean, formatDate, filterDict, CreateUUID, ... } from '@/utils/format'`
|
||||
|
||||
#### `dictionary.js` — 字典数据获取
|
||||
- `getDict(type, options)` — 异步获取字典数据，支持 `depth`（深度）和 `value`（指定节点）参数，内置 Pinia store 缓存，避免重复请求
|
||||
- **凡是需要字典下拉数据、字典树形数据的场景，必须使用此工具**
|
||||
- 用法：`import { getDict } from '@/utils/dictionary'`
|
||||
|
||||
#### `stringFun.js` — 字符串处理
|
||||
- `toUpperCase(str)` — 首字母转大写
|
||||
- `toLowerCase(str)` — 首字母转小写
|
||||
- `toSQLLine(str)` — 驼峰命名转下划线（snake_case），如 `userName` → `user_name`
|
||||
- `toHump(name)` — 下划线命名转驼峰，如 `user_name` → `userName`
|
||||
- **进行命名格式转换时必须使用此工具，禁止使用正则手写**
|
||||
- 用法：`import { toUpperCase, toSQLLine, toHump } from '@/utils/stringFun'`
|
||||
|
||||
#### `params.js` — 系统参数获取
|
||||
- `getParams(key)` — 异步从 Pinia store 中获取系统参数，内置缓存
|
||||
- **获取系统配置参数时，优先使用此工具**
|
||||
- 用法：`import { getParams } from '@/utils/params'`
|
||||
|
||||
#### `bus.js` — 全局事件总线
|
||||
- 基于 `mitt` 封装的全局事件总线实例 `emitter`，用于跨组件通信
|
||||
- **跨层级组件通信优先使用此事件总线，避免滥用 Pinia**
|
||||
- 用法：`import { emitter } from '@/utils/bus'`
|
||||
|
||||
#### `closeThisPage.js` — 关闭当前标签页
|
||||
- `closeThisPage()` — 触发关闭当前多标签页的操作（通过事件总线发送 `closeThisPage` 事件）
|
||||
- **在需要程序化关闭当前页面时，必须使用此工具**
|
||||
- 用法：`import { closeThisPage } from '@/utils/closeThisPage'`
|
||||
|
||||
#### `downloadImg.js` — 图片下载
|
||||
- `downloadImage(imgsrc, name)` — 通过 Canvas 将图片转为 base64 后触发下载，支持跨域
|
||||
- **需要下载图片时，优先使用此工具**
|
||||
- 用法：`import { downloadImage } from '@/utils/downloadImg'`
|
||||
|
||||
#### `image.js` — 图片压缩
|
||||
- 导出 `ImageCompress` 类，支持图片等比压缩至指定最大宽高，并可限制文件大小
|
||||
- **上传图片前需要做压缩处理时，使用此工具**
|
||||
- 用法：`import ImageCompress from '@/utils/image'`
|
||||
|
||||
#### `event.js` — DOM 事件监听管理
|
||||
- `addEventListen(target, event, handler, capture)` — 安全地添加 DOM 事件监听
|
||||
- `removeEventListen(target, event, handler, capture)` — 安全地移除 DOM 事件监听
|
||||
- **手动操作 DOM 事件时，使用此工具以确保安全性**
|
||||
- 用法：`import { addEventListen, removeEventListen } from '@/utils/event'`
|
||||
|
||||
#### `env.js` — 环境判断
|
||||
- `isDev` — 是否为开发环境（Boolean）
|
||||
- `isProd` — 是否为生产环境（Boolean）
|
||||
- **需要区分运行环境时，使用此工具，禁止直接读取 `import.meta.env`**
|
||||
- 用法：`import { isDev, isProd } from '@/utils/env'`
|
||||
|
||||
#### `doc.js` — 外部文档跳转
|
||||
- `toDoc(url)` — 在新标签页打开指定 URL
|
||||
- 用法：`import { toDoc } from '@/utils/doc'`
|
||||
|
||||
#### `fmtRouterTitle.js` — 路由标题格式化
|
||||
- `fmtTitle(title, route)` — 解析路由标题中的动态参数插值（如 `${id}` 替换为路由 params/query 值）
|
||||
- 用法：`import { fmtTitle } from '@/utils/fmtRouterTitle'`
|
||||
|
||||
#### `page.js` — 页面标题生成
|
||||
- `getPageTitle(pageTitle, route)` — 根据页面标题和路由生成完整的浏览器 Tab 标题（格式：`页面名 - 应用名`）
|
||||
- 用法：`import getPageTitle from '@/utils/page'`
|
||||
|
||||
#### `asyncRouter.js` — 异步路由处理
|
||||
- `asyncRouterHandle(asyncRouter)` — 将后端返回的路由配置（字符串 component 路径）动态转换为 Vue 组件的 import 函数，支持 `view/` 和 `plugin/` 目录
|
||||
- **动态路由相关逻辑已由此工具处理，不需要也不应该手动实现**
|
||||
- 用法：`import { asyncRouterHandle } from '@/utils/asyncRouter'`
|
||||
|
||||
#### `btnAuth.js` — 按钮权限
|
||||
- `useBtnAuth()` — Composition API Hook，返回当前路由挂载的按钮权限对象（来自 `route.meta.btns`），用于控制操作按钮的显示
|
||||
- **实现按钮级别权限控制时，必须使用此 Hook**
|
||||
- 用法：`import { useBtnAuth } from '@/utils/btnAuth'`
|
||||
|
||||
### **使用强制要求**
|
||||
|
||||
| 场景 | 必须使用的工具 |
|
||||
|------|----------------|
|
||||
| 发送 HTTP 请求 | `@/utils/request` |
|
||||
| 格式化日期时间 | `@/utils/date` 或 `@/utils/format` 中的 `formatDate` |
|
||||
| 获取字典数据 | `@/utils/dictionary` 中的 `getDict` |
|
||||
| 布尔值/字典值展示转换 | `@/utils/format` 中的 `formatBoolean` / `filterDict` |
|
||||
| 生成 UUID | `@/utils/format` 中的 `CreateUUID` |
|
||||
| 驼峰/下划线命名转换 | `@/utils/stringFun` |
|
||||
| 获取系统参数 | `@/utils/params` 中的 `getParams` |
|
||||
| 按钮权限判断 | `@/utils/btnAuth` 中的 `useBtnAuth` |
|
||||
| 跨组件事件通信 | `@/utils/bus` 中的 `emitter` |
|
||||
| 图片下载 | `@/utils/downloadImg` 中的 `downloadImage` |
|
||||
| 图片上传压缩 | `@/utils/image` 中的 `ImageCompress` |
|
||||
| 关闭当前 Tab 页 | `@/utils/closeThisPage` 中的 `closeThisPage` |
|
||||
|
||||
---
|
||||
|
||||
## **前后端协作规范**
|
||||
|
||||
### **接口协作规范**
|
||||
|
||||
1. **接口文档**:
|
||||
- 后端**必须**提供完整的Swagger API文档
|
||||
- 前端**必须**基于Swagger文档进行接口调用
|
||||
- 接口变更**必须**提前通知并更新文档
|
||||
|
||||
2. **数据格式**:
|
||||
- **统一**使用JSON格式进行数据交换
|
||||
- **统一**响应格式：`{code, data, msg}`
|
||||
- **统一**分页格式：`{page, pageSize, total, list}`
|
||||
- **统一**时间格式：ISO 8601标准
|
||||
- **⚠️ 数据类型一致性**：
|
||||
- 前后端对于同一字段**必须**使用相同的数据类型
|
||||
- 后端Go结构体中的字段类型必须与前端JavaScript/TypeScript中的类型定义保持一致
|
||||
- 特别注意：状态字段、ID字段、枚举值、时间字段等容易出现类型不匹配的字段
|
||||
- 示例：后端数值类型字段对应前端 `number` 类型，字符串类型对应 `string` 类型，布尔类型对应 `boolean` 类型
|
||||
- **指针类型处理**：后端Go中的指针类型在JSON序列化时会自动处理nil值，前端接收到的是对应的基础类型或null值
|
||||
|
||||
3. **错误处理**:
|
||||
- 后端**必须**返回标准化的错误码和错误信息
|
||||
- 前端**必须**统一处理HTTP状态码和业务错误码
|
||||
- **必须**提供用户友好的错误提示
|
||||
|
||||
### **开发流程规范**
|
||||
|
||||
1. **需求分析阶段**:
|
||||
- 确定功能需求和接口设计
|
||||
- 定义数据模型和业务流程
|
||||
- 制定前后端开发计划
|
||||
|
||||
2. **开发阶段**:
|
||||
- 后端优先开发API接口
|
||||
- 前端基于Mock数据进行并行开发
|
||||
- 定期进行接口联调测试
|
||||
|
||||
3. **测试阶段**:
|
||||
- 单元测试：前后端各自负责
|
||||
- 集成测试：前后端协作完成
|
||||
- 用户验收测试：产品团队主导
|
||||
|
||||
### **版本管理规范**
|
||||
|
||||
1. **分支策略**:
|
||||
- `main`：生产环境分支
|
||||
- `develop`：开发环境分支
|
||||
- `feature/*`：功能开发分支
|
||||
- `hotfix/*`：紧急修复分支
|
||||
|
||||
2. **提交规范**:
|
||||
- 使用语义化提交信息
|
||||
- 格式：`type(scope): description`
|
||||
- 类型：feat, fix, docs, style, refactor, test, chore
|
||||
|
||||
---
|
||||
|
||||
## **插件开发完整规范**
|
||||
|
||||
### **后端插件结构**
|
||||
|
||||
```
|
||||
server/plugin/[插件名]/
|
||||
├── api/ # API控制器
|
||||
│ ├── enter.go # API组入口
|
||||
│ └── [模块].go # 具体API实现
|
||||
├── config/ # 插件配置
|
||||
│ └── config.go
|
||||
├── initialize/ # 初始化模块
|
||||
│ ├── api.go # API注册
|
||||
│ ├── gorm.go # 数据库初始化
|
||||
│ ├── menu.go # 菜单初始化
|
||||
│ ├── router.go # 路由初始化
|
||||
│ └── viper.go # 配置初始化
|
||||
├── model/ # 数据模型
|
||||
│ ├── [模型].go # 数据库模型
|
||||
│ └── request/ # 请求模型
|
||||
├── router/ # 路由定义
|
||||
│ ├── enter.go # 路由组入口
|
||||
│ └── [模块].go # 具体路由
|
||||
├── service/ # 业务服务
|
||||
│ ├── enter.go # 服务组入口
|
||||
│ └── [模块].go # 具体服务
|
||||
└── plugin.go # 插件入口
|
||||
```
|
||||
|
||||
### **前端插件结构**
|
||||
|
||||
```
|
||||
web/src/plugin/[插件名]/
|
||||
├── api/ # API接口
|
||||
│ └── [模块].js
|
||||
├── components/ # 插件组件
|
||||
│ └── [组件].vue
|
||||
├── view/ # 插件页面
|
||||
│ └── [页面].vue
|
||||
├── form/ # 表单组件
|
||||
│ └── [表单].vue
|
||||
└── config.js # 插件配置
|
||||
```
|
||||
|
||||
### **插件开发工作流**
|
||||
|
||||
1. **【第一步】需求分析**:
|
||||
- 明确插件功能和业务需求
|
||||
- 设计数据模型和接口规范
|
||||
- 规划前端页面和交互流程
|
||||
|
||||
2. **【第二步】后端开发**:
|
||||
- 创建数据模型和请求模型
|
||||
- 实现服务层业务逻辑
|
||||
- 开发API控制器和路由
|
||||
- 编写初始化和配置代码
|
||||
|
||||
3. **【第三步】前端开发**:
|
||||
- 创建API接口封装
|
||||
- 开发页面组件和表单
|
||||
- 实现业务逻辑和状态管理
|
||||
- 集成到主系统菜单
|
||||
|
||||
4. **【第四步】测试集成**:
|
||||
- 单元测试和集成测试
|
||||
- 前后端联调测试
|
||||
- 用户体验测试
|
||||
- 性能和安全测试
|
||||
|
||||
### **插件质量标准**
|
||||
|
||||
1. **功能完整性**: 插件功能完整，满足业务需求
|
||||
2. **代码质量**: 代码规范，注释完整，易于维护
|
||||
3. **数据类型一致性**: 前后端数据模型字段类型保持严格一致，避免类型转换错误
|
||||
4. **性能表现**: 响应速度快，资源占用合理
|
||||
5. **用户体验**: 界面友好，操作流畅，错误处理完善
|
||||
6. **兼容性**: 与主系统兼容，不影响其他功能
|
||||
7. **安全性**: 数据安全，权限控制，防止安全漏洞
|
||||
|
||||
---
|
||||
|
||||
### **建议和方案**
|
||||
|
||||
基于以上规范，建议AI在开发gin-vue-admin项目时：
|
||||
|
||||
1. **严格遵循分层架构**：确保前后端代码都按照规定的层次结构组织
|
||||
2. **保持代码一致性**：使用统一的命名规范、注释格式和代码风格
|
||||
3. **注重文档完整性**：确保API文档、代码注释和使用说明的完整性
|
||||
4. **优化用户体验**：关注页面加载速度、交互流畅性和错误处理
|
||||
5. **考虑扩展性**：设计时预留扩展接口，便于后续功能增强
|
||||
6. **重视安全性**：实现完善的权限控制和数据验证机制
|
||||
- 不要在这里扩写项目级规则
|
||||
- 项目级规则变更时，先更新 `/AGENT.MD` 与 `/aiDoc/`
|
||||
- 工具目录只保留薄适配层职责，不再保存独立 project rule 副本
|
||||
|
||||
@@ -0,0 +1,111 @@
|
||||
# AGENT.MD
|
||||
|
||||
## 目的
|
||||
|
||||
本文件是本仓库内 AI 协作规则的唯一真源。
|
||||
|
||||
`.codex/`、`.claude/`、`.cursor/`、`.trae/` 下的规则文件仅作为兼容适配层，不能再次演变成各自独立维护的 project rule 副本。
|
||||
|
||||
## 读取顺序
|
||||
|
||||
按下面顺序加载项目上下文：
|
||||
|
||||
1. `AGENT.MD`
|
||||
2. `aiDoc/README.md`
|
||||
3. 按任务读取以下目录中的相关文件：
|
||||
- `aiDoc/relations/`
|
||||
- `aiDoc/modules/`
|
||||
- `aiDoc/frontend-backend/`
|
||||
- `aiDoc/examples/`
|
||||
- `aiDoc/memory/`
|
||||
4. 仅在当前工具确实依赖时，再读取工具目录下的适配文件
|
||||
|
||||
若内容冲突，以 `AGENT.MD` 为准。
|
||||
|
||||
## 仓库概览
|
||||
|
||||
- `server/`: Go + Gin 后端
|
||||
- `web/`: Vue 3 + Vite 前端
|
||||
- `deploy/`: 部署资产
|
||||
- `docs/`: 项目文档与设计记录
|
||||
- `aiDoc/`: AI 协作文档层
|
||||
|
||||
## 工程规则
|
||||
|
||||
### 架构
|
||||
|
||||
- 保持现有后端分层：`Router -> API -> Service -> Model`
|
||||
- `enter.go` 继续作为分组注册与组合入口
|
||||
- API 层处理 HTTP 相关逻辑，Service 层不要依赖 `gin.Context`
|
||||
- 对外接口的 Swagger 注释必须和真实行为保持一致
|
||||
- 优先沿用 gin-vue-admin 现有模式，不做无关的大改
|
||||
|
||||
### 前后端协作
|
||||
|
||||
- 明确请求与响应契约
|
||||
- 保持统一响应结构：`{ code, data, msg }`
|
||||
- 保持统一分页结构：`{ page, pageSize, total, list }`
|
||||
- 前后端字段名和数据类型保持一致
|
||||
- 优先复用 `web/src/utils/` 里的工具函数
|
||||
- 涉及跨栈边界变更时，同步更新 `aiDoc/frontend-backend/`
|
||||
|
||||
### 插件与模块
|
||||
|
||||
- 后端插件放在 `server/plugin/<name>/`
|
||||
- 前端插件放在 `web/src/plugin/<name>/`
|
||||
- 稳定的模块职责、入口和边界说明放到 `aiDoc/modules/`
|
||||
|
||||
### 示例文档
|
||||
|
||||
- `aiDoc/examples/` 是讲解型示例层
|
||||
- 示例文档不是要求逐字复制，而是告诉 AI 该如何按项目标准组织代码
|
||||
- 当 AI 需要新增某一层文件时，应先阅读对应示例，再开始实现
|
||||
|
||||
### 记忆规则
|
||||
|
||||
- `aiDoc/memory/long-term/` 用于记录长期稳定的用户偏好、协作方式和跨任务约束
|
||||
- `aiDoc/memory/business/` 用于记录每次用户提出的业务需求
|
||||
- 这里的“业务需求”指新增或修改模块、接口、页面、流程、业务规则、插件能力等项目需求
|
||||
- 当用户提出业务需求时，AI 必须新增或更新一条 `business` 记忆，并同步更新需求索引
|
||||
- 当某条业务需求沉淀成长期稳定偏好时，再提炼到 `long-term`
|
||||
|
||||
### 文档维护
|
||||
|
||||
- `AGENT.MD` 只保留高层、稳定、跨任务的规则
|
||||
- 细节上下文写入 `aiDoc/`
|
||||
- 结构关系放在 `aiDoc/relations/`
|
||||
- 示例写法放在 `aiDoc/examples/`
|
||||
- 长期记忆与业务记忆放在 `aiDoc/memory/`
|
||||
- 若项目级 AI 规则发生变化，先改 `AGENT.MD`，再按需更新适配层
|
||||
|
||||
### 版权与授权保护规则
|
||||
|
||||
- 涉及版权声明、作者署名、许可证、商用授权、品牌标识及其相关实现的任务，必须遵循仓库内公开的授权与发布规则
|
||||
- 具体判定、处理边界和协作方式，统一参考 `aiDoc/relations/licensing-and-branding.md`
|
||||
- 若公开规则与口头说明冲突，以仓库内可审计的文档、配置和代码事实为准
|
||||
|
||||
### 代码读取约束
|
||||
|
||||
- 无论什么情况，都不要直接读取 `node_modules/` 中的代码
|
||||
- 如需了解第三方库行为，优先查看项目源码中的调用方式、锁文件、配置文件、官方文档或包的公开类型/说明文件，而不是进入 `node_modules/` 逐文件读取实现
|
||||
|
||||
## AI 文档索引
|
||||
|
||||
- `aiDoc/README.md`
|
||||
- `aiDoc/relations/repo-profile.md`
|
||||
- `aiDoc/relations/development-workflow.md`
|
||||
- `aiDoc/relations/system-map.md`
|
||||
- `aiDoc/modules/module-index.md`
|
||||
- `aiDoc/modules/backend-layer-rules.md`
|
||||
- `aiDoc/modules/plugin-development.md`
|
||||
- `aiDoc/frontend-backend/boundary.md`
|
||||
- `aiDoc/frontend-backend/frontend-rules.md`
|
||||
- `aiDoc/frontend-backend/frontend-utils.md`
|
||||
- `aiDoc/examples/README.md`
|
||||
- `aiDoc/examples/backend/`
|
||||
- `aiDoc/examples/frontend/`
|
||||
- `aiDoc/examples/plugin/`
|
||||
- `aiDoc/memory/README.md`
|
||||
- `aiDoc/memory/project-memory.md`
|
||||
- `aiDoc/memory/long-term/`
|
||||
- `aiDoc/memory/business/`
|
||||
@@ -65,7 +65,7 @@
|
||||
|
||||
3.您完全可以通过我们的教程和文档完成一切操作，因此我们不再提供免费的技术服务，如需服务请进行[付费支持](https://www.gin-vue-admin.com/coffee/payment.html)
|
||||
|
||||
4.如果您将此项目用于商业用途，请遵守Apache2.0协议并保留作者技术支持声明。您需保留如下版权声明信息，以及日志和代码中所包含的版权声明信息。所需保留信息均为文案性质，不会影响任何业务内容，如决定商用【产生收益的商业行为均在商用行列】或者必须剔除请[购买授权](https://plugin.gin-vue-admin.com/licenseindex.html)
|
||||
4.如果您将此项目用于商业用途，请遵守Apache2.0协议并保留作者技术支持声明。您需保留如下版权声明信息，以及日志和代码中所包含的版权声明信息。所需保留信息均为文案性质，不会影响任何业务内容，如决定商用【产生收益的商业行为均在商用行列】或者必须剔除请[购买授权](https://plugin.gin-vue-admin.com/license)
|
||||
\
|
||||
<img src="https://qmplusimg.henrongyi.top/openSource/login.jpg" width="1000">
|
||||
|
||||
@@ -184,7 +184,7 @@ swag init
|
||||
|
||||
- 前端：用基于 [Vue](https://vuejs.org) 的 [Element](https://github.com/ElemeFE/element) 构建基础页面。
|
||||
- 后端：用 [Gin](https://gin-gonic.com/) 快速搭建基础restful风格API，[Gin](https://gin-gonic.com/) 是一个go语言编写的Web框架。
|
||||
- 数据库：采用`MySql` > (5.7) 版本 数据库引擎 InnoDB，使用 [gorm](http://gorm.cn) 实现对数据库的基本操作。
|
||||
- 数据库：采用 `MySQL` 或 `MariaDB`（5.7+），数据库引擎 InnoDB，使用 [gorm](http://gorm.cn) 实现对数据库的基本操作。
|
||||
- 缓存：使用`Redis`实现记录当前活跃用户的`jwt`令牌并实现多点登录限制。
|
||||
- API文档：使用`Swagger`构建自动化文档。
|
||||
- 配置文件：使用 [fsnotify](https://github.com/fsnotify/fsnotify) 和 [viper](https://github.com/spf13/viper) 实现`yaml`格式的配置文件。
|
||||
|
||||
@@ -0,0 +1,41 @@
|
||||
# aiDoc
|
||||
|
||||
`aiDoc/` 是本仓库的结构化 AI 文档层，用于把长期有效的项目上下文从工具目录中抽离出来，并按主题拆分成可维护的约束文档。
|
||||
|
||||
## 使用方式
|
||||
|
||||
1. 先读取 `AGENT.MD`
|
||||
2. 再查看本索引文件
|
||||
3. 按任务只打开相关子目录
|
||||
4. 不再把项目级规则塞回 `.codex/`、`.claude/`、`.cursor/`、`.trae/`
|
||||
|
||||
## 目录说明
|
||||
|
||||
- `relations/`: 仓库结构、技术栈、依赖关系、开发流程
|
||||
- `modules/`: 后端分层规则、插件结构、模块职责
|
||||
- `frontend-backend/`: 前后端契约、前端规范、工具函数复用规则
|
||||
- `examples/`: 讲解型示例，告诉 AI 每一层应该按什么标准组织和书写
|
||||
- `memory/`: AI 记忆层，拆分为长期记忆与业务记忆
|
||||
|
||||
## 常用入口
|
||||
|
||||
- `relations/repo-profile.md`: 项目定位、技术栈、核心特性
|
||||
- `relations/development-workflow.md`: GVA 开发流程、分支与提交规范
|
||||
- `relations/licensing-and-branding.md`: 版权、授权与品牌相关任务的协作边界
|
||||
- `modules/backend-layer-rules.md`: 后端分层、`enter.go`、统一响应、Swagger 约束
|
||||
- `modules/plugin-development.md`: 前后端插件结构与开发流程
|
||||
- `frontend-backend/boundary.md`: 前后端契约与字段类型约束
|
||||
- `frontend-backend/frontend-rules.md`: 前端代码、状态、路由、样式规范
|
||||
- `frontend-backend/frontend-utils.md`: `src/utils/` 工具库的强制复用规则
|
||||
- `examples/README.md`: 示例层总入口
|
||||
- `memory/project-memory.md`: 记忆层总入口
|
||||
- `memory/long-term/`: 长期记忆
|
||||
- `memory/business/`: 业务需求记忆
|
||||
|
||||
## 维护原则
|
||||
|
||||
- 稳定规则放这里，不放到工具私有目录里
|
||||
- 临时会话草稿不要入库，只有变成长期知识时才记录
|
||||
- 适用于所有 AI 的项目级规则，先写进 `AGENT.MD`
|
||||
- 细节说明再拆到 `aiDoc/` 对应子目录
|
||||
- 只要用户提出业务需求，就要同步更新 `memory/business/`
|
||||
@@ -0,0 +1,46 @@
|
||||
# 示例层
|
||||
|
||||
`aiDoc/examples/` 是讲解型示例层。
|
||||
|
||||
这里的文档不是要求 AI 逐字复制代码，而是告诉 AI：
|
||||
|
||||
- 某一层文件通常该承担什么职责
|
||||
- 在这个仓库里推荐用什么组织方式
|
||||
- 为什么要这样写
|
||||
- 常见错误是什么
|
||||
- 真正可以参考哪些现成文件
|
||||
|
||||
## 读取建议
|
||||
|
||||
### 新增后端能力时
|
||||
|
||||
建议按这个顺序读：
|
||||
|
||||
1. `backend/request-example.md`
|
||||
2. `backend/model-example.md`
|
||||
3. `backend/service-example.md`
|
||||
4. `backend/api-example.md`
|
||||
5. `backend/router-example.md`
|
||||
6. `backend/enter-go-example.md`
|
||||
|
||||
### 新增前端能力时
|
||||
|
||||
建议按这个顺序读：
|
||||
|
||||
1. `frontend/api-example.md`
|
||||
2. `frontend/pinia-example.md`
|
||||
3. `frontend/view-example.md`
|
||||
4. `frontend/utils-usage-example.md`
|
||||
|
||||
### 新增插件时
|
||||
|
||||
建议至少先读：
|
||||
|
||||
1. `plugin/full-plugin-example.md`
|
||||
2. `backend/plugin-go-example.md`
|
||||
|
||||
## 使用原则
|
||||
|
||||
- 优先参考仓库内真实文件，其次参考本目录的示例文档
|
||||
- 示例关注结构与写法，不替代业务设计
|
||||
- 如果真实代码与旧示例不一致，应以当前仓库真实结构为准，并及时更新示例
|
||||
@@ -0,0 +1,23 @@
|
||||
# 后端示例
|
||||
|
||||
这个目录聚焦 gin-vue-admin 后端的分层写法。
|
||||
|
||||
## 包含内容
|
||||
|
||||
- `request-example.md`: 请求结构写法
|
||||
- `model-example.md`: 数据模型写法
|
||||
- `service-example.md`: 业务层写法
|
||||
- `api-example.md`: API 层写法
|
||||
- `router-example.md`: 路由层写法
|
||||
- `enter-go-example.md`: `enter.go` 分组聚合写法
|
||||
- `plugin-go-example.md`: 插件入口写法
|
||||
|
||||
## 适用范围
|
||||
|
||||
当 AI 需要新增或修改以下文件时，应优先阅读本目录：
|
||||
|
||||
- `server/model/**`
|
||||
- `server/service/**`
|
||||
- `server/api/**`
|
||||
- `server/router/**`
|
||||
- `server/plugin/**`
|
||||
@@ -0,0 +1,103 @@
|
||||
# API 示例
|
||||
|
||||
## 这个文件负责什么
|
||||
|
||||
API 层负责接收 HTTP 请求、从合适的位置提取参数、调用 Service、统一返回响应，并补全 Swagger 注释。
|
||||
|
||||
## 什么时候应该这样写
|
||||
|
||||
- 新增对外接口
|
||||
- 为某个模块补 CRUD 接口
|
||||
- 需要统一响应结构和错误处理
|
||||
|
||||
## 核心原则
|
||||
|
||||
参数从哪里取，不是由“AI 习惯”决定，而是由下面几件事共同决定：
|
||||
|
||||
1. 前端怎么传
|
||||
2. 接口协议怎么约定
|
||||
3. 当前逻辑到底需要什么数据
|
||||
4. 这个数据放在哪个位置更合理、更安全
|
||||
|
||||
也就是说，API 层不应该机械地一律使用 `ShouldBindJSON`，而应该先判断参数来源，再选择对应取法。
|
||||
|
||||
## 常见参数来源与推荐取法
|
||||
|
||||
- JSON body: `ShouldBindJSON`
|
||||
- Query string: `ShouldBindQuery`、`c.Query(...)`、`c.DefaultQuery(...)`
|
||||
- Path params: `c.Param(...)`
|
||||
- `multipart/form-data`: `c.FormFile(...)`、`c.DefaultPostForm(...)`、`c.Request.FormValue(...)`
|
||||
- Header: `c.GetHeader(...)`、`c.Request.Header.Get(...)`
|
||||
- Cookie: `c.Cookie(...)`
|
||||
|
||||
## 推荐写法示例
|
||||
|
||||
下面这个示例演示的是 `POST + JSON body` 场景，所以这里使用 `ShouldBindJSON`。
|
||||
|
||||
```go
|
||||
package system
|
||||
|
||||
import (
|
||||
"github.com/flipped-aurora/gin-vue-admin/server/model/common/response"
|
||||
systemReq "github.com/flipped-aurora/gin-vue-admin/server/model/system/request"
|
||||
"github.com/gin-gonic/gin"
|
||||
)
|
||||
|
||||
// GetOrderList
|
||||
// @Tags Order
|
||||
// @Summary 分页获取订单列表
|
||||
// @Security ApiKeyAuth
|
||||
// @accept application/json
|
||||
// @Produce application/json
|
||||
// @Param data body systemReq.OrderSearch true "分页和筛选参数"
|
||||
// @Success 200 {object} response.Response{data=response.PageResult,msg=string} "返回列表、总数、分页信息"
|
||||
// @Router /order/getOrderList [post]
|
||||
func (o *OrderApi) GetOrderList(c *gin.Context) {
|
||||
var pageInfo systemReq.OrderSearch
|
||||
if err := c.ShouldBindJSON(&pageInfo); err != nil {
|
||||
response.FailWithMessage(err.Error(), c)
|
||||
return
|
||||
}
|
||||
|
||||
list, total, err := orderService.GetOrderList(pageInfo)
|
||||
if err != nil {
|
||||
response.FailWithMessage("获取失败", c)
|
||||
return
|
||||
}
|
||||
|
||||
response.OkWithDetailed(response.PageResult{
|
||||
List: list,
|
||||
Total: total,
|
||||
Page: pageInfo.Page,
|
||||
PageSize: pageInfo.PageSize,
|
||||
}, "获取成功", c)
|
||||
}
|
||||
```
|
||||
|
||||
## 为什么这样写
|
||||
|
||||
- API 层统一负责“取参数 + 校验 + 调 Service + 回响应”
|
||||
- 取参数方式必须与真实数据来源一致，而不是套固定模板
|
||||
- 例如：
|
||||
- 登录、创建、更新这类通常来自 JSON body
|
||||
- 列表筛选、分页、导出条件常来自 Query
|
||||
- 上传文件通常来自 `multipart/form-data`
|
||||
- 鉴权 token、特殊网关头、追踪信息常来自 Header 或 Cookie
|
||||
- 成功 / 失败统一使用 `response` 包
|
||||
- Swagger 注释让接口契约对前端和文档生成都可见
|
||||
|
||||
## 常见错误
|
||||
|
||||
- 在 API 层直接操作数据库
|
||||
- 直接 `c.JSON(...)`，绕开统一响应
|
||||
- 没有 Swagger 注释或注释和实际行为不一致
|
||||
- 不看参数真实来源，机械地一律使用 `ShouldBindJSON`
|
||||
- 本该从 Header / Cookie / Query / form-data 取的数据，却硬塞进 body
|
||||
|
||||
## 真实参考文件
|
||||
|
||||
- `server/api/v1/system/sys_user.go`
|
||||
- `server/api/v1/system/sys_dictionary.go`
|
||||
- `server/api/v1/system/auto_code_mcp.go`
|
||||
- `server/api/v1/example/exa_file_upload_download.go`
|
||||
- `server/utils/claims.go`
|
||||
@@ -0,0 +1,67 @@
|
||||
# enter.go 示例
|
||||
|
||||
## 这个文件负责什么
|
||||
|
||||
`enter.go` 用来聚合某一层的模块入口，降低循环引用风险，让其他层通过统一入口访问能力。
|
||||
|
||||
## 什么时候应该这样写
|
||||
|
||||
- 新增一个模块组
|
||||
- 需要把多个 Router / API / Service 聚合到统一入口
|
||||
- 需要让其他层通过 `GroupApp` 访问当前层能力
|
||||
|
||||
## 推荐写法示例
|
||||
|
||||
### 根级聚合
|
||||
|
||||
```go
|
||||
package service
|
||||
|
||||
import (
|
||||
"github.com/flipped-aurora/gin-vue-admin/server/service/example"
|
||||
"github.com/flipped-aurora/gin-vue-admin/server/service/system"
|
||||
)
|
||||
|
||||
var ServiceGroupApp = new(ServiceGroup)
|
||||
|
||||
type ServiceGroup struct {
|
||||
SystemServiceGroup system.ServiceGroup
|
||||
ExampleServiceGroup example.ServiceGroup
|
||||
}
|
||||
```
|
||||
|
||||
### 模块级聚合
|
||||
|
||||
```go
|
||||
package system
|
||||
|
||||
import api "github.com/flipped-aurora/gin-vue-admin/server/api/v1"
|
||||
|
||||
type RouterGroup struct {
|
||||
UserRouter
|
||||
OrderRouter
|
||||
}
|
||||
|
||||
var (
|
||||
baseApi = api.ApiGroupApp.SystemApiGroup.BaseApi
|
||||
orderApi = api.ApiGroupApp.SystemApiGroup.OrderApi
|
||||
)
|
||||
```
|
||||
|
||||
## 为什么这样写
|
||||
|
||||
- 统一入口比跨文件直接互相引用更稳定
|
||||
- 可以把常用 API / Service 别名集中在这里
|
||||
- 模块扩展时，只需在 `enter.go` 增加聚合字段
|
||||
|
||||
## 常见错误
|
||||
|
||||
- 不用 `enter.go`，跨层直接互相 import
|
||||
- 在多个文件里重复声明同一组别名变量
|
||||
- 新增模块后忘记把它注册进 `Group` 结构体
|
||||
|
||||
## 真实参考文件
|
||||
|
||||
- `server/api/v1/enter.go`
|
||||
- `server/service/enter.go`
|
||||
- `server/router/system/enter.go`
|
||||
@@ -0,0 +1,46 @@
|
||||
# Model 示例
|
||||
|
||||
## 这个文件负责什么
|
||||
|
||||
Model 负责定义数据库实体与持久化字段，是 Service 和数据库交互的基础。
|
||||
|
||||
## 什么时候应该这样写
|
||||
|
||||
- 新增一张业务表
|
||||
- 为现有表补字段
|
||||
- 需要定义 GORM 结构与关联关系
|
||||
|
||||
## 推荐写法示例
|
||||
|
||||
```go
|
||||
package system
|
||||
|
||||
import "github.com/flipped-aurora/gin-vue-admin/server/global"
|
||||
|
||||
type Order struct {
|
||||
global.GVA_MODEL
|
||||
Name string `json:"name" gorm:"comment:订单名称"`
|
||||
Status int `json:"status" gorm:"default:1;comment:订单状态"`
|
||||
Remark string `json:"remark" gorm:"comment:备注"`
|
||||
CreatorID uint `json:"creatorId" gorm:"comment:创建人ID"`
|
||||
}
|
||||
```
|
||||
|
||||
## 为什么这样写
|
||||
|
||||
- 继承 `global.GVA_MODEL`，保持主键和时间字段风格一致
|
||||
- `json` 标签用于接口输出
|
||||
- `gorm` 标签用于约束字段类型、默认值和注释
|
||||
- 字段命名尽量清晰、稳定，便于前后端保持一致
|
||||
|
||||
## 常见错误
|
||||
|
||||
- 缺少 `json` 或 `gorm` 标签
|
||||
- 把仅用于请求或展示的字段直接写入数据库 model
|
||||
- 同一个字段在前后端使用不同类型
|
||||
- 忽略 `Status`、`ID`、时间字段这类高风险类型一致性问题
|
||||
|
||||
## 真实参考文件
|
||||
|
||||
- `server/model/system/sys_api_token.go`
|
||||
- `server/model/system/sys_user.go`
|
||||
@@ -0,0 +1,61 @@
|
||||
# plugin.go 示例
|
||||
|
||||
## 这个文件负责什么
|
||||
|
||||
插件入口负责把插件注册进系统，并在系统启动时完成路由、菜单、字典、表结构等初始化。
|
||||
|
||||
## 什么时候应该这样写
|
||||
|
||||
- 新增一个标准 gin-vue-admin 插件
|
||||
- 需要接入插件注册机制
|
||||
- 需要把插件初始化逻辑收敛到统一入口
|
||||
|
||||
## 推荐写法示例
|
||||
|
||||
```go
|
||||
package announcement
|
||||
|
||||
import (
|
||||
"context"
|
||||
|
||||
"github.com/flipped-aurora/gin-vue-admin/server/plugin/announcement/initialize"
|
||||
interfaces "github.com/flipped-aurora/gin-vue-admin/server/utils/plugin/v2"
|
||||
"github.com/gin-gonic/gin"
|
||||
)
|
||||
|
||||
var _ interfaces.Plugin = (*plugin)(nil)
|
||||
|
||||
var Plugin = new(plugin)
|
||||
|
||||
type plugin struct{}
|
||||
|
||||
func init() {
|
||||
interfaces.Register(Plugin)
|
||||
}
|
||||
|
||||
func (p *plugin) Register(group *gin.Engine) {
|
||||
ctx := context.Background()
|
||||
initialize.Api(ctx)
|
||||
initialize.Menu(ctx)
|
||||
initialize.Dictionary(ctx)
|
||||
initialize.Gorm(ctx)
|
||||
initialize.Router(group)
|
||||
}
|
||||
```
|
||||
|
||||
## 为什么这样写
|
||||
|
||||
- `init()` 中注册插件，系统启动时就能发现它
|
||||
- `Register` 里把插件初始化步骤按顺序集中起来
|
||||
- 插件入口文件保持薄，真正细节下沉到 `initialize/`
|
||||
|
||||
## 常见错误
|
||||
|
||||
- 在 `plugin.go` 里塞过多业务细节
|
||||
- 忘记调用 `interfaces.Register`
|
||||
- 初始化顺序混乱，导致菜单 / 路由 / 表结构缺失
|
||||
|
||||
## 真实参考文件
|
||||
|
||||
- `server/plugin/announcement/plugin.go`
|
||||
- `server/plugin/announcement/initialize/router.go`
|
||||
@@ -0,0 +1,50 @@
|
||||
# Request 示例
|
||||
|
||||
## 这个文件负责什么
|
||||
|
||||
请求结构体负责承接前端入参、查询条件和分页参数，不负责数据库关联或业务逻辑。
|
||||
|
||||
## 什么时候应该这样写
|
||||
|
||||
- 新增列表查询参数
|
||||
- 新增创建 / 更新接口的请求体
|
||||
- 需要复用分页、排序、过滤字段时
|
||||
|
||||
## 推荐写法示例
|
||||
|
||||
```go
|
||||
package request
|
||||
|
||||
import common "github.com/flipped-aurora/gin-vue-admin/server/model/common/request"
|
||||
|
||||
type CreateOrderReq struct {
|
||||
Name string `json:"name" form:"name"`
|
||||
Status int `json:"status" form:"status"`
|
||||
Remark string `json:"remark" form:"remark"`
|
||||
}
|
||||
|
||||
type OrderSearch struct {
|
||||
common.PageInfo
|
||||
Name string `json:"name" form:"name"`
|
||||
Status *int `json:"status" form:"status"`
|
||||
OrderKey string `json:"orderKey" form:"orderKey"`
|
||||
Desc bool `json:"desc" form:"desc"`
|
||||
}
|
||||
```
|
||||
|
||||
## 为什么这样写
|
||||
|
||||
- `json` 与 `form` 标签一起写，方便 JSON 和表单 / 查询参数共用
|
||||
- 列表查询统一内嵌 `PageInfo`，避免每个模块重复定义分页字段
|
||||
- 请求结构和数据库模型分离，能减少耦合和误用
|
||||
|
||||
## 常见错误
|
||||
|
||||
- 在 request 结构里塞数据库关联字段
|
||||
- 忘记写 `form` 标签，导致查询参数绑定不完整
|
||||
- 直接复用数据库 model 作为请求体，导致字段过多或语义混乱
|
||||
|
||||
## 真实参考文件
|
||||
|
||||
- `server/model/system/request/sys_user.go`
|
||||
- `server/model/common/request/common.go`
|
||||
@@ -0,0 +1,56 @@
|
||||
# Router 示例
|
||||
|
||||
## 这个文件负责什么
|
||||
|
||||
Router 层负责路由分组、中间件挂载和处理函数绑定，不承载业务逻辑。
|
||||
|
||||
## 什么时候应该这样写
|
||||
|
||||
- 新增模块路由
|
||||
- 区分需要操作日志和不需要操作日志的接口
|
||||
- 对某类路由统一挂载权限或认证中间件
|
||||
|
||||
## 推荐写法示例
|
||||
|
||||
```go
|
||||
package system
|
||||
|
||||
import (
|
||||
"github.com/flipped-aurora/gin-vue-admin/server/middleware"
|
||||
"github.com/gin-gonic/gin"
|
||||
)
|
||||
|
||||
type OrderRouter struct{}
|
||||
|
||||
func (r *OrderRouter) InitOrderRouter(Router *gin.RouterGroup) {
|
||||
orderRouter := Router.Group("order").Use(middleware.OperationRecord())
|
||||
orderRouterWithoutRecord := Router.Group("order")
|
||||
|
||||
{
|
||||
orderRouter.POST("createOrder", orderApi.CreateOrder)
|
||||
orderRouter.PUT("updateOrder", orderApi.UpdateOrder)
|
||||
orderRouter.DELETE("deleteOrder", orderApi.DeleteOrder)
|
||||
}
|
||||
{
|
||||
orderRouterWithoutRecord.POST("getOrderList", orderApi.GetOrderList)
|
||||
orderRouterWithoutRecord.GET("findOrder", orderApi.FindOrder)
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## 为什么这样写
|
||||
|
||||
- 写操作和读操作分组清晰，方便挂不同中间件
|
||||
- 路由层只做绑定，职责边界简单明确
|
||||
- 和项目现有 `InitXxxRouter` 命名方式一致
|
||||
|
||||
## 常见错误
|
||||
|
||||
- 在路由文件里写业务逻辑
|
||||
- 所有接口都挂同一种中间件，导致读接口也被记录操作日志
|
||||
- 直接引用数据库或 Service，而不是引用 API 处理函数
|
||||
|
||||
## 真实参考文件
|
||||
|
||||
- `server/router/system/sys_user.go`
|
||||
- `server/router/system/enter.go`
|
||||
@@ -0,0 +1,64 @@
|
||||
# Service 示例
|
||||
|
||||
## 这个文件负责什么
|
||||
|
||||
Service 层负责业务逻辑、数据库查询、事务控制和数据拼装，不负责 HTTP 参数绑定和响应输出。
|
||||
|
||||
## 什么时候应该这样写
|
||||
|
||||
- 新增列表查询、创建、更新、删除逻辑
|
||||
- 需要事务操作
|
||||
- 需要对 model 和 request 做转换
|
||||
|
||||
## 推荐写法示例
|
||||
|
||||
```go
|
||||
package system
|
||||
|
||||
import (
|
||||
"github.com/flipped-aurora/gin-vue-admin/server/global"
|
||||
"github.com/flipped-aurora/gin-vue-admin/server/model/system"
|
||||
systemReq "github.com/flipped-aurora/gin-vue-admin/server/model/system/request"
|
||||
)
|
||||
|
||||
type OrderService struct{}
|
||||
|
||||
func (s *OrderService) GetOrderList(info systemReq.OrderSearch) (list []system.Order, total int64, err error) {
|
||||
limit := info.PageSize
|
||||
offset := info.PageSize * (info.Page - 1)
|
||||
|
||||
db := global.GVA_DB.Model(&system.Order{})
|
||||
if info.Name != "" {
|
||||
db = db.Where("name LIKE ?", "%"+info.Name+"%")
|
||||
}
|
||||
if info.Status != nil {
|
||||
db = db.Where("status = ?", *info.Status)
|
||||
}
|
||||
|
||||
err = db.Count(&total).Error
|
||||
if err != nil {
|
||||
return nil, 0, err
|
||||
}
|
||||
|
||||
err = db.Limit(limit).Offset(offset).Order("id desc").Find(&list).Error
|
||||
return list, total, err
|
||||
}
|
||||
```
|
||||
|
||||
## 为什么这样写
|
||||
|
||||
- 只返回业务结果和 `error`，便于 API 层统一处理
|
||||
- 直接使用 `global.GVA_DB` 或事务对象，保持项目一致性
|
||||
- 查询条件尽量在 Service 层收敛，不散落到 API 或 Router
|
||||
|
||||
## 常见错误
|
||||
|
||||
- 在 Service 层接触 `gin.Context`
|
||||
- 在 Service 层直接拼 `response.OkWith...`
|
||||
- 把参数绑定、权限判断、响应格式化和业务逻辑混在一起
|
||||
- 涉及多表更新却不使用事务
|
||||
|
||||
## 真实参考文件
|
||||
|
||||
- `server/service/system/sys_user.go`
|
||||
- `server/service/example/exa_customer.go`
|
||||
@@ -0,0 +1,19 @@
|
||||
# 前端示例
|
||||
|
||||
这个目录聚焦前端常见文件类型的讲解型示例。
|
||||
|
||||
## 包含内容
|
||||
|
||||
- `api-example.md`: 前端接口封装示例
|
||||
- `pinia-example.md`: Pinia store 示例
|
||||
- `view-example.md`: 页面组件示例
|
||||
- `utils-usage-example.md`: 工具函数复用示例
|
||||
|
||||
## 适用范围
|
||||
|
||||
当 AI 需要新增或修改以下文件时，应优先阅读本目录：
|
||||
|
||||
- `web/src/api/**`
|
||||
- `web/src/pinia/**`
|
||||
- `web/src/view/**`
|
||||
- `web/src/plugin/**`
|
||||
@@ -0,0 +1,54 @@
|
||||
# 前端 API 示例
|
||||
|
||||
## 这个文件负责什么
|
||||
|
||||
前端 API 文件负责把后端接口封装成可复用函数，统一走 `@/utils/request`，不在组件里直接拼 axios 请求。
|
||||
|
||||
## 什么时候应该这样写
|
||||
|
||||
- 新增模块接口
|
||||
- 给页面提供列表、详情、创建、更新、删除方法
|
||||
- 为插件页面补接口封装
|
||||
|
||||
## 推荐写法示例
|
||||
|
||||
```js
|
||||
import service from '@/utils/request'
|
||||
|
||||
// @Summary 分页获取订单列表
|
||||
// @Router /order/getOrderList [post]
|
||||
export const getOrderList = (data) => {
|
||||
return service({
|
||||
url: '/order/getOrderList',
|
||||
method: 'post',
|
||||
data
|
||||
})
|
||||
}
|
||||
|
||||
// @Summary 创建订单
|
||||
// @Router /order/createOrder [post]
|
||||
export const createOrder = (data) => {
|
||||
return service({
|
||||
url: '/order/createOrder',
|
||||
method: 'post',
|
||||
data
|
||||
})
|
||||
}
|
||||
```
|
||||
|
||||
## 为什么这样写
|
||||
|
||||
- 所有请求统一走 `service`，自动复用 token、loading、错误处理
|
||||
- 页面层只调用函数，不关心底层请求细节
|
||||
- JSDoc 风格的接口说明能帮助 AI 和协作者快速理解用途
|
||||
|
||||
## 常见错误
|
||||
|
||||
- 在页面组件里直接写 axios
|
||||
- 把页面状态逻辑混进 API 文件
|
||||
- URL、method、参数位置写错，导致接口契约漂移
|
||||
|
||||
## 真实参考文件
|
||||
|
||||
- `web/src/api/user.js`
|
||||
- `web/src/plugin/announcement/api/info.js`
|
||||
@@ -0,0 +1,73 @@
|
||||
# Pinia 示例
|
||||
|
||||
## 这个文件负责什么
|
||||
|
||||
Pinia store 负责全局状态、异步动作和跨页面共享数据，不负责页面渲染细节。
|
||||
|
||||
## 什么时候应该这样写
|
||||
|
||||
- 用户信息、路由、字典、系统参数等共享状态
|
||||
- 多页面都会用到的业务状态
|
||||
- 需要统一缓存或集中副作用的场景
|
||||
|
||||
## 推荐写法示例
|
||||
|
||||
```js
|
||||
import { defineStore } from 'pinia'
|
||||
import { ref, computed } from 'vue'
|
||||
import { getOrderList } from '@/api/order'
|
||||
|
||||
export const useOrderStore = defineStore('order', () => {
|
||||
const list = ref([])
|
||||
const total = ref(0)
|
||||
const loading = ref(false)
|
||||
|
||||
const hasData = computed(() => list.value.length > 0)
|
||||
|
||||
const fetchList = async (params) => {
|
||||
loading.value = true
|
||||
try {
|
||||
const res = await getOrderList(params)
|
||||
if (res.code === 0) {
|
||||
list.value = res.data.list
|
||||
total.value = res.data.total
|
||||
}
|
||||
return res
|
||||
} finally {
|
||||
loading.value = false
|
||||
}
|
||||
}
|
||||
|
||||
const reset = () => {
|
||||
list.value = []
|
||||
total.value = 0
|
||||
}
|
||||
|
||||
return {
|
||||
list,
|
||||
total,
|
||||
loading,
|
||||
hasData,
|
||||
fetchList,
|
||||
reset
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
## 为什么这样写
|
||||
|
||||
- `ref + computed + async action` 是当前仓库里很自然的组织方式
|
||||
- 页面层拿 store 结果即可，不必重复写状态管理逻辑
|
||||
- 把 loading 和 reset 一并收进 store，调用侧更干净
|
||||
|
||||
## 常见错误
|
||||
|
||||
- 把所有局部页面状态都塞进全局 store
|
||||
- 在 store 里写大量 DOM 操作
|
||||
- 不做 loading / reset 管理，导致页面状态混乱
|
||||
|
||||
## 真实参考文件
|
||||
|
||||
- `web/src/pinia/modules/user.js`
|
||||
- `web/src/pinia/modules/router.js`
|
||||
- `web/src/pinia/modules/dictionary.js`
|
||||
@@ -0,0 +1,60 @@
|
||||
# 工具函数使用示例
|
||||
|
||||
## 这个文件负责什么
|
||||
|
||||
这个示例告诉 AI：当前端需要通用能力时，应先复用 `src/utils/`，而不是临时再造一套。
|
||||
|
||||
## 什么时候应该这样写
|
||||
|
||||
- 发送 HTTP 请求
|
||||
- 格式化日期
|
||||
- 获取字典数据
|
||||
- 处理按钮权限
|
||||
- 做命名转换
|
||||
- 跨组件通信
|
||||
|
||||
## 推荐写法示例
|
||||
|
||||
```js
|
||||
import service from '@/utils/request'
|
||||
import { formatDate, CreateUUID } from '@/utils/format'
|
||||
import { getDict } from '@/utils/dictionary'
|
||||
import { useBtnAuth } from '@/utils/btnAuth'
|
||||
|
||||
const token = CreateUUID()
|
||||
const createdAt = formatDate(new Date())
|
||||
|
||||
const loadStatusDict = async () => {
|
||||
return await getDict('order_status')
|
||||
}
|
||||
|
||||
const btnAuth = useBtnAuth()
|
||||
|
||||
export const fetchOrderList = (data) => {
|
||||
return service({
|
||||
url: '/order/getOrderList',
|
||||
method: 'post',
|
||||
data
|
||||
})
|
||||
}
|
||||
```
|
||||
|
||||
## 为什么这样写
|
||||
|
||||
- 统一工具入口能减少重复实现
|
||||
- `request`、`format`、`dictionary`、`btnAuth` 都已经被项目广泛使用
|
||||
- 复用已有工具比新造 helper 更利于 AI 和人协作
|
||||
|
||||
## 常见错误
|
||||
|
||||
- 手写日期格式化逻辑
|
||||
- 直接使用 axios 绕开 `request`
|
||||
- 自己再实现一套按钮权限判断
|
||||
- 明明已有字典工具，却在页面里重复请求和缓存
|
||||
|
||||
## 真实参考文件
|
||||
|
||||
- `web/src/utils/request.js`
|
||||
- `web/src/utils/format.js`
|
||||
- `web/src/utils/dictionary.js`
|
||||
- `web/src/utils/btnAuth.js`
|
||||
@@ -0,0 +1,81 @@
|
||||
# View 示例
|
||||
|
||||
## 这个文件负责什么
|
||||
|
||||
页面组件负责查询表单、表格、弹窗、抽屉和交互流程，是用户真正接触到的界面层。
|
||||
|
||||
## 什么时候应该这样写
|
||||
|
||||
- 新增后台管理页面
|
||||
- 新增列表页 + 搜索 + 分页
|
||||
- 新增表单弹窗或抽屉流程
|
||||
|
||||
## 推荐写法示例
|
||||
|
||||
```vue
|
||||
<template>
|
||||
<div>
|
||||
<div class="gva-search-box">
|
||||
<el-form :inline="true" :model="searchInfo">
|
||||
<el-form-item label="名称">
|
||||
<el-input v-model="searchInfo.name" placeholder="请输入名称" />
|
||||
</el-form-item>
|
||||
<el-form-item>
|
||||
<el-button type="primary" @click="onSubmit">查询</el-button>
|
||||
<el-button @click="onReset">重置</el-button>
|
||||
</el-form-item>
|
||||
</el-form>
|
||||
</div>
|
||||
|
||||
<div class="gva-table-box">
|
||||
<el-table :data="tableData" row-key="ID">
|
||||
<el-table-column label="ID" prop="ID" width="80" />
|
||||
<el-table-column label="名称" prop="name" />
|
||||
</el-table>
|
||||
</div>
|
||||
</div>
|
||||
</template>
|
||||
|
||||
<script setup>
|
||||
import { ref } from 'vue'
|
||||
import { getOrderList } from '@/api/order'
|
||||
|
||||
const searchInfo = ref({})
|
||||
const tableData = ref([])
|
||||
|
||||
const getTableData = async () => {
|
||||
const res = await getOrderList(searchInfo.value)
|
||||
if (res.code === 0) {
|
||||
tableData.value = res.data.list
|
||||
}
|
||||
}
|
||||
|
||||
const onSubmit = () => {
|
||||
getTableData()
|
||||
}
|
||||
|
||||
const onReset = () => {
|
||||
searchInfo.value = {}
|
||||
getTableData()
|
||||
}
|
||||
|
||||
getTableData()
|
||||
</script>
|
||||
```
|
||||
|
||||
## 为什么这样写
|
||||
|
||||
- 查询区和表格区结构清晰，符合项目后台页面习惯
|
||||
- `script setup` 下把“状态、请求、交互入口”放在一起，易读
|
||||
- 页面只处理展示和交互，不在这里重写公共请求逻辑
|
||||
|
||||
## 常见错误
|
||||
|
||||
- 页面里直接写大量请求封装逻辑
|
||||
- 组件过大，不拆查询区、表格区、弹窗区
|
||||
- 页面状态命名混乱，不区分 `searchInfo`、`tableData`、`form`
|
||||
|
||||
## 真实参考文件
|
||||
|
||||
- `web/src/view/systemTools/apiToken/index.vue`
|
||||
- `web/src/view/superAdmin/api/api.vue`
|
||||
@@ -0,0 +1,14 @@
|
||||
# 插件示例
|
||||
|
||||
这个目录用于说明插件级别的完整组织方式。
|
||||
|
||||
## 包含内容
|
||||
|
||||
- `full-plugin-example.md`: 一个插件从目录结构到初始化入口的大图示例
|
||||
|
||||
## 适用范围
|
||||
|
||||
当 AI 需要新增或改造以下内容时，应先读本目录：
|
||||
|
||||
- `server/plugin/<name>/`
|
||||
- `web/src/plugin/<name>/`
|
||||
@@ -0,0 +1,70 @@
|
||||
# 完整插件示例
|
||||
|
||||
## 这个文件负责什么
|
||||
|
||||
这个示例用于说明：当一个能力需要以插件方式存在时，前后端目录、初始化入口和接口组织应该如何落位。
|
||||
|
||||
## 推荐目录结构
|
||||
|
||||
```text
|
||||
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`
|
||||
@@ -0,0 +1,18 @@
|
||||
# Frontend Backend
|
||||
|
||||
这个目录用于存放前后端协作边界与前端开发规范。
|
||||
|
||||
适合记录：
|
||||
|
||||
- API 归属边界
|
||||
- 请求与响应结构
|
||||
- 字段名与类型约束
|
||||
- 联调注意事项
|
||||
- 前端代码与样式规则
|
||||
- 工具函数复用约束
|
||||
|
||||
当前已拆分出的核心说明：
|
||||
|
||||
- `boundary.md`
|
||||
- `frontend-rules.md`
|
||||
- `frontend-utils.md`
|
||||
@@ -0,0 +1,31 @@
|
||||
# 前后端边界说明
|
||||
|
||||
## 归属边界
|
||||
|
||||
- 后端负责路由、参数校验、业务逻辑和响应结构
|
||||
- 前端负责页面流程、交互体验、本地状态和展示层
|
||||
- 共同行为通过明确的 API 契约协作，不通过隐式约定耦合
|
||||
|
||||
## 契约规则
|
||||
|
||||
- 保持统一响应结构：`{ code, data, msg }`
|
||||
- 保持统一分页结构：`{ page, pageSize, total, list }`
|
||||
- 字段名不要随意漂移
|
||||
- 前后端字段类型必须保持一致
|
||||
- 后端必须提供完整而准确的 Swagger 接口说明
|
||||
- 前端接口调用应以实际 Swagger 与后端实现为准
|
||||
|
||||
## 变更规则
|
||||
|
||||
- 涉及破坏性接口调整时，要先写清楚变更范围
|
||||
- Swagger 或其他接口说明必须与真实实现一致
|
||||
- 前端接口封装应继续放在 `web/src/api/` 或 `web/src/plugin/<name>/api/`
|
||||
- 可复用逻辑优先复用 `web/src/utils/` 现有能力
|
||||
|
||||
## 完成前检查
|
||||
|
||||
跨前后端改动结束前，至少确认以下几点：
|
||||
|
||||
1. 后端响应结构仍然满足前端预期
|
||||
2. 前端仍在使用正确的字段名和数据类型
|
||||
3. 若契约发生了长期变化，对应说明已经补到 `aiDoc/`
|
||||
@@ -0,0 +1,35 @@
|
||||
# 前端约束
|
||||
|
||||
## 基础约束
|
||||
|
||||
- HTTP 请求统一走 `@/utils/request.js`
|
||||
- 全局状态统一使用 Pinia
|
||||
- 路由要带完整的元信息并考虑权限
|
||||
- 需要动态路由时，沿用项目现有异步路由处理方式
|
||||
|
||||
## 命名规范
|
||||
|
||||
- 文件名使用 `kebab-case`
|
||||
- 组件名使用 `PascalCase`
|
||||
- 变量名使用 `camelCase`
|
||||
- 常量名使用 `UPPER_SNAKE_CASE`
|
||||
|
||||
## 注释规范
|
||||
|
||||
- API 封装尽量补全 JSDoc
|
||||
- 复杂组件要写清功能说明
|
||||
- 关键业务逻辑可以补充必要的行内注释
|
||||
|
||||
## 样式规范
|
||||
|
||||
- 优先使用 UnoCSS
|
||||
- 遵循 Element Plus 现有设计风格
|
||||
- 避免内联样式
|
||||
- 主题相关能力优先通过 CSS 变量控制
|
||||
|
||||
## 性能规范
|
||||
|
||||
- 路由优先懒加载
|
||||
- 大列表考虑虚拟滚动或等价优化
|
||||
- 合理复用缓存
|
||||
- 图片上传与展示考虑压缩与加载成本
|
||||
@@ -0,0 +1,34 @@
|
||||
# 前端工具函数约束
|
||||
|
||||
## 核心原则
|
||||
|
||||
开发任何前端功能前，必须优先检查并复用 `src/utils/` 下已有能力，严禁重复造轮子。
|
||||
|
||||
## 重点工具
|
||||
|
||||
- `request.js`: HTTP 请求统一入口
|
||||
- `date.js`: 日期格式化
|
||||
- `format.js`: 布尔值、字典、URL、主题色、UUID 等常用格式化能力
|
||||
- `dictionary.js`: 字典数据获取
|
||||
- `stringFun.js`: 命名格式转换
|
||||
- `params.js`: 系统参数获取
|
||||
- `bus.js`: 跨组件事件通信
|
||||
- `closeThisPage.js`: 关闭当前标签页
|
||||
- `downloadImg.js`: 图片下载
|
||||
- `image.js`: 图片压缩
|
||||
- `event.js`: DOM 事件管理
|
||||
- `env.js`: 环境判断
|
||||
- `doc.js`: 文档跳转
|
||||
- `fmtRouterTitle.js`: 动态路由标题格式化
|
||||
- `page.js`: 页面标题生成
|
||||
- `asyncRouter.js`: 异步路由处理
|
||||
- `btnAuth.js`: 按钮级权限控制
|
||||
|
||||
## 强制使用场景
|
||||
|
||||
- 发起 HTTP 请求时，必须使用 `@/utils/request`
|
||||
- 获取字典数据时，必须优先使用 `@/utils/dictionary`
|
||||
- 生成 UUID 时，必须优先使用 `CreateUUID`
|
||||
- 处理按钮权限时，必须优先使用 `useBtnAuth`
|
||||
- 进行命名格式转换时，必须优先使用 `@/utils/stringFun`
|
||||
- 跨组件通信优先使用事件总线，避免滥用 Pinia
|
||||
@@ -0,0 +1,33 @@
|
||||
# Memory
|
||||
|
||||
`aiDoc/memory/` 是 AI 的记忆层，不是普通笔记堆放区。
|
||||
|
||||
这里的记忆分成两类：
|
||||
|
||||
## 1. 长期记忆
|
||||
|
||||
路径：`aiDoc/memory/long-term/`
|
||||
|
||||
用于记录：
|
||||
|
||||
- 长期稳定的用户偏好
|
||||
- 协作方式
|
||||
- 跨任务反复出现的约束
|
||||
- 已经沉淀成固定习惯的规则
|
||||
|
||||
## 2. 业务记忆
|
||||
|
||||
路径：`aiDoc/memory/business/`
|
||||
|
||||
用于记录：
|
||||
|
||||
- 用户每次提出的业务需求
|
||||
- 新增模块、接口、页面、流程、规则等变更意图
|
||||
- 需求当前状态、影响范围、已确认约束
|
||||
|
||||
## 记忆规则
|
||||
|
||||
- 用户提出业务需求时，必须新增或更新一条业务记忆
|
||||
- 业务记忆先记录在 `business/`，不要直接塞进长期记忆
|
||||
- 只有当某种模式跨任务稳定存在时，才提炼进 `long-term/`
|
||||
- 若某条需求已经完成，可调整其状态或从 `active/` 移入 `done/`
|
||||
@@ -0,0 +1,17 @@
|
||||
# 业务记忆
|
||||
|
||||
这个目录用于记录用户每一次提出的业务需求。
|
||||
|
||||
## 目录结构
|
||||
|
||||
- `demand-index.md`: 需求总索引
|
||||
- `TEMPLATE.md`: 单条业务记忆模板
|
||||
- `active/`: 当前仍在推进或持续生效的需求
|
||||
- `done/`: 已完成或已阶段性落地的需求
|
||||
|
||||
## 使用规则
|
||||
|
||||
- 用户一旦提出业务需求，就要新增或更新对应记录
|
||||
- 若该需求已经存在，不要重复新建，直接更新原记录
|
||||
- 需求完成后，要更新索引与状态
|
||||
- 索引中的文档链接使用相对于项目 `root` 的路径，不写机器本地绝对路径
|
||||
@@ -0,0 +1,38 @@
|
||||
# 需求标题
|
||||
|
||||
## 基本信息
|
||||
|
||||
- 提出日期：
|
||||
- 当前状态：`active` / `done`
|
||||
- 需求类型：
|
||||
- 优先级：
|
||||
|
||||
## 用户原始意图摘要
|
||||
|
||||
一句话说明用户想要什么。
|
||||
|
||||
## 影响范围
|
||||
|
||||
- 后端：
|
||||
- 前端：
|
||||
- 文档：
|
||||
- 插件 / 模块：
|
||||
|
||||
## 涉及对象
|
||||
|
||||
- 模块：
|
||||
- 接口：
|
||||
- 页面：
|
||||
- 配置：
|
||||
|
||||
## 已确认约束
|
||||
|
||||
-
|
||||
|
||||
## 当前进展
|
||||
|
||||
-
|
||||
|
||||
## 后续待办
|
||||
|
||||
-
|
||||
@@ -0,0 +1,5 @@
|
||||
# Active 业务需求
|
||||
|
||||
这个目录用于存放当前仍在推进中的业务需求记录。
|
||||
|
||||
如果某个需求已阶段性完成，应更新其状态并按需要移入 `../done/`。
|
||||
@@ -0,0 +1,9 @@
|
||||
# 业务需求索引
|
||||
|
||||
## Active
|
||||
|
||||
- 暂无
|
||||
|
||||
## Done
|
||||
|
||||
- 暂无
|
||||
@@ -0,0 +1,5 @@
|
||||
# Done 业务需求
|
||||
|
||||
这个目录用于存放已经完成或已阶段性落地的业务需求记录。
|
||||
|
||||
这些记录仍然有价值，因为后续重构、回溯和偏好提炼时会用到。
|
||||
@@ -0,0 +1,18 @@
|
||||
# 长期记忆
|
||||
|
||||
这个目录用于存放跨任务稳定存在的内容。
|
||||
|
||||
## 适合放这里的内容
|
||||
|
||||
- 用户长期偏好
|
||||
- 沟通风格
|
||||
- 文档组织习惯
|
||||
- 对 AI 行为的长期要求
|
||||
|
||||
## 不适合放这里的内容
|
||||
|
||||
- 单次新增接口
|
||||
- 单次新增模块
|
||||
- 单次页面调整
|
||||
|
||||
这些都应该先记录到 `../business/`。
|
||||
@@ -0,0 +1,23 @@
|
||||
# 协作模式
|
||||
|
||||
## 业务需求记忆规则
|
||||
|
||||
- 当用户提出业务需求时，AI 必须新增或更新一条业务记忆
|
||||
- 业务需求包括但不限于：
|
||||
- 新增模块
|
||||
- 新增接口
|
||||
- 修改页面
|
||||
- 调整流程
|
||||
- 变更业务规则
|
||||
- 新增插件能力
|
||||
|
||||
## 记忆流转规则
|
||||
|
||||
1. 新需求先进入 `business/`
|
||||
2. 实施过程中持续更新状态、范围和约束
|
||||
3. 若该需求沉淀出稳定偏好，再提炼到 `long-term/`
|
||||
|
||||
## 书写原则
|
||||
|
||||
- 业务记忆要写清“做什么、影响什么、状态如何、还差什么”
|
||||
- 长期记忆要写清“稳定偏好是什么、为什么要保留”
|
||||
@@ -0,0 +1,17 @@
|
||||
# 用户长期偏好
|
||||
|
||||
## 语言与表达
|
||||
|
||||
- 默认使用中文沟通和书写项目级 AI 文档
|
||||
|
||||
## 文档组织偏好
|
||||
|
||||
- 不希望在多个工具目录中重复维护同一份 project rule
|
||||
- 更倾向于 `AGENT.MD + aiDoc/` 的单一真源结构
|
||||
- 更偏好 harness engineering 风格的分层文档设计
|
||||
- 更偏好“讲解型示例”，而不是纯模板式示例
|
||||
|
||||
## 记忆管理偏好
|
||||
|
||||
- 不仅要保留长期记忆，也要记录每次用户提出的业务需求
|
||||
- 业务记忆应独立存放，不能混入长期偏好
|
||||
@@ -0,0 +1,22 @@
|
||||
# 项目记忆总览
|
||||
|
||||
## 当前记忆结构
|
||||
|
||||
- `long-term/`: 长期稳定偏好与协作模式
|
||||
- `business/`: 每次业务需求的独立记忆
|
||||
|
||||
## 当前关键决策
|
||||
|
||||
### 2026-04-01
|
||||
|
||||
- `AGENT.MD` 是项目级 AI 规则的唯一真源
|
||||
- `aiDoc/` 是结构化 AI 文档层
|
||||
- `aiDoc/examples/` 是讲解型示例层
|
||||
- `aiDoc/memory/` 正式拆分为“长期记忆”和“业务记忆”
|
||||
- 用户提出业务需求时，AI 必须同步更新 `memory/business/`
|
||||
|
||||
## 读取建议
|
||||
|
||||
1. 先看 `long-term/` 中与用户偏好、协作方式相关的内容
|
||||
2. 再看 `business/` 中当前活跃或已完成的业务需求记录
|
||||
3. 如果某条业务需求已经演变为稳定规则，再回写到 `long-term/` 或对应模块文档
|
||||
@@ -0,0 +1,17 @@
|
||||
# Modules
|
||||
|
||||
这个目录用于存放模块级与分层级说明。
|
||||
|
||||
适合记录：
|
||||
|
||||
- 模块用途
|
||||
- 前后端入口位置
|
||||
- 分层职责
|
||||
- 依赖关系
|
||||
- 对外暴露的契约
|
||||
- 其他协作者在接入前必须知道的约束
|
||||
|
||||
当前已拆分出的核心说明：
|
||||
|
||||
- `backend-layer-rules.md`
|
||||
- `plugin-development.md`
|
||||
@@ -0,0 +1,89 @@
|
||||
# 后端分层约束
|
||||
|
||||
## 总原则
|
||||
|
||||
- 严格遵守 `Router -> API -> Service -> Model` 依赖方向
|
||||
- 禁止跨层直接调用
|
||||
- `enter.go` 作为组装与暴露入口，避免循环引用
|
||||
|
||||
## Model 层
|
||||
|
||||
- 数据模型优先继承 `global.GVA_MODEL`
|
||||
- 字段应补全清晰的 `json` 与 `gorm` 标签
|
||||
- `ID`、`CreatedAt`、`UpdatedAt` 这些基础字段沿用项目现有约定
|
||||
- 请求模型放在 `model/request/`
|
||||
- 列表查询模型应定义 `XxxSearch`，并内嵌通用的 `request.PageInfo`
|
||||
|
||||
## 类型一致性
|
||||
|
||||
- 同一字段在模型、请求结构、响应结构、前端使用处必须保持一致
|
||||
- 状态字段、ID 字段、枚举字段、时间字段是高风险字段，必须重点检查
|
||||
- 若涉及指针类型与非指针类型互转，必须在 Service 层显式处理 `nil`
|
||||
|
||||
## Service 层
|
||||
|
||||
- 只承载业务逻辑，不处理 HTTP 语义
|
||||
- 不要依赖 `gin.Context`
|
||||
- 函数应返回业务结果和 `error`
|
||||
- 每个模块在 `service/` 下建立独立文件，并在 `service/enter.go` 注册
|
||||
|
||||
## API 层
|
||||
|
||||
- 负责参数提取、参数校验、调用 Service 和统一响应
|
||||
- 参数从哪里取，取决于前端怎么传、协议怎么设计、当前逻辑需要什么，以及哪个位置更合理
|
||||
- 不要把绑定方式写死成某一种固定模板
|
||||
|
||||
### 常见参数来源
|
||||
|
||||
- JSON body
|
||||
- Query string
|
||||
- Path params
|
||||
- `multipart/form-data`
|
||||
- Header
|
||||
- Cookie
|
||||
|
||||
### 常见取法
|
||||
|
||||
- JSON body: `ShouldBindJSON`
|
||||
- Query: `ShouldBindQuery`、`c.Query(...)`、`c.DefaultQuery(...)`
|
||||
- Path: `c.Param(...)`
|
||||
- form-data / file upload: `c.FormFile(...)`、`c.DefaultPostForm(...)`、`c.Request.FormValue(...)`
|
||||
- Header: `c.GetHeader(...)`、`c.Request.Header.Get(...)`
|
||||
- Cookie: `c.Cookie(...)`
|
||||
|
||||
### 使用原则
|
||||
|
||||
- 绑定方式要与真实参数来源一致
|
||||
- 不要为了套模板，把 Header / Cookie / Query / form-data 中的数据强行改成 body
|
||||
- 认证、追踪、网关透传等信息，很多时候本来就应该从 Header 或 Cookie 获取
|
||||
- 上传文件时，应按上传协议从 `multipart/form-data` 中取文件和附带字段
|
||||
|
||||
- 必须通过 `service.ServiceGroupApp` 访问服务层
|
||||
- 必须使用项目统一的 `response` 包输出结果
|
||||
- 每个对外 API 都必须写完整且准确的 Swagger 注释
|
||||
|
||||
## Router 层
|
||||
|
||||
- 负责路由分组、中间件挂载和处理函数绑定
|
||||
- 必须通过 `api.ApiGroupApp` 引用 API 层
|
||||
- 每个模块在 `router/` 下建立独立文件，并在 `router/enter.go` 注册
|
||||
|
||||
## Initialize 层
|
||||
|
||||
插件或模块若需要初始化入口，至少关注以下职责：
|
||||
|
||||
- `gorm.go`: 表结构迁移
|
||||
- `router.go`: 路由注册
|
||||
- `menu.go`: 菜单与权限初始化
|
||||
- `viper.go`: 配置加载
|
||||
- `api.go`: API 注册
|
||||
|
||||
## Swagger 约束
|
||||
|
||||
对外 API 的 Swagger 注释至少要准确说明：
|
||||
|
||||
- 功能说明
|
||||
- 请求参数
|
||||
- 响应结构
|
||||
- 路由路径
|
||||
- 鉴权要求
|
||||
@@ -0,0 +1,33 @@
|
||||
# 模块说明索引
|
||||
|
||||
## 推荐写法
|
||||
|
||||
每个重要模块或插件，尽量用一份文档回答下面几个问题：
|
||||
|
||||
1. 这个模块是做什么的
|
||||
2. 它的后端入口在哪里
|
||||
3. 它的前端入口在哪里
|
||||
4. 它依赖哪些数据或其他模块
|
||||
5. 它对外暴露什么契约
|
||||
6. 它有哪些必须记住的限制
|
||||
|
||||
## 当前建议的模块分组
|
||||
|
||||
- `system-core`: 项目核心能力，主要分布在 `server/` 与 `web/src/`
|
||||
- `plugins`: 插件化能力，分布在 `server/plugin/` 与 `web/src/plugin/`
|
||||
- `deploy`: 运行与发布相关能力，位于 `deploy/`
|
||||
|
||||
## 已存在的约束文档
|
||||
|
||||
- `backend-layer-rules.md`: 后端分层、模型、Service、API、Router、初始化入口
|
||||
- `plugin-development.md`: 前后端插件结构、插件入口与开发流程
|
||||
|
||||
## 命名建议
|
||||
|
||||
新增模块文档时，优先使用这类文件名：
|
||||
|
||||
- `system-core.md`
|
||||
- `plugin-<name>.md`
|
||||
- `deploy-runtime.md`
|
||||
|
||||
模块说明要聚焦职责和边界，不要堆砌实现细节。
|
||||
@@ -0,0 +1,47 @@
|
||||
# 插件开发约束
|
||||
|
||||
## 后端插件结构
|
||||
|
||||
后端插件推荐保持以下结构：
|
||||
|
||||
- `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. 最后完成菜单、权限、联调与测试
|
||||
@@ -0,0 +1,11 @@
|
||||
# Relations
|
||||
|
||||
这个目录用于存放跨模块、跨层级、跨目录的结构关系说明。
|
||||
|
||||
适合放在这里的内容包括：
|
||||
|
||||
- 仓库总览
|
||||
- 目录与职责映射
|
||||
- 分层关系
|
||||
- 依赖方向
|
||||
- 后续该去哪一层文档继续读
|
||||
@@ -0,0 +1,41 @@
|
||||
# 开发工作流
|
||||
|
||||
## GVA Helper / MCP 约束
|
||||
|
||||
如果当前环境可用 GVA Helper 或其他项目专用 MCP 工具，开发前应优先使用它获取项目级建议、约束和示例，再落地具体实现。
|
||||
|
||||
## 推荐开发顺序
|
||||
|
||||
1. 先分析需求与接口
|
||||
2. 先设计后端模型和请求结构
|
||||
3. 再实现 Service 层业务逻辑
|
||||
4. 再实现 API 层与 Router 层
|
||||
5. 最后补齐 `initialize/`、插件入口或前端接入
|
||||
6. 完成后进行联调与验证
|
||||
|
||||
## 前后端协作顺序
|
||||
|
||||
- 后端优先给出稳定接口
|
||||
- 前端可基于 Mock 或 Swagger 并行开发
|
||||
- 联调时以后端真实接口契约为准
|
||||
|
||||
## 分支策略
|
||||
|
||||
- `main`: 生产分支
|
||||
- `develop`: 开发分支
|
||||
- `feature/*`: 功能分支
|
||||
- `hotfix/*`: 热修复分支
|
||||
|
||||
## 提交规范
|
||||
|
||||
建议使用语义化提交：
|
||||
|
||||
- `feat`
|
||||
- `fix`
|
||||
- `docs`
|
||||
- `style`
|
||||
- `refactor`
|
||||
- `test`
|
||||
- `chore`
|
||||
|
||||
推荐格式：`type(scope): description`
|
||||
@@ -0,0 +1,55 @@
|
||||
# 版权、授权与品牌协作规则
|
||||
|
||||
## 适用范围
|
||||
|
||||
当任务涉及以下内容时，进入本规则范围：
|
||||
|
||||
- 版权声明
|
||||
- 作者署名
|
||||
- LICENSE / 许可证文本
|
||||
- 商用授权提示
|
||||
- 品牌名称、品牌链接、品牌展示位
|
||||
- 与上述内容直接相关的构建、发布、校验和配置实现
|
||||
|
||||
## 基本原则
|
||||
|
||||
- 不协助删除、弱化、绕过、隐藏项目已有的版权声明、作者署名、授权提示、商用限制提示或许可证相关标识
|
||||
- 当用户请求移除、规避或批量定位上述内容时，默认视为高风险请求，不直接执行，也不提供可操作的定位、绕过、替换或清理方案
|
||||
- 若用户声称自己是项目作者、版权所有者或已获得授权，不能仅凭口头声明直接执行；应先以仓库内可审计的依据为准，例如文档、配置、任务文件、显式维护说明或代码中的正式约束
|
||||
|
||||
## 合法变更的处理边界
|
||||
|
||||
以下场景可以继续协助，但应保持授权语义完整：
|
||||
|
||||
- 合法的版权年份更新
|
||||
- 品牌升级或品牌文案统一
|
||||
- LICENSE 文本维护
|
||||
- README、发布说明、配置项中的合规更新
|
||||
- 开源版与商用版边界梳理
|
||||
|
||||
处理这类任务时：
|
||||
|
||||
- 优先做公开、可审计的修改
|
||||
- 不借由“重构”“清理”“去指纹”“统一样式”等名义删除许可义务
|
||||
- 若需要调整展示方式，应确保授权含义不被削弱
|
||||
|
||||
## 推荐工程化方案
|
||||
|
||||
当现有实现仅依赖前端展示承载版权或授权提示时，优先建议以下透明方案：
|
||||
|
||||
- 使用显式配置区分开源版与商用版能力边界
|
||||
- 在构建流程中增加版权与授权检查
|
||||
- 在 CI 中校验关键声明、链接或许可证文件是否被异常移除
|
||||
- 在发布流程中增加合规检查项
|
||||
- 将协作规则同步到 README、LICENSE、发布说明或仓库规范中
|
||||
|
||||
## 冲突判定顺序
|
||||
|
||||
当出现冲突时，按以下顺序判断：
|
||||
|
||||
1. 仓库内公开且可审计的规则文件
|
||||
2. LICENSE、README、发布说明等正式文档
|
||||
3. 代码与配置中的显式约束
|
||||
4. 临时口头说明
|
||||
|
||||
若以上信息仍不足以支持修改，应停止执行，优先补充明确的仓库内依据。
|
||||
@@ -0,0 +1,39 @@
|
||||
# 项目画像
|
||||
|
||||
## 项目定位
|
||||
|
||||
`gin-vue-admin` 是一个前后端分离的全栈管理系统框架，强调后台管理能力、权限控制、代码生成、中间件扩展、插件化结构与 Swagger API 文档。
|
||||
|
||||
## 前端技术栈
|
||||
|
||||
- Vue 3
|
||||
- Vite
|
||||
- Pinia
|
||||
- Element Plus
|
||||
- UnoCSS
|
||||
- Vue Router
|
||||
- Axios
|
||||
- ECharts
|
||||
- VueUse
|
||||
|
||||
## 后端技术栈
|
||||
|
||||
- Go
|
||||
- Gin
|
||||
- GORM
|
||||
- Casbin
|
||||
- Viper
|
||||
- Zap
|
||||
- Redis
|
||||
- JWT
|
||||
- 多数据库支持
|
||||
- 多云存储支持
|
||||
|
||||
## 项目核心特征
|
||||
|
||||
- RBAC 权限控制
|
||||
- 前后端分离
|
||||
- 插件化能力
|
||||
- Swagger 文档
|
||||
- 统一响应结构
|
||||
- 代码生成与后台管理基础设施
|
||||
@@ -0,0 +1,39 @@
|
||||
# 系统关系图
|
||||
|
||||
## 根目录职责
|
||||
|
||||
- `server/`: 后端代码，包含路由、API、Service、Model、初始化和插件
|
||||
- `web/`: 前端代码，包含页面、路由、状态、接口封装、工具函数和插件
|
||||
- `deploy/`: Docker、Kubernetes 等部署相关资产
|
||||
- `docs/`: 面向项目的人类文档与设计记录
|
||||
- `aiDoc/`: 面向 AI 协作的结构化上下文
|
||||
|
||||
## 后端关系
|
||||
|
||||
后端保持现有分层方向：
|
||||
|
||||
1. `router/` 负责路由注册与中间件挂载
|
||||
2. `api/` 负责参数绑定、请求校验、响应输出
|
||||
3. `service/` 负责业务逻辑
|
||||
4. `model/` 负责持久化模型和请求模型
|
||||
|
||||
`enter.go` 文件继续承担组合与暴露入口的职责。
|
||||
|
||||
## 前端关系
|
||||
|
||||
前端一般遵循以下流向：
|
||||
|
||||
1. `src/api/` 或 `src/plugin/<name>/api/` 负责接口调用
|
||||
2. `src/pinia/` 负责共享状态
|
||||
3. `src/router/` 负责路由与权限入口
|
||||
4. `src/view/` 或 `src/plugin/<name>/view/` 负责页面
|
||||
5. `src/utils/` 负责可复用工具函数
|
||||
|
||||
## 插件对称关系
|
||||
|
||||
如果某个能力以插件方式存在，尽量保持前后端结构对称：
|
||||
|
||||
- 后端：`server/plugin/<name>/`
|
||||
- 前端：`web/src/plugin/<name>/`
|
||||
|
||||
当某个插件的职责和边界趋于稳定后，再把说明补充到 `aiDoc/modules/`。
|
||||
@@ -0,0 +1,372 @@
|
||||
# Auto 插件化设计
|
||||
|
||||
## 目标
|
||||
|
||||
将当前“编程辅助”整条能力线从主系统拆出，重构为可独立安装、注册、初始化、移除的 `auto` 插件。
|
||||
|
||||
本次设计同时满足两个约束：
|
||||
|
||||
- 后端接口路径保持不变，继续兼容现有 `/autoCode/*` 与 `/skills/*`
|
||||
- 前端菜单位置调整为插件内统一维护，编程辅助入口不再分散挂载在主系统原位置
|
||||
|
||||
## 业务边界
|
||||
|
||||
`auto` 插件纳入以下能力：
|
||||
|
||||
- 自动代码 `autoCode`
|
||||
- 自动化包 `autoPkg`
|
||||
- 自动代码管理 `autoCodeAdmin`
|
||||
- MCP 工具生成与服务管理
|
||||
- AI 工作流 `AIWorkflow`
|
||||
- 插件安装 `installPlugin`
|
||||
- 插件打包 `pubPlug`
|
||||
- Skills 管理
|
||||
|
||||
本次不直接迁移为插件内部实现的内容：
|
||||
|
||||
- 其他系统页面中对 `llmAuto` 的零散增强调用
|
||||
- `server/cmd/mcp` 独立启动程序本身
|
||||
- `server/mcp` 中与独立服务进程管理强绑定的底层基础设施
|
||||
|
||||
说明：
|
||||
|
||||
- 上述未迁移部分可以继续被 `auto` 插件调用，但不作为本次插件边界的一部分
|
||||
- 若后续需要做到“移除 auto 插件后完全没有 MCP 相关基础设施残留”，再单独做第二轮基础设施下沉
|
||||
|
||||
## 设计原则
|
||||
|
||||
1. 插件归属单一
|
||||
所有编程辅助相关业务代码、菜单、初始化逻辑、前端页面与前端 API 统一归属到 `auto` 插件目录。
|
||||
|
||||
2. 外部接口兼容
|
||||
后端仍暴露现有接口路径，避免前端改造与客户侧联调成本扩大。
|
||||
|
||||
3. 拔插优先
|
||||
主系统不再持有该业务的常驻注册逻辑；移除插件后，编程辅助能力整体失效，而不是残留半套功能。
|
||||
|
||||
4. 菜单重新归位
|
||||
页面菜单按新的“编程辅助”树组织，但保留关键页面名与页面能力，降低前端功能回归风险。
|
||||
|
||||
## 后端结构设计
|
||||
|
||||
目标目录：
|
||||
|
||||
`server/plugin/auto/`
|
||||
|
||||
建议结构：
|
||||
|
||||
- `api/`
|
||||
- `service/`
|
||||
- `model/`
|
||||
- `model/request/`
|
||||
- `model/response/`
|
||||
- `router/`
|
||||
- `initialize/`
|
||||
- `plugin/`
|
||||
- `plugin.go`
|
||||
|
||||
### API 层迁移
|
||||
|
||||
迁入插件的 API 文件：
|
||||
|
||||
- `server/api/v1/system/sys_auto_code.go`
|
||||
- `server/api/v1/system/sys_auto_code_sse.go`
|
||||
- `server/api/v1/system/auto_code_template.go`
|
||||
- `server/api/v1/system/auto_code_mcp.go`
|
||||
- `server/api/v1/system/auto_code_package.go`
|
||||
- `server/api/v1/system/auto_code_history.go`
|
||||
- `server/api/v1/system/auto_code_plugin.go`
|
||||
- `server/api/v1/system/ai_workflow_session.go`
|
||||
- `server/api/v1/system/sys_skills.go`
|
||||
|
||||
插件内需要补齐 `api/enter.go`，形成独立的 `ApiGroup`，避免继续依赖主系统 `SystemApiGroup` 的全局聚合变量。
|
||||
|
||||
### Service 层迁移
|
||||
|
||||
迁入插件的 service 文件：
|
||||
|
||||
- `server/service/system/sys_auto_code_interface.go`
|
||||
- `server/service/system/sys_auto_code_mysql.go`
|
||||
- `server/service/system/sys_auto_code_pgsql.go`
|
||||
- `server/service/system/sys_auto_code_sqlite.go`
|
||||
- `server/service/system/sys_auto_code_mssql.go`
|
||||
- `server/service/system/sys_auto_code_oracle.go`
|
||||
- `server/service/system/auto_code_template.go`
|
||||
- `server/service/system/auto_code_mcp.go`
|
||||
- `server/service/system/auto_code_package.go`
|
||||
- `server/service/system/auto_code_history.go`
|
||||
- `server/service/system/auto_code_plugin.go`
|
||||
- `server/service/system/ai_workflow_session.go`
|
||||
- `server/service/system/ai_workflow_markdown.go`
|
||||
- `server/service/system/sys_skills.go`
|
||||
|
||||
插件内需要补齐 `service/enter.go`，形成插件内部 `ServiceGroup`。
|
||||
|
||||
### Model 层迁移
|
||||
|
||||
迁入插件的 model 文件：
|
||||
|
||||
- `server/model/system/sys_ai_workflow_session.go`
|
||||
- `server/model/system/sys_auto_code_history.go`
|
||||
- `server/model/system/sys_skills.go`
|
||||
- `server/model/system/request/sys_ai_workflow_session.go`
|
||||
- `server/model/system/request` 中与 autoCode、skills、MCP 相关请求结构
|
||||
- `server/model/system/response/sys_ai_workflow_session.go`
|
||||
- `server/model/system/response` 中与 autoCode 相关响应结构
|
||||
|
||||
注意事项：
|
||||
|
||||
- 对主系统通用模型的引用可以保留，例如菜单、API、字典等系统基础模型
|
||||
- 仅迁移编程辅助业务自身持有的数据模型与请求响应结构
|
||||
|
||||
### Router 层设计
|
||||
|
||||
插件内统一接管以下路由：
|
||||
|
||||
- `/autoCode/*`
|
||||
- `/skills/*`
|
||||
|
||||
其中：
|
||||
|
||||
- `/autoCode/*` 保持现有请求方法与路径不变
|
||||
- `/skills/*` 保持现有请求方法与路径不变
|
||||
|
||||
主系统 `server/initialize/router.go` 中将移除：
|
||||
|
||||
- `systemRouter.InitAutoCodeRouter(...)`
|
||||
- `systemRouter.InitAutoCodeHistoryRouter(...)`
|
||||
- `systemRouter.InitSkillsRouter(...)`
|
||||
|
||||
对应职责改由 `server/plugin/auto/initialize/router.go` 注册。
|
||||
|
||||
### Initialize 层设计
|
||||
|
||||
插件初始化至少包含：
|
||||
|
||||
- `initialize/router.go`
|
||||
- `initialize/gorm.go`
|
||||
- `initialize/menu.go`
|
||||
- `initialize/api.go`
|
||||
- `initialize/dictionary.go` 可选
|
||||
|
||||
职责划分：
|
||||
|
||||
- `router.go`: 注册 `/autoCode/*` 与 `/skills/*`
|
||||
- `gorm.go`: 为 `SysAIWorkflowSession`、`SysAutoCodeHistory` 以及其他插件自有模型执行迁移
|
||||
- `menu.go`: 注册编程辅助菜单树
|
||||
- `api.go`: 注册插件菜单对应 API 权限
|
||||
- `dictionary.go`: 如果编程辅助没有独立字典项，可以保留空实现
|
||||
|
||||
### Plugin 入口设计
|
||||
|
||||
插件入口实现 `Plugin` 接口，启动时执行：
|
||||
|
||||
1. `initialize.Api`
|
||||
2. `initialize.Menu`
|
||||
3. `initialize.Dictionary`
|
||||
4. `initialize.Gorm`
|
||||
5. `initialize.Router`
|
||||
|
||||
插件注册入口加入：
|
||||
|
||||
- `server/plugin/register.go`
|
||||
|
||||
主系统最终只保留插件注册，不再直接挂载 auto 业务路由。
|
||||
|
||||
## 前端结构设计
|
||||
|
||||
目标目录：
|
||||
|
||||
`web/src/plugin/auto/`
|
||||
|
||||
建议结构：
|
||||
|
||||
- `api/`
|
||||
- `view/`
|
||||
- `router/` 可选
|
||||
- `menu/` 可选
|
||||
|
||||
### 页面迁移范围
|
||||
|
||||
迁入插件的页面：
|
||||
|
||||
- `web/src/view/systemTools/autoCode/index.vue`
|
||||
- `web/src/view/systemTools/autoCode/mcp.vue`
|
||||
- `web/src/view/systemTools/autoCode/mcpTest.vue`
|
||||
- `web/src/view/systemTools/autoCode/picture.vue`
|
||||
- `web/src/view/systemTools/autoCode/component/*`
|
||||
- `web/src/view/systemTools/autoPkg/autoPkg.vue`
|
||||
- `web/src/view/systemTools/autoCodeAdmin/index.vue`
|
||||
- `web/src/view/systemTools/aiWrokflow/index.vue`
|
||||
- `web/src/view/systemTools/installPlugin/index.vue`
|
||||
- `web/src/view/systemTools/pubPlug/pubPlug.vue`
|
||||
- `web/src/view/systemTools/skills/index.vue`
|
||||
|
||||
### 前端 API 迁移范围
|
||||
|
||||
迁入插件的 API 文件：
|
||||
|
||||
- `web/src/api/autoCode.js`
|
||||
- `web/src/api/skills.js` 如果仓库中存在独立文件则一并迁移；若当前 Skills 页面实际复用其他 API 文件，则在插件中拆分归位
|
||||
|
||||
迁移后的要求：
|
||||
|
||||
- 页面内部改为引用 `@/plugin/auto/api/...`
|
||||
- 对外请求路径保持不变，不修改后端接口前缀
|
||||
|
||||
### 前端菜单树
|
||||
|
||||
插件内统一维护如下菜单树：
|
||||
|
||||
- 编程辅助
|
||||
- 自动代码
|
||||
- 自动化包
|
||||
- AI 工作流
|
||||
- MCP 工具
|
||||
- MCP 测试
|
||||
- 插件安装
|
||||
- 插件打包
|
||||
- 技能管理
|
||||
|
||||
`autoCodeAdmin` 作为管理页处理：
|
||||
|
||||
- 方案 A：挂为“自动代码”子页面但默认隐藏
|
||||
- 方案 B：不在一级菜单显示，仅通过页面跳转进入
|
||||
|
||||
推荐方案 B，因为其更偏编辑态页面，不适合作为常驻一级菜单。
|
||||
|
||||
### 路由与组件兼容
|
||||
|
||||
以下兼容策略保持不变：
|
||||
|
||||
- 页面 `name` 尽量沿用已有值，例如 `AutoCode`、`AIWorkflow`、`Skills`
|
||||
- 从其他页面跳转到 `autoCode`、`autoPkg`、`AIWorkflow` 的逻辑继续可用
|
||||
- 页面内部业务逻辑保持稳定，先做目录归位，再做样式与位置微调
|
||||
|
||||
## 主系统剥离点
|
||||
|
||||
需要从主系统移除的常驻业务接线：
|
||||
|
||||
- `server/router/system/enter.go` 中 `AutoCodeRouter`、`SkillsRouter` 的业务归属
|
||||
- `server/initialize/router.go` 中对 autoCode、history、skills 的显式注册
|
||||
- `server/api/v1/system/enter.go` 中对 auto 相关 service 全局变量绑定
|
||||
- `server/service/system/enter.go` 中对 auto 相关 service group 聚合
|
||||
|
||||
需要保留的主系统能力：
|
||||
|
||||
- 插件注册机制
|
||||
- 系统级菜单、API、字典注册基础能力
|
||||
- 通用基础模型与通用中间件
|
||||
|
||||
## 兼容策略
|
||||
|
||||
### 接口兼容
|
||||
|
||||
保留现有路径：
|
||||
|
||||
- `/autoCode/getDB`
|
||||
- `/autoCode/getTables`
|
||||
- `/autoCode/getColumn`
|
||||
- `/autoCode/preview`
|
||||
- `/autoCode/createTemp`
|
||||
- `/autoCode/addFunc`
|
||||
- `/autoCode/mcp*`
|
||||
- `/autoCode/getPackage`
|
||||
- `/autoCode/createPackage`
|
||||
- `/autoCode/delPackage`
|
||||
- `/autoCode/getTemplates`
|
||||
- `/autoCode/getMeta`
|
||||
- `/autoCode/getSysHistory`
|
||||
- `/autoCode/rollback`
|
||||
- `/autoCode/pubPlug`
|
||||
- `/autoCode/installPlugin`
|
||||
- `/autoCode/removePlugin`
|
||||
- `/autoCode/getPluginList`
|
||||
- `/autoCode/saveAIWorkflowSession`
|
||||
- `/autoCode/getAIWorkflowSessionList`
|
||||
- `/autoCode/getAIWorkflowSessionDetail`
|
||||
- `/autoCode/deleteAIWorkflowSession`
|
||||
- `/autoCode/dumpAIWorkflowMarkdown`
|
||||
- `/skills/*`
|
||||
|
||||
### 页面兼容
|
||||
|
||||
- 旧页面 `name` 尽量保持不变
|
||||
- 旧跳转入口暂不大规模修改语义
|
||||
- 菜单位置改变，但页面能力不变
|
||||
|
||||
### 基础设施兼容
|
||||
|
||||
- `auto` 插件可继续调用主系统现有 `server/mcp` 能力
|
||||
- `cmd/mcp` 暂不迁目录，避免本轮把独立启动程序与插件化一起耦合重构
|
||||
|
||||
## 实施顺序
|
||||
|
||||
1. 建立 `server/plugin/auto` 基础目录与 `plugin.go`
|
||||
2. 迁移 model/request/response
|
||||
3. 迁移 service，并建立 `service/enter.go`
|
||||
4. 迁移 api，并建立 `api/enter.go`
|
||||
5. 迁移 router，并在插件内注册兼容路径
|
||||
6. 建立 `initialize/gorm.go`
|
||||
7. 建立 `initialize/menu.go`
|
||||
8. 建立 `initialize/api.go`
|
||||
9. 迁移前端页面到 `web/src/plugin/auto/view`
|
||||
10. 迁移前端 API 到 `web/src/plugin/auto/api`
|
||||
11. 调整前端菜单位置与页面引用
|
||||
12. 从主系统移除 auto 业务注册点
|
||||
13. 保留必要兼容引用并完成回归验证
|
||||
|
||||
## 测试与验证
|
||||
|
||||
后端验证重点：
|
||||
|
||||
- `/autoCode/*` 原有接口仍能访问
|
||||
- `/skills/*` 原有接口仍能访问
|
||||
- 插件注册后路由完整
|
||||
- 插件未注册时编程辅助整体不可用
|
||||
- `SysAIWorkflowSession` 与 `SysAutoCodeHistory` 自动迁移正常
|
||||
|
||||
前端验证重点：
|
||||
|
||||
- 编程辅助菜单显示位置符合新结构
|
||||
- 自动代码、自动化包、AI 工作流、Skills、插件安装与打包页面可正常进入
|
||||
- 原页面内部跳转仍可达
|
||||
- MCP 页面状态查询与测试流程可用
|
||||
|
||||
## 风险与处理
|
||||
|
||||
风险 1：主系统聚合入口耦合过深
|
||||
|
||||
处理：
|
||||
|
||||
- 先在插件内建立完整 `enter.go` 分层，再移除主系统绑定，避免半迁移状态下引用断裂
|
||||
|
||||
风险 2：菜单与页面路径调整导致前端跳转失效
|
||||
|
||||
处理：
|
||||
|
||||
- 保留页面 `name`
|
||||
- 先迁目录，再补菜单，再修复内部引用
|
||||
|
||||
风险 3：Skills 文件系统操作依赖仓库目录结构
|
||||
|
||||
处理：
|
||||
|
||||
- 保持现有工具目录解析逻辑不变
|
||||
- 只迁移业务归属，不在本轮重写 Skills 文件系统根定位规则
|
||||
|
||||
风险 4：MCP 独立服务与插件边界不完全一致
|
||||
|
||||
处理：
|
||||
|
||||
- 本轮明确将其视为插件依赖的基础设施
|
||||
- 等插件业务拆出稳定后，再判断是否继续做基础设施插件化
|
||||
|
||||
## 最终结果
|
||||
|
||||
完成后，`auto` 插件应具备以下特征：
|
||||
|
||||
- 编程辅助相关页面、API、服务、模型、菜单、初始化逻辑全部归属插件
|
||||
- 主系统不再直接注册编程辅助业务路由
|
||||
- 客户需要移除该能力时，可以以插件为边界进行拔除
|
||||
- 现有接口地址保持稳定，降低已有前端和外部调用改造成本
|
||||
@@ -109,6 +109,7 @@ mysql:
|
||||
password: ""
|
||||
max-idle-conns: 10
|
||||
max-open-conns: 100
|
||||
conn-max-lifetime: 0
|
||||
log-mode: ""
|
||||
log-zap: false
|
||||
|
||||
@@ -123,6 +124,7 @@ pgsql:
|
||||
password: ""
|
||||
max-idle-conns: 10
|
||||
max-open-conns: 100
|
||||
conn-max-lifetime: 0
|
||||
log-mode: ""
|
||||
log-zap: false
|
||||
oracle:
|
||||
@@ -134,6 +136,7 @@ oracle:
|
||||
password: ""
|
||||
max-idle-conns: 10
|
||||
max-open-conns: 100
|
||||
conn-max-lifetime: 0
|
||||
log-mode: ""
|
||||
log-zap: false
|
||||
mssql:
|
||||
@@ -145,6 +148,7 @@ mssql:
|
||||
password: ""
|
||||
max-idle-conns: 10
|
||||
max-open-conns: 100
|
||||
conn-max-lifetime: 0
|
||||
log-mode: ""
|
||||
log-zap: false
|
||||
sqlite:
|
||||
@@ -156,6 +160,7 @@ sqlite:
|
||||
password: ""
|
||||
max-idle-conns: 10
|
||||
max-open-conns: 100
|
||||
conn-max-lifetime: 0
|
||||
log-mode: ""
|
||||
log-zap: false
|
||||
db-list:
|
||||
@@ -170,6 +175,7 @@ db-list:
|
||||
password: ""
|
||||
max-idle-conns: 10
|
||||
max-open-conns: 100
|
||||
conn-max-lifetime: 0
|
||||
log-mode: ""
|
||||
log-zap: false
|
||||
|
||||
|
||||
+14
-13
@@ -15,19 +15,20 @@ type DsnProvider interface {
|
||||
|
||||
// GeneralDB 也被 Pgsql 和 Mysql 原样使用
|
||||
type GeneralDB struct {
|
||||
Prefix string `mapstructure:"prefix" json:"prefix" yaml:"prefix"` // 数据库前缀
|
||||
Port string `mapstructure:"port" json:"port" yaml:"port"` // 数据库端口
|
||||
Config string `mapstructure:"config" json:"config" yaml:"config"` // 高级配置
|
||||
Dbname string `mapstructure:"db-name" json:"db-name" yaml:"db-name"` // 数据库名
|
||||
Username string `mapstructure:"username" json:"username" yaml:"username"` // 数据库账号
|
||||
Password string `mapstructure:"password" json:"password" yaml:"password"` // 数据库密码
|
||||
Path string `mapstructure:"path" json:"path" yaml:"path"` // 数据库地址
|
||||
Engine string `mapstructure:"engine" json:"engine" yaml:"engine" default:"InnoDB"` // 数据库引擎，默认InnoDB
|
||||
LogMode string `mapstructure:"log-mode" json:"log-mode" yaml:"log-mode"` // 是否开启Gorm全局日志
|
||||
MaxIdleConns int `mapstructure:"max-idle-conns" json:"max-idle-conns" yaml:"max-idle-conns"` // 空闲中的最大连接数
|
||||
MaxOpenConns int `mapstructure:"max-open-conns" json:"max-open-conns" yaml:"max-open-conns"` // 打开到数据库的最大连接数
|
||||
Singular bool `mapstructure:"singular" json:"singular" yaml:"singular"` // 是否开启全局禁用复数，true表示开启
|
||||
LogZap bool `mapstructure:"log-zap" json:"log-zap" yaml:"log-zap"` // 是否通过zap写入日志文件
|
||||
Prefix string `mapstructure:"prefix" json:"prefix" yaml:"prefix"` // 数据库前缀
|
||||
Port string `mapstructure:"port" json:"port" yaml:"port"` // 数据库端口
|
||||
Config string `mapstructure:"config" json:"config" yaml:"config"` // 高级配置
|
||||
Dbname string `mapstructure:"db-name" json:"db-name" yaml:"db-name"` // 数据库名
|
||||
Username string `mapstructure:"username" json:"username" yaml:"username"` // 数据库账号
|
||||
Password string `mapstructure:"password" json:"password" yaml:"password"` // 数据库密码
|
||||
Path string `mapstructure:"path" json:"path" yaml:"path"` // 数据库地址
|
||||
Engine string `mapstructure:"engine" json:"engine" yaml:"engine" default:"InnoDB"` // 数据库引擎，默认InnoDB
|
||||
LogMode string `mapstructure:"log-mode" json:"log-mode" yaml:"log-mode"` // 是否开启Gorm全局日志
|
||||
MaxIdleConns int `mapstructure:"max-idle-conns" json:"max-idle-conns" yaml:"max-idle-conns"` // 空闲中的最大连接数
|
||||
MaxOpenConns int `mapstructure:"max-open-conns" json:"max-open-conns" yaml:"max-open-conns"` // 打开到数据库的最大连接数
|
||||
ConnMaxLifetime int `mapstructure:"conn-max-lifetime" json:"conn-max-lifetime" yaml:"conn-max-lifetime"` // 连接最长复用时间,单位秒
|
||||
Singular bool `mapstructure:"singular" json:"singular" yaml:"singular"` // 是否开启全局禁用复数，true表示开启
|
||||
LogZap bool `mapstructure:"log-zap" json:"log-zap" yaml:"log-zap"` // 是否通过zap写入日志文件
|
||||
}
|
||||
|
||||
func (c GeneralDB) LogLevel() logger.LogLevel {
|
||||
|
||||
@@ -4,7 +4,7 @@ package global
|
||||
// 目前只有Version正式使用 其余为预留
|
||||
const (
|
||||
// Version 当前版本号
|
||||
Version = "v2.9.1"
|
||||
Version = "v2.9.2"
|
||||
// AppName 应用名称
|
||||
AppName = "Gin-Vue-Admin"
|
||||
// Description 应用描述
|
||||
|
||||
+27
-26
@@ -11,14 +11,14 @@ require (
|
||||
github.com/aws/aws-sdk-go-v2/credentials v1.19.10
|
||||
github.com/aws/aws-sdk-go-v2/feature/s3/manager v1.22.3
|
||||
github.com/aws/aws-sdk-go-v2/service/s3 v1.96.1
|
||||
github.com/casbin/casbin/v2 v2.103.0
|
||||
github.com/casbin/gorm-adapter/v3 v3.32.0
|
||||
github.com/casbin/casbin/v3 v3.10.0
|
||||
github.com/casbin/gorm-adapter/v3 v3.41.0
|
||||
github.com/dzwvip/gorm-oracle v0.1.2
|
||||
github.com/fsnotify/fsnotify v1.8.0
|
||||
github.com/gin-contrib/sse v1.0.0
|
||||
github.com/gin-gonic/gin v1.10.0
|
||||
github.com/glebarez/sqlite v1.11.0
|
||||
github.com/go-sql-driver/mysql v1.8.1
|
||||
github.com/go-sql-driver/mysql v1.9.3
|
||||
github.com/goccy/go-json v0.10.4
|
||||
github.com/golang-jwt/jwt/v5 v5.2.2
|
||||
github.com/google/uuid v1.6.0
|
||||
@@ -38,7 +38,7 @@ require (
|
||||
github.com/shirou/gopsutil/v3 v3.24.5
|
||||
github.com/songzhibin97/gkit v1.2.13
|
||||
github.com/spf13/viper v1.19.0
|
||||
github.com/stretchr/testify v1.10.0
|
||||
github.com/stretchr/testify v1.11.1
|
||||
github.com/swaggo/files v1.0.1
|
||||
github.com/swaggo/gin-swagger v1.6.0
|
||||
github.com/swaggo/swag v1.16.4
|
||||
@@ -48,16 +48,17 @@ require (
|
||||
go.mongodb.org/mongo-driver v1.17.2
|
||||
go.uber.org/automaxprocs v1.6.0
|
||||
go.uber.org/zap v1.27.0
|
||||
golang.org/x/crypto v0.37.0
|
||||
golang.org/x/sync v0.13.0
|
||||
golang.org/x/text v0.24.0
|
||||
golang.org/x/crypto v0.46.0
|
||||
golang.org/x/sync v0.19.0
|
||||
golang.org/x/sys v0.39.0
|
||||
golang.org/x/text v0.32.0
|
||||
gopkg.in/yaml.v3 v3.0.1
|
||||
gorm.io/datatypes v1.2.5
|
||||
gorm.io/driver/mysql v1.5.7
|
||||
gorm.io/driver/postgres v1.5.11
|
||||
gorm.io/driver/sqlserver v1.5.4
|
||||
gorm.io/driver/mysql v1.6.0
|
||||
gorm.io/driver/postgres v1.6.0
|
||||
gorm.io/driver/sqlserver v1.6.3
|
||||
gorm.io/gen v0.3.26
|
||||
gorm.io/gorm v1.25.12
|
||||
gorm.io/gorm v1.31.1
|
||||
)
|
||||
|
||||
require (
|
||||
@@ -83,14 +84,14 @@ require (
|
||||
github.com/aws/aws-sdk-go-v2/service/sts v1.41.7 // indirect
|
||||
github.com/aws/smithy-go v1.24.1 // indirect
|
||||
github.com/bahlo/generic-list-go v0.2.0 // indirect
|
||||
github.com/bmatcuk/doublestar/v4 v4.8.0 // indirect
|
||||
github.com/bmatcuk/doublestar/v4 v4.9.1 // indirect
|
||||
github.com/bodgit/plumbing v1.3.0 // indirect
|
||||
github.com/bodgit/sevenzip v1.6.0 // indirect
|
||||
github.com/bodgit/windows v1.0.1 // indirect
|
||||
github.com/buger/jsonparser v1.1.1 // indirect
|
||||
github.com/bytedance/sonic v1.12.7 // indirect
|
||||
github.com/bytedance/sonic/loader v0.2.3 // indirect
|
||||
github.com/casbin/govaluate v1.3.0 // indirect
|
||||
github.com/casbin/govaluate v1.10.0 // indirect
|
||||
github.com/cespare/xxhash/v2 v2.3.0 // indirect
|
||||
github.com/clbanning/mxj v1.8.4 // indirect
|
||||
github.com/cloudwego/base64x v0.1.5 // indirect
|
||||
@@ -124,7 +125,7 @@ require (
|
||||
github.com/invopop/jsonschema v0.13.0 // indirect
|
||||
github.com/jackc/pgpassfile v1.0.0 // indirect
|
||||
github.com/jackc/pgservicefile v0.0.0-20240606120523-5a60cdf6a761 // indirect
|
||||
github.com/jackc/pgx/v5 v5.7.2 // indirect
|
||||
github.com/jackc/pgx/v5 v5.8.0 // indirect
|
||||
github.com/jackc/puddle/v2 v2.2.2 // indirect
|
||||
github.com/jinzhu/inflection v1.0.0 // indirect
|
||||
github.com/jinzhu/now v1.1.5 // indirect
|
||||
@@ -138,7 +139,7 @@ require (
|
||||
github.com/magiconair/properties v1.8.9 // indirect
|
||||
github.com/mailru/easyjson v0.9.0 // indirect
|
||||
github.com/mattn/go-isatty v0.0.20 // indirect
|
||||
github.com/microsoft/go-mssqldb v1.8.0 // indirect
|
||||
github.com/microsoft/go-mssqldb v1.9.5 // indirect
|
||||
github.com/minio/md5-simd v1.1.2 // indirect
|
||||
github.com/minio/minlz v1.0.0 // indirect
|
||||
github.com/mitchellh/mapstructure v1.5.0 // indirect
|
||||
@@ -147,7 +148,7 @@ require (
|
||||
github.com/mohae/deepcopy v0.0.0-20170929034955-c48cc78d4826 // indirect
|
||||
github.com/montanaflynn/stats v0.7.1 // indirect
|
||||
github.com/mozillazg/go-httpheader v0.4.0 // indirect
|
||||
github.com/ncruces/go-strftime v0.1.9 // indirect
|
||||
github.com/ncruces/go-strftime v1.0.0 // indirect
|
||||
github.com/nwaples/rardecode/v2 v2.1.0 // indirect
|
||||
github.com/otiai10/mint v1.6.3 // indirect
|
||||
github.com/pelletier/go-toml/v2 v2.2.3 // indirect
|
||||
@@ -161,6 +162,7 @@ require (
|
||||
github.com/sagikazarmark/locafero v0.7.0 // indirect
|
||||
github.com/sagikazarmark/slog-shim v0.1.0 // indirect
|
||||
github.com/shoenig/go-m1cpu v0.1.6 // indirect
|
||||
github.com/shopspring/decimal v1.4.0 // indirect
|
||||
github.com/sijms/go-ora/v2 v2.7.17 // indirect
|
||||
github.com/sorairolake/lzip-go v0.3.5 // indirect
|
||||
github.com/sourcegraph/conc v0.3.0 // indirect
|
||||
@@ -188,20 +190,19 @@ require (
|
||||
go.uber.org/multierr v1.11.0 // indirect
|
||||
go4.org v0.0.0-20230225012048-214862532bf5 // indirect
|
||||
golang.org/x/arch v0.13.0 // indirect
|
||||
golang.org/x/exp v0.0.0-20250106191152-7588d65b2ba8 // indirect
|
||||
golang.org/x/exp v0.0.0-20251219203646-944ab1f22d93 // indirect
|
||||
golang.org/x/image v0.23.0 // indirect
|
||||
golang.org/x/mod v0.22.0 // indirect
|
||||
golang.org/x/net v0.35.0 // indirect
|
||||
golang.org/x/sys v0.32.0 // indirect
|
||||
golang.org/x/mod v0.31.0 // indirect
|
||||
golang.org/x/net v0.48.0 // indirect
|
||||
golang.org/x/time v0.9.0 // indirect
|
||||
golang.org/x/tools v0.29.0 // indirect
|
||||
golang.org/x/tools v0.40.0 // indirect
|
||||
google.golang.org/protobuf v1.36.6 // indirect
|
||||
gopkg.in/ini.v1 v1.67.0 // indirect
|
||||
gorm.io/hints v1.1.2 // indirect
|
||||
gorm.io/plugin/dbresolver v1.5.3 // indirect
|
||||
modernc.org/fileutil v1.3.0 // indirect
|
||||
modernc.org/libc v1.61.9 // indirect
|
||||
gorm.io/plugin/dbresolver v1.6.2 // indirect
|
||||
modernc.org/fileutil v1.3.40 // indirect
|
||||
modernc.org/libc v1.67.4 // indirect
|
||||
modernc.org/mathutil v1.7.1 // indirect
|
||||
modernc.org/memory v1.8.2 // indirect
|
||||
modernc.org/sqlite v1.34.5 // indirect
|
||||
modernc.org/memory v1.11.0 // indirect
|
||||
modernc.org/sqlite v1.42.2 // indirect
|
||||
)
|
||||
|
||||
+100
-87
@@ -19,25 +19,28 @@ filippo.io/edwards25519 v1.1.0 h1:FNf4tywRC1HmFuKW5xopWpigGjJKiJSV0Cqo0cJWDaA=
|
||||
filippo.io/edwards25519 v1.1.0/go.mod h1:BxyFTGdWcka3PhytdK4V28tE5sGfRvvvRV7EaN4VDT4=
|
||||
github.com/Azure/azure-sdk-for-go/sdk/azcore v1.7.0/go.mod h1:bjGvMhVMb+EEm3VRNQawDMUyMMjo+S5ewNjflkep/0Q=
|
||||
github.com/Azure/azure-sdk-for-go/sdk/azcore v1.7.1/go.mod h1:bjGvMhVMb+EEm3VRNQawDMUyMMjo+S5ewNjflkep/0Q=
|
||||
github.com/Azure/azure-sdk-for-go/sdk/azcore v1.9.1/go.mod h1:RKUqNu35KJYcVG/fqTRqmuXJZYNhYkBrnC/hX7yGbTA=
|
||||
github.com/Azure/azure-sdk-for-go/sdk/azcore v1.11.1 h1:E+OJmp2tPvt1W+amx48v1eqbjDYsgN+RzP4q16yV5eM=
|
||||
github.com/Azure/azure-sdk-for-go/sdk/azcore v1.11.1/go.mod h1:a6xsAQUZg+VsS3TJ05SRp524Hs4pZ/AeFSr5ENf0Yjo=
|
||||
github.com/Azure/azure-sdk-for-go/sdk/azcore v1.18.0 h1:Gt0j3wceWMwPmiazCa8MzMA0MfhmPIz0Qp0FJ6qcM0U=
|
||||
github.com/Azure/azure-sdk-for-go/sdk/azcore v1.18.0/go.mod h1:Ot/6aikWnKWi4l9QB7qVSwa8iMphQNqkWALMoNT3rzM=
|
||||
github.com/Azure/azure-sdk-for-go/sdk/azidentity v1.3.1/go.mod h1:uE9zaUfEQT/nbQjVi2IblCG9iaLtZsuYZ8ne+PuQ02M=
|
||||
github.com/Azure/azure-sdk-for-go/sdk/azidentity v1.5.1/go.mod h1:h8hyGFDsU5HMivxiS2iYFZsgDbU9OnnJ163x5UGVKYo=
|
||||
github.com/Azure/azure-sdk-for-go/sdk/azidentity v1.6.0 h1:U2rTu3Ef+7w9FHKIAXM6ZyqF3UOWJZ12zIm8zECAFfg=
|
||||
github.com/Azure/azure-sdk-for-go/sdk/azidentity v1.6.0/go.mod h1:9kIvujWAA58nmPmWB1m23fyWic1kYZMxD9CxaWn4Qpg=
|
||||
github.com/Azure/azure-sdk-for-go/sdk/azidentity v1.10.1 h1:B+blDbyVIG3WaikNxPnhPiJ1MThR03b3vKGtER95TP4=
|
||||
github.com/Azure/azure-sdk-for-go/sdk/azidentity v1.10.1/go.mod h1:JdM5psgjfBf5fo2uWOZhflPWyDBZ/O/CNAH9CtsuZE4=
|
||||
github.com/Azure/azure-sdk-for-go/sdk/internal v1.3.0/go.mod h1:okt5dMMTOFjX/aovMlrjvvXoPMBVSPzk9185BT0+eZM=
|
||||
github.com/Azure/azure-sdk-for-go/sdk/internal v1.5.1/go.mod h1:s4kgfzA0covAXNicZHDMN58jExvcng2mC/DepXiF1EI=
|
||||
github.com/Azure/azure-sdk-for-go/sdk/internal v1.8.0 h1:jBQA3cKT4L2rWMpgE7Yt3Hwh2aUj8KXjIGLxjHeYNNo=
|
||||
github.com/Azure/azure-sdk-for-go/sdk/internal v1.5.2/go.mod h1:yInRyqWXAuaPrgI7p70+lDDgh3mlBohis29jGMISnmc=
|
||||
github.com/Azure/azure-sdk-for-go/sdk/internal v1.8.0/go.mod h1:4OG6tQ9EOP/MT0NMjDlRzWoVFxfu9rN9B2X+tlSVktg=
|
||||
github.com/Azure/azure-sdk-for-go/sdk/security/keyvault/azkeys v1.0.1 h1:MyVTgWR8qd/Jw1Le0NZebGBUCLbtak3bJ3z1OlqZBpw=
|
||||
github.com/Azure/azure-sdk-for-go/sdk/internal v1.11.1 h1:FPKJS1T+clwv+OLGt13a8UjqeRuh0O4SJ3lUriThc+4=
|
||||
github.com/Azure/azure-sdk-for-go/sdk/internal v1.11.1/go.mod h1:j2chePtV91HrC22tGoRX3sGY42uF13WzmmV80/OdVAA=
|
||||
github.com/Azure/azure-sdk-for-go/sdk/security/keyvault/azkeys v1.0.1/go.mod h1:GpPjLhVR9dnUoJMyHWSPy71xY9/lcmpzIPZXmF0FCVY=
|
||||
github.com/Azure/azure-sdk-for-go/sdk/security/keyvault/internal v1.0.0 h1:D3occbWoio4EBLkbkevetNMAVX197GkzbUMtqjGWn80=
|
||||
github.com/Azure/azure-sdk-for-go/sdk/security/keyvault/azkeys v1.3.1 h1:Wgf5rZba3YZqeTNJPtvqZoBu1sBN/L4sry+u2U3Y75w=
|
||||
github.com/Azure/azure-sdk-for-go/sdk/security/keyvault/azkeys v1.3.1/go.mod h1:xxCBG/f/4Vbmh2XQJBsOmNdxWUY5j/s27jujKPbQf14=
|
||||
github.com/Azure/azure-sdk-for-go/sdk/security/keyvault/internal v1.0.0/go.mod h1:bTSOgj05NGRuHHhQwAdPnYr9TOdNmKlZTgGLL6nyAdI=
|
||||
github.com/Azure/azure-sdk-for-go/sdk/security/keyvault/internal v1.1.1 h1:bFWuoEKg+gImo7pvkiQEFAc8ocibADgXeiLAxWhWmkI=
|
||||
github.com/Azure/azure-sdk-for-go/sdk/security/keyvault/internal v1.1.1/go.mod h1:Vih/3yc6yac2JzU4hzpaDupBJP0Flaia9rXXrU8xyww=
|
||||
github.com/AzureAD/microsoft-authentication-library-for-go v1.1.1/go.mod h1:wP83P5OoQ5p6ip3ScPr0BAq0BvuPAvacpEuSzyouqAI=
|
||||
github.com/AzureAD/microsoft-authentication-library-for-go v1.2.1/go.mod h1:wP83P5OoQ5p6ip3ScPr0BAq0BvuPAvacpEuSzyouqAI=
|
||||
github.com/AzureAD/microsoft-authentication-library-for-go v1.2.2 h1:XHOnouVk1mxXfQidrMEnLlPk9UMeRtyBTnEFtxkV0kU=
|
||||
github.com/AzureAD/microsoft-authentication-library-for-go v1.2.2/go.mod h1:wP83P5OoQ5p6ip3ScPr0BAq0BvuPAvacpEuSzyouqAI=
|
||||
github.com/AzureAD/microsoft-authentication-library-for-go v1.4.2 h1:oygO0locgZJe7PpYPXT5A29ZkwJaPqcva7BVeemZOZs=
|
||||
github.com/AzureAD/microsoft-authentication-library-for-go v1.4.2/go.mod h1:wP83P5OoQ5p6ip3ScPr0BAq0BvuPAvacpEuSzyouqAI=
|
||||
github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
|
||||
github.com/BurntSushi/toml v1.3.2/go.mod h1:CxXYINrC8qIiEnFrOxCa7Jy5BFHlXnUU2pbicEuybxQ=
|
||||
github.com/BurntSushi/toml v1.4.0 h1:kuoIxZQy2WRRk1pttg9asf+WVv6tWQuBNVmK8+nqPr0=
|
||||
@@ -97,8 +100,8 @@ github.com/aws/smithy-go v1.24.1/go.mod h1:LEj2LM3rBRQJxPZTB4KuzZkaZYnZPnvgIhb4p
|
||||
github.com/bahlo/generic-list-go v0.2.0 h1:5sz/EEAK+ls5wF+NeqDpk5+iNdMDXrh3z3nPnH1Wvgk=
|
||||
github.com/bahlo/generic-list-go v0.2.0/go.mod h1:2KvAjgMlE5NNynlg/5iLrrCCZ2+5xWbdbCW3pNTGyYg=
|
||||
github.com/bmatcuk/doublestar/v4 v4.6.1/go.mod h1:xBQ8jztBU6kakFMg+8WGxn0c6z1fTSPVIjEY1Wr7jzc=
|
||||
github.com/bmatcuk/doublestar/v4 v4.8.0 h1:DSXtrypQddoug1459viM9X9D3dp1Z7993fw36I2kNcQ=
|
||||
github.com/bmatcuk/doublestar/v4 v4.8.0/go.mod h1:xBQ8jztBU6kakFMg+8WGxn0c6z1fTSPVIjEY1Wr7jzc=
|
||||
github.com/bmatcuk/doublestar/v4 v4.9.1 h1:X8jg9rRZmJd4yRy7ZeNDRnM+T3ZfHv15JiBJ/avrEXE=
|
||||
github.com/bmatcuk/doublestar/v4 v4.9.1/go.mod h1:xBQ8jztBU6kakFMg+8WGxn0c6z1fTSPVIjEY1Wr7jzc=
|
||||
github.com/bodgit/plumbing v1.3.0 h1:pf9Itz1JOQgn7vEOE7v7nlEfBykYqvUYioC61TwWCFU=
|
||||
github.com/bodgit/plumbing v1.3.0/go.mod h1:JOTb4XiRu5xfnmdnDJo6GmSbSbtSyufrsyZFByMtKEs=
|
||||
github.com/bodgit/sevenzip v1.6.0 h1:a4R0Wu6/P1o1pP/3VV++aEOcyeBxeO/xE2Y9NSTrr6A=
|
||||
@@ -116,12 +119,13 @@ github.com/bytedance/sonic v1.12.7/go.mod h1:tnbal4mxOMju17EGfknm2XyYcpyCnIROYOE
|
||||
github.com/bytedance/sonic/loader v0.1.1/go.mod h1:ncP89zfokxS5LZrJxl5z0UJcsk4M4yY2JpfqGeCtNLU=
|
||||
github.com/bytedance/sonic/loader v0.2.3 h1:yctD0Q3v2NOGfSWPLPvG2ggA2kV6TS6s4wioyEqssH0=
|
||||
github.com/bytedance/sonic/loader v0.2.3/go.mod h1:N8A3vUdtUebEY2/VQC0MyhYeKUFosQU6FxH2JmUe6VI=
|
||||
github.com/casbin/casbin/v2 v2.103.0 h1:dHElatNXNrr8XcseUov0ZSiWjauwmZZE6YMV3eU1yic=
|
||||
github.com/casbin/casbin/v2 v2.103.0/go.mod h1:Ee33aqGrmES+GNL17L0h9X28wXuo829wnNUnS0edAco=
|
||||
github.com/casbin/gorm-adapter/v3 v3.32.0 h1:Au+IOILBIE9clox5BJhI2nA3p9t7Ep1ePlupdGbGfus=
|
||||
github.com/casbin/gorm-adapter/v3 v3.32.0/go.mod h1:Zre/H8p17mpv5U3EaWgPoxLILLdXO3gHW5aoQQpUDZI=
|
||||
github.com/casbin/govaluate v1.3.0 h1:VA0eSY0M2lA86dYd5kPPuNZMUD9QkWnOCnavGrw9myc=
|
||||
github.com/casbin/casbin/v3 v3.10.0 h1:039ORla55vCeIZWd0LfzWFt1yiEA5X4W41xBW2bQuHs=
|
||||
github.com/casbin/casbin/v3 v3.10.0/go.mod h1:5rJbQr2e6AuuDDNxnPc5lQlC9nIgg6nS1zYwKXhpHC8=
|
||||
github.com/casbin/gorm-adapter/v3 v3.41.0 h1:Xhpi0tfRP9aKPDWDf6dgBxHZ9UM6IophxxPIEGWqCNM=
|
||||
github.com/casbin/gorm-adapter/v3 v3.41.0/go.mod h1:BQZRJhwUnwMpI+pT2m7/cUJwXxrHfzpBpPcNTyMGeGA=
|
||||
github.com/casbin/govaluate v1.3.0/go.mod h1:G/UnbIjZk/0uMNaLwZZmFQrR72tYRZWQkO70si/iR7A=
|
||||
github.com/casbin/govaluate v1.10.0 h1:ffGw51/hYH3w3rZcxO/KcaUIDOLP84w7nsidMVgaDG0=
|
||||
github.com/casbin/govaluate v1.10.0/go.mod h1:G/UnbIjZk/0uMNaLwZZmFQrR72tYRZWQkO70si/iR7A=
|
||||
github.com/census-instrumentation/opencensus-proto v0.2.1/go.mod h1:f6KPmirojxKA12rnyqOA5BBL4O983OfeGPqjHWSTneU=
|
||||
github.com/cespare/xxhash/v2 v2.3.0 h1:UL815xU9SqsFlibzuggzjXhog7bL6oX9BbNZnL2UFvs=
|
||||
github.com/cespare/xxhash/v2 v2.3.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
|
||||
@@ -203,16 +207,14 @@ github.com/go-playground/validator/v10 v10.4.1/go.mod h1:nlOn6nFhuKACm19sB/8EGNn
|
||||
github.com/go-playground/validator/v10 v10.7.0/go.mod h1:xm76BBt941f7yWdGnI2DVPFFg1UK3YY04qifoXU3lOk=
|
||||
github.com/go-playground/validator/v10 v10.24.0 h1:KHQckvo8G6hlWnrPX4NJJ+aBfWNAE/HH+qdL2cBpCmg=
|
||||
github.com/go-playground/validator/v10 v10.24.0/go.mod h1:GGzBIJMuE98Ic/kJsBXbz1x/7cByt++cQ+YOuDM5wus=
|
||||
github.com/go-sql-driver/mysql v1.7.0/go.mod h1:OXbVy3sEdcQ2Doequ6Z5BW6fXNQTmx+9S1MCJN5yJMI=
|
||||
github.com/go-sql-driver/mysql v1.8.1 h1:LedoTUt/eveggdHS9qUFC1EFSa8bU2+1pZjSRpvNJ1Y=
|
||||
github.com/go-sql-driver/mysql v1.8.1/go.mod h1:wEBSXgmK//2ZFJyE+qWnIsVGmvmEKlqwuVSjsCm7DZg=
|
||||
github.com/go-sql-driver/mysql v1.9.3 h1:U/N249h2WzJ3Ukj8SowVFjdtZKfu9vlLZxjPXV1aweo=
|
||||
github.com/go-sql-driver/mysql v1.9.3/go.mod h1:qn46aNg1333BRMNU69Lq93t8du/dwxI64Gl8i5p1WMU=
|
||||
github.com/goccy/go-json v0.10.4 h1:JSwxQzIqKfmFX1swYPpUThQZp/Ka4wzJdK0LWVytLPM=
|
||||
github.com/goccy/go-json v0.10.4/go.mod h1:oq7eo15ShAhp70Anwd5lgX2pLfOS3QCiwU/PULtXL6M=
|
||||
github.com/gofrs/flock v0.8.1/go.mod h1:F1TvTiK9OcQqauNUHlbJvyl9Qa1QvF/gOUDKA14jxHU=
|
||||
github.com/gofrs/flock v0.12.1 h1:MTLVXXHf8ekldpJk3AKicLij9MdwOWkZ+a/jHHZby9E=
|
||||
github.com/gofrs/flock v0.12.1/go.mod h1:9zxTsyu5xtJ9DK+1tFZyibEV7y3uwDxPPfbxeeHCoD0=
|
||||
github.com/golang-jwt/jwt/v5 v5.0.0/go.mod h1:pqrtFR0X4osieyHYxtmOUWsAWrfe1Q5UVIyoH402zdk=
|
||||
github.com/golang-jwt/jwt/v5 v5.2.0/go.mod h1:pqrtFR0X4osieyHYxtmOUWsAWrfe1Q5UVIyoH402zdk=
|
||||
github.com/golang-jwt/jwt/v5 v5.2.1/go.mod h1:pqrtFR0X4osieyHYxtmOUWsAWrfe1Q5UVIyoH402zdk=
|
||||
github.com/golang-jwt/jwt/v5 v5.2.2 h1:Rl4B7itRWVtYIHFrSNd7vhTiz9UpLdi6gZhZ3wEeDy8=
|
||||
github.com/golang-jwt/jwt/v5 v5.2.2/go.mod h1:pqrtFR0X4osieyHYxtmOUWsAWrfe1Q5UVIyoH402zdk=
|
||||
@@ -230,8 +232,6 @@ github.com/golang/mock v1.1.1/go.mod h1:oTYuIxOrZwtPieC+H1uAHpcLFnEyAGVDL/k47Jfb
|
||||
github.com/golang/mock v1.2.0/go.mod h1:oTYuIxOrZwtPieC+H1uAHpcLFnEyAGVDL/k47Jfbm0A=
|
||||
github.com/golang/mock v1.3.1/go.mod h1:sBzyDLLjw3U8JLTeZvSv8jJB+tU5PVekmnlKIyFUx0Y=
|
||||
github.com/golang/mock v1.4.0/go.mod h1:UOMv5ysSaYNkG+OFQykRIcU/QvvxJf3p21QfJ2Bt3cw=
|
||||
github.com/golang/mock v1.4.4 h1:l75CXGRSwbaYNpl/Z2X1XIIAMSCquvXgpVZDhwEIJsc=
|
||||
github.com/golang/mock v1.4.4/go.mod h1:l3mdAwkq5BuhzHwde/uurv3sEJeZMXNpwsxVWU71h+4=
|
||||
github.com/golang/protobuf v1.2.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=
|
||||
github.com/golang/protobuf v1.3.1/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=
|
||||
github.com/golang/protobuf v1.3.2/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=
|
||||
@@ -256,12 +256,11 @@ github.com/google/martian v2.1.0+incompatible/go.mod h1:9I4somxYTbIHy5NJKHRl3wXi
|
||||
github.com/google/pprof v0.0.0-20181206194817-3ea8567a2e57/go.mod h1:zfwlbNMJ+OItoe0UupaVj+oy1omPYYDuagoSzA8v9mc=
|
||||
github.com/google/pprof v0.0.0-20190515194954-54271f7e092f/go.mod h1:zfwlbNMJ+OItoe0UupaVj+oy1omPYYDuagoSzA8v9mc=
|
||||
github.com/google/pprof v0.0.0-20200212024743-f11f1df84d12/go.mod h1:ZgVRPoUq/hfqzAqh7sHMqb3I9Rq5C59dIz2SbBwJ4eM=
|
||||
github.com/google/pprof v0.0.0-20240409012703-83162a5b38cd h1:gbpYu9NMq8jhDVbvlGkMFWCjLFlqqEZjEmObmhUy6Vo=
|
||||
github.com/google/pprof v0.0.0-20240409012703-83162a5b38cd/go.mod h1:kf6iHlnVGwgKolg33glAes7Yg/8iWP8ukqeldJSO7jw=
|
||||
github.com/google/pprof v0.0.0-20250317173921-a4b03ec1a45e h1:ijClszYn+mADRFY17kjQEVQ1XRhq2/JR1M3sGqeJoxs=
|
||||
github.com/google/pprof v0.0.0-20250317173921-a4b03ec1a45e/go.mod h1:boTsfXsheKC2y+lKOCMpSfarhxDeIzfZG1jqGcPl3cA=
|
||||
github.com/google/renameio v0.1.0/go.mod h1:KWCgfxg9yswjAJkECMjeO8J8rahYeXnNhOm40UhjYkI=
|
||||
github.com/google/uuid v1.1.1/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
|
||||
github.com/google/uuid v1.3.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
|
||||
github.com/google/uuid v1.5.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
|
||||
github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
|
||||
github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
|
||||
github.com/googleapis/gax-go/v2 v2.0.4/go.mod h1:0Wqv26UfaUD9n4G6kQubkQ+KchISgw+vpHVxEJEs9eg=
|
||||
@@ -295,8 +294,8 @@ github.com/jackc/pgpassfile v1.0.0 h1:/6Hmqy13Ss2zCq62VdNG8tM1wchn8zjSGOBJ6icpsI
|
||||
github.com/jackc/pgpassfile v1.0.0/go.mod h1:CEx0iS5ambNFdcRtxPj5JhEz+xB6uRky5eyVu/W2HEg=
|
||||
github.com/jackc/pgservicefile v0.0.0-20240606120523-5a60cdf6a761 h1:iCEnooe7UlwOQYpKFhBabPMi4aNAfoODPEFNiAnClxo=
|
||||
github.com/jackc/pgservicefile v0.0.0-20240606120523-5a60cdf6a761/go.mod h1:5TJZWKEWniPve33vlWYSoGYefn3gLQRzjfDlhSJ9ZKM=
|
||||
github.com/jackc/pgx/v5 v5.7.2 h1:mLoDLV6sonKlvjIEsV56SkWNCnuNv531l94GaIzO+XI=
|
||||
github.com/jackc/pgx/v5 v5.7.2/go.mod h1:ncY89UGWxg82EykZUwSpUKEfccBGGYq1xjrOpsbsfGQ=
|
||||
github.com/jackc/pgx/v5 v5.8.0 h1:TYPDoleBBme0xGSAX3/+NujXXtpZn9HBONkQC7IEZSo=
|
||||
github.com/jackc/pgx/v5 v5.8.0/go.mod h1:QVeDInX2m9VyzvNeiCJVjCkNFqzsNb43204HshNSZKw=
|
||||
github.com/jackc/puddle/v2 v2.2.2 h1:PR8nw+E/1w0GLuRFSmiioY6UooMp6KJv0/61nB7icHo=
|
||||
github.com/jackc/puddle/v2 v2.2.2/go.mod h1:vriiEXHvEE654aYKXXjOvZM39qJ0q+azkZFrfEOc3H4=
|
||||
github.com/jcmturner/aescts/v2 v2.0.0/go.mod h1:AiaICIRyfYg35RUkr8yESTqvSy7csK90qZ5xfvvsoNs=
|
||||
@@ -360,13 +359,14 @@ github.com/mark3labs/mcp-go v0.41.1/go.mod h1:T7tUa2jO6MavG+3P25Oy/jR7iCeJPHImCZ
|
||||
github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
|
||||
github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
|
||||
github.com/mattn/go-sqlite3 v1.14.15/go.mod h1:2eHXhiwb8IkHr+BDWZGa96P6+rkvnG63S2DGjv9HUNg=
|
||||
github.com/mattn/go-sqlite3 v1.14.16 h1:yOQRA0RpS5PFz/oikGwBEqvAWhWg5ufRz4ETLjwpU1Y=
|
||||
github.com/mattn/go-sqlite3 v1.14.16/go.mod h1:2eHXhiwb8IkHr+BDWZGa96P6+rkvnG63S2DGjv9HUNg=
|
||||
github.com/mattn/go-sqlite3 v1.14.22 h1:2gZY6PC6kBnID23Tichd1K+Z0oS6nE/XwU+Vz/5o4kU=
|
||||
github.com/mattn/go-sqlite3 v1.14.22/go.mod h1:Uh1q+B4BYcTPb+yiD3kU8Ct7aC0hY9fxUwlHK0RXw+Y=
|
||||
github.com/mholt/archives v0.1.1 h1:c7J3qXN1FB54y0qiUXiq9Bxk4eCUc8pdXWwOhZdRzeY=
|
||||
github.com/mholt/archives v0.1.1/go.mod h1:FQVz01Q2uXKB/35CXeW/QFO23xT+hSCGZHVtha78U4I=
|
||||
github.com/microsoft/go-mssqldb v1.7.2/go.mod h1:kOvZKUdrhhFQmxLZqbwUV0rHkNkZpthMITIb2Ko1IoA=
|
||||
github.com/microsoft/go-mssqldb v1.8.0 h1:7cyZ/AT7ycDsEoWPIXibd+aVKFtteUNhDGf3aobP+tw=
|
||||
github.com/microsoft/go-mssqldb v1.8.0/go.mod h1:6znkekS3T2vp0waiMhen4GPU1BiAsrP+iXHcE7a7rFo=
|
||||
github.com/microsoft/go-mssqldb v1.8.2/go.mod h1:vp38dT33FGfVotRiTmDo3bFyaHq+p3LektQrjTULowo=
|
||||
github.com/microsoft/go-mssqldb v1.9.5 h1:orwya0X/5bsL1o+KasupTkk2eNTNFkTQG0BEe/HxCn0=
|
||||
github.com/microsoft/go-mssqldb v1.9.5/go.mod h1:VCP2a0KEZZtGLRHd1PsLavLFYy/3xX2yJUPycv3Sr2Q=
|
||||
github.com/minio/md5-simd v1.1.2 h1:Gdi1DZK69+ZVMoNHRXJyNcxrMA4dSxoYHZSQbirFg34=
|
||||
github.com/minio/md5-simd v1.1.2/go.mod h1:MzdKDxYpY2BT9XQFocsiZf/NKVtR7nkE4RoEpN+20RM=
|
||||
github.com/minio/minio-go/v7 v7.0.84 h1:D1HVmAF8JF8Bpi6IU4V9vIEj+8pc+xU88EWMs2yed0E=
|
||||
@@ -392,8 +392,8 @@ github.com/montanaflynn/stats v0.7.1/go.mod h1:etXPPgVO6n31NxCd9KQUMvCM+ve0ruNzt
|
||||
github.com/mozillazg/go-httpheader v0.2.1/go.mod h1:jJ8xECTlalr6ValeXYdOF8fFUISeBAdw6E61aqQma60=
|
||||
github.com/mozillazg/go-httpheader v0.4.0 h1:aBn6aRXtFzyDLZ4VIRLsZbbJloagQfMnCiYgOq6hK4w=
|
||||
github.com/mozillazg/go-httpheader v0.4.0/go.mod h1:PuT8h0pw6efvp8ZeUec1Rs7dwjK08bt6gKSReGMqtdA=
|
||||
github.com/ncruces/go-strftime v0.1.9 h1:bY0MQC28UADQmHmaF5dgpLmImcShSi2kHU9XLdhx/f4=
|
||||
github.com/ncruces/go-strftime v0.1.9/go.mod h1:Fwc5htZGVVkseilnfgOVb9mKy6w1naJmn9CehxcKcls=
|
||||
github.com/ncruces/go-strftime v1.0.0 h1:HMFp8mLCTPp341M/ZnA4qaf7ZlsbTc+miZjCLOFAw7w=
|
||||
github.com/ncruces/go-strftime v1.0.0/go.mod h1:Fwc5htZGVVkseilnfgOVb9mKy6w1naJmn9CehxcKcls=
|
||||
github.com/nwaples/rardecode/v2 v2.1.0 h1:JQl9ZoBPDy+nIZGb1mx8+anfHp/LV3NE2MjMiv0ct/U=
|
||||
github.com/nwaples/rardecode/v2 v2.1.0/go.mod h1:7uz379lSxPe6j9nvzxUZ+n7mnJNgjsRNb6IbvGVHRmw=
|
||||
github.com/otiai10/copy v1.14.1 h1:5/7E6qsUMBaH5AnQ0sSLzzTg1oTECmcCmT6lvF45Na8=
|
||||
@@ -438,6 +438,7 @@ github.com/robfig/cron/v3 v3.0.1/go.mod h1:eQICP3HwyT7UooqI/z+Ov+PtYAWygg1TEWWzG
|
||||
github.com/rogpeppe/go-internal v1.3.0/go.mod h1:M8bDsm7K2OlrFYOpmOWEs/qY81heoFRclV5y23lUDJ4=
|
||||
github.com/rogpeppe/go-internal v1.6.1/go.mod h1:xXDCJY+GAPziupqXw64V24skbSoqbTEfhy4qGm1nDQc=
|
||||
github.com/rogpeppe/go-internal v1.8.0/go.mod h1:WmiCO8CzOY8rg0OYDC4/i/2WRWAB6poM+XZ2dLUbcbE=
|
||||
github.com/rogpeppe/go-internal v1.9.0/go.mod h1:WtVeX8xhTBvf0smdhujwtBcq4Qrzq/fJaraNFVN+nFs=
|
||||
github.com/rogpeppe/go-internal v1.12.0 h1:exVL4IDcn6na9z1rAb56Vxr+CgyK3nn3O+epU5NdKM8=
|
||||
github.com/rogpeppe/go-internal v1.12.0/go.mod h1:E+RYuTGaKKdloAfM02xzb0FW3Paa99yedzYV+kq4uf4=
|
||||
github.com/rs/xid v1.6.0 h1:fV591PaemRlL6JfRxGDEPl69wICngIQ3shQtzfy2gxU=
|
||||
@@ -453,6 +454,8 @@ github.com/shoenig/go-m1cpu v0.1.6 h1:nxdKQNcEB6vzgA2E2bvzKIYRuNj7XNJ4S/aRSwKzFt
|
||||
github.com/shoenig/go-m1cpu v0.1.6/go.mod h1:1JJMcUBvfNwpq05QDQVAnx3gUHr9IYF7GNg9SUEw2VQ=
|
||||
github.com/shoenig/test v0.6.4 h1:kVTaSd7WLz5WZ2IaoM0RSzRsUD+m8wRR+5qvntpn4LU=
|
||||
github.com/shoenig/test v0.6.4/go.mod h1:byHiCGXqrVaflBLAMq/srcZIHynQPQgeyvkvXnjqq0k=
|
||||
github.com/shopspring/decimal v1.4.0 h1:bxl37RwXBklmTi0C79JfXCEBD1cqqHt0bbgBAGFp81k=
|
||||
github.com/shopspring/decimal v1.4.0/go.mod h1:gawqmDU56v4yIKSwfBSFip1HdCCXN8/+DMd9qYNcwME=
|
||||
github.com/sijms/go-ora/v2 v2.7.17 h1:M/pYIqjaMUeBxyzOWp2oj4ntF6fHSBloJWGNH9vbmsU=
|
||||
github.com/sijms/go-ora/v2 v2.7.17/go.mod h1:EHxlY6x7y9HAsdfumurRfTd+v8NrEOTR3Xl4FWlH6xk=
|
||||
github.com/songzhibin97/gkit v1.2.13 h1:paY0XJkdRuy9/8k9nTnbdrzo8pC22jIIFldUkOQv5nU=
|
||||
@@ -482,8 +485,10 @@ github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/
|
||||
github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
|
||||
github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
|
||||
github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
|
||||
github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
|
||||
github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
|
||||
github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
|
||||
github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U=
|
||||
github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U=
|
||||
github.com/subosito/gotenv v1.6.0 h1:9NlTDc1FTs4qu0DDq7AEtTPNw6SVm7uBMsUCUjABIf8=
|
||||
github.com/subosito/gotenv v1.6.0/go.mod h1:Dk4QP5c2W3ibzajGcXpNraDfq2IrhjMIvMSWPKKo0FU=
|
||||
github.com/swaggo/files v1.0.1 h1:J1bVJ4XHZNq0I46UU90611i9/YzdrF7x92oX1ig5IdE=
|
||||
@@ -567,16 +572,15 @@ golang.org/x/crypto v0.6.0/go.mod h1:OFC/31mSvZgRz0V1QTNCzfAI1aIRzbiufJtkMIlEp58
|
||||
golang.org/x/crypto v0.11.0/go.mod h1:xgJhtzW8F9jGdVFWZESrid1U1bjeNy4zgy5cRr/CIio=
|
||||
golang.org/x/crypto v0.12.0/go.mod h1:NF0Gs7EO5K4qLn+Ylc+fih8BSTeIjAP05siRnAh98yw=
|
||||
golang.org/x/crypto v0.13.0/go.mod h1:y6Z2r+Rw4iayiXXAIxJIDAJ1zMW4yaTpebo8fPOliYc=
|
||||
golang.org/x/crypto v0.14.0/go.mod h1:MVFd36DqK4CsrnJYDkBA3VC4m2GkXAM0PvzMCn4JQf4=
|
||||
golang.org/x/crypto v0.16.0/go.mod h1:gCAAfMLgwOJRpTjQ2zCCt2OcSfYMTeZVSRtQlPC7Nq4=
|
||||
golang.org/x/crypto v0.17.0/go.mod h1:gCAAfMLgwOJRpTjQ2zCCt2OcSfYMTeZVSRtQlPC7Nq4=
|
||||
golang.org/x/crypto v0.18.0/go.mod h1:R0j02AL6hcrfOiy9T4ZYp/rcWeMxM3L6QYxlOuEG1mg=
|
||||
golang.org/x/crypto v0.19.0/go.mod h1:Iy9bg/ha4yyC70EfRS8jz+B6ybOBKMaSxLj6P6oBDfU=
|
||||
golang.org/x/crypto v0.21.0/go.mod h1:0BP7YvVV9gBbVKyeTG0Gyn+gZm94bibOW5BjDEYAOMs=
|
||||
golang.org/x/crypto v0.22.0/go.mod h1:vr6Su+7cTlO45qkww3VDJlzDn0ctJvRgYbC2NvXHt+M=
|
||||
golang.org/x/crypto v0.23.0/go.mod h1:CKFgDieR+mRhux2Lsu27y0fO304Db0wZe70UKqHu0v8=
|
||||
golang.org/x/crypto v0.24.0/go.mod h1:Z1PMYSOR5nyMcyAVAIQSKCDwalqy85Aqn1x3Ws4L5DM=
|
||||
golang.org/x/crypto v0.26.0/go.mod h1:GY7jblb9wI+FOo5y8/S2oY4zWP07AkOJ4+jxCqdqn54=
|
||||
golang.org/x/crypto v0.37.0 h1:kJNSjF/Xp7kU0iB2Z+9viTPMW4EqqsrywMXLJOOsXSE=
|
||||
golang.org/x/crypto v0.37.0/go.mod h1:vg+k43peMZ0pUMhYmVAWysMK35e6ioLh3wB8ZCAfbVc=
|
||||
golang.org/x/crypto v0.46.0 h1:cKRW/pmt1pKAfetfu+RCEvjvZkA9RimPbh7bhFjGVBU=
|
||||
golang.org/x/crypto v0.46.0/go.mod h1:Evb/oLKmMraqjZ2iQTwDwvCtJkczlDuTmdJXoZVzqU0=
|
||||
golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA=
|
||||
golang.org/x/exp v0.0.0-20190306152737-a1d7652674e8/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA=
|
||||
golang.org/x/exp v0.0.0-20190510132918-efd6b22b2522/go.mod h1:ZjyILWgesfNpC6sMxTJOJm9Kp84zZh5NQWvqDGG3Qr8=
|
||||
@@ -585,8 +589,8 @@ golang.org/x/exp v0.0.0-20191030013958-a1ab85dbe136/go.mod h1:JXzH8nQsPlswgeRAPE
|
||||
golang.org/x/exp v0.0.0-20191129062945-2f5052295587/go.mod h1:2RIsYlXP63K8oxa1u096TMicItID8zy7Y6sNkU49FU4=
|
||||
golang.org/x/exp v0.0.0-20191227195350-da58074b4299/go.mod h1:2RIsYlXP63K8oxa1u096TMicItID8zy7Y6sNkU49FU4=
|
||||
golang.org/x/exp v0.0.0-20200207192155-f17229e696bd/go.mod h1:J/WKrq2StrnmMY6+EHIKF9dgMWnmCNThgcyBT1FY9mM=
|
||||
golang.org/x/exp v0.0.0-20250106191152-7588d65b2ba8 h1:yqrTHse8TCMW1M1ZCP+VAR/l0kKxwaAIqN/il7x4voA=
|
||||
golang.org/x/exp v0.0.0-20250106191152-7588d65b2ba8/go.mod h1:tujkw807nyEEAamNbDrEGzRav+ilXA7PCRAd6xsmwiU=
|
||||
golang.org/x/exp v0.0.0-20251219203646-944ab1f22d93 h1:fQsdNF2N+/YewlRZiricy4P1iimyPKZ/xwniHj8Q2a0=
|
||||
golang.org/x/exp v0.0.0-20251219203646-944ab1f22d93/go.mod h1:EPRbTFwzwjXj9NpYyyrvenVh9Y+GFeEvMNh7Xuz7xgU=
|
||||
golang.org/x/image v0.0.0-20190227222117-0694c2d4d067/go.mod h1:kZ7UVZpmo3dzQBMxlp+ypCbDeSB+sBbTgSJuh5dn5js=
|
||||
golang.org/x/image v0.0.0-20190802002840-cff245a6509b/go.mod h1:FeLwcggjj3mMvU+oOTbSwawSJRM1uh48EjtB4UJZlP0=
|
||||
golang.org/x/image v0.23.0 h1:HseQ7c2OpPKTPVzNjG5fwJsOTCiiwS4QdsYi5XU6H68=
|
||||
@@ -608,11 +612,12 @@ golang.org/x/mod v0.1.1-0.20191105210325-c90efee705ee/go.mod h1:QqPTAvyqsEbceGzB
|
||||
golang.org/x/mod v0.2.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
|
||||
golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4=
|
||||
golang.org/x/mod v0.8.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs=
|
||||
golang.org/x/mod v0.9.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs=
|
||||
golang.org/x/mod v0.12.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs=
|
||||
golang.org/x/mod v0.15.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c=
|
||||
golang.org/x/mod v0.17.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c=
|
||||
golang.org/x/mod v0.22.0 h1:D4nJWe9zXqHOmWqj4VMOJhvzj7bEZg4wEYa759z1pH4=
|
||||
golang.org/x/mod v0.22.0/go.mod h1:6SkKJ3Xj0I0BrPOZoBy3bdMptDDU9oJrpohJ3eWZ1fY=
|
||||
golang.org/x/mod v0.31.0 h1:HaW9xtz0+kOcWKwli0ZXy79Ix+UW/vOfmWI5QVd2tgI=
|
||||
golang.org/x/mod v0.31.0/go.mod h1:43JraMp9cGx1Rx3AqioxrbrhNsLl2l/iNAvuBkrezpg=
|
||||
golang.org/x/net v0.0.0-20180724234803-3673e40ba225/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
|
||||
golang.org/x/net v0.0.0-20180826012351-8a410e7b638d/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
|
||||
golang.org/x/net v0.0.0-20190108225652-1e06a53dbb7e/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
|
||||
@@ -636,13 +641,14 @@ golang.org/x/net v0.10.0/go.mod h1:0qNGK6F8kojg2nk9dLZ2mShWaEBan6FAoqfSigmmuDg=
|
||||
golang.org/x/net v0.13.0/go.mod h1:zEVYFnQC7m/vmpQFELhcD1EWkZlX69l4oqgmer6hfKA=
|
||||
golang.org/x/net v0.14.0/go.mod h1:PpSgVXXLK0OxS0F31C1/tv6XNguvCrnXIDrFMspZIUI=
|
||||
golang.org/x/net v0.15.0/go.mod h1:idbUs1IY1+zTqbi8yxTbhexhEEk5ur9LInksu6HrEpk=
|
||||
golang.org/x/net v0.17.0/go.mod h1:NxSsAGuq816PNPmqtQdLE42eU2Fs7NoRIZrHJAlaCOE=
|
||||
golang.org/x/net v0.19.0/go.mod h1:CfAk/cbD4CthTvqiEl8NpboMuiuOYsAr/7NOjZJtv1U=
|
||||
golang.org/x/net v0.20.0/go.mod h1:z8BVo6PvndSri0LbOE3hAn0apkU+1YvI6E70E9jsnvY=
|
||||
golang.org/x/net v0.21.0/go.mod h1:bIjVDfnllIU7BJ2DNgfnXvpSvtn8VRwhlsaeUTyUS44=
|
||||
golang.org/x/net v0.22.0/go.mod h1:JKghWKKOSdJwpW2GEx0Ja7fmaKnMsbu+MWVZTokSYmg=
|
||||
golang.org/x/net v0.24.0/go.mod h1:2Q7sJY5mzlzWjKtYUEXSlBWCdyaioyXzRB2RtU8KVE8=
|
||||
golang.org/x/net v0.25.0/go.mod h1:JkAGAh7GEvH74S6FOH42FLoXpXbE/aqXSrIQjXgsiwM=
|
||||
golang.org/x/net v0.35.0 h1:T5GQRQb2y08kTAByq9L4/bz8cipCdA8FbRTXewonqY8=
|
||||
golang.org/x/net v0.35.0/go.mod h1:EglIi67kWsHKlRzzVMUD93VMSWGFOMSZgxFjparz1Qk=
|
||||
golang.org/x/net v0.26.0/go.mod h1:5YKkiSynbBIh3p6iOc/vibscux0x38BZDkn8sCUPxHE=
|
||||
golang.org/x/net v0.48.0 h1:zyQRTTrjc33Lhh0fBgT/H3oZq9WuvRR5gPC70xpDiQU=
|
||||
golang.org/x/net v0.48.0/go.mod h1:+ndRgGjkh8FGtu1w1FGbEC31if4VrNVMuKTgcAAnQRY=
|
||||
golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U=
|
||||
golang.org/x/oauth2 v0.0.0-20190226205417-e64efc72b421/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw=
|
||||
golang.org/x/oauth2 v0.0.0-20190604053449-0f29369cfe45/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw=
|
||||
@@ -660,9 +666,10 @@ golang.org/x/sync v0.3.0/go.mod h1:FU7BRWz2tNW+3quACPkgCx/L+uEAv1htQ0V83Z9Rj+Y=
|
||||
golang.org/x/sync v0.6.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
|
||||
golang.org/x/sync v0.7.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
|
||||
golang.org/x/sync v0.8.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
|
||||
golang.org/x/sync v0.9.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
|
||||
golang.org/x/sync v0.10.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
|
||||
golang.org/x/sync v0.13.0 h1:AauUjRAJ9OSnvULf/ARrrVywoJDy0YS2AwQ98I37610=
|
||||
golang.org/x/sync v0.13.0/go.mod h1:1dzgHSNfp02xaA81J2MS99Qcpr2w7fw1gpm99rleRqA=
|
||||
golang.org/x/sync v0.19.0 h1:vV+1eWNmZ5geRlYjzm2adRgW2/mcpevXNg50YZtPCE4=
|
||||
golang.org/x/sync v0.19.0/go.mod h1:9KTHXmSnoGruLpwFjVSX0lNNA75CykiMECbovNTZqGI=
|
||||
golang.org/x/sys v0.0.0-20180830151530-49385e6e1522/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
|
||||
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
|
||||
golang.org/x/sys v0.0.0-20190312061237-fead79001313/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||
@@ -689,15 +696,15 @@ golang.org/x/sys v0.8.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||
golang.org/x/sys v0.10.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||
golang.org/x/sys v0.11.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||
golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||
golang.org/x/sys v0.13.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||
golang.org/x/sys v0.15.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
|
||||
golang.org/x/sys v0.16.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
|
||||
golang.org/x/sys v0.17.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
|
||||
golang.org/x/sys v0.18.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
|
||||
golang.org/x/sys v0.19.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
|
||||
golang.org/x/sys v0.20.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
|
||||
golang.org/x/sys v0.21.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
|
||||
golang.org/x/sys v0.23.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
|
||||
golang.org/x/sys v0.32.0 h1:s77OFDvIQeibCmezSnk/q6iAfkdiQaJi4VzroCFrN20=
|
||||
golang.org/x/sys v0.32.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k=
|
||||
golang.org/x/sys v0.39.0 h1:CvCKL8MeisomCi6qNZ+wbb0DN9E5AATixKsvNtMoMFk=
|
||||
golang.org/x/sys v0.39.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks=
|
||||
golang.org/x/telemetry v0.0.0-20240228155512-f48c80bd79b2/go.mod h1:TeRTkGYfJXctD9OcfyVLyj2J3IxLnKwHJR8f4D8a3YE=
|
||||
golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
|
||||
golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
|
||||
@@ -707,12 +714,12 @@ golang.org/x/term v0.8.0/go.mod h1:xPskH00ivmX89bAKVGSKKtLOWNx2+17Eiy94tnKShWo=
|
||||
golang.org/x/term v0.10.0/go.mod h1:lpqdcUyK/oCiQxvxVrppt5ggO2KCZ5QblwqPnfZ6d5o=
|
||||
golang.org/x/term v0.11.0/go.mod h1:zC9APTIj3jG3FdV/Ons+XE1riIZXG4aZ4GTHiPZJPIU=
|
||||
golang.org/x/term v0.12.0/go.mod h1:owVbMEjm3cBLCHdkQu9b1opXd4ETQWc3BhuQGKgXgvU=
|
||||
golang.org/x/term v0.13.0/go.mod h1:LTmsnFJwVN6bCy1rVCoS+qHT1HhALEFxKncY3WNNh4U=
|
||||
golang.org/x/term v0.15.0/go.mod h1:BDl952bC7+uMoWR75FIrCDx79TPU9oHkTZ9yRbYOrX0=
|
||||
golang.org/x/term v0.16.0/go.mod h1:yn7UURbUtPyrVJPGPq404EukNFxcm/foM+bV/bfcDsY=
|
||||
golang.org/x/term v0.17.0/go.mod h1:lLRBjIVuehSbZlaOtGMbcMncT+aqLLLmKrsjNrUguwk=
|
||||
golang.org/x/term v0.18.0/go.mod h1:ILwASektA3OnRv7amZ1xhE/KTR+u50pbXfZ03+6Nx58=
|
||||
golang.org/x/term v0.19.0/go.mod h1:2CuTdWZ7KHSQwUzKva0cbMg6q2DMI3Mmxp+gKJbskEk=
|
||||
golang.org/x/term v0.20.0/go.mod h1:8UkIAJTvZgivsXaD6/pH6U9ecQzZ45awqEOzuCvwpFY=
|
||||
golang.org/x/term v0.21.0/go.mod h1:ooXLefLobQVslOqselCNF4SxFAaoS6KujMbsGzSDmX0=
|
||||
golang.org/x/term v0.23.0/go.mod h1:DgV24QBUrK6jhZXl+20l6UWznPlwAHm1Q1mGHtydmSk=
|
||||
golang.org/x/text v0.0.0-20170915032832-14c0d48ead0c/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
|
||||
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
|
||||
@@ -730,10 +737,12 @@ golang.org/x/text v0.12.0/go.mod h1:TvPlkZtksWOMsz7fbANvkp4WM8x/WCo/om8BMLbz+aE=
|
||||
golang.org/x/text v0.13.0/go.mod h1:TvPlkZtksWOMsz7fbANvkp4WM8x/WCo/om8BMLbz+aE=
|
||||
golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
|
||||
golang.org/x/text v0.15.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
|
||||
golang.org/x/text v0.16.0/go.mod h1:GhwF1Be+LQoKShO3cGOHzqOgRrGaYc9AvblQOmPVHnI=
|
||||
golang.org/x/text v0.17.0/go.mod h1:BuEKDfySbSR4drPmRPG/7iBdf8hvFMuRexcpahXilzY=
|
||||
golang.org/x/text v0.20.0/go.mod h1:D4IsuqiFMhST5bX19pQ9ikHC2GsaKyk/oF+pn3ducp4=
|
||||
golang.org/x/text v0.21.0/go.mod h1:4IBbMaMmOPCJ8SecivzSH54+73PCFmPWxNTLm+vZkEQ=
|
||||
golang.org/x/text v0.24.0 h1:dd5Bzh4yt5KYA8f9CJHCP4FB4D51c2c6JvN37xJJkJ0=
|
||||
golang.org/x/text v0.24.0/go.mod h1:L8rBsPeo2pSS+xqN0d5u2ikmjtmoJbDBT1b7nHvFCdU=
|
||||
golang.org/x/text v0.32.0 h1:ZD01bjUt1FQ9WJ0ClOL5vxgxOI/sVCNgX1YtKwcY0mU=
|
||||
golang.org/x/text v0.32.0/go.mod h1:o/rUWzghvpD5TXrTIBuJU77MTaN0ljMWE47kxGJQ7jY=
|
||||
golang.org/x/time v0.0.0-20181108054448-85acf8d2951c/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
|
||||
golang.org/x/time v0.0.0-20190308202827-9d24e82272b4/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
|
||||
golang.org/x/time v0.9.0 h1:EsRrnYcQiGH+5FfbgvV4AP7qEZstoyrHB0DzarOQ4ZY=
|
||||
@@ -766,8 +775,8 @@ golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc
|
||||
golang.org/x/tools v0.6.0/go.mod h1:Xwgl3UAJ/d3gWutnCtw505GrjyAbvKui8lOU390QaIU=
|
||||
golang.org/x/tools v0.13.0/go.mod h1:HvlwmtVNQAhOuCjW7xxvovg8wbNq7LwfXh/k7wXUl58=
|
||||
golang.org/x/tools v0.21.1-0.20240508182429-e35e4ccd0d2d/go.mod h1:aiJjzUbINMkxbQROHiO6hDPo2LHcIPhhQsa9DLh0yGk=
|
||||
golang.org/x/tools v0.29.0 h1:Xx0h3TtM9rzQpQuR4dKLrdglAmCEN5Oi+P74JdhdzXE=
|
||||
golang.org/x/tools v0.29.0/go.mod h1:KMQVMRsVxU6nHCFXrBPhDB8XncLNLM0lIy/F14RP588=
|
||||
golang.org/x/tools v0.40.0 h1:yLkxfA+Qnul4cs9QA3KnlFu0lVmd8JJfoq+E41uSutA=
|
||||
golang.org/x/tools v0.40.0/go.mod h1:Ik/tzLRlbscWpqqMRjyWYDisX8bG13FrdXp3o4Sr9lc=
|
||||
golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
|
||||
golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
|
||||
golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
|
||||
@@ -823,53 +832,57 @@ gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
|
||||
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
||||
gorm.io/datatypes v1.2.5 h1:9UogU3jkydFVW1bIVVeoYsTpLRgwDVW3rHfJG6/Ek9I=
|
||||
gorm.io/datatypes v1.2.5/go.mod h1:I5FUdlKpLb5PMqeMQhm30CQ6jXP8Rj89xkTeCSAaAD4=
|
||||
gorm.io/driver/mysql v1.5.7 h1:MndhOPYOfEp2rHKgkZIhJ16eVUIRf2HmzgoPmh7FCWo=
|
||||
gorm.io/driver/mysql v1.5.7/go.mod h1:sEtPWMiqiN1N1cMXoXmBbd8C6/l+TESwriotuRRpkDM=
|
||||
gorm.io/driver/postgres v1.5.11 h1:ubBVAfbKEUld/twyKZ0IYn9rSQh448EdelLYk9Mv314=
|
||||
gorm.io/driver/postgres v1.5.11/go.mod h1:DX3GReXH+3FPWGrrgffdvCk3DQ1dwDPdmbenSkweRGI=
|
||||
gorm.io/driver/sqlite v1.5.0 h1:zKYbzRCpBrT1bNijRnxLDJWPjVfImGEn0lSnUY5gZ+c=
|
||||
gorm.io/driver/mysql v1.6.0 h1:eNbLmNTpPpTOVZi8MMxCi2aaIm0ZpInbORNXDwyLGvg=
|
||||
gorm.io/driver/mysql v1.6.0/go.mod h1:D/oCC2GWK3M/dqoLxnOlaNKmXz8WNTfcS9y5ovaSqKo=
|
||||
gorm.io/driver/postgres v1.6.0 h1:2dxzU8xJ+ivvqTRph34QX+WrRaJlmfyPqXmoGVjMBa4=
|
||||
gorm.io/driver/postgres v1.6.0/go.mod h1:vUw0mrGgrTK+uPHEhAdV4sfFELrByKVGnaVRkXDhtWo=
|
||||
gorm.io/driver/sqlite v1.5.0/go.mod h1:kDMDfntV9u/vuMmz8APHtHF0b4nyBB7sfCieC6G8k8I=
|
||||
gorm.io/driver/sqlserver v1.5.4 h1:xA+Y1KDNspv79q43bPyjDMUgHoYHLhXYmdFcYPobg8g=
|
||||
gorm.io/driver/sqlserver v1.5.4/go.mod h1:+frZ/qYmuna11zHPlh5oc2O6ZA/lS88Keb0XSH1Zh/g=
|
||||
gorm.io/driver/sqlite v1.6.0 h1:WHRRrIiulaPiPFmDcod6prc4l2VGVWHz80KspNsxSfQ=
|
||||
gorm.io/driver/sqlite v1.6.0/go.mod h1:AO9V1qIQddBESngQUKWL9yoH93HIeA1X6V633rBwyT8=
|
||||
gorm.io/driver/sqlserver v1.6.3 h1:UR+nWCuphPnq7UxnL57PSrlYjuvs+sf1N59GgFX7uAI=
|
||||
gorm.io/driver/sqlserver v1.6.3/go.mod h1:VZeNn7hqX1aXoN5TPAFGWvxWG90xtA8erGn2gQmpc6U=
|
||||
gorm.io/gen v0.3.26 h1:sFf1j7vNStimPRRAtH4zz5NiHM+1dr6eA9aaRdplyhY=
|
||||
gorm.io/gen v0.3.26/go.mod h1:a5lq5y3w4g5LMxBcw0wnO6tYUCdNutWODq5LrIt75LE=
|
||||
gorm.io/gorm v1.24.0/go.mod h1:DVrVomtaYTbqs7gB/x2uVvqnXzv0nqjB396B8cG4dBA=
|
||||
gorm.io/gorm v1.24.7-0.20230306060331-85eaf9eeda11/go.mod h1:L4uxeKpfBml98NYqVqwAdmV1a2nBtAec/cf3fpucW/k=
|
||||
gorm.io/gorm v1.25.0/go.mod h1:L4uxeKpfBml98NYqVqwAdmV1a2nBtAec/cf3fpucW/k=
|
||||
gorm.io/gorm v1.25.7-0.20240204074919-46816ad31dde/go.mod h1:hbnx/Oo0ChWMn1BIhpy1oYozzpM15i4YPuHDmfYtwg8=
|
||||
gorm.io/gorm v1.25.7/go.mod h1:hbnx/Oo0ChWMn1BIhpy1oYozzpM15i4YPuHDmfYtwg8=
|
||||
gorm.io/gorm v1.25.12 h1:I0u8i2hWQItBq1WfE0o2+WuL9+8L21K9e2HHSTE/0f8=
|
||||
gorm.io/gorm v1.25.12/go.mod h1:xh7N7RHfYlNc5EmcI/El95gXusucDrQnHXe0+CgWcLQ=
|
||||
gorm.io/gorm v1.30.0/go.mod h1:8Z33v652h4//uMA76KjeDH8mJXPm1QNCYrMeatR0DOE=
|
||||
gorm.io/gorm v1.31.1 h1:7CA8FTFz/gRfgqgpeKIBcervUn3xSyPUmr6B2WXJ7kg=
|
||||
gorm.io/gorm v1.31.1/go.mod h1:XyQVbO2k6YkOis7C2437jSit3SsDK72s7n7rsSHd+Gs=
|
||||
gorm.io/hints v1.1.2 h1:b5j0kwk5p4+3BtDtYqqfY+ATSxjj+6ptPgVveuynn9o=
|
||||
gorm.io/hints v1.1.2/go.mod h1:/ARdpUHAtyEMCh5NNi3tI7FsGh+Cj/MIUlvNxCNCFWg=
|
||||
gorm.io/plugin/dbresolver v1.5.3 h1:wFwINGZZmttuu9h7XpvbDHd8Lf9bb8GNzp/NpAMV2wU=
|
||||
gorm.io/plugin/dbresolver v1.5.3/go.mod h1:TSrVhaUg2DZAWP3PrHlDlITEJmNOkL0tFTjvTEsQ4XE=
|
||||
gorm.io/plugin/dbresolver v1.6.2 h1:F4b85TenghUeITqe3+epPSUtHH7RIk3fXr5l83DF8Pc=
|
||||
gorm.io/plugin/dbresolver v1.6.2/go.mod h1:tctw63jdrOezFR9HmrKnPkmig3m5Edem9fdxk9bQSzM=
|
||||
honnef.co/go/tools v0.0.0-20190102054323-c2f93a96b099/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=
|
||||
honnef.co/go/tools v0.0.0-20190106161140-3f1c8253044a/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=
|
||||
honnef.co/go/tools v0.0.0-20190418001031-e561f6794a2a/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=
|
||||
honnef.co/go/tools v0.0.0-20190523083050-ea95bdfd59fc/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=
|
||||
honnef.co/go/tools v0.0.1-2019.2.3/go.mod h1:a3bituU0lyd329TUQxRnasdCoJDkEUEAqEt0JzvZhAg=
|
||||
modernc.org/cc/v4 v4.24.4 h1:TFkx1s6dCkQpd6dKurBNmpo+G8Zl4Sq/ztJ+2+DEsh0=
|
||||
modernc.org/cc/v4 v4.24.4/go.mod h1:uVtb5OGqUKpoLWhqwNQo/8LwvoiEBLvZXIQ/SmO6mL0=
|
||||
modernc.org/ccgo/v4 v4.23.13 h1:PFiaemQwE/jdwi8XEHyEV+qYWoIuikLP3T4rvDeJb00=
|
||||
modernc.org/ccgo/v4 v4.23.13/go.mod h1:vdN4h2WR5aEoNondUx26K7G8X+nuBscYnAEWSRmN2/0=
|
||||
modernc.org/cc/v4 v4.27.1 h1:9W30zRlYrefrDV2JE2O8VDtJ1yPGownxciz5rrbQZis=
|
||||
modernc.org/cc/v4 v4.27.1/go.mod h1:uVtb5OGqUKpoLWhqwNQo/8LwvoiEBLvZXIQ/SmO6mL0=
|
||||
modernc.org/ccgo/v4 v4.30.1 h1:4r4U1J6Fhj98NKfSjnPUN7Ze2c6MnAdL0hWw6+LrJpc=
|
||||
modernc.org/ccgo/v4 v4.30.1/go.mod h1:bIOeI1JL54Utlxn+LwrFyjCx2n2RDiYEaJVSrgdrRfM=
|
||||
modernc.org/fileutil v1.0.0/go.mod h1:JHsWpkrk/CnVV1H/eGlFf85BEpfkrp56ro8nojIq9Q8=
|
||||
modernc.org/fileutil v1.3.0 h1:gQ5SIzK3H9kdfai/5x41oQiKValumqNTDXMvKo62HvE=
|
||||
modernc.org/fileutil v1.3.0/go.mod h1:XatxS8fZi3pS8/hKG2GH/ArUogfxjpEKs3Ku3aK4JyQ=
|
||||
modernc.org/gc/v2 v2.6.1 h1:+Qf6xdG8l7B27TQ8D8lw/iFMUj1RXRBOuMUWziJOsk8=
|
||||
modernc.org/gc/v2 v2.6.1/go.mod h1:YgIahr1ypgfe7chRuJi2gD7DBQiKSLMPgBQe9oIiito=
|
||||
modernc.org/libc v1.61.9 h1:PLSBXVkifXGELtJ5BOnBUyAHr7lsatNwFU/RRo4kfJM=
|
||||
modernc.org/libc v1.61.9/go.mod h1:61xrnzk/aR8gr5bR7Uj/lLFLuXu2/zMpIjcry63Eumk=
|
||||
modernc.org/fileutil v1.3.40 h1:ZGMswMNc9JOCrcrakF1HrvmergNLAmxOPjizirpfqBA=
|
||||
modernc.org/fileutil v1.3.40/go.mod h1:HxmghZSZVAz/LXcMNwZPA/DRrQZEVP9VX0V4LQGQFOc=
|
||||
modernc.org/gc/v2 v2.6.5 h1:nyqdV8q46KvTpZlsw66kWqwXRHdjIlJOhG6kxiV/9xI=
|
||||
modernc.org/gc/v2 v2.6.5/go.mod h1:YgIahr1ypgfe7chRuJi2gD7DBQiKSLMPgBQe9oIiito=
|
||||
modernc.org/gc/v3 v3.1.1 h1:k8T3gkXWY9sEiytKhcgyiZ2L0DTyCQ/nvX+LoCljoRE=
|
||||
modernc.org/gc/v3 v3.1.1/go.mod h1:HFK/6AGESC7Ex+EZJhJ2Gni6cTaYpSMmU/cT9RmlfYY=
|
||||
modernc.org/goabi0 v0.2.0 h1:HvEowk7LxcPd0eq6mVOAEMai46V+i7Jrj13t4AzuNks=
|
||||
modernc.org/goabi0 v0.2.0/go.mod h1:CEFRnnJhKvWT1c1JTI3Avm+tgOWbkOu5oPA8eH8LnMI=
|
||||
modernc.org/libc v1.67.4 h1:zZGmCMUVPORtKv95c2ReQN5VDjvkoRm9GWPTEPuvlWg=
|
||||
modernc.org/libc v1.67.4/go.mod h1:QvvnnJ5P7aitu0ReNpVIEyesuhmDLQ8kaEoyMjIFZJA=
|
||||
modernc.org/mathutil v1.7.1 h1:GCZVGXdaN8gTqB1Mf/usp1Y/hSqgI2vAGGP4jZMCxOU=
|
||||
modernc.org/mathutil v1.7.1/go.mod h1:4p5IwJITfppl0G4sUEDtCr4DthTaT47/N3aT6MhfgJg=
|
||||
modernc.org/memory v1.8.2 h1:cL9L4bcoAObu4NkxOlKWBWtNHIsnnACGF/TbqQ6sbcI=
|
||||
modernc.org/memory v1.8.2/go.mod h1:ZbjSvMO5NQ1A2i3bWeDiVMxIorXwdClKE/0SZ+BMotU=
|
||||
modernc.org/memory v1.11.0 h1:o4QC8aMQzmcwCK3t3Ux/ZHmwFPzE6hf2Y5LbkRs+hbI=
|
||||
modernc.org/memory v1.11.0/go.mod h1:/JP4VbVC+K5sU2wZi9bHoq2MAkCnrt2r98UGeSK7Mjw=
|
||||
modernc.org/opt v0.1.4 h1:2kNGMRiUjrp4LcaPuLY2PzUfqM/w9N23quVwhKt5Qm8=
|
||||
modernc.org/opt v0.1.4/go.mod h1:03fq9lsNfvkYSfxrfUhZCWPk1lm4cq4N+Bh//bEtgns=
|
||||
modernc.org/sortutil v1.2.1 h1:+xyoGf15mM3NMlPDnFqrteY07klSFxLElE2PVuWIJ7w=
|
||||
modernc.org/sortutil v1.2.1/go.mod h1:7ZI3a3REbai7gzCLcotuw9AC4VZVpYMjDzETGsSMqJE=
|
||||
modernc.org/sqlite v1.34.5 h1:Bb6SR13/fjp15jt70CL4f18JIN7p7dnMExd+UFnF15g=
|
||||
modernc.org/sqlite v1.34.5/go.mod h1:YLuNmX9NKs8wRNK2ko1LW1NGYcc9FkBO69JOt1AR9JE=
|
||||
modernc.org/sqlite v1.42.2 h1:7hkZUNJvJFN2PgfUdjni9Kbvd4ef4mNLOu0B9FGxM74=
|
||||
modernc.org/sqlite v1.42.2/go.mod h1:+VkC6v3pLOAE0A0uVucQEcbVW0I5nHCeDaBf+DpsQT8=
|
||||
modernc.org/strutil v1.2.1 h1:UneZBkQA+DX2Rp35KcM69cSsNES9ly8mQWD71HKlOA0=
|
||||
modernc.org/strutil v1.2.1/go.mod h1:EHkiggD70koQxjVdSBM3JKM7k6L0FbGE5eymy9i3B9A=
|
||||
modernc.org/token v1.1.0 h1:Xl7Ap9dKaEs5kLoOQeQmPWevfnk/DM5qcLcYlA8ys6Y=
|
||||
|
||||
@@ -10,9 +10,12 @@ package initialize
|
||||
*/
|
||||
|
||||
import (
|
||||
"time"
|
||||
|
||||
"github.com/flipped-aurora/gin-vue-admin/server/config"
|
||||
"github.com/flipped-aurora/gin-vue-admin/server/global"
|
||||
"github.com/flipped-aurora/gin-vue-admin/server/initialize/internal"
|
||||
|
||||
"gorm.io/driver/sqlserver"
|
||||
"gorm.io/gorm"
|
||||
)
|
||||
@@ -37,6 +40,7 @@ func GormMssql() *gorm.DB {
|
||||
sqlDB, _ := db.DB()
|
||||
sqlDB.SetMaxIdleConns(m.MaxIdleConns)
|
||||
sqlDB.SetMaxOpenConns(m.MaxOpenConns)
|
||||
sqlDB.SetConnMaxLifetime(time.Duration(m.ConnMaxLifetime) * time.Second)
|
||||
return db
|
||||
}
|
||||
}
|
||||
@@ -59,6 +63,7 @@ func GormMssqlByConfig(m config.Mssql) *gorm.DB {
|
||||
sqlDB, _ := db.DB()
|
||||
sqlDB.SetMaxIdleConns(m.MaxIdleConns)
|
||||
sqlDB.SetMaxOpenConns(m.MaxOpenConns)
|
||||
sqlDB.SetConnMaxLifetime(time.Duration(m.ConnMaxLifetime) * time.Second)
|
||||
return db
|
||||
}
|
||||
}
|
||||
|
||||
@@ -5,6 +5,8 @@ import (
|
||||
"github.com/flipped-aurora/gin-vue-admin/server/global"
|
||||
"github.com/flipped-aurora/gin-vue-admin/server/initialize/internal"
|
||||
_ "github.com/go-sql-driver/mysql"
|
||||
"time"
|
||||
|
||||
"gorm.io/driver/mysql"
|
||||
"gorm.io/gorm"
|
||||
)
|
||||
@@ -43,6 +45,7 @@ func initMysqlDatabase(m config.Mysql) *gorm.DB {
|
||||
sqlDB, _ := db.DB()
|
||||
sqlDB.SetMaxIdleConns(m.MaxIdleConns)
|
||||
sqlDB.SetMaxOpenConns(m.MaxOpenConns)
|
||||
sqlDB.SetConnMaxLifetime(time.Duration(m.ConnMaxLifetime) * time.Second)
|
||||
return db
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,6 +1,8 @@
|
||||
package initialize
|
||||
|
||||
import (
|
||||
"time"
|
||||
|
||||
oracle "github.com/dzwvip/gorm-oracle"
|
||||
"github.com/flipped-aurora/gin-vue-admin/server/config"
|
||||
"github.com/flipped-aurora/gin-vue-admin/server/global"
|
||||
@@ -32,6 +34,7 @@ func initOracleDatabase(m config.Oracle) *gorm.DB {
|
||||
sqlDB, _ := db.DB()
|
||||
sqlDB.SetMaxIdleConns(m.MaxIdleConns)
|
||||
sqlDB.SetMaxOpenConns(m.MaxOpenConns)
|
||||
sqlDB.SetConnMaxLifetime(time.Duration(m.ConnMaxLifetime) * time.Second)
|
||||
return db
|
||||
}
|
||||
}
|
||||
|
||||
@@ -4,6 +4,8 @@ import (
|
||||
"github.com/flipped-aurora/gin-vue-admin/server/config"
|
||||
"github.com/flipped-aurora/gin-vue-admin/server/global"
|
||||
"github.com/flipped-aurora/gin-vue-admin/server/initialize/internal"
|
||||
"time"
|
||||
|
||||
"gorm.io/driver/postgres"
|
||||
"gorm.io/gorm"
|
||||
)
|
||||
@@ -38,6 +40,7 @@ func initPgSqlDatabase(p config.Pgsql) *gorm.DB {
|
||||
sqlDB, _ := db.DB()
|
||||
sqlDB.SetMaxIdleConns(p.MaxIdleConns)
|
||||
sqlDB.SetMaxOpenConns(p.MaxOpenConns)
|
||||
sqlDB.SetConnMaxLifetime(time.Duration(p.ConnMaxLifetime) * time.Second)
|
||||
return db
|
||||
}
|
||||
}
|
||||
|
||||
@@ -4,6 +4,8 @@ import (
|
||||
"github.com/flipped-aurora/gin-vue-admin/server/config"
|
||||
"github.com/flipped-aurora/gin-vue-admin/server/global"
|
||||
"github.com/flipped-aurora/gin-vue-admin/server/initialize/internal"
|
||||
"time"
|
||||
|
||||
"github.com/glebarez/sqlite"
|
||||
"gorm.io/gorm"
|
||||
)
|
||||
@@ -33,6 +35,7 @@ func initSqliteDatabase(s config.Sqlite) *gorm.DB {
|
||||
sqlDB, _ := db.DB()
|
||||
sqlDB.SetMaxIdleConns(s.MaxIdleConns)
|
||||
sqlDB.SetMaxOpenConns(s.MaxOpenConns)
|
||||
sqlDB.SetConnMaxLifetime(time.Duration(s.ConnMaxLifetime) * time.Second)
|
||||
return db
|
||||
}
|
||||
}
|
||||
|
||||
@@ -6,10 +6,33 @@ import (
|
||||
)
|
||||
|
||||
func InstallPlugin(PrivateGroup *gin.RouterGroup, PublicRouter *gin.RouterGroup, engine *gin.Engine) {
|
||||
notifier := GetDBReadyNotifier()
|
||||
|
||||
// 保存插件初始化参数
|
||||
notifier.SetPluginParams(&PluginParams{
|
||||
PrivateGroup: PrivateGroup,
|
||||
PublicRouter: PublicRouter,
|
||||
Engine: engine,
|
||||
})
|
||||
|
||||
if global.GVA_DB == nil {
|
||||
global.GVA_LOG.Info("项目暂未初始化，无法安装插件，初始化后重启项目即可完成插件安装")
|
||||
global.GVA_LOG.Info("项目暂未初始化，插件将在数据库初始化完成后自动注册")
|
||||
// 订阅数据库就绪事件
|
||||
notifier.Subscribe(func() {
|
||||
global.GVA_LOG.Info("数据库已就绪，开始注册插件")
|
||||
params := notifier.GetPluginParams()
|
||||
if params != nil {
|
||||
bizPluginV1(params.PrivateGroup, params.PublicRouter)
|
||||
bizPluginV2(params.Engine)
|
||||
// 重新同步全局路由表，包含插件注册的路由
|
||||
global.GVA_ROUTERS = params.Engine.Routes()
|
||||
global.GVA_LOG.Info("插件注册完成")
|
||||
}
|
||||
})
|
||||
return
|
||||
}
|
||||
|
||||
// 数据库已存在，直接注册
|
||||
bizPluginV1(PrivateGroup, PublicRouter)
|
||||
bizPluginV2(engine)
|
||||
}
|
||||
|
||||
@@ -0,0 +1,112 @@
|
||||
package initialize
|
||||
|
||||
import (
|
||||
"sync"
|
||||
|
||||
"github.com/flipped-aurora/gin-vue-admin/server/service/system"
|
||||
"github.com/gin-gonic/gin"
|
||||
)
|
||||
|
||||
func init() {
|
||||
// 注入数据库就绪回调到 service 层
|
||||
system.SetDBReadyCallback(func() {
|
||||
GetDBReadyNotifier().NotifyDBReady()
|
||||
})
|
||||
}
|
||||
|
||||
var (
|
||||
dbReadyNotifier *DBReadyNotifier
|
||||
dbReadyNotifierOnce sync.Once
|
||||
)
|
||||
|
||||
// DBReadyNotifier 数据库就绪通知器
|
||||
type DBReadyNotifier struct {
|
||||
mu sync.RWMutex
|
||||
subscribers []func()
|
||||
dbReady bool
|
||||
pluginParams *PluginParams // 保存插件初始化所需的参数
|
||||
}
|
||||
|
||||
// PluginParams 插件初始化参数
|
||||
type PluginParams struct {
|
||||
PrivateGroup *gin.RouterGroup
|
||||
PublicRouter *gin.RouterGroup
|
||||
Engine *gin.Engine
|
||||
}
|
||||
|
||||
// GetDBReadyNotifier 获取全局通知器实例（单例）
|
||||
func GetDBReadyNotifier() *DBReadyNotifier {
|
||||
dbReadyNotifierOnce.Do(func() {
|
||||
dbReadyNotifier = &DBReadyNotifier{
|
||||
subscribers: make([]func(), 0),
|
||||
dbReady: false,
|
||||
}
|
||||
})
|
||||
return dbReadyNotifier
|
||||
}
|
||||
|
||||
// Subscribe 订阅数据库就绪事件
|
||||
// 如果数据库已经就绪，立即执行回调
|
||||
// 否则将回调加入订阅列表，等待通知
|
||||
func (n *DBReadyNotifier) Subscribe(callback func()) {
|
||||
n.mu.Lock()
|
||||
defer n.mu.Unlock()
|
||||
|
||||
if n.dbReady {
|
||||
// 数据库已就绪，立即执行
|
||||
callback()
|
||||
} else {
|
||||
// 数据库未就绪，加入订阅列表
|
||||
n.subscribers = append(n.subscribers, callback)
|
||||
}
|
||||
}
|
||||
|
||||
// SetPluginParams 设置插件初始化参数
|
||||
func (n *DBReadyNotifier) SetPluginParams(params *PluginParams) {
|
||||
n.mu.Lock()
|
||||
defer n.mu.Unlock()
|
||||
n.pluginParams = params
|
||||
}
|
||||
|
||||
// GetPluginParams 获取插件初始化参数
|
||||
func (n *DBReadyNotifier) GetPluginParams() *PluginParams {
|
||||
n.mu.RLock()
|
||||
defer n.mu.RUnlock()
|
||||
return n.pluginParams
|
||||
}
|
||||
|
||||
// NotifyDBReady 通知数据库已就绪
|
||||
// 会触发所有订阅的回调函数
|
||||
func (n *DBReadyNotifier) NotifyDBReady() {
|
||||
n.mu.Lock()
|
||||
|
||||
if n.dbReady {
|
||||
// 已经通知过了，避免重复通知
|
||||
n.mu.Unlock()
|
||||
return
|
||||
}
|
||||
|
||||
n.dbReady = true
|
||||
|
||||
// 复制订阅列表，避免在执行回调时持有锁
|
||||
callbacks := make([]func(), len(n.subscribers))
|
||||
copy(callbacks, n.subscribers)
|
||||
|
||||
// 清空订阅列表
|
||||
n.subscribers = nil
|
||||
|
||||
// 释放锁后再执行回调，避免死锁
|
||||
n.mu.Unlock()
|
||||
|
||||
// 执行所有订阅的回调
|
||||
for _, callback := range callbacks {
|
||||
callback()
|
||||
}
|
||||
}
|
||||
|
||||
// IsDBReady 检查数据库是否已就绪
|
||||
func (n *DBReadyNotifier) IsDBReady() bool {
|
||||
n.mu.RLock()
|
||||
defer n.mu.RUnlock()
|
||||
return n.dbReady
|
||||
}
|
||||
+22
-25
@@ -74,34 +74,31 @@ func Routers() *gin.Engine {
|
||||
})
|
||||
}
|
||||
{
|
||||
systemRouter.InitBaseRouter(PublicGroup) // 注册基础功能路由 不做鉴权
|
||||
systemRouter.InitInitRouter(PublicGroup) // 自动初始化相关
|
||||
systemRouter.InitBaseRouter(PublicGroup) // 注册基础功能路由 不做鉴权
|
||||
systemRouter.InitInitRouter(PublicGroup) // 自动初始化相关
|
||||
}
|
||||
|
||||
{
|
||||
systemRouter.InitApiRouter(PrivateGroup, PublicGroup) // 注册功能api路由
|
||||
systemRouter.InitJwtRouter(PrivateGroup) // jwt相关路由
|
||||
systemRouter.InitUserRouter(PrivateGroup) // 注册用户路由
|
||||
systemRouter.InitMenuRouter(PrivateGroup) // 注册menu路由
|
||||
systemRouter.InitSystemRouter(PrivateGroup) // system相关路由
|
||||
systemRouter.InitSysVersionRouter(PrivateGroup) // 发版相关路由
|
||||
systemRouter.InitCasbinRouter(PrivateGroup) // 权限相关路由
|
||||
systemRouter.InitAutoCodeRouter(PrivateGroup, PublicGroup) // 创建自动化代码
|
||||
systemRouter.InitAuthorityRouter(PrivateGroup) // 注册角色路由
|
||||
systemRouter.InitSysDictionaryRouter(PrivateGroup) // 字典管理
|
||||
systemRouter.InitAutoCodeHistoryRouter(PrivateGroup) // 自动化代码历史
|
||||
systemRouter.InitSysOperationRecordRouter(PrivateGroup) // 操作记录
|
||||
systemRouter.InitSysDictionaryDetailRouter(PrivateGroup) // 字典详情管理
|
||||
systemRouter.InitAuthorityBtnRouterRouter(PrivateGroup) // 按钮权限管理
|
||||
systemRouter.InitSysExportTemplateRouter(PrivateGroup, PublicGroup) // 导出模板
|
||||
systemRouter.InitSysParamsRouter(PrivateGroup, PublicGroup) // 参数管理
|
||||
systemRouter.InitSysErrorRouter(PrivateGroup, PublicGroup) // 错误日志
|
||||
systemRouter.InitLoginLogRouter(PrivateGroup) // 登录日志
|
||||
systemRouter.InitApiTokenRouter(PrivateGroup) // apiToken签发
|
||||
systemRouter.InitSkillsRouter(PrivateGroup, PublicGroup) // Skills 定义器
|
||||
exampleRouter.InitCustomerRouter(PrivateGroup) // 客户路由
|
||||
exampleRouter.InitFileUploadAndDownloadRouter(PrivateGroup) // 文件上传下载功能路由
|
||||
exampleRouter.InitAttachmentCategoryRouterRouter(PrivateGroup) // 文件上传下载分类
|
||||
systemRouter.InitApiRouter(PrivateGroup, PublicGroup) // 注册功能api路由
|
||||
systemRouter.InitJwtRouter(PrivateGroup) // jwt相关路由
|
||||
systemRouter.InitUserRouter(PrivateGroup) // 注册用户路由
|
||||
systemRouter.InitMenuRouter(PrivateGroup) // 注册menu路由
|
||||
systemRouter.InitSystemRouter(PrivateGroup) // system相关路由
|
||||
systemRouter.InitSysVersionRouter(PrivateGroup) // 发版相关路由
|
||||
systemRouter.InitCasbinRouter(PrivateGroup) // 权限相关路由
|
||||
systemRouter.InitAuthorityRouter(PrivateGroup) // 注册角色路由
|
||||
systemRouter.InitSysDictionaryRouter(PrivateGroup) // 字典管理
|
||||
systemRouter.InitSysOperationRecordRouter(PrivateGroup) // 操作记录
|
||||
systemRouter.InitSysDictionaryDetailRouter(PrivateGroup) // 字典详情管理
|
||||
systemRouter.InitAuthorityBtnRouterRouter(PrivateGroup) // 按钮权限管理
|
||||
systemRouter.InitSysExportTemplateRouter(PrivateGroup, PublicGroup) // 导出模板
|
||||
systemRouter.InitSysParamsRouter(PrivateGroup, PublicGroup) // 参数管理
|
||||
systemRouter.InitSysErrorRouter(PrivateGroup, PublicGroup) // 错误日志
|
||||
systemRouter.InitLoginLogRouter(PrivateGroup) // 登录日志
|
||||
systemRouter.InitApiTokenRouter(PrivateGroup) // apiToken签发
|
||||
exampleRouter.InitCustomerRouter(PrivateGroup) // 客户路由
|
||||
exampleRouter.InitFileUploadAndDownloadRouter(PrivateGroup) // 文件上传下载功能路由
|
||||
exampleRouter.InitAttachmentCategoryRouterRouter(PrivateGroup) // 文件上传下载分类
|
||||
}
|
||||
|
||||
//插件路由安装
|
||||
|
||||
+1
-1
@@ -21,7 +21,7 @@ import (
|
||||
// @Tag.Description 用户
|
||||
|
||||
// @title Gin-Vue-Admin Swagger API接口文档
|
||||
// @version v2.9.1
|
||||
// @version v2.9.2
|
||||
// @description 使用gin+vue进行极速开发的全栈开发基础平台
|
||||
// @securityDefinitions.apikey ApiKeyAuth
|
||||
// @in header
|
||||
|
||||
@@ -477,7 +477,7 @@ func (g *GVAAnalyzer) scanModulesInDirectory(dir, packageName, template string)
|
||||
for _, entry := range entries {
|
||||
if !entry.IsDir() && strings.HasSuffix(entry.Name(), ".go") {
|
||||
moduleName := strings.TrimSuffix(entry.Name(), ".go")
|
||||
filePath := filepath.Join(dir, entry.Name())
|
||||
filePath := outputPath(filepath.Join(dir, entry.Name()))
|
||||
|
||||
module := PredesignedModuleInfo{
|
||||
ModuleName: moduleName,
|
||||
|
||||
+24
-23
@@ -5,6 +5,7 @@ import (
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
|
||||
"github.com/flipped-aurora/gin-vue-admin/server/global"
|
||||
@@ -547,76 +548,76 @@ func (g *GVAExecutor) buildDirectoryStructure(plan *ExecutionPlan) map[string]st
|
||||
|
||||
// 构建服务端路径
|
||||
if serverPath != "" {
|
||||
serverBasePath := fmt.Sprintf("%s/%s", rootPath, serverPath)
|
||||
serverBasePath := filepath.Join(rootPath, serverPath)
|
||||
|
||||
if packageType == "plugin" {
|
||||
// Plugin 模式：所有文件都在 /plugin/packageName/ 目录中
|
||||
plugingBasePath := fmt.Sprintf("%s/plugin/%s", serverBasePath, packageName)
|
||||
plugingBasePath := filepath.Join(serverBasePath, "plugin", packageName)
|
||||
|
||||
// API 路径
|
||||
paths["api"] = fmt.Sprintf("%s/api", plugingBasePath)
|
||||
paths["api"] = outputPath(filepath.Join(plugingBasePath, "api"))
|
||||
|
||||
// Service 路径
|
||||
paths["service"] = fmt.Sprintf("%s/service", plugingBasePath)
|
||||
paths["service"] = outputPath(filepath.Join(plugingBasePath, "service"))
|
||||
|
||||
// Model 路径
|
||||
paths["model"] = fmt.Sprintf("%s/model", plugingBasePath)
|
||||
paths["model"] = outputPath(filepath.Join(plugingBasePath, "model"))
|
||||
|
||||
// Router 路径
|
||||
paths["router"] = fmt.Sprintf("%s/router", plugingBasePath)
|
||||
paths["router"] = outputPath(filepath.Join(plugingBasePath, "router"))
|
||||
|
||||
// Request 路径
|
||||
paths["request"] = fmt.Sprintf("%s/model/request", plugingBasePath)
|
||||
paths["request"] = outputPath(filepath.Join(plugingBasePath, "model", "request"))
|
||||
|
||||
// Response 路径
|
||||
paths["response"] = fmt.Sprintf("%s/model/response", plugingBasePath)
|
||||
paths["response"] = outputPath(filepath.Join(plugingBasePath, "model", "response"))
|
||||
|
||||
// Plugin 特有文件
|
||||
paths["plugin_main"] = fmt.Sprintf("%s/main.go", plugingBasePath)
|
||||
paths["plugin_config"] = fmt.Sprintf("%s/plugin.go", plugingBasePath)
|
||||
paths["plugin_initialize"] = fmt.Sprintf("%s/initialize", plugingBasePath)
|
||||
paths["plugin_main"] = outputPath(filepath.Join(plugingBasePath, "main.go"))
|
||||
paths["plugin_config"] = outputPath(filepath.Join(plugingBasePath, "plugin.go"))
|
||||
paths["plugin_initialize"] = outputPath(filepath.Join(plugingBasePath, "initialize"))
|
||||
} else {
|
||||
// Package 模式：传统的目录结构
|
||||
// API 路径
|
||||
paths["api"] = fmt.Sprintf("%s/api/v1/%s", serverBasePath, packageName)
|
||||
paths["api"] = outputPath(filepath.Join(serverBasePath, "api", "v1", packageName))
|
||||
|
||||
// Service 路径
|
||||
paths["service"] = fmt.Sprintf("%s/service/%s", serverBasePath, packageName)
|
||||
paths["service"] = outputPath(filepath.Join(serverBasePath, "service", packageName))
|
||||
|
||||
// Model 路径
|
||||
paths["model"] = fmt.Sprintf("%s/model/%s", serverBasePath, packageName)
|
||||
paths["model"] = outputPath(filepath.Join(serverBasePath, "model", packageName))
|
||||
|
||||
// Router 路径
|
||||
paths["router"] = fmt.Sprintf("%s/router/%s", serverBasePath, packageName)
|
||||
paths["router"] = outputPath(filepath.Join(serverBasePath, "router", packageName))
|
||||
|
||||
// Request 路径
|
||||
paths["request"] = fmt.Sprintf("%s/model/%s/request", serverBasePath, packageName)
|
||||
paths["request"] = outputPath(filepath.Join(serverBasePath, "model", packageName, "request"))
|
||||
|
||||
// Response 路径
|
||||
paths["response"] = fmt.Sprintf("%s/model/%s/response", serverBasePath, packageName)
|
||||
paths["response"] = outputPath(filepath.Join(serverBasePath, "model", packageName, "response"))
|
||||
}
|
||||
}
|
||||
|
||||
// 构建前端路径（两种模式相同）
|
||||
if webPath != "" {
|
||||
webBasePath := fmt.Sprintf("%s/%s", rootPath, webPath)
|
||||
webBasePath := filepath.Join(rootPath, webPath)
|
||||
|
||||
if packageType == "plugin" {
|
||||
// Plugin 模式：前端文件也在 /plugin/packageName/ 目录中
|
||||
pluginWebBasePath := fmt.Sprintf("%s/plugin/%s", webBasePath, packageName)
|
||||
pluginWebBasePath := filepath.Join(webBasePath, "plugin", packageName)
|
||||
|
||||
// Vue 页面路径
|
||||
paths["vue_page"] = fmt.Sprintf("%s/view", pluginWebBasePath)
|
||||
paths["vue_page"] = outputPath(filepath.Join(pluginWebBasePath, "view"))
|
||||
|
||||
// API 路径
|
||||
paths["vue_api"] = fmt.Sprintf("%s/api", pluginWebBasePath)
|
||||
paths["vue_api"] = outputPath(filepath.Join(pluginWebBasePath, "api"))
|
||||
} else {
|
||||
// Package 模式：传统的目录结构
|
||||
// Vue 页面路径
|
||||
paths["vue_page"] = fmt.Sprintf("%s/view/%s", webBasePath, packageName)
|
||||
paths["vue_page"] = outputPath(filepath.Join(webBasePath, "view", packageName))
|
||||
|
||||
// API 路径
|
||||
paths["vue_api"] = fmt.Sprintf("%s/api/%s", webBasePath, packageName)
|
||||
paths["vue_api"] = outputPath(filepath.Join(webBasePath, "api", packageName))
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -0,0 +1,91 @@
|
||||
package mcpTool
|
||||
|
||||
import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/flipped-aurora/gin-vue-admin/server/config"
|
||||
"github.com/flipped-aurora/gin-vue-admin/server/global"
|
||||
"github.com/flipped-aurora/gin-vue-admin/server/model/system/request"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
func TestBuildDirectoryStructureReturnsRootRelativePaths(t *testing.T) {
|
||||
original := global.GVA_CONFIG.AutoCode
|
||||
t.Cleanup(func() {
|
||||
global.GVA_CONFIG.AutoCode = original
|
||||
})
|
||||
|
||||
root := filepath.Join(t.TempDir(), "repo")
|
||||
global.GVA_CONFIG.AutoCode = config.Autocode{
|
||||
Root: root,
|
||||
Server: "server",
|
||||
Web: "web",
|
||||
Module: "demo-module",
|
||||
}
|
||||
|
||||
paths := (&GVAExecutor{}).buildDirectoryStructure(&ExecutionPlan{
|
||||
PackageName: "demo",
|
||||
PackageType: "package",
|
||||
})
|
||||
|
||||
require.Equal(t, "server/api/v1/demo", paths["api"])
|
||||
require.Equal(t, "server/service/demo", paths["service"])
|
||||
require.Equal(t, "server/model/demo", paths["model"])
|
||||
require.Equal(t, "web/view/demo", paths["vue_page"])
|
||||
require.Equal(t, "web/api/demo", paths["vue_api"])
|
||||
require.NotContains(t, filepath.ToSlash(paths["api"]), filepath.ToSlash(root))
|
||||
}
|
||||
|
||||
func TestCollectExpectedFilePathsReturnsRootRelativePaths(t *testing.T) {
|
||||
original := global.GVA_CONFIG.AutoCode
|
||||
t.Cleanup(func() {
|
||||
global.GVA_CONFIG.AutoCode = original
|
||||
})
|
||||
|
||||
root := filepath.Join(t.TempDir(), "repo")
|
||||
global.GVA_CONFIG.AutoCode = config.Autocode{
|
||||
Root: root,
|
||||
Server: "server",
|
||||
Web: "web",
|
||||
}
|
||||
|
||||
paths := (&GVAExecutor{}).collectExpectedFilePaths(&ExecutionPlan{
|
||||
PackageName: "demo",
|
||||
PackageType: "package",
|
||||
NeedCreatedModules: true,
|
||||
ModulesInfo: []*request.AutoCode{
|
||||
{StructName: "DemoItem"},
|
||||
},
|
||||
})
|
||||
|
||||
require.Contains(t, paths, "server/api/v1/demo/demoitem.go")
|
||||
require.Contains(t, paths, "server/service/demo/demoitem.go")
|
||||
require.Contains(t, paths, "server/model/demo/demoitem.go")
|
||||
require.Contains(t, paths, "web/view/demo/demoitem.vue")
|
||||
require.NotContains(t, strings.Join(paths, "\n"), filepath.ToSlash(root))
|
||||
}
|
||||
|
||||
func TestScanModulesInDirectoryReturnsRootRelativeFilePaths(t *testing.T) {
|
||||
original := global.GVA_CONFIG.AutoCode
|
||||
t.Cleanup(func() {
|
||||
global.GVA_CONFIG.AutoCode = original
|
||||
})
|
||||
|
||||
root := t.TempDir()
|
||||
global.GVA_CONFIG.AutoCode = config.Autocode{
|
||||
Root: root,
|
||||
Server: "server",
|
||||
}
|
||||
|
||||
modelDir := filepath.Join(root, "server", "model", "demo")
|
||||
require.NoError(t, os.MkdirAll(modelDir, 0o755))
|
||||
require.NoError(t, os.WriteFile(filepath.Join(modelDir, "demo_item.go"), []byte("package demo\n"), 0o644))
|
||||
|
||||
modules, err := (&GVAAnalyzer{}).scanModulesInDirectory(modelDir, "demo", "package")
|
||||
require.NoError(t, err)
|
||||
require.Len(t, modules, 1)
|
||||
require.Equal(t, []string{"server/model/demo/demo_item.go"}, modules[0].FilePaths)
|
||||
}
|
||||
@@ -0,0 +1,43 @@
|
||||
package mcpTool
|
||||
|
||||
import (
|
||||
"path/filepath"
|
||||
"strings"
|
||||
|
||||
"github.com/flipped-aurora/gin-vue-admin/server/global"
|
||||
)
|
||||
|
||||
func outputPath(path string) string {
|
||||
path = strings.TrimSpace(path)
|
||||
if path == "" {
|
||||
return ""
|
||||
}
|
||||
|
||||
root := strings.TrimSpace(global.GVA_CONFIG.AutoCode.Root)
|
||||
if root != "" {
|
||||
normalizedRoot := normalizeFilesystemPath(root)
|
||||
normalizedPath := normalizeFilesystemPath(path)
|
||||
|
||||
if rel, err := filepath.Rel(normalizedRoot, normalizedPath); err == nil && !isParentTraversal(rel) {
|
||||
return filepath.ToSlash(filepath.Clean(rel))
|
||||
}
|
||||
}
|
||||
|
||||
return filepath.ToSlash(filepath.Clean(path))
|
||||
}
|
||||
|
||||
func normalizeFilesystemPath(path string) string {
|
||||
cleaned := filepath.Clean(path)
|
||||
if absPath, err := filepath.Abs(cleaned); err == nil {
|
||||
return absPath
|
||||
}
|
||||
return cleaned
|
||||
}
|
||||
|
||||
func isParentTraversal(path string) bool {
|
||||
path = filepath.Clean(path)
|
||||
if path == ".." {
|
||||
return true
|
||||
}
|
||||
return strings.HasPrefix(path, ".."+string(filepath.Separator))
|
||||
}
|
||||
@@ -0,0 +1,163 @@
|
||||
package mcpTool
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"fmt"
|
||||
"strconv"
|
||||
"strings"
|
||||
|
||||
systemReq "github.com/flipped-aurora/gin-vue-admin/server/model/system/request"
|
||||
"github.com/mark3labs/mcp-go/mcp"
|
||||
)
|
||||
|
||||
func init() {
|
||||
RegisterTool(&RoleAPIAssigner{})
|
||||
}
|
||||
|
||||
type RoleAPIAssigner struct{}
|
||||
|
||||
type roleAPIAssignResponse struct {
|
||||
Success bool `json:"success"`
|
||||
Message string `json:"message"`
|
||||
AuthorityID uint `json:"authorityId"`
|
||||
Path string `json:"path"`
|
||||
Method string `json:"method"`
|
||||
Added bool `json:"added"`
|
||||
AlreadyExists bool `json:"alreadyExists"`
|
||||
TotalPolicies int `json:"totalPolicies"`
|
||||
}
|
||||
|
||||
func (a *RoleAPIAssigner) New() mcp.Tool {
|
||||
return mcp.NewTool("assign_api_to_role",
|
||||
mcp.WithDescription(`将指定API权限追加分配给角色（仅追加，不覆盖原有权限）。
|
||||
|
||||
**功能说明：**
|
||||
- 自动读取角色当前API权限
|
||||
- 若目标权限不存在则追加并保存
|
||||
- 若已存在则幂等返回成功，不重复写入
|
||||
|
||||
**适用场景：**
|
||||
- create_api后将新API授权给指定角色
|
||||
- 手动补齐某个角色缺失的API权限`),
|
||||
mcp.WithNumber("authorityId",
|
||||
mcp.Required(),
|
||||
mcp.Description("角色ID，如：888"),
|
||||
),
|
||||
mcp.WithString("path",
|
||||
mcp.Required(),
|
||||
mcp.Description("API路径，如：/user/getCustomerUserList"),
|
||||
),
|
||||
mcp.WithString("method",
|
||||
mcp.Description("HTTP方法，默认POST"),
|
||||
mcp.DefaultString("POST"),
|
||||
),
|
||||
)
|
||||
}
|
||||
|
||||
func (a *RoleAPIAssigner) Handle(ctx context.Context, request mcp.CallToolRequest) (*mcp.CallToolResult, error) {
|
||||
args := request.GetArguments()
|
||||
|
||||
authorityID, err := parseAuthorityID(args["authorityId"])
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
path, ok := args["path"].(string)
|
||||
if !ok || strings.TrimSpace(path) == "" {
|
||||
return nil, errors.New("path 参数是必需的")
|
||||
}
|
||||
method := "POST"
|
||||
if value, ok := args["method"].(string); ok && strings.TrimSpace(value) != "" {
|
||||
method = value
|
||||
}
|
||||
|
||||
path, method = normalizePolicy(path, method)
|
||||
currentResp, err := postUpstream[map[string][]systemReq.CasbinInfo](ctx, "/casbin/getPolicyPathByAuthorityId", map[string]any{
|
||||
"authorityId": authorityID,
|
||||
})
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("获取角色当前API权限失败: %w", err)
|
||||
}
|
||||
|
||||
current := currentResp.Data["paths"]
|
||||
updated, added := appendPolicyIfMissing(current, path, method)
|
||||
if added {
|
||||
if _, err = postUpstream[map[string]any](ctx, "/casbin/updateCasbin", map[string]any{
|
||||
"authorityId": authorityID,
|
||||
"casbinInfos": updated,
|
||||
}); err != nil {
|
||||
return nil, fmt.Errorf("分配API权限失败: %w", err)
|
||||
}
|
||||
}
|
||||
|
||||
msg := "权限已存在，无需重复分配"
|
||||
if added {
|
||||
msg = fmt.Sprintf("成功为角色 %d 分配权限 %s %s", authorityID, method, path)
|
||||
}
|
||||
|
||||
return textResultWithJSON("角色API权限分配结果：", roleAPIAssignResponse{
|
||||
Success: true,
|
||||
Message: msg,
|
||||
AuthorityID: authorityID,
|
||||
Path: path,
|
||||
Method: method,
|
||||
Added: added,
|
||||
AlreadyExists: !added,
|
||||
TotalPolicies: len(updated),
|
||||
})
|
||||
}
|
||||
|
||||
func parseAuthorityID(v any) (uint, error) {
|
||||
switch value := v.(type) {
|
||||
case float64:
|
||||
if value <= 0 {
|
||||
return 0, errors.New("authorityId 必须大于0")
|
||||
}
|
||||
return uint(value), nil
|
||||
case string:
|
||||
id := strings.TrimSpace(value)
|
||||
if id == "" {
|
||||
return 0, errors.New("authorityId 参数是必需的")
|
||||
}
|
||||
parsed, err := strconv.ParseUint(id, 10, 64)
|
||||
if err != nil || parsed == 0 {
|
||||
return 0, errors.New("authorityId 格式不正确")
|
||||
}
|
||||
return uint(parsed), nil
|
||||
default:
|
||||
return 0, errors.New("authorityId 参数是必需的")
|
||||
}
|
||||
}
|
||||
|
||||
func appendPolicyIfMissing(current []systemReq.CasbinInfo, path, method string) ([]systemReq.CasbinInfo, bool) {
|
||||
path, method = normalizePolicy(path, method)
|
||||
for _, policy := range current {
|
||||
p, m := normalizePolicy(policy.Path, policy.Method)
|
||||
if p == path && m == method {
|
||||
return current, false
|
||||
}
|
||||
}
|
||||
updated := make([]systemReq.CasbinInfo, 0, len(current)+1)
|
||||
updated = append(updated, current...)
|
||||
updated = append(updated, systemReq.CasbinInfo{
|
||||
Path: path,
|
||||
Method: method,
|
||||
})
|
||||
return updated, true
|
||||
}
|
||||
|
||||
func normalizePolicy(path, method string) (string, string) {
|
||||
path = strings.TrimSpace(path)
|
||||
if path == "" {
|
||||
path = "/"
|
||||
}
|
||||
if !strings.HasPrefix(path, "/") {
|
||||
path = "/" + path
|
||||
}
|
||||
method = strings.ToUpper(strings.TrimSpace(method))
|
||||
if method == "" {
|
||||
method = "POST"
|
||||
}
|
||||
return path, method
|
||||
}
|
||||
@@ -60,7 +60,7 @@ func JWTAuth() gin.HandlerFunc {
|
||||
newClaims, _ := j.ParseToken(newToken)
|
||||
c.Header("new-token", newToken)
|
||||
c.Header("new-expires-at", strconv.FormatInt(newClaims.ExpiresAt.Unix(), 10))
|
||||
utils.SetToken(c, newToken, int(dr.Seconds()/60))
|
||||
utils.SetToken(c, newToken, int(dr.Seconds()))
|
||||
if global.GVA_CONFIG.System.UseMultipoint {
|
||||
// 记录新的活跃jwt
|
||||
_ = utils.SetRedisJWT(newToken, newClaims.Username)
|
||||
|
||||
@@ -4,9 +4,26 @@ import (
|
||||
"database/sql/driver"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"strings"
|
||||
"sync"
|
||||
|
||||
"gorm.io/gorm"
|
||||
"gorm.io/gorm/schema"
|
||||
)
|
||||
|
||||
type JSONMap map[string]interface{}
|
||||
type JSONMap map[string]any
|
||||
|
||||
type JSONSlice[T any] []T
|
||||
|
||||
var mysqlJSONTypeCache sync.Map
|
||||
|
||||
func (JSONMap) GormDataType() string {
|
||||
return "json"
|
||||
}
|
||||
|
||||
func (JSONMap) GormDBDataType(db *gorm.DB, field *schema.Field) string {
|
||||
return resolveJSONDBDataType(db)
|
||||
}
|
||||
|
||||
func (m JSONMap) Value() (driver.Value, error) {
|
||||
if m == nil {
|
||||
@@ -15,17 +32,17 @@ func (m JSONMap) Value() (driver.Value, error) {
|
||||
return json.Marshal(m)
|
||||
}
|
||||
|
||||
func (m *JSONMap) Scan(value interface{}) error {
|
||||
func (m *JSONMap) Scan(value any) error {
|
||||
if value == nil {
|
||||
*m = make(map[string]interface{})
|
||||
*m = make(map[string]any)
|
||||
return nil
|
||||
}
|
||||
var err error
|
||||
switch value.(type) {
|
||||
switch typed := value.(type) {
|
||||
case []byte:
|
||||
err = json.Unmarshal(value.([]byte), m)
|
||||
err = json.Unmarshal(typed, m)
|
||||
case string:
|
||||
err = json.Unmarshal([]byte(value.(string)), m)
|
||||
err = json.Unmarshal([]byte(typed), m)
|
||||
default:
|
||||
err = errors.New("basetypes.JSONMap.Scan: invalid value type")
|
||||
}
|
||||
@@ -35,6 +52,81 @@ func (m *JSONMap) Scan(value interface{}) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
func (JSONSlice[T]) GormDataType() string {
|
||||
return "json"
|
||||
}
|
||||
|
||||
func (JSONSlice[T]) GormDBDataType(db *gorm.DB, field *schema.Field) string {
|
||||
return resolveJSONDBDataType(db)
|
||||
}
|
||||
|
||||
func (s JSONSlice[T]) Value() (driver.Value, error) {
|
||||
if s == nil {
|
||||
return nil, nil
|
||||
}
|
||||
return json.Marshal(s)
|
||||
}
|
||||
|
||||
func (s *JSONSlice[T]) Scan(value any) error {
|
||||
if value == nil {
|
||||
*s = JSONSlice[T]{}
|
||||
return nil
|
||||
}
|
||||
var err error
|
||||
switch typed := value.(type) {
|
||||
case []byte:
|
||||
err = json.Unmarshal(typed, s)
|
||||
case string:
|
||||
err = json.Unmarshal([]byte(typed), s)
|
||||
default:
|
||||
err = errors.New("basetypes.JSONSlice.Scan: invalid value type")
|
||||
}
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func resolveJSONDBDataType(db *gorm.DB) string {
|
||||
switch db.Dialector.Name() {
|
||||
case "mysql":
|
||||
if mysqlSupportsJSON(db) {
|
||||
return "JSON"
|
||||
}
|
||||
return "LONGTEXT"
|
||||
case "postgres":
|
||||
return "JSONB"
|
||||
default:
|
||||
return "JSON"
|
||||
}
|
||||
}
|
||||
|
||||
func mysqlSupportsJSON(db *gorm.DB) bool {
|
||||
sqlDB, err := db.DB()
|
||||
if err != nil {
|
||||
return true
|
||||
}
|
||||
|
||||
cacheKey := sqlDB
|
||||
if cached, ok := mysqlJSONTypeCache.Load(cacheKey); ok {
|
||||
return cached.(bool)
|
||||
}
|
||||
|
||||
supports := true
|
||||
var version string
|
||||
if err := db.Raw("SELECT VERSION()").Scan(&version).Error; err == nil {
|
||||
lowerVersion := strings.ToLower(version)
|
||||
if strings.Contains(lowerVersion, "mariadb") {
|
||||
supports = false
|
||||
} else if strings.HasPrefix(version, "5.5.") || strings.HasPrefix(version, "5.6.") {
|
||||
supports = false
|
||||
}
|
||||
}
|
||||
|
||||
mysqlJSONTypeCache.Store(cacheKey, supports)
|
||||
return supports
|
||||
}
|
||||
|
||||
type TreeNode[T any] interface {
|
||||
GetChildren() []T
|
||||
SetChildren(children T)
|
||||
|
||||
@@ -15,6 +15,8 @@ type AIWorkflowMessage struct {
|
||||
CreatedAt string `json:"createdAt"`
|
||||
}
|
||||
|
||||
type AIWorkflowMessages = common.JSONSlice[AIWorkflowMessage]
|
||||
|
||||
type SysAIWorkflowSession struct {
|
||||
global.GVA_MODEL
|
||||
UserID uint `json:"userId" gorm:"column:user_id;index;comment:用户ID"`
|
||||
@@ -24,10 +26,10 @@ type SysAIWorkflowSession struct {
|
||||
ConversationID string `json:"conversationId" gorm:"column:conversation_id;size:255;comment:Dify会话ID"`
|
||||
MessageID string `json:"messageId" gorm:"column:message_id;size:255;comment:Dify消息ID"`
|
||||
CurrentNodeID string `json:"currentNodeId" gorm:"column:current_node_id;size:64;comment:当前选中节点ID"`
|
||||
Settings common.JSONMap `json:"settings" gorm:"column:settings;type:longtext;comment:页面设置"`
|
||||
FormData common.JSONMap `json:"formData" gorm:"column:form_data;type:longtext;comment:表单数据"`
|
||||
ResultData common.JSONMap `json:"resultData" gorm:"column:result_data;type:longtext;comment:当前展示结果"`
|
||||
Messages []AIWorkflowMessage `json:"messages" gorm:"column:messages;serializer:json;type:longtext;comment:会话消息"`
|
||||
Settings common.JSONMap `json:"settings" gorm:"column:settings;comment:页面设置"`
|
||||
FormData common.JSONMap `json:"formData" gorm:"column:form_data;comment:表单数据"`
|
||||
ResultData common.JSONMap `json:"resultData" gorm:"column:result_data;comment:当前展示结果"`
|
||||
Messages AIWorkflowMessages `json:"messages" gorm:"column:messages;comment:会话消息"`
|
||||
}
|
||||
|
||||
func (s *SysAIWorkflowSession) TableName() string {
|
||||
|
||||
@@ -20,7 +20,7 @@ type SysAutoCodeHistory struct {
|
||||
BusinessDB string `json:"businessDb" gorm:"column:business_db;comment:业务库"`
|
||||
Description string `json:"description" gorm:"column:description;comment:Struct中文名称"`
|
||||
Templates map[string]string `json:"template" gorm:"serializer:json;type:text;column:templates;comment:模板信息"`
|
||||
Injections map[string]string `json:"injections" gorm:"serializer:json;type:text;column:Injections;comment:注入路径"`
|
||||
Injections map[string]string `json:"injections" gorm:"serializer:json;type:text;column:injections;comment:注入路径"`
|
||||
Flag int `json:"flag" gorm:"column:flag;comment:[0:创建,1:回滚]"`
|
||||
ApiIDs []uint `json:"apiIDs" gorm:"serializer:json;column:api_ids;comment:api表注册内容"`
|
||||
MenuID uint `json:"menuId" gorm:"column:menu_id;comment:菜单ID"`
|
||||
|
||||
@@ -0,0 +1,5 @@
|
||||
package api
|
||||
|
||||
type ApiGroup struct{}
|
||||
|
||||
var ApiGroupApp = new(ApiGroup)
|
||||
@@ -0,0 +1,73 @@
|
||||
package initialize
|
||||
|
||||
import (
|
||||
"context"
|
||||
|
||||
model "github.com/flipped-aurora/gin-vue-admin/server/model/system"
|
||||
"github.com/flipped-aurora/gin-vue-admin/server/plugin/plugin-tool/utils"
|
||||
)
|
||||
|
||||
func Api(ctx context.Context) {
|
||||
_ = ctx
|
||||
entities := []model.SysApi{
|
||||
// 代码生成器
|
||||
{Path: "/autoCode/getDB", Description: "获取数据库列表", ApiGroup: "代码生成器", Method: "GET"},
|
||||
{Path: "/autoCode/getTables", Description: "获取数据表列表", ApiGroup: "代码生成器", Method: "GET"},
|
||||
{Path: "/autoCode/getColumn", Description: "获取字段列表", ApiGroup: "代码生成器", Method: "GET"},
|
||||
{Path: "/autoCode/preview", Description: "预览自动代码", ApiGroup: "代码生成器", Method: "POST"},
|
||||
{Path: "/autoCode/createTemp", Description: "生成自动代码", ApiGroup: "代码生成器", Method: "POST"},
|
||||
{Path: "/autoCode/mcp", Description: "生成 MCP 工具", ApiGroup: "代码生成器", Method: "POST"},
|
||||
{Path: "/autoCode/mcpStatus", Description: "获取 MCP 状态", ApiGroup: "代码生成器", Method: "POST"},
|
||||
{Path: "/autoCode/mcpStart", Description: "启动 MCP", ApiGroup: "代码生成器", Method: "POST"},
|
||||
{Path: "/autoCode/mcpStop", Description: "停止 MCP", ApiGroup: "代码生成器", Method: "POST"},
|
||||
{Path: "/autoCode/mcpList", Description: "获取 MCP 工具列表", ApiGroup: "代码生成器", Method: "POST"},
|
||||
{Path: "/autoCode/mcpRoutes", Description: "获取 MCP 路由", ApiGroup: "代码生成器", Method: "POST"},
|
||||
{Path: "/autoCode/mcpTest", Description: "测试 MCP 调用", ApiGroup: "代码生成器", Method: "POST"},
|
||||
{Path: "/autoCode/pubPlug", Description: "打包插件", ApiGroup: "代码生成器", Method: "POST"},
|
||||
{Path: "/autoCode/installPlugin", Description: "安装插件", ApiGroup: "代码生成器", Method: "POST"},
|
||||
{Path: "/autoCode/removePlugin", Description: "移除插件", ApiGroup: "代码生成器", Method: "POST"},
|
||||
{Path: "/autoCode/getPluginList", Description: "获取插件列表", ApiGroup: "代码生成器", Method: "GET"},
|
||||
{Path: "/autoCode/saveAIWorkflowSession", Description: "保存 AI 工作流会话", ApiGroup: "代码生成器", Method: "POST"},
|
||||
{Path: "/autoCode/getAIWorkflowSessionList", Description: "获取 AI 工作流列表", ApiGroup: "代码生成器", Method: "POST"},
|
||||
{Path: "/autoCode/getAIWorkflowSessionDetail", Description: "获取 AI 工作流详情", ApiGroup: "代码生成器", Method: "POST"},
|
||||
{Path: "/autoCode/deleteAIWorkflowSession", Description: "删除 AI 工作流会话", ApiGroup: "代码生成器", Method: "POST"},
|
||||
{Path: "/autoCode/dumpAIWorkflowMarkdown", Description: "导出 AI 工作流 Markdown", ApiGroup: "代码生成器", Method: "POST"},
|
||||
|
||||
// 模板配置
|
||||
{Path: "/autoCode/getPackage", Description: "获取自动化包列表", ApiGroup: "模板配置", Method: "POST"},
|
||||
{Path: "/autoCode/delPackage", Description: "删除自动化包", ApiGroup: "模板配置", Method: "POST"},
|
||||
{Path: "/autoCode/createPackage", Description: "创建自动化包", ApiGroup: "模板配置", Method: "POST"},
|
||||
{Path: "/autoCode/getTemplates", Description: "获取模板列表", ApiGroup: "模板配置", Method: "GET"},
|
||||
|
||||
// 代码生成器历史
|
||||
{Path: "/autoCode/getMeta", Description: "获取自动代码历史元数据", ApiGroup: "代码生成器历史", Method: "POST"},
|
||||
{Path: "/autoCode/rollback", Description: "回滚自动代码历史", ApiGroup: "代码生成器历史", Method: "POST"},
|
||||
{Path: "/autoCode/delSysHistory", Description: "删除自动代码历史", ApiGroup: "代码生成器历史", Method: "POST"},
|
||||
{Path: "/autoCode/getSysHistory", Description: "获取自动代码历史列表", ApiGroup: "代码生成器历史", Method: "POST"},
|
||||
{Path: "/autoCode/addFunc", Description: "追加自动代码方法", ApiGroup: "代码生成器历史", Method: "POST"},
|
||||
|
||||
// skills
|
||||
{Path: "/skills/getTools", Description: "获取 AI 工具列表", ApiGroup: "skills", Method: "GET"},
|
||||
{Path: "/skills/getSkillList", Description: "获取技能列表", ApiGroup: "skills", Method: "POST"},
|
||||
{Path: "/skills/getSkillDetail", Description: "获取技能详情", ApiGroup: "skills", Method: "POST"},
|
||||
{Path: "/skills/saveSkill", Description: "保存技能", ApiGroup: "skills", Method: "POST"},
|
||||
{Path: "/skills/deleteSkill", Description: "删除技能", ApiGroup: "skills", Method: "POST"},
|
||||
{Path: "/skills/createScript", Description: "创建脚本", ApiGroup: "skills", Method: "POST"},
|
||||
{Path: "/skills/getScript", Description: "获取脚本", ApiGroup: "skills", Method: "POST"},
|
||||
{Path: "/skills/saveScript", Description: "保存脚本", ApiGroup: "skills", Method: "POST"},
|
||||
{Path: "/skills/createResource", Description: "创建资源", ApiGroup: "skills", Method: "POST"},
|
||||
{Path: "/skills/getResource", Description: "获取资源", ApiGroup: "skills", Method: "POST"},
|
||||
{Path: "/skills/saveResource", Description: "保存资源", ApiGroup: "skills", Method: "POST"},
|
||||
{Path: "/skills/createReference", Description: "创建参考资料", ApiGroup: "skills", Method: "POST"},
|
||||
{Path: "/skills/getReference", Description: "获取参考资料", ApiGroup: "skills", Method: "POST"},
|
||||
{Path: "/skills/saveReference", Description: "保存参考资料", ApiGroup: "skills", Method: "POST"},
|
||||
{Path: "/skills/createTemplate", Description: "创建模板", ApiGroup: "skills", Method: "POST"},
|
||||
{Path: "/skills/getTemplate", Description: "获取模板", ApiGroup: "skills", Method: "POST"},
|
||||
{Path: "/skills/saveTemplate", Description: "保存模板", ApiGroup: "skills", Method: "POST"},
|
||||
{Path: "/skills/getGlobalConstraint", Description: "获取全局约束", ApiGroup: "skills", Method: "POST"},
|
||||
{Path: "/skills/saveGlobalConstraint", Description: "保存全局约束", ApiGroup: "skills", Method: "POST"},
|
||||
{Path: "/skills/packageSkill", Description: "打包技能", ApiGroup: "skills", Method: "POST"},
|
||||
{Path: "/skills/downloadOnlineSkill", Description: "下载在线技能", ApiGroup: "skills", Method: "POST"},
|
||||
}
|
||||
utils.RegisterApis(entities...)
|
||||
}
|
||||
@@ -0,0 +1,5 @@
|
||||
package initialize
|
||||
|
||||
import "context"
|
||||
|
||||
func Dictionary(context.Context) {}
|
||||
@@ -0,0 +1,23 @@
|
||||
package initialize
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
|
||||
"github.com/flipped-aurora/gin-vue-admin/server/global"
|
||||
autoModel "github.com/flipped-aurora/gin-vue-admin/server/plugin/auto/model"
|
||||
"github.com/pkg/errors"
|
||||
"go.uber.org/zap"
|
||||
)
|
||||
|
||||
func Gorm(ctx context.Context) {
|
||||
err := global.GVA_DB.WithContext(ctx).AutoMigrate(
|
||||
new(autoModel.SysAIWorkflowSession),
|
||||
new(autoModel.SysAutoCodeHistory),
|
||||
new(autoModel.SysAutoCodePackage),
|
||||
)
|
||||
if err != nil {
|
||||
err = errors.Wrap(err, "register auto plugin tables failed")
|
||||
zap.L().Error(fmt.Sprintf("%+v", err))
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,128 @@
|
||||
package initialize
|
||||
|
||||
import (
|
||||
"context"
|
||||
|
||||
model "github.com/flipped-aurora/gin-vue-admin/server/model/system"
|
||||
"github.com/flipped-aurora/gin-vue-admin/server/plugin/plugin-tool/utils"
|
||||
)
|
||||
|
||||
func Menu(ctx context.Context) {
|
||||
_ = ctx
|
||||
entities := []model.SysBaseMenu{
|
||||
{
|
||||
ParentId: 0,
|
||||
Path: "programmingAssistant",
|
||||
Name: "AutoRoot",
|
||||
Hidden: false,
|
||||
Component: "view/routerHolder.vue",
|
||||
Sort: 91,
|
||||
Meta: model.Meta{Title: "编程辅助", Icon: "cpu"},
|
||||
},
|
||||
{
|
||||
Path: "autoCode",
|
||||
Name: "AutoCode",
|
||||
Hidden: false,
|
||||
Component: "plugin/auto/view/autoCode/index.vue",
|
||||
Sort: 1,
|
||||
Meta: model.Meta{Title: "自动代码", Icon: "magic-stick"},
|
||||
},
|
||||
{
|
||||
Path: "autoPkg",
|
||||
Name: "AutoPkg",
|
||||
Hidden: false,
|
||||
Component: "plugin/auto/view/autoPkg/autoPkg.vue",
|
||||
Sort: 2,
|
||||
Meta: model.Meta{Title: "自动化包", Icon: "files"},
|
||||
},
|
||||
{
|
||||
Path: "formCreate",
|
||||
Name: "formCreate",
|
||||
Hidden: false,
|
||||
Component: "view/systemTools/formCreate/index.vue",
|
||||
Sort: 3,
|
||||
Meta: model.Meta{Title: "表单生成器", Icon: "magic-stick", KeepAlive: true},
|
||||
},
|
||||
{
|
||||
Path: "aiWorkflow",
|
||||
Name: "AIWorkflow",
|
||||
Hidden: false,
|
||||
Component: "plugin/auto/view/aiWorkflow/index.vue",
|
||||
Sort: 4,
|
||||
Meta: model.Meta{Title: "AI 工作流", Icon: "memo"},
|
||||
},
|
||||
{
|
||||
Path: "autoCodeEdit/:id",
|
||||
Name: "autoCodeEdit",
|
||||
Hidden: true,
|
||||
Component: "view/systemTools/autoCode/index.vue",
|
||||
Sort: 0,
|
||||
Meta: model.Meta{Title: "自动化代码-${id}", Icon: "magic-stick"},
|
||||
},
|
||||
{
|
||||
Path: "exportTemplate",
|
||||
Name: "exportTemplate",
|
||||
Hidden: false,
|
||||
Component: "view/systemTools/exportTemplate/exportTemplate.vue",
|
||||
Sort: 5,
|
||||
Meta: model.Meta{Title: "导出模板", Icon: "reading"},
|
||||
},
|
||||
{
|
||||
Path: "mcp",
|
||||
Name: "MCP",
|
||||
Hidden: false,
|
||||
Component: "plugin/auto/view/autoCode/mcp.vue",
|
||||
Sort: 6,
|
||||
Meta: model.Meta{Title: "MCP 工具", Icon: "monitor"},
|
||||
},
|
||||
{
|
||||
Path: "mcpTest",
|
||||
Name: "MCPTest",
|
||||
Hidden: false,
|
||||
Component: "plugin/auto/view/autoCode/mcpTest.vue",
|
||||
Sort: 5,
|
||||
Meta: model.Meta{Title: "MCP 测试", Icon: "connection"},
|
||||
},
|
||||
{
|
||||
Path: "installPlugin",
|
||||
Name: "AutoInstallPlugin",
|
||||
Hidden: false,
|
||||
Component: "plugin/auto/view/installPlugin/index.vue",
|
||||
Sort: 6,
|
||||
Meta: model.Meta{Title: "插件安装", Icon: "upload-filled"},
|
||||
},
|
||||
{
|
||||
Path: "pubPlug",
|
||||
Name: "PubPlug",
|
||||
Hidden: false,
|
||||
Component: "plugin/auto/view/pubPlug/pubPlug.vue",
|
||||
Sort: 7,
|
||||
Meta: model.Meta{Title: "插件打包", Icon: "box"},
|
||||
},
|
||||
{
|
||||
Path: "skills",
|
||||
Name: "Skills",
|
||||
Hidden: false,
|
||||
Component: "plugin/auto/view/skills/index.vue",
|
||||
Sort: 8,
|
||||
Meta: model.Meta{Title: "技能管理", Icon: "edit-pen"},
|
||||
},
|
||||
{
|
||||
Path: "picture",
|
||||
Name: "picture",
|
||||
Hidden: false,
|
||||
Component: "view/systemTools/autoCode/picture.vue",
|
||||
Sort: 10,
|
||||
Meta: model.Meta{Title: "AI页面绘制", Icon: "picture-filled"},
|
||||
},
|
||||
{
|
||||
Path: "autoCodeAdmin",
|
||||
Name: "AutoCodeAdmin",
|
||||
Hidden: true,
|
||||
Component: "plugin/auto/view/autoCodeAdmin/index.vue",
|
||||
Sort: 9,
|
||||
Meta: model.Meta{Title: "自动代码管理", Icon: "setting"},
|
||||
},
|
||||
}
|
||||
utils.RegisterMenus(entities...)
|
||||
}
|
||||
@@ -0,0 +1,22 @@
|
||||
package initialize
|
||||
|
||||
import (
|
||||
"github.com/flipped-aurora/gin-vue-admin/server/global"
|
||||
"github.com/flipped-aurora/gin-vue-admin/server/middleware"
|
||||
"github.com/flipped-aurora/gin-vue-admin/server/plugin/auto/router"
|
||||
"github.com/gin-gonic/gin"
|
||||
)
|
||||
|
||||
func Router(engine *gin.Engine) {
|
||||
InitializeRouter(engine)
|
||||
}
|
||||
|
||||
func InitializeRouter(engine *gin.Engine) {
|
||||
public := engine.Group(global.GVA_CONFIG.System.RouterPrefix).Group("")
|
||||
private := engine.Group(global.GVA_CONFIG.System.RouterPrefix).Group("")
|
||||
private.Use(middleware.JWTAuth()).Use(middleware.CasbinHandler())
|
||||
|
||||
router.RouterGroupApp.InitAutoCodeRouter(private, public)
|
||||
router.RouterGroupApp.InitAutoCodeHistoryRouter(private)
|
||||
router.RouterGroupApp.InitSkillsRouter(private, public)
|
||||
}
|
||||
@@ -0,0 +1,32 @@
|
||||
package initialize
|
||||
|
||||
import (
|
||||
"testing"
|
||||
|
||||
"github.com/gin-gonic/gin"
|
||||
)
|
||||
|
||||
func TestInitializeRouterRegistersAutoCompatibilityPrefixes(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
engine := gin.New()
|
||||
|
||||
InitializeRouter(engine)
|
||||
|
||||
foundAutoCode := false
|
||||
foundSkills := false
|
||||
for _, route := range engine.Routes() {
|
||||
if route.Path == "/autoCode/getDB" {
|
||||
foundAutoCode = true
|
||||
}
|
||||
if route.Path == "/skills/getTools" {
|
||||
foundSkills = true
|
||||
}
|
||||
}
|
||||
|
||||
if !foundAutoCode {
|
||||
t.Fatalf("expected /autoCode/getDB to be registered by plugin router")
|
||||
}
|
||||
if !foundSkills {
|
||||
t.Fatalf("expected /skills/getTools to be registered by plugin router")
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,37 @@
|
||||
package model
|
||||
|
||||
import (
|
||||
"github.com/flipped-aurora/gin-vue-admin/server/global"
|
||||
common "github.com/flipped-aurora/gin-vue-admin/server/model/common"
|
||||
)
|
||||
|
||||
type AIWorkflowMessage struct {
|
||||
ID string `json:"id"`
|
||||
Role string `json:"role"`
|
||||
Content string `json:"content"`
|
||||
Snapshot common.JSONMap `json:"snapshot"`
|
||||
ConversationID string `json:"conversationId"`
|
||||
MessageID string `json:"messageId"`
|
||||
CreatedAt string `json:"createdAt"`
|
||||
}
|
||||
|
||||
type AIWorkflowMessages = common.JSONSlice[AIWorkflowMessage]
|
||||
|
||||
type SysAIWorkflowSession struct {
|
||||
global.GVA_MODEL
|
||||
UserID uint `json:"userId" gorm:"column:user_id;index;comment:用户ID"`
|
||||
Tab string `json:"tab" gorm:"column:tab;size:32;index;comment:会话类型"`
|
||||
Title string `json:"title" gorm:"column:title;size:255;comment:会话标题"`
|
||||
Summary string `json:"summary" gorm:"column:summary;type:text;comment:摘要"`
|
||||
ConversationID string `json:"conversationId" gorm:"column:conversation_id;size:255;comment:Dify会话ID"`
|
||||
MessageID string `json:"messageId" gorm:"column:message_id;size:255;comment:Dify消息ID"`
|
||||
CurrentNodeID string `json:"currentNodeId" gorm:"column:current_node_id;size:64;comment:当前选中节点ID"`
|
||||
Settings common.JSONMap `json:"settings" gorm:"column:settings;comment:页面设置"`
|
||||
FormData common.JSONMap `json:"formData" gorm:"column:form_data;comment:表单数据"`
|
||||
ResultData common.JSONMap `json:"resultData" gorm:"column:result_data;comment:当前展示结果"`
|
||||
Messages AIWorkflowMessages `json:"messages" gorm:"column:messages;comment:会话消息"`
|
||||
}
|
||||
|
||||
func (s *SysAIWorkflowSession) TableName() string {
|
||||
return "sys_ai_workflow_sessions"
|
||||
}
|
||||
@@ -0,0 +1,65 @@
|
||||
package model
|
||||
|
||||
import (
|
||||
"os"
|
||||
"path"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
|
||||
"github.com/flipped-aurora/gin-vue-admin/server/global"
|
||||
"gorm.io/gorm"
|
||||
)
|
||||
|
||||
// SysAutoCodeHistory 自动代码生成记录，用于回滚与重放。
|
||||
type SysAutoCodeHistory struct {
|
||||
global.GVA_MODEL
|
||||
Table string `json:"tableName" gorm:"column:table_name;comment:表名"`
|
||||
Package string `json:"package" gorm:"column:package;comment:模块名或插件名"`
|
||||
Request string `json:"request" gorm:"type:text;column:request;comment:前端传入的结构化信息"`
|
||||
StructName string `json:"structName" gorm:"column:struct_name;comment:结构体名称"`
|
||||
Abbreviation string `json:"abbreviation" gorm:"column:abbreviation;comment:结构体简称"`
|
||||
BusinessDB string `json:"businessDb" gorm:"column:business_db;comment:业务库"`
|
||||
Description string `json:"description" gorm:"column:description;comment:结构体中文名"`
|
||||
Templates map[string]string `json:"template" gorm:"serializer:json;type:text;column:templates;comment:模板信息"`
|
||||
Injections map[string]string `json:"injections" gorm:"serializer:json;type:text;column:injections;comment:注入信息"`
|
||||
Flag int `json:"flag" gorm:"column:flag;comment:[0:创建,1:回滚]"`
|
||||
ApiIDs []uint `json:"apiIDs" gorm:"serializer:json;column:api_ids;comment:关联API ID"`
|
||||
MenuID uint `json:"menuId" gorm:"column:menu_id;comment:菜单ID"`
|
||||
ExportTemplateID uint `json:"exportTemplateID" gorm:"column:export_template_id;comment:导出模板ID"`
|
||||
AutoCodePackage SysAutoCodePackage `json:"autoCodePackage" gorm:"foreignKey:ID;references:PackageID"`
|
||||
PackageID uint `json:"packageID" gorm:"column:package_id;comment:包ID"`
|
||||
}
|
||||
|
||||
func (s *SysAutoCodeHistory) BeforeCreate(db *gorm.DB) error {
|
||||
_ = db
|
||||
templates := make(map[string]string, len(s.Templates))
|
||||
for key, value := range s.Templates {
|
||||
server := filepath.Join(global.GVA_CONFIG.AutoCode.Root, global.GVA_CONFIG.AutoCode.Server)
|
||||
if hasServer := strings.Index(key, server); hasServer != -1 {
|
||||
key = strings.TrimPrefix(key, server)
|
||||
keys := strings.Split(key, string(os.PathSeparator))
|
||||
key = path.Join(keys...)
|
||||
}
|
||||
|
||||
web := filepath.Join(global.GVA_CONFIG.AutoCode.Root, global.GVA_CONFIG.AutoCode.WebRoot())
|
||||
if hasWeb := strings.Index(value, web); hasWeb != -1 {
|
||||
value = strings.TrimPrefix(value, web)
|
||||
values := strings.Split(value, string(os.PathSeparator))
|
||||
templates[key] = path.Join(values...)
|
||||
continue
|
||||
}
|
||||
|
||||
if hasServer := strings.Index(value, server); hasServer != -1 {
|
||||
value = strings.TrimPrefix(value, server)
|
||||
values := strings.Split(value, string(os.PathSeparator))
|
||||
templates[key] = path.Join(values...)
|
||||
continue
|
||||
}
|
||||
}
|
||||
s.Templates = templates
|
||||
return nil
|
||||
}
|
||||
|
||||
func (s *SysAutoCodeHistory) TableName() string {
|
||||
return "sys_auto_code_histories"
|
||||
}
|
||||
@@ -0,0 +1,16 @@
|
||||
package model
|
||||
|
||||
import "github.com/flipped-aurora/gin-vue-admin/server/global"
|
||||
|
||||
type SysAutoCodePackage struct {
|
||||
global.GVA_MODEL
|
||||
Desc string `json:"desc" gorm:"comment:描述"`
|
||||
Label string `json:"label" gorm:"comment:显示名称"`
|
||||
Template string `json:"template" gorm:"comment:模板"`
|
||||
PackageName string `json:"packageName" gorm:"comment:包名"`
|
||||
Module string `json:"-" example:"模块"`
|
||||
}
|
||||
|
||||
func (s *SysAutoCodePackage) TableName() string {
|
||||
return "sys_auto_code_packages"
|
||||
}
|
||||
@@ -0,0 +1,26 @@
|
||||
package model
|
||||
|
||||
type SkillMeta struct {
|
||||
Name string `json:"name" yaml:"name"`
|
||||
Description string `json:"description" yaml:"description"`
|
||||
AllowedTools string `json:"allowedTools" yaml:"allowed-tools,omitempty"`
|
||||
Context string `json:"context" yaml:"context,omitempty"`
|
||||
Agent string `json:"agent" yaml:"agent,omitempty"`
|
||||
}
|
||||
|
||||
type SkillDetail struct {
|
||||
Tool string `json:"tool"`
|
||||
Skill string `json:"skill"`
|
||||
Meta SkillMeta `json:"meta"`
|
||||
Markdown string `json:"markdown"`
|
||||
Scripts []string `json:"scripts"`
|
||||
Resources []string `json:"resources"`
|
||||
References []string `json:"references"`
|
||||
Templates []string `json:"templates"`
|
||||
}
|
||||
|
||||
type SkillTool struct {
|
||||
Key string `json:"key"`
|
||||
Label string `json:"label"`
|
||||
}
|
||||
|
||||
@@ -0,0 +1,26 @@
|
||||
package auto
|
||||
|
||||
import (
|
||||
"context"
|
||||
|
||||
"github.com/flipped-aurora/gin-vue-admin/server/plugin/auto/initialize"
|
||||
interfaces "github.com/flipped-aurora/gin-vue-admin/server/utils/plugin/v2"
|
||||
"github.com/gin-gonic/gin"
|
||||
)
|
||||
|
||||
var Plugin = new(plugin)
|
||||
|
||||
type plugin struct{}
|
||||
|
||||
func init() {
|
||||
interfaces.Register(Plugin)
|
||||
}
|
||||
|
||||
func (p *plugin) Register(engine *gin.Engine) {
|
||||
ctx := context.Background()
|
||||
initialize.Api(ctx)
|
||||
initialize.Menu(ctx)
|
||||
initialize.Dictionary(ctx)
|
||||
initialize.Gorm(ctx)
|
||||
initialize.Router(engine)
|
||||
}
|
||||
@@ -0,0 +1,20 @@
|
||||
package router
|
||||
|
||||
import api "github.com/flipped-aurora/gin-vue-admin/server/api/v1"
|
||||
|
||||
type RouterGroup struct {
|
||||
AutoCodeRouter
|
||||
SkillsRouter
|
||||
}
|
||||
|
||||
var (
|
||||
autoCodeApi = api.ApiGroupApp.SystemApiGroup.AutoCodeApi
|
||||
autoCodePluginApi = api.ApiGroupApp.SystemApiGroup.AutoCodePluginApi
|
||||
autocodeHistoryApi = api.ApiGroupApp.SystemApiGroup.AutoCodeHistoryApi
|
||||
autoCodePackageApi = api.ApiGroupApp.SystemApiGroup.AutoCodePackageApi
|
||||
autoCodeTemplateApi = api.ApiGroupApp.SystemApiGroup.AutoCodeTemplateApi
|
||||
skillsApi = api.ApiGroupApp.SystemApiGroup.SkillsApi
|
||||
aiWorkflowSessionApi = api.ApiGroupApp.SystemApiGroup.AIWorkflowSessionApi
|
||||
)
|
||||
|
||||
var RouterGroupApp = new(RouterGroup)
|
||||
@@ -0,0 +1,55 @@
|
||||
package router
|
||||
|
||||
import "github.com/gin-gonic/gin"
|
||||
|
||||
type AutoCodeRouter struct{}
|
||||
|
||||
func (s *AutoCodeRouter) InitAutoCodeRouter(Router *gin.RouterGroup, RouterPublic *gin.RouterGroup) {
|
||||
autoCodeRouter := Router.Group("autoCode")
|
||||
publicAutoCodeRouter := RouterPublic.Group("autoCode")
|
||||
{
|
||||
autoCodeRouter.GET("getDB", autoCodeApi.GetDB)
|
||||
autoCodeRouter.GET("getTables", autoCodeApi.GetTables)
|
||||
autoCodeRouter.GET("getColumn", autoCodeApi.GetColumn)
|
||||
}
|
||||
{
|
||||
autoCodeRouter.POST("preview", autoCodeTemplateApi.Preview)
|
||||
autoCodeRouter.POST("createTemp", autoCodeTemplateApi.Create)
|
||||
autoCodeRouter.POST("addFunc", autoCodeTemplateApi.AddFunc)
|
||||
}
|
||||
{
|
||||
autoCodeRouter.POST("mcp", autoCodeTemplateApi.MCP)
|
||||
autoCodeRouter.POST("mcpStatus", autoCodeTemplateApi.MCPStatus)
|
||||
autoCodeRouter.POST("mcpStart", autoCodeTemplateApi.MCPStart)
|
||||
autoCodeRouter.POST("mcpStop", autoCodeTemplateApi.MCPStop)
|
||||
autoCodeRouter.POST("mcpList", autoCodeTemplateApi.MCPList)
|
||||
autoCodeRouter.POST("mcpRoutes", autoCodeTemplateApi.MCPRoutes)
|
||||
autoCodeRouter.POST("mcpTest", autoCodeTemplateApi.MCPTest)
|
||||
}
|
||||
{
|
||||
autoCodeRouter.POST("getPackage", autoCodePackageApi.All)
|
||||
autoCodeRouter.POST("delPackage", autoCodePackageApi.Delete)
|
||||
autoCodeRouter.POST("createPackage", autoCodePackageApi.Create)
|
||||
autoCodeRouter.POST("saveAIWorkflowSession", aiWorkflowSessionApi.Save)
|
||||
autoCodeRouter.POST("getAIWorkflowSessionList", aiWorkflowSessionApi.GetList)
|
||||
autoCodeRouter.POST("getAIWorkflowSessionDetail", aiWorkflowSessionApi.GetDetail)
|
||||
autoCodeRouter.POST("deleteAIWorkflowSession", aiWorkflowSessionApi.Delete)
|
||||
autoCodeRouter.POST("dumpAIWorkflowMarkdown", aiWorkflowSessionApi.DumpMarkdown)
|
||||
}
|
||||
{
|
||||
autoCodeRouter.GET("getTemplates", autoCodePackageApi.Templates)
|
||||
}
|
||||
{
|
||||
autoCodeRouter.POST("pubPlug", autoCodePluginApi.Packaged)
|
||||
autoCodeRouter.POST("installPlugin", autoCodePluginApi.Install)
|
||||
autoCodeRouter.POST("removePlugin", autoCodePluginApi.Remove)
|
||||
autoCodeRouter.GET("getPluginList", autoCodePluginApi.GetPluginList)
|
||||
}
|
||||
{
|
||||
publicAutoCodeRouter.POST("llmAuto", autoCodeApi.LLMAuto)
|
||||
publicAutoCodeRouter.POST("llmAutoSSE", autoCodeApi.LLMAutoSSE)
|
||||
publicAutoCodeRouter.POST("initMenu", autoCodePluginApi.InitMenu)
|
||||
publicAutoCodeRouter.POST("initAPI", autoCodePluginApi.InitAPI)
|
||||
publicAutoCodeRouter.POST("initDictionary", autoCodePluginApi.InitDictionary)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,17 @@
|
||||
package router
|
||||
|
||||
import (
|
||||
"github.com/gin-gonic/gin"
|
||||
)
|
||||
|
||||
type AutoCodeHistoryRouter struct{}
|
||||
|
||||
func (s *AutoCodeRouter) InitAutoCodeHistoryRouter(Router *gin.RouterGroup) {
|
||||
autoCodeHistoryRouter := Router.Group("autoCode")
|
||||
{
|
||||
autoCodeHistoryRouter.POST("getMeta", autocodeHistoryApi.First) // 根据 ID 获取元数据
|
||||
autoCodeHistoryRouter.POST("rollback", autocodeHistoryApi.RollBack) // 回滚
|
||||
autoCodeHistoryRouter.POST("delSysHistory", autocodeHistoryApi.Delete) // 删除回滚记录
|
||||
autoCodeHistoryRouter.POST("getSysHistory", autocodeHistoryApi.GetList) // 获取回滚记录分页
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,35 @@
|
||||
package router
|
||||
|
||||
import "github.com/gin-gonic/gin"
|
||||
|
||||
type SkillsRouter struct{}
|
||||
|
||||
func (s *SkillsRouter) InitSkillsRouter(Router *gin.RouterGroup, pubRouter *gin.RouterGroup) {
|
||||
skillsRouter := Router.Group("skills")
|
||||
skillsRouterPub := pubRouter.Group("skills")
|
||||
{
|
||||
skillsRouter.GET("getTools", skillsApi.GetTools)
|
||||
skillsRouter.POST("getSkillList", skillsApi.GetSkillList)
|
||||
skillsRouter.POST("getSkillDetail", skillsApi.GetSkillDetail)
|
||||
skillsRouter.POST("saveSkill", skillsApi.SaveSkill)
|
||||
skillsRouter.POST("deleteSkill", skillsApi.DeleteSkill)
|
||||
skillsRouter.POST("createScript", skillsApi.CreateScript)
|
||||
skillsRouter.POST("getScript", skillsApi.GetScript)
|
||||
skillsRouter.POST("saveScript", skillsApi.SaveScript)
|
||||
skillsRouter.POST("createResource", skillsApi.CreateResource)
|
||||
skillsRouter.POST("getResource", skillsApi.GetResource)
|
||||
skillsRouter.POST("saveResource", skillsApi.SaveResource)
|
||||
skillsRouter.POST("createReference", skillsApi.CreateReference)
|
||||
skillsRouter.POST("getReference", skillsApi.GetReference)
|
||||
skillsRouter.POST("saveReference", skillsApi.SaveReference)
|
||||
skillsRouter.POST("createTemplate", skillsApi.CreateTemplate)
|
||||
skillsRouter.POST("getTemplate", skillsApi.GetTemplate)
|
||||
skillsRouter.POST("saveTemplate", skillsApi.SaveTemplate)
|
||||
skillsRouter.POST("getGlobalConstraint", skillsApi.GetGlobalConstraint)
|
||||
skillsRouter.POST("saveGlobalConstraint", skillsApi.SaveGlobalConstraint)
|
||||
skillsRouter.POST("packageSkill", skillsApi.PackageSkill)
|
||||
}
|
||||
{
|
||||
skillsRouterPub.POST("downloadOnlineSkill", skillsApi.DownloadOnlineSkill)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,5 @@
|
||||
package service
|
||||
|
||||
type ServiceGroup struct{}
|
||||
|
||||
var ServiceGroupApp = new(ServiceGroup)
|
||||
@@ -0,0 +1,9 @@
|
||||
package service
|
||||
|
||||
import "testing"
|
||||
|
||||
func TestServiceGroupAppProvidesAutoServices(t *testing.T) {
|
||||
if ServiceGroupApp == nil {
|
||||
t.Fatalf("expected plugin service group to be initialized")
|
||||
}
|
||||
}
|
||||
@@ -2,4 +2,5 @@ package plugin
|
||||
|
||||
import (
|
||||
_ "github.com/flipped-aurora/gin-vue-admin/server/plugin/announcement"
|
||||
_ "github.com/flipped-aurora/gin-vue-admin/server/plugin/auto"
|
||||
)
|
||||
|
||||
@@ -571,6 +571,7 @@ func (s *autoCodePackage) templates(ctx context.Context, entity model.SysAutoCod
|
||||
Type: ast.TypePluginInitializeGorm,
|
||||
Path: filepath.Join(global.GVA_CONFIG.AutoCode.Root, global.GVA_CONFIG.AutoCode.Server, "plugin", entity.PackageName, secondDirs[j].Name(), strings.TrimSuffix(threeDirs[k].Name(), ext)),
|
||||
ImportPath: fmt.Sprintf(`"%s/plugin/%s/model"`, global.GVA_CONFIG.AutoCode.Module, entity.PackageName),
|
||||
Business: info.BusinessDB,
|
||||
StructName: info.StructName,
|
||||
PackageName: "model",
|
||||
IsNew: true,
|
||||
|
||||
@@ -0,0 +1,69 @@
|
||||
package system
|
||||
|
||||
import (
|
||||
"context"
|
||||
"path/filepath"
|
||||
"reflect"
|
||||
"runtime"
|
||||
"testing"
|
||||
|
||||
"github.com/flipped-aurora/gin-vue-admin/server/global"
|
||||
model "github.com/flipped-aurora/gin-vue-admin/server/model/system"
|
||||
"github.com/flipped-aurora/gin-vue-admin/server/model/system/request"
|
||||
utilsAst "github.com/flipped-aurora/gin-vue-admin/server/utils/ast"
|
||||
)
|
||||
|
||||
func TestPluginInitializeGormInjectionCarriesBusinessDB(t *testing.T) {
|
||||
_, currentFile, _, ok := runtime.Caller(0)
|
||||
if !ok {
|
||||
t.Fatal("runtime.Caller() failed")
|
||||
}
|
||||
repoRoot := filepath.Clean(filepath.Join(filepath.Dir(currentFile), "..", "..", ".."))
|
||||
|
||||
oldRoot := global.GVA_CONFIG.AutoCode.Root
|
||||
oldServer := global.GVA_CONFIG.AutoCode.Server
|
||||
oldModule := global.GVA_CONFIG.AutoCode.Module
|
||||
global.GVA_CONFIG.AutoCode.Root = repoRoot
|
||||
global.GVA_CONFIG.AutoCode.Server = "server"
|
||||
global.GVA_CONFIG.AutoCode.Module = "github.com/flipped-aurora/gin-vue-admin/server"
|
||||
defer func() {
|
||||
global.GVA_CONFIG.AutoCode.Root = oldRoot
|
||||
global.GVA_CONFIG.AutoCode.Server = oldServer
|
||||
global.GVA_CONFIG.AutoCode.Module = oldModule
|
||||
}()
|
||||
|
||||
info := request.AutoCode{
|
||||
Package: "demoPlugin",
|
||||
PackageName: "demo",
|
||||
HumpPackageName: "demo",
|
||||
StructName: "Demo",
|
||||
Abbreviation: "demo",
|
||||
BusinessDB: "bizdb",
|
||||
GenerateServer: true,
|
||||
}
|
||||
entity := model.SysAutoCodePackage{
|
||||
Template: "plugin",
|
||||
PackageName: info.Package,
|
||||
}
|
||||
|
||||
_, asts, _, err := AutoCodePackage.templates(context.Background(), entity, info, false)
|
||||
if err != nil {
|
||||
t.Fatalf("templates() error = %v", err)
|
||||
}
|
||||
|
||||
var pluginInitializeGorm *utilsAst.PluginInitializeGorm
|
||||
for _, injection := range asts {
|
||||
if candidate, ok := injection.(*utilsAst.PluginInitializeGorm); ok {
|
||||
pluginInitializeGorm = candidate
|
||||
break
|
||||
}
|
||||
}
|
||||
if pluginInitializeGorm == nil {
|
||||
t.Fatal("expected plugin initialize gorm injection")
|
||||
}
|
||||
|
||||
businessField := reflect.ValueOf(pluginInitializeGorm).Elem().FieldByName("Business")
|
||||
if !businessField.IsValid() || businessField.String() != info.BusinessDB {
|
||||
t.Fatalf("expected PluginInitializeGorm.Business = %q, got %v", info.BusinessDB, businessField)
|
||||
}
|
||||
}
|
||||
@@ -337,6 +337,9 @@ func (s *autoCodeTemplate) getTemplateStr(t string, info request.AutoFunc) (stri
|
||||
}
|
||||
|
||||
func (s *autoCodeTemplate) addTemplateToAst(t string, info request.AutoFunc) error {
|
||||
if !isSafeFileName(info.HumpPackageName) {
|
||||
return fmt.Errorf("文件名包含非法字符，拒绝写入")
|
||||
}
|
||||
tPath := filepath.Join(global.GVA_CONFIG.AutoCode.Root, global.GVA_CONFIG.AutoCode.Server, "router", info.Package, info.HumpPackageName+".go")
|
||||
funcName := fmt.Sprintf("Init%sRouter", info.StructName)
|
||||
|
||||
@@ -401,6 +404,9 @@ func (s *autoCodeTemplate) addTemplateToAst(t string, info request.AutoFunc) err
|
||||
}
|
||||
|
||||
func (s *autoCodeTemplate) addTemplateToFile(t string, info request.AutoFunc) error {
|
||||
if !isSafeFileName(info.HumpPackageName) || !isSafeFileName(info.PackageName) {
|
||||
return fmt.Errorf("文件名包含非法字符，拒绝写入")
|
||||
}
|
||||
getTemplateStr, err := s.getTemplateStr(t, info)
|
||||
if err != nil {
|
||||
return err
|
||||
|
||||
@@ -66,7 +66,13 @@ func (casbinService *CasbinService) UpdateCasbin(adminAuthorityID, AuthorityID u
|
||||
return nil
|
||||
} // 设置空权限无需调用 AddPolicies 方法
|
||||
e := utils.GetCasbin()
|
||||
success, _ := e.AddPolicies(rules)
|
||||
if e == nil {
|
||||
return errors.New("casbin enforcer 初始化失败")
|
||||
}
|
||||
success, err := e.AddPolicies(rules)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if !success {
|
||||
return errors.New("存在相同api,添加失败,请联系管理员")
|
||||
}
|
||||
@@ -89,6 +95,9 @@ func (casbinService *CasbinService) UpdateCasbinApi(oldPath string, newPath stri
|
||||
}
|
||||
|
||||
e := utils.GetCasbin()
|
||||
if e == nil {
|
||||
return errors.New("casbin enforcer 初始化失败")
|
||||
}
|
||||
return e.LoadPolicy()
|
||||
}
|
||||
|
||||
@@ -100,6 +109,9 @@ func (casbinService *CasbinService) UpdateCasbinApi(oldPath string, newPath stri
|
||||
|
||||
func (casbinService *CasbinService) GetPolicyPathByAuthorityId(AuthorityID uint) (pathMaps []request.CasbinInfo) {
|
||||
e := utils.GetCasbin()
|
||||
if e == nil {
|
||||
return pathMaps
|
||||
}
|
||||
authorityId := strconv.Itoa(int(AuthorityID))
|
||||
list, _ := e.GetFilteredPolicy(0, authorityId)
|
||||
for _, v := range list {
|
||||
@@ -119,6 +131,9 @@ func (casbinService *CasbinService) GetPolicyPathByAuthorityId(AuthorityID uint)
|
||||
|
||||
func (casbinService *CasbinService) ClearCasbin(v int, p ...string) bool {
|
||||
e := utils.GetCasbin()
|
||||
if e == nil {
|
||||
return false
|
||||
}
|
||||
success, _ := e.RemoveFilteredPolicy(v, p...)
|
||||
return success
|
||||
}
|
||||
@@ -168,6 +183,9 @@ func (casbinService *CasbinService) AddPolicies(db *gorm.DB, rules [][]string) e
|
||||
|
||||
func (casbinService *CasbinService) FreshCasbin() (err error) {
|
||||
e := utils.GetCasbin()
|
||||
if e == nil {
|
||||
return errors.New("casbin enforcer 初始化失败")
|
||||
}
|
||||
err = e.LoadPolicy()
|
||||
return err
|
||||
}
|
||||
|
||||
@@ -11,6 +11,14 @@ import (
|
||||
"sort"
|
||||
)
|
||||
|
||||
// dbReadyCallback 数据库就绪回调函数，由 initialize 包注入
|
||||
var dbReadyCallback func()
|
||||
|
||||
// SetDBReadyCallback 设置数据库就绪回调
|
||||
func SetDBReadyCallback(callback func()) {
|
||||
dbReadyCallback = callback
|
||||
}
|
||||
|
||||
const (
|
||||
Mysql = "mysql"
|
||||
Pgsql = "pgsql"
|
||||
@@ -135,6 +143,12 @@ func (initDBService *InitDBService) InitDB(conf request.InitDB) (err error) {
|
||||
}
|
||||
initializers = initSlice{}
|
||||
cache = map[string]*orderedInitializer{}
|
||||
|
||||
// 通知数据库已就绪，触发插件注册
|
||||
if dbReadyCallback != nil {
|
||||
dbReadyCallback()
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
|
||||
@@ -78,6 +78,8 @@ func (i *initApi) InitializeData(ctx context.Context) (context.Context, error) {
|
||||
{ApiGroup: "api", Method: "GET", Path: "/api/getApiGroups", Description: "获取路由组"},
|
||||
{ApiGroup: "api", Method: "POST", Path: "/api/enterSyncApi", Description: "确认同步API"},
|
||||
{ApiGroup: "api", Method: "POST", Path: "/api/ignoreApi", Description: "忽略API"},
|
||||
{ApiGroup: "api", Method: "GET", Path: "/api/getApiRoles", Description: "获取指定API关联角色列表"},
|
||||
{ApiGroup: "api", Method: "POST", Path: "/api/setApiRoles", Description: "全量覆盖API关联角色列表"},
|
||||
|
||||
{ApiGroup: "角色", Method: "POST", Path: "/authority/copyAuthority", Description: "拷贝角色"},
|
||||
{ApiGroup: "角色", Method: "POST", Path: "/authority/createAuthority", Description: "创建角色"},
|
||||
@@ -100,6 +102,8 @@ func (i *initApi) InitializeData(ctx context.Context) (context.Context, error) {
|
||||
{ApiGroup: "菜单", Method: "POST", Path: "/menu/getBaseMenuTree", Description: "获取用户动态路由"},
|
||||
{ApiGroup: "菜单", Method: "POST", Path: "/menu/getMenuAuthority", Description: "获取指定角色menu"},
|
||||
{ApiGroup: "菜单", Method: "POST", Path: "/menu/addMenuAuthority", Description: "增加menu和角色关联关系"},
|
||||
{ApiGroup: "菜单", Method: "GET", Path: "/menu/getMenuRoles", Description: "获取菜单关联角色列表"},
|
||||
{ApiGroup: "菜单", Method: "POST", Path: "/menu/setMenuRoles", Description: "全量覆盖菜单关联角色列表"},
|
||||
|
||||
{ApiGroup: "分片上传", Method: "GET", Path: "/fileUploadAndDownload/findFile", Description: "寻找目标文件（秒传）"},
|
||||
{ApiGroup: "分片上传", Method: "POST", Path: "/fileUploadAndDownload/breakpointContinue", Description: "断点续传"},
|
||||
@@ -156,6 +160,7 @@ func (i *initApi) InitializeData(ctx context.Context) (context.Context, error) {
|
||||
{ApiGroup: "代码生成器", Method: "POST", Path: "/autoCode/mcpStatus", Description: "获取 MCP 独立服务状态"},
|
||||
{ApiGroup: "代码生成器", Method: "POST", Path: "/autoCode/mcpStart", Description: "启动 MCP 独立服务"},
|
||||
{ApiGroup: "代码生成器", Method: "POST", Path: "/autoCode/mcpStop", Description: "停用 MCP 独立服务"},
|
||||
{ApiGroup: "代码生成器", Method: "POST", Path: "/autoCode/mcpRoutes", Description: "获取 MCP 路由列表"},
|
||||
{ApiGroup: "代码生成器", Method: "POST", Path: "/autoCode/mcpTest", Description: "MCP Tool 管理"},
|
||||
{ApiGroup: "代码生成器", Method: "POST", Path: "/autoCode/mcpList", Description: "获取 MCP ToolList"},
|
||||
{ApiGroup: "代码生成器", Method: "POST", Path: "/autoCode/saveAIWorkflowSession", Description: "保存AI需求工作流会话"},
|
||||
|
||||
@@ -67,6 +67,8 @@ func (i *initCasbin) InitializeData(ctx context.Context) (context.Context, error
|
||||
{Ptype: "p", V0: "888", V1: "/api/getApiGroups", V2: "GET"},
|
||||
{Ptype: "p", V0: "888", V1: "/api/enterSyncApi", V2: "POST"},
|
||||
{Ptype: "p", V0: "888", V1: "/api/ignoreApi", V2: "POST"},
|
||||
{Ptype: "p", V0: "888", V1: "/api/getApiRoles", V2: "GET"},
|
||||
{Ptype: "p", V0: "888", V1: "/api/setApiRoles", V2: "POST"},
|
||||
|
||||
{Ptype: "p", V0: "888", V1: "/authority/copyAuthority", V2: "POST"},
|
||||
{Ptype: "p", V0: "888", V1: "/authority/updateAuthority", V2: "PUT"},
|
||||
@@ -83,6 +85,8 @@ func (i *initCasbin) InitializeData(ctx context.Context) (context.Context, error
|
||||
{Ptype: "p", V0: "888", V1: "/menu/getBaseMenuTree", V2: "POST"},
|
||||
{Ptype: "p", V0: "888", V1: "/menu/addMenuAuthority", V2: "POST"},
|
||||
{Ptype: "p", V0: "888", V1: "/menu/getMenuAuthority", V2: "POST"},
|
||||
{Ptype: "p", V0: "888", V1: "/menu/getMenuRoles", V2: "GET"},
|
||||
{Ptype: "p", V0: "888", V1: "/menu/setMenuRoles", V2: "POST"},
|
||||
{Ptype: "p", V0: "888", V1: "/menu/deleteBaseMenu", V2: "POST"},
|
||||
{Ptype: "p", V0: "888", V1: "/menu/updateBaseMenu", V2: "POST"},
|
||||
{Ptype: "p", V0: "888", V1: "/menu/getBaseMenuById", V2: "POST"},
|
||||
@@ -168,6 +172,7 @@ func (i *initCasbin) InitializeData(ctx context.Context) (context.Context, error
|
||||
{Ptype: "p", V0: "888", V1: "/autoCode/mcpStatus", V2: "POST"},
|
||||
{Ptype: "p", V0: "888", V1: "/autoCode/mcpStart", V2: "POST"},
|
||||
{Ptype: "p", V0: "888", V1: "/autoCode/mcpStop", V2: "POST"},
|
||||
{Ptype: "p", V0: "888", V1: "/autoCode/mcpRoutes", V2: "POST"},
|
||||
{Ptype: "p", V0: "888", V1: "/autoCode/mcpTest", V2: "POST"},
|
||||
{Ptype: "p", V0: "888", V1: "/autoCode/mcpList", V2: "POST"},
|
||||
{Ptype: "p", V0: "888", V1: "/autoCode/saveAIWorkflowSession", V2: "POST"},
|
||||
@@ -264,6 +269,8 @@ func (i *initCasbin) InitializeData(ctx context.Context) (context.Context, error
|
||||
{Ptype: "p", V0: "8881", V1: "/api/deleteApi", V2: "POST"},
|
||||
{Ptype: "p", V0: "8881", V1: "/api/updateApi", V2: "POST"},
|
||||
{Ptype: "p", V0: "8881", V1: "/api/getAllApis", V2: "POST"},
|
||||
{Ptype: "p", V0: "8881", V1: "/api/getApiRoles", V2: "GET"},
|
||||
{Ptype: "p", V0: "8881", V1: "/api/setApiRoles", V2: "POST"},
|
||||
{Ptype: "p", V0: "8881", V1: "/authority/createAuthority", V2: "POST"},
|
||||
{Ptype: "p", V0: "8881", V1: "/authority/deleteAuthority", V2: "POST"},
|
||||
{Ptype: "p", V0: "8881", V1: "/authority/getAuthorityList", V2: "POST"},
|
||||
@@ -276,6 +283,8 @@ func (i *initCasbin) InitializeData(ctx context.Context) (context.Context, error
|
||||
{Ptype: "p", V0: "8881", V1: "/menu/getBaseMenuTree", V2: "POST"},
|
||||
{Ptype: "p", V0: "8881", V1: "/menu/addMenuAuthority", V2: "POST"},
|
||||
{Ptype: "p", V0: "8881", V1: "/menu/getMenuAuthority", V2: "POST"},
|
||||
{Ptype: "p", V0: "8881", V1: "/menu/getMenuRoles", V2: "GET"},
|
||||
{Ptype: "p", V0: "8881", V1: "/menu/setMenuRoles", V2: "POST"},
|
||||
{Ptype: "p", V0: "8881", V1: "/menu/deleteBaseMenu", V2: "POST"},
|
||||
{Ptype: "p", V0: "8881", V1: "/menu/updateBaseMenu", V2: "POST"},
|
||||
{Ptype: "p", V0: "8881", V1: "/menu/getBaseMenuById", V2: "POST"},
|
||||
@@ -306,6 +315,8 @@ func (i *initCasbin) InitializeData(ctx context.Context) (context.Context, error
|
||||
{Ptype: "p", V0: "9528", V1: "/api/deleteApi", V2: "POST"},
|
||||
{Ptype: "p", V0: "9528", V1: "/api/updateApi", V2: "POST"},
|
||||
{Ptype: "p", V0: "9528", V1: "/api/getAllApis", V2: "POST"},
|
||||
{Ptype: "p", V0: "9528", V1: "/api/getApiRoles", V2: "GET"},
|
||||
{Ptype: "p", V0: "9528", V1: "/api/setApiRoles", V2: "POST"},
|
||||
|
||||
{Ptype: "p", V0: "9528", V1: "/authority/createAuthority", V2: "POST"},
|
||||
{Ptype: "p", V0: "9528", V1: "/authority/deleteAuthority", V2: "POST"},
|
||||
@@ -320,6 +331,8 @@ func (i *initCasbin) InitializeData(ctx context.Context) (context.Context, error
|
||||
{Ptype: "p", V0: "9528", V1: "/menu/getBaseMenuTree", V2: "POST"},
|
||||
{Ptype: "p", V0: "9528", V1: "/menu/addMenuAuthority", V2: "POST"},
|
||||
{Ptype: "p", V0: "9528", V1: "/menu/getMenuAuthority", V2: "POST"},
|
||||
{Ptype: "p", V0: "9528", V1: "/menu/getMenuRoles", V2: "GET"},
|
||||
{Ptype: "p", V0: "9528", V1: "/menu/setMenuRoles", V2: "POST"},
|
||||
{Ptype: "p", V0: "9528", V1: "/menu/deleteBaseMenu", V2: "POST"},
|
||||
{Ptype: "p", V0: "9528", V1: "/menu/updateBaseMenu", V2: "POST"},
|
||||
{Ptype: "p", V0: "9528", V1: "/menu/getBaseMenuById", V2: "POST"},
|
||||
@@ -345,6 +358,7 @@ func (i *initCasbin) InitializeData(ctx context.Context) (context.Context, error
|
||||
{Ptype: "p", V0: "9528", V1: "/autoCode/mcpStatus", V2: "POST"},
|
||||
{Ptype: "p", V0: "9528", V1: "/autoCode/mcpStart", V2: "POST"},
|
||||
{Ptype: "p", V0: "9528", V1: "/autoCode/mcpStop", V2: "POST"},
|
||||
{Ptype: "p", V0: "9528", V1: "/autoCode/mcpRoutes", V2: "POST"},
|
||||
{Ptype: "p", V0: "9528", V1: "/autoCode/saveAIWorkflowSession", V2: "POST"},
|
||||
{Ptype: "p", V0: "9528", V1: "/autoCode/getAIWorkflowSessionList", V2: "POST"},
|
||||
{Ptype: "p", V0: "9528", V1: "/autoCode/getAIWorkflowSessionDetail", V2: "POST"},
|
||||
|
||||
@@ -1,7 +1,12 @@
|
||||
package ast
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"fmt"
|
||||
"go/ast"
|
||||
"go/format"
|
||||
"go/parser"
|
||||
"go/token"
|
||||
"io"
|
||||
)
|
||||
|
||||
@@ -11,9 +16,10 @@ type PluginInitializeGorm struct {
|
||||
Path string // 文件路径
|
||||
ImportPath string // 导包路径
|
||||
RelativePath string // 相对路径
|
||||
Business string // 业务库
|
||||
StructName string // 结构体名称
|
||||
PackageName string // 包名
|
||||
IsNew bool // 是否使用new关键字 true: new(PackageName.StructName) false: &PackageName.StructName{}
|
||||
IsNew bool // 是否使用 new 关键字 true: new(PackageName.StructName) false: &PackageName.StructName{}
|
||||
}
|
||||
|
||||
func (a *PluginInitializeGorm) Parse(filename string, writer io.Writer) (file *ast.File, err error) {
|
||||
@@ -44,7 +50,7 @@ func (a *PluginInitializeGorm) Rollback(file *ast.File) error {
|
||||
if len(callExpr.Args) <= 1 {
|
||||
needRollBackImport = true
|
||||
}
|
||||
// 删除指定的参数
|
||||
// 删除指定参数
|
||||
for i, arg := range callExpr.Args {
|
||||
compLit, cok := arg.(*ast.CompositeLit)
|
||||
if !cok {
|
||||
@@ -76,7 +82,8 @@ func (a *PluginInitializeGorm) Rollback(file *ast.File) error {
|
||||
|
||||
func (a *PluginInitializeGorm) Injection(file *ast.File) error {
|
||||
_ = NewImport(a.ImportPath).Injection(file)
|
||||
var call *ast.CallExpr
|
||||
|
||||
var targetCall *ast.CallExpr
|
||||
ast.Inspect(file, func(n ast.Node) bool {
|
||||
callExpr, ok := n.(*ast.CallExpr)
|
||||
if !ok {
|
||||
@@ -84,22 +91,35 @@ func (a *PluginInitializeGorm) Injection(file *ast.File) error {
|
||||
}
|
||||
|
||||
selExpr, ok := callExpr.Fun.(*ast.SelectorExpr)
|
||||
if ok && selExpr.Sel.Name == "AutoMigrate" {
|
||||
call = callExpr
|
||||
if !ok || selExpr.Sel.Name != "AutoMigrate" {
|
||||
return true
|
||||
}
|
||||
|
||||
if a.isTargetAutoMigrateCall(callExpr) {
|
||||
targetCall = callExpr
|
||||
return false
|
||||
}
|
||||
|
||||
return true
|
||||
})
|
||||
|
||||
arg := &ast.CompositeLit{
|
||||
if targetCall == nil {
|
||||
targetCall = a.appendAutoMigrateBlock(file)
|
||||
}
|
||||
if targetCall == nil {
|
||||
return nil
|
||||
}
|
||||
|
||||
if a.hasModelArg(targetCall) {
|
||||
return nil
|
||||
}
|
||||
|
||||
targetCall.Args = append(targetCall.Args, &ast.CompositeLit{
|
||||
Type: &ast.SelectorExpr{
|
||||
X: &ast.Ident{Name: a.PackageName},
|
||||
Sel: &ast.Ident{Name: a.StructName},
|
||||
},
|
||||
}
|
||||
|
||||
call.Args = append(call.Args, arg)
|
||||
})
|
||||
return nil
|
||||
}
|
||||
|
||||
@@ -109,3 +129,95 @@ func (a *PluginInitializeGorm) Format(filename string, writer io.Writer, file *a
|
||||
}
|
||||
return a.Base.Format(filename, writer, file)
|
||||
}
|
||||
|
||||
func (a *PluginInitializeGorm) isTargetAutoMigrateCall(callExpr *ast.CallExpr) bool {
|
||||
selExpr, ok := callExpr.Fun.(*ast.SelectorExpr)
|
||||
if !ok || selExpr.Sel.Name != "AutoMigrate" {
|
||||
return false
|
||||
}
|
||||
return exprString(selExpr.X) == exprString(a.autoMigrateReceiverExpr())
|
||||
}
|
||||
|
||||
func (a *PluginInitializeGorm) appendAutoMigrateBlock(file *ast.File) *ast.CallExpr {
|
||||
gormFunc := FindFunction(file, "Gorm")
|
||||
if gormFunc == nil || gormFunc.Body == nil {
|
||||
return nil
|
||||
}
|
||||
|
||||
src := fmt.Sprintf(`package placeholder
|
||||
func Gorm() {
|
||||
if err = %s.AutoMigrate(); err != nil {
|
||||
err = errors.Wrap(err, "注册表失败!")
|
||||
zap.L().Error(fmt.Sprintf("%%+v", err))
|
||||
}
|
||||
}
|
||||
`, exprString(a.autoMigrateReceiverExpr()))
|
||||
|
||||
parsed, err := parser.ParseFile(token.NewFileSet(), "", src, 0)
|
||||
if err != nil || len(parsed.Decls) == 0 {
|
||||
return nil
|
||||
}
|
||||
|
||||
stmt := parsed.Decls[0].(*ast.FuncDecl).Body.List[0].(*ast.IfStmt)
|
||||
clearPosition(stmt)
|
||||
gormFunc.Body.List = append(gormFunc.Body.List, stmt)
|
||||
|
||||
assignStmt := stmt.Init.(*ast.AssignStmt)
|
||||
callExpr := assignStmt.Rhs[0].(*ast.CallExpr)
|
||||
return callExpr
|
||||
}
|
||||
|
||||
func (a *PluginInitializeGorm) autoMigrateReceiverExpr() ast.Expr {
|
||||
return &ast.CallExpr{
|
||||
Fun: &ast.SelectorExpr{
|
||||
X: a.dbExpr(),
|
||||
Sel: &ast.Ident{Name: "WithContext"},
|
||||
},
|
||||
Args: []ast.Expr{&ast.Ident{Name: "ctx"}},
|
||||
}
|
||||
}
|
||||
|
||||
func (a *PluginInitializeGorm) dbExpr() ast.Expr {
|
||||
if a.Business == "" {
|
||||
return &ast.SelectorExpr{
|
||||
X: &ast.Ident{Name: "global"},
|
||||
Sel: &ast.Ident{Name: "GVA_DB"},
|
||||
}
|
||||
}
|
||||
return &ast.CallExpr{
|
||||
Fun: &ast.SelectorExpr{
|
||||
X: &ast.Ident{Name: "global"},
|
||||
Sel: &ast.Ident{Name: "MustGetGlobalDBByDBName"},
|
||||
},
|
||||
Args: []ast.Expr{
|
||||
&ast.BasicLit{
|
||||
Kind: token.STRING,
|
||||
Value: fmt.Sprintf("\"%s\"", a.Business),
|
||||
},
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
func (a *PluginInitializeGorm) hasModelArg(callExpr *ast.CallExpr) bool {
|
||||
for _, arg := range callExpr.Args {
|
||||
compositeLit, ok := arg.(*ast.CompositeLit)
|
||||
if !ok {
|
||||
continue
|
||||
}
|
||||
selectorExpr, ok := compositeLit.Type.(*ast.SelectorExpr)
|
||||
if !ok {
|
||||
continue
|
||||
}
|
||||
packageIdent, ok := selectorExpr.X.(*ast.Ident)
|
||||
if ok && packageIdent.Name == a.PackageName && selectorExpr.Sel.Name == a.StructName {
|
||||
return true
|
||||
}
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
func exprString(expr ast.Expr) string {
|
||||
var buffer bytes.Buffer
|
||||
_ = format.Node(&buffer, token.NewFileSet(), expr)
|
||||
return buffer.String()
|
||||
}
|
||||
|
||||
@@ -0,0 +1,79 @@
|
||||
package ast
|
||||
|
||||
import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
"reflect"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestPluginInitializeGormInjectionUsesBusinessDB(t *testing.T) {
|
||||
const source = `package initialize
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
|
||||
"github.com/flipped-aurora/gin-vue-admin/server/global"
|
||||
"github.com/pkg/errors"
|
||||
"go.uber.org/zap"
|
||||
)
|
||||
|
||||
func Gorm(ctx context.Context) {
|
||||
err := global.GVA_DB.WithContext(ctx).AutoMigrate()
|
||||
if err != nil {
|
||||
err = errors.Wrap(err, "注册表失败!")
|
||||
zap.L().Error(fmt.Sprintf("%+v", err))
|
||||
}
|
||||
}
|
||||
`
|
||||
|
||||
dir := t.TempDir()
|
||||
path := filepath.Join(dir, "gorm.go")
|
||||
if err := os.WriteFile(path, []byte(source), 0o666); err != nil {
|
||||
t.Fatalf("WriteFile() error = %v", err)
|
||||
}
|
||||
|
||||
injection := &PluginInitializeGorm{
|
||||
Type: TypePluginInitializeGorm,
|
||||
Path: path,
|
||||
ImportPath: `"github.com/flipped-aurora/gin-vue-admin/server/plugin/demo/model"`,
|
||||
StructName: "Demo",
|
||||
PackageName: "model",
|
||||
IsNew: true,
|
||||
}
|
||||
|
||||
businessField := reflect.ValueOf(injection).Elem().FieldByName("Business")
|
||||
if !businessField.IsValid() {
|
||||
t.Fatal("expected PluginInitializeGorm.Business field")
|
||||
}
|
||||
businessField.SetString("bizdb")
|
||||
|
||||
file, err := injection.Parse(path, nil)
|
||||
if err != nil {
|
||||
t.Fatalf("Parse() error = %v", err)
|
||||
}
|
||||
if err := injection.Injection(file); err != nil {
|
||||
t.Fatalf("Injection() error = %v", err)
|
||||
}
|
||||
if err := injection.Format(path, nil, file); err != nil {
|
||||
t.Fatalf("Format() error = %v", err)
|
||||
}
|
||||
|
||||
content, err := os.ReadFile(path)
|
||||
if err != nil {
|
||||
t.Fatalf("ReadFile() error = %v", err)
|
||||
}
|
||||
|
||||
got := string(content)
|
||||
if !strings.Contains(got, "global.GVA_DB.WithContext(ctx).AutoMigrate()") {
|
||||
t.Fatalf("expected default gorm block to remain, got:\n%s", got)
|
||||
}
|
||||
if !strings.Contains(got, `global.MustGetGlobalDBByDBName("bizdb").WithContext(ctx).AutoMigrate(`) {
|
||||
t.Fatalf("expected gorm injection to use business db, got:\n%s", got)
|
||||
}
|
||||
if !strings.Contains(got, "model.Demo{}") {
|
||||
t.Fatalf("expected model injection, got:\n%s", got)
|
||||
}
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user