From cb97d3832d5321e008a32d65845e56e34a2af123 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?PiexlMax=28=E5=A5=87=E6=B7=BC?= <165128580+pixelmaxQm@users.noreply.github.com> Date: Thu, 28 Aug 2025 11:45:01 +0800 Subject: [PATCH] Merge pull request #2080 from flipped-aurora/v2.8.5 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 发布v2.8.5 beta 版本 --- .claude/rules/project_rules.md | 738 ++++++++++++++++++ .cursor/rules/project_rules.md | 738 ++++++++++++++++++ .trae/rules/project_rules.md | 738 ++++++++++++++++++ server/api/v1/system/sys_user.go | 2 +- server/core/server.go | 3 +- server/docs/docs.go | 2 +- server/initialize/gorm_mssql.go | 8 +- server/initialize/gorm_mysql.go | 5 +- server/initialize/gorm_oracle.go | 4 +- server/initialize/gorm_pgsql.go | 4 +- server/initialize/gorm_sqlite.go | 4 +- server/initialize/internal/gorm.go | 25 +- server/main.go | 2 +- server/mcp/api_lister.go | 165 ++++ server/mcp/menu_lister.go | 112 +++ server/model/system/sys_version.go | 2 +- .../resource/package/web/view/table.vue.tpl | 4 +- server/resource/plugin/web/view/view.vue.tpl | 4 +- server/utils/autocode/template_funcs.go | 24 +- web/limit.js | 4 +- web/openDocument.js | 2 +- web/package.json | 10 +- web/postcss.config.js | 6 - web/src/components/errorPreview/index.vue | 14 +- web/src/core/config.js | 2 +- web/src/core/gin-vue-admin.js | 3 +- web/src/main.js | 1 + web/src/style/element_visiable.scss | 3 - web/src/style/main.scss | 10 +- web/src/view/error/index.vue | 14 +- web/src/view/init/index.vue | 22 +- web/src/view/layout/aside/combinationMode.vue | 4 +- web/src/view/layout/aside/headMode.vue | 2 +- web/src/view/layout/aside/normalMode.vue | 2 +- web/src/view/layout/aside/sidebarMode.vue | 6 +- web/src/view/layout/header/tools.vue | 12 +- web/src/view/layout/index.vue | 2 +- web/src/view/layout/setting/index.vue | 8 +- web/src/view/layout/tabs/index.vue | 2 +- .../superAdmin/authority/components/menus.vue | 2 +- web/tailwind.config.js | 23 - web/uno.config.js | 26 + web/vite.config.js | 5 +- 43 files changed, 2659 insertions(+), 110 deletions(-) create mode 100644 .claude/rules/project_rules.md create mode 100644 .cursor/rules/project_rules.md create mode 100644 .trae/rules/project_rules.md create mode 100644 server/mcp/api_lister.go create mode 100644 server/mcp/menu_lister.go delete mode 100644 web/postcss.config.js delete mode 100644 web/tailwind.config.js create mode 100644 web/uno.config.js diff --git a/.claude/rules/project_rules.md b/.claude/rules/project_rules.md new file mode 100644 index 000000000..3998e9989 --- /dev/null +++ b/.claude/rules/project_rules.md @@ -0,0 +1,738 @@ +### 功能描述以及必要性描述 + +--- +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文档 +--- + +#### **角色与目标** + +你是一名资深的 Go 后端开发专家，**专精于 `gin-vue-admin` (GVA) 框架的架构与开发范式**。 + +你的核心任务是，根据需求开发**完整、生产级别的全栈功能包或插件**。你必须严格遵循 GVA 的分层架构、代码规范和核心设计模式，确保你生成的每一部分代码都能无缝集成到现有项目中。 + +--- + +### **🚀 重要提示：GVA Helper MCP 支持** + +**在开始任何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` 和 `gorm` 标签。 + +- **请求模型 (`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` 接口。 + +- **`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文件组织和暴露功能，避免循环引用 + +### 代码组织示例： + +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 + + + + ``` + +#### **3. 页面层 (`src/view/`)** + +- **职责**: 实现具体的业务页面 +- **结构**: 按业务模块组织，每个页面一个Vue文件 +- **规范**: + - **必须**使用Composition API + - **必须**进行响应式数据管理 + - **必须**处理加载状态和错误状态 + - **必须**遵循Element Plus组件规范 + +#### **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. **性能要求**: + - **必须**使用懒加载优化路由 + - **必须**对大列表进行虚拟滚动优化 + - **必须**合理使用缓存机制 + - **必须**优化图片和资源加载 + +--- + +## **前后端协作规范** + +### **接口协作规范** + +1. **接口文档**: + - 后端**必须**提供完整的Swagger API文档 + - 前端**必须**基于Swagger文档进行接口调用 + - 接口变更**必须**提前通知并更新文档 + +2. **数据格式**: + - **统一**使用JSON格式进行数据交换 + - **统一**响应格式：`{code, data, msg}` + - **统一**分页格式：`{page, pageSize, total, list}` + - **统一**时间格式：ISO 8601标准 + +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. **安全性**: 数据安全，权限控制，防止安全漏洞 + +--- + +### **建议和方案** + +基于以上规范，建议AI在开发gin-vue-admin项目时： + +1. **严格遵循分层架构**：确保前后端代码都按照规定的层次结构组织 +2. **保持代码一致性**：使用统一的命名规范、注释格式和代码风格 +3. **注重文档完整性**：确保API文档、代码注释和使用说明的完整性 +4. **优化用户体验**：关注页面加载速度、交互流畅性和错误处理 +5. **考虑扩展性**：设计时预留扩展接口，便于后续功能增强 +6. **重视安全性**：实现完善的权限控制和数据验证机制 \ No newline at end of file diff --git a/.cursor/rules/project_rules.md b/.cursor/rules/project_rules.md new file mode 100644 index 000000000..3998e9989 --- /dev/null +++ b/.cursor/rules/project_rules.md @@ -0,0 +1,738 @@ +### 功能描述以及必要性描述 + +--- +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文档 +--- + +#### **角色与目标** + +你是一名资深的 Go 后端开发专家，**专精于 `gin-vue-admin` (GVA) 框架的架构与开发范式**。 + +你的核心任务是，根据需求开发**完整、生产级别的全栈功能包或插件**。你必须严格遵循 GVA 的分层架构、代码规范和核心设计模式，确保你生成的每一部分代码都能无缝集成到现有项目中。 + +--- + +### **🚀 重要提示：GVA Helper MCP 支持** + +**在开始任何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` 和 `gorm` 标签。 + +- **请求模型 (`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` 接口。 + +- **`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文件组织和暴露功能，避免循环引用 + +### 代码组织示例： + +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 + + + + ``` + +#### **3. 页面层 (`src/view/`)** + +- **职责**: 实现具体的业务页面 +- **结构**: 按业务模块组织，每个页面一个Vue文件 +- **规范**: + - **必须**使用Composition API + - **必须**进行响应式数据管理 + - **必须**处理加载状态和错误状态 + - **必须**遵循Element Plus组件规范 + +#### **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. **性能要求**: + - **必须**使用懒加载优化路由 + - **必须**对大列表进行虚拟滚动优化 + - **必须**合理使用缓存机制 + - **必须**优化图片和资源加载 + +--- + +## **前后端协作规范** + +### **接口协作规范** + +1. **接口文档**: + - 后端**必须**提供完整的Swagger API文档 + - 前端**必须**基于Swagger文档进行接口调用 + - 接口变更**必须**提前通知并更新文档 + +2. **数据格式**: + - **统一**使用JSON格式进行数据交换 + - **统一**响应格式：`{code, data, msg}` + - **统一**分页格式：`{page, pageSize, total, list}` + - **统一**时间格式：ISO 8601标准 + +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. **安全性**: 数据安全，权限控制，防止安全漏洞 + +--- + +### **建议和方案** + +基于以上规范，建议AI在开发gin-vue-admin项目时： + +1. **严格遵循分层架构**：确保前后端代码都按照规定的层次结构组织 +2. **保持代码一致性**：使用统一的命名规范、注释格式和代码风格 +3. **注重文档完整性**：确保API文档、代码注释和使用说明的完整性 +4. **优化用户体验**：关注页面加载速度、交互流畅性和错误处理 +5. **考虑扩展性**：设计时预留扩展接口，便于后续功能增强 +6. **重视安全性**：实现完善的权限控制和数据验证机制 \ No newline at end of file diff --git a/.trae/rules/project_rules.md b/.trae/rules/project_rules.md new file mode 100644 index 000000000..3998e9989 --- /dev/null +++ b/.trae/rules/project_rules.md @@ -0,0 +1,738 @@ +### 功能描述以及必要性描述 + +--- +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文档 +--- + +#### **角色与目标** + +你是一名资深的 Go 后端开发专家，**专精于 `gin-vue-admin` (GVA) 框架的架构与开发范式**。 + +你的核心任务是，根据需求开发**完整、生产级别的全栈功能包或插件**。你必须严格遵循 GVA 的分层架构、代码规范和核心设计模式，确保你生成的每一部分代码都能无缝集成到现有项目中。 + +--- + +### **🚀 重要提示：GVA Helper MCP 支持** + +**在开始任何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` 和 `gorm` 标签。 + +- **请求模型 (`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` 接口。 + +- **`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文件组织和暴露功能，避免循环引用 + +### 代码组织示例： + +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 + + + + ``` + +#### **3. 页面层 (`src/view/`)** + +- **职责**: 实现具体的业务页面 +- **结构**: 按业务模块组织，每个页面一个Vue文件 +- **规范**: + - **必须**使用Composition API + - **必须**进行响应式数据管理 + - **必须**处理加载状态和错误状态 + - **必须**遵循Element Plus组件规范 + +#### **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. **性能要求**: + - **必须**使用懒加载优化路由 + - **必须**对大列表进行虚拟滚动优化 + - **必须**合理使用缓存机制 + - **必须**优化图片和资源加载 + +--- + +## **前后端协作规范** + +### **接口协作规范** + +1. **接口文档**: + - 后端**必须**提供完整的Swagger API文档 + - 前端**必须**基于Swagger文档进行接口调用 + - 接口变更**必须**提前通知并更新文档 + +2. **数据格式**: + - **统一**使用JSON格式进行数据交换 + - **统一**响应格式：`{code, data, msg}` + - **统一**分页格式：`{page, pageSize, total, list}` + - **统一**时间格式：ISO 8601标准 + +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. **安全性**: 数据安全，权限控制，防止安全漏洞 + +--- + +### **建议和方案** + +基于以上规范，建议AI在开发gin-vue-admin项目时： + +1. **严格遵循分层架构**：确保前后端代码都按照规定的层次结构组织 +2. **保持代码一致性**：使用统一的命名规范、注释格式和代码风格 +3. **注重文档完整性**：确保API文档、代码注释和使用说明的完整性 +4. **优化用户体验**：关注页面加载速度、交互流畅性和错误处理 +5. **考虑扩展性**：设计时预留扩展接口，便于后续功能增强 +6. **重视安全性**：实现完善的权限控制和数据验证机制 \ No newline at end of file diff --git a/server/api/v1/system/sys_user.go b/server/api/v1/system/sys_user.go index 40f09341b..9169f06ce 100644 --- a/server/api/v1/system/sys_user.go +++ b/server/api/v1/system/sys_user.go @@ -47,7 +47,7 @@ func (b *BaseApi) Login(c *gin.Context) { } var oc bool = openCaptcha == 0 || openCaptcha < interfaceToInt(v) - if oc && !store.Verify(l.CaptchaId, l.Captcha, true) { + if oc && (l.Captcha == "" || l.CaptchaId == "" || !store.Verify(l.CaptchaId, l.Captcha, true)) { // 验证码次数+1 global.BlackCache.Increment(key, 1) response.FailWithMessage("验证码错误", c) diff --git a/server/core/server.go b/server/core/server.go index 6e386e071..550150cd2 100644 --- a/server/core/server.go +++ b/server/core/server.go @@ -35,7 +35,7 @@ func RunServer() { fmt.Printf(` 欢迎使用 gin-vue-admin - 当前版本:v2.8.4 + 当前版本:v2.8.5 加群方式:微信号：shouzi_1994 QQ群：470239250 项目地址：https://github.com/flipped-aurora/gin-vue-admin 插件市场:https://plugin.gin-vue-admin.com @@ -48,6 +48,7 @@ func RunServer() { ** 版权所有方：flipped-aurora开源团队 ** ** 版权持有公司：北京翻转极光科技有限责任公司 ** ** 剔除授权标识需购买商用授权：https://gin-vue-admin.com/empower/index.html ** + ** 感谢您对Gin-Vue-Admin的支持与关注 合法授权使用更有利于项目的长久发展** `, address, address, global.GVA_CONFIG.MCP.SSEPath, address, global.GVA_CONFIG.MCP.MessagePath) initServer(address, Router, 10*time.Minute, 10*time.Minute) } diff --git a/server/docs/docs.go b/server/docs/docs.go index 669b94b6a..853db3480 100644 --- a/server/docs/docs.go +++ b/server/docs/docs.go @@ -9296,7 +9296,7 @@ const docTemplate = `{ // SwaggerInfo holds exported Swagger Info so clients can modify it var SwaggerInfo = &swag.Spec{ - Version: "v2.8.4", + Version: "v2.8.5", Host: "", BasePath: "", Schemes: []string{}, diff --git a/server/initialize/gorm_mssql.go b/server/initialize/gorm_mssql.go index e1478ea41..530275ab1 100644 --- a/server/initialize/gorm_mssql.go +++ b/server/initialize/gorm_mssql.go @@ -28,7 +28,9 @@ func GormMssql() *gorm.DB { DSN: m.Dsn(), // DSN data source name DefaultStringSize: 191, // string 类型字段的默认长度 } - if db, err := gorm.Open(sqlserver.New(mssqlConfig), internal.Gorm.Config(m.Prefix, m.Singular)); err != nil { + // 数据库配置 + general := m.GeneralDB + if db, err := gorm.Open(sqlserver.New(mssqlConfig), internal.Gorm.Config(general)); err != nil { return nil } else { db.InstanceSet("gorm:table_options", "ENGINE="+m.Engine) @@ -48,7 +50,9 @@ func GormMssqlByConfig(m config.Mssql) *gorm.DB { DSN: m.Dsn(), // DSN data source name DefaultStringSize: 191, // string 类型字段的默认长度 } - if db, err := gorm.Open(sqlserver.New(mssqlConfig), internal.Gorm.Config(m.Prefix, m.Singular)); err != nil { + // 数据库配置 + general := m.GeneralDB + if db, err := gorm.Open(sqlserver.New(mssqlConfig), internal.Gorm.Config(general)); err != nil { panic(err) } else { db.InstanceSet("gorm:table_options", "ENGINE=InnoDB") diff --git a/server/initialize/gorm_mysql.go b/server/initialize/gorm_mysql.go index 61e50ba29..cf949aa18 100644 --- a/server/initialize/gorm_mysql.go +++ b/server/initialize/gorm_mysql.go @@ -34,8 +34,9 @@ func initMysqlDatabase(m config.Mysql) *gorm.DB { DefaultStringSize: 191, // string 类型字段的默认长度 SkipInitializeWithVersion: false, // 根据版本自动配置 } - - if db, err := gorm.Open(mysql.New(mysqlConfig), internal.Gorm.Config(m.Prefix, m.Singular)); err != nil { + // 数据库配置 + general := m.GeneralDB + if db, err := gorm.Open(mysql.New(mysqlConfig), internal.Gorm.Config(general)); err != nil { panic(err) } else { db.InstanceSet("gorm:table_options", "ENGINE="+m.Engine) diff --git a/server/initialize/gorm_oracle.go b/server/initialize/gorm_oracle.go index 80fa8fa8a..9d3d66359 100644 --- a/server/initialize/gorm_oracle.go +++ b/server/initialize/gorm_oracle.go @@ -24,7 +24,9 @@ func initOracleDatabase(m config.Oracle) *gorm.DB { if m.Dbname == "" { return nil } - if db, err := gorm.Open(oracle.Open(m.Dsn()), internal.Gorm.Config(m.Prefix, m.Singular)); err != nil { + // 数据库配置 + general := m.GeneralDB + if db, err := gorm.Open(oracle.Open(m.Dsn()), internal.Gorm.Config(general)); err != nil { panic(err) } else { sqlDB, _ := db.DB() diff --git a/server/initialize/gorm_pgsql.go b/server/initialize/gorm_pgsql.go index 6abde5892..b5022db2f 100644 --- a/server/initialize/gorm_pgsql.go +++ b/server/initialize/gorm_pgsql.go @@ -30,7 +30,9 @@ func initPgSqlDatabase(p config.Pgsql) *gorm.DB { DSN: p.Dsn(), // DSN data source name PreferSimpleProtocol: false, } - if db, err := gorm.Open(postgres.New(pgsqlConfig), internal.Gorm.Config(p.Prefix, p.Singular)); err != nil { + // 数据库配置 + general := p.GeneralDB + if db, err := gorm.Open(postgres.New(pgsqlConfig), internal.Gorm.Config(general)); err != nil { panic(err) } else { sqlDB, _ := db.DB() diff --git a/server/initialize/gorm_sqlite.go b/server/initialize/gorm_sqlite.go index 9d158bf16..33510eea5 100644 --- a/server/initialize/gorm_sqlite.go +++ b/server/initialize/gorm_sqlite.go @@ -25,7 +25,9 @@ func initSqliteDatabase(s config.Sqlite) *gorm.DB { return nil } - if db, err := gorm.Open(sqlite.Open(s.Dsn()), internal.Gorm.Config(s.Prefix, s.Singular)); err != nil { + // 数据库配置 + general := s.GeneralDB + if db, err := gorm.Open(sqlite.Open(s.Dsn()), internal.Gorm.Config(general)); err != nil { panic(err) } else { sqlDB, _ := db.DB() diff --git a/server/initialize/internal/gorm.go b/server/initialize/internal/gorm.go index ebf5526c3..28f40979a 100644 --- a/server/initialize/internal/gorm.go +++ b/server/initialize/internal/gorm.go @@ -1,12 +1,12 @@ package internal import ( + "time" + "github.com/flipped-aurora/gin-vue-admin/server/config" - "github.com/flipped-aurora/gin-vue-admin/server/global" "gorm.io/gorm" "gorm.io/gorm/logger" "gorm.io/gorm/schema" - "time" ) var Gorm = new(_gorm) @@ -15,22 +15,7 @@ type _gorm struct{} // Config gorm 自定义配置 // Author [SliverHorn](https://github.com/SliverHorn) -func (g *_gorm) Config(prefix string, singular bool) *gorm.Config { - var general config.GeneralDB - switch global.GVA_CONFIG.System.DbType { - case "mysql": - general = global.GVA_CONFIG.Mysql.GeneralDB - case "pgsql": - general = global.GVA_CONFIG.Pgsql.GeneralDB - case "oracle": - general = global.GVA_CONFIG.Oracle.GeneralDB - case "sqlite": - general = global.GVA_CONFIG.Sqlite.GeneralDB - case "mssql": - general = global.GVA_CONFIG.Mssql.GeneralDB - default: - general = global.GVA_CONFIG.Mysql.GeneralDB - } +func (g *_gorm) Config(general config.GeneralDB) *gorm.Config { return &gorm.Config{ Logger: logger.New(NewWriter(general), logger.Config{ SlowThreshold: 200 * time.Millisecond, @@ -38,8 +23,8 @@ func (g *_gorm) Config(prefix string, singular bool) *gorm.Config { Colorful: true, }), NamingStrategy: schema.NamingStrategy{ - TablePrefix: prefix, - SingularTable: singular, + TablePrefix: general.Prefix, + SingularTable: general.Singular, }, DisableForeignKeyConstraintWhenMigrating: true, } diff --git a/server/main.go b/server/main.go index f5badf750..1f4c37d5c 100644 --- a/server/main.go +++ b/server/main.go @@ -21,7 +21,7 @@ import ( // @Tag.Description 用户 // @title Gin-Vue-Admin Swagger API接口文档 -// @version v2.8.4 +// @version v2.8.5 // @description 使用gin+vue进行极速开发的全栈开发基础平台 // @securityDefinitions.apikey ApiKeyAuth // @in header diff --git a/server/mcp/api_lister.go b/server/mcp/api_lister.go new file mode 100644 index 000000000..d8a87d1f1 --- /dev/null +++ b/server/mcp/api_lister.go @@ -0,0 +1,165 @@ +package mcpTool + +import ( + "context" + "encoding/json" + "fmt" + + "github.com/flipped-aurora/gin-vue-admin/server/global" + "github.com/flipped-aurora/gin-vue-admin/server/model/system" + "github.com/mark3labs/mcp-go/mcp" + "go.uber.org/zap" +) + +// 注册工具 +func init() { + // 注册工具将在enter.go中统一处理 + RegisterTool(&ApiLister{}) +} + +// ApiInfo API信息结构 +type ApiInfo struct { + ID uint `json:"id,omitempty"` // 数据库ID（仅数据库API有） + Path string `json:"path"` // API路径 + Description string `json:"description,omitempty"` // API描述 + ApiGroup string `json:"apiGroup,omitempty"` // API组 + Method string `json:"method"` // HTTP方法 + Source string `json:"source"` // 来源：database 或 gin +} + +// ApiListResponse API列表响应结构 +type ApiListResponse struct { + Success bool `json:"success"` + Message string `json:"message"` + DatabaseApis []ApiInfo `json:"databaseApis"` // 数据库中的API + GinApis []ApiInfo `json:"ginApis"` // gin框架中的API + TotalCount int `json:"totalCount"` // 总数量 +} + +// ApiLister API列表工具 +type ApiLister struct{} + +// New 创建API列表工具 +func (a *ApiLister) New() mcp.Tool { + return mcp.NewTool("list_all_apis", + mcp.WithDescription(`获取系统中所有的API接口，分为两组： + +**功能说明：** +- 返回数据库中已注册的API列表 +- 返回gin框架中实际注册的路由API列表 +- 帮助前端判断是使用现有API还是需要创建新的API,如果api在前端未使用且需要前端调用的时候，请到api文件夹下对应模块的js中添加方法并暴露给当前业务调用 + +**返回数据结构：** +- databaseApis: 数据库中的API记录（包含ID、描述、分组等完整信息） +- ginApis: gin路由中的API（仅包含路径和方法），需要AI根据路径自行揣摩路径的业务含义，例如：/api/user/:id 表示根据用户ID获取用户信息`), + ) +} + +// Handle 处理API列表请求 +func (a *ApiLister) Handle(_ context.Context, _ mcp.CallToolRequest) (*mcp.CallToolResult, error) { + + // 获取数据库中的API + databaseApis, err := a.getDatabaseApis() + if err != nil { + global.GVA_LOG.Error("获取数据库API失败", zap.Error(err)) + errorResponse := ApiListResponse{ + Success: false, + Message: "获取数据库API失败: " + err.Error(), + } + resultJSON, _ := json.Marshal(errorResponse) + return &mcp.CallToolResult{ + Content: []mcp.Content{ + mcp.TextContent{ + Type: "text", + Text: string(resultJSON), + }, + }, + }, nil + } + + // 获取gin路由中的API + ginApis, err := a.getGinApis() + if err != nil { + global.GVA_LOG.Error("获取gin路由API失败", zap.Error(err)) + errorResponse := ApiListResponse{ + Success: false, + Message: "获取gin路由API失败: " + err.Error(), + } + resultJSON, _ := json.Marshal(errorResponse) + return &mcp.CallToolResult{ + Content: []mcp.Content{ + mcp.TextContent{ + Type: "text", + Text: string(resultJSON), + }, + }, + }, nil + } + + // 构建响应 + response := ApiListResponse{ + Success: true, + Message: "获取API列表成功", + DatabaseApis: databaseApis, + GinApis: ginApis, + TotalCount: len(databaseApis) + len(ginApis), + } + + global.GVA_LOG.Info("API列表获取成功", + zap.Int("数据库API数量", len(databaseApis)), + zap.Int("gin路由API数量", len(ginApis)), + zap.Int("总数量", response.TotalCount)) + + resultJSON, err := json.Marshal(response) + if err != nil { + return nil, fmt.Errorf("序列化结果失败: %v", err) + } + + return &mcp.CallToolResult{ + Content: []mcp.Content{ + mcp.TextContent{ + Type: "text", + Text: string(resultJSON), + }, + }, + }, nil +} + +// getDatabaseApis 获取数据库中的所有API +func (a *ApiLister) getDatabaseApis() ([]ApiInfo, error) { + var apis []system.SysApi + err := global.GVA_DB.Model(&system.SysApi{}).Order("api_group ASC, path ASC").Find(&apis).Error + if err != nil { + return nil, err + } + + // 转换为ApiInfo格式 + var result []ApiInfo + for _, api := range apis { + result = append(result, ApiInfo{ + ID: api.ID, + Path: api.Path, + Description: api.Description, + ApiGroup: api.ApiGroup, + Method: api.Method, + Source: "database", + }) + } + + return result, nil +} + +// getGinApis 获取gin路由中的所有API（包含被忽略的API） +func (a *ApiLister) getGinApis() ([]ApiInfo, error) { + // 从gin路由信息中获取所有API + var result []ApiInfo + for _, route := range global.GVA_ROUTERS { + result = append(result, ApiInfo{ + Path: route.Path, + Method: route.Method, + Source: "gin", + }) + } + + return result, nil +} diff --git a/server/mcp/menu_lister.go b/server/mcp/menu_lister.go new file mode 100644 index 000000000..c04c83e92 --- /dev/null +++ b/server/mcp/menu_lister.go @@ -0,0 +1,112 @@ +package mcpTool + +import ( + "context" + "encoding/json" + "fmt" + + "github.com/flipped-aurora/gin-vue-admin/server/global" + "github.com/flipped-aurora/gin-vue-admin/server/model/system" + "github.com/mark3labs/mcp-go/mcp" + "go.uber.org/zap" +) + +// 注册工具 +func init() { + // 注册工具将在enter.go中统一处理 + RegisterTool(&MenuLister{}) +} + +// MenuListResponse 菜单列表响应结构 +type MenuListResponse struct { + Success bool `json:"success"` + Message string `json:"message"` + Menus []system.SysBaseMenu `json:"menus"` + TotalCount int `json:"totalCount"` + Description string `json:"description"` +} + +// MenuLister 菜单列表工具 +type MenuLister struct{} + +// New 创建菜单列表工具 +func (m *MenuLister) New() mcp.Tool { + return mcp.NewTool("list_all_menus", + mcp.WithDescription(`获取系统中所有菜单信息，包括菜单树结构、路由信息、组件路径等，用于前端编写vue-router时正确跳转 + +**功能说明：** +- 返回完整的菜单树形结构 +- 包含路由配置信息（path、name、component） +- 包含菜单元数据（title、icon、keepAlive等） +- 包含菜单参数和按钮配置 +- 支持父子菜单关系展示 + +**使用场景：** +- 前端路由配置：获取所有菜单信息用于配置vue-router +- 菜单权限管理：了解系统中所有可用的菜单项 +- 导航组件开发：构建动态导航菜单 +- 系统架构分析：了解系统的菜单结构和页面组织`), + ) +} + +// Handle 处理菜单列表请求 +func (m *MenuLister) Handle(_ context.Context, _ mcp.CallToolRequest) (*mcp.CallToolResult, error) { + // 获取所有基础菜单 + allMenus, err := m.getAllMenus() + if err != nil { + global.GVA_LOG.Error("获取菜单列表失败", zap.Error(err)) + return &mcp.CallToolResult{ + Content: []mcp.Content{ + mcp.TextContent{ + Type: "text", + Text: fmt.Sprintf("获取菜单列表失败: %v", err), + }, + }, + IsError: true, + }, nil + } + + // 构建返回结果 + response := MenuListResponse{ + Success: true, + Message: "获取菜单列表成功", + Menus: allMenus, + TotalCount: len(allMenus), + Description: "系统中所有菜单信息的标准列表，包含路由配置和组件信息", + } + + // 序列化响应 + responseJSON, err := json.MarshalIndent(response, "", " ") + if err != nil { + global.GVA_LOG.Error("序列化菜单响应失败", zap.Error(err)) + return &mcp.CallToolResult{ + Content: []mcp.Content{ + mcp.TextContent{ + Type: "text", + Text: fmt.Sprintf("序列化响应失败: %v", err), + }, + }, + IsError: true, + }, nil + } + + return &mcp.CallToolResult{ + Content: []mcp.Content{ + mcp.TextContent{ + Type: "text", + Text: string(responseJSON), + }, + }, + }, nil +} + +// getAllMenus 获取所有基础菜单 +func (m *MenuLister) getAllMenus() ([]system.SysBaseMenu, error) { + var menus []system.SysBaseMenu + err := global.GVA_DB.Order("sort").Preload("Parameters").Preload("MenuBtn").Find(&menus).Error + if err != nil { + return nil, err + } + return menus, nil +} + diff --git a/server/model/system/sys_version.go b/server/model/system/sys_version.go index e20cbdf24..a4d7ceb3a 100644 --- a/server/model/system/sys_version.go +++ b/server/model/system/sys_version.go @@ -11,7 +11,7 @@ type SysVersion struct { VersionName *string `json:"versionName" form:"versionName" gorm:"comment:版本名称;column:version_name;size:255;" binding:"required"` //版本名称 VersionCode *string `json:"versionCode" form:"versionCode" gorm:"comment:版本号;column:version_code;size:100;" binding:"required"` //版本号 Description *string `json:"description" form:"description" gorm:"comment:版本描述;column:description;size:500;"` //版本描述 - VersionData *string `json:"versionData" form:"versionData" gorm:"comment:版本数据JSON;column:version_data;type:text;"` //版本数据 + VersionData *string `json:"versionData" form:"versionData" gorm:"comment:版本数据JSON;column:version_data;type:longtext;"` //版本数据 } // TableName 版本管理 SysVersion自定义表名 sys_versions diff --git a/server/resource/package/web/view/table.vue.tpl b/server/resource/package/web/view/table.vue.tpl index 895ad2d4e..beadadef3 100644 --- a/server/resource/package/web/view/table.vue.tpl +++ b/server/resource/package/web/view/table.vue.tpl @@ -393,8 +393,8 @@ const searchInfo = ref({}) // 排序 const sortChange = ({ prop, order }) => { const sortMap = { - CreatedAt:"CreatedAt", - ID:"ID", + CreatedAt:"created_at", + ID:"id", {{- range .Fields}} {{- if .Table}} {{- if and .Sort}} diff --git a/server/resource/plugin/web/view/view.vue.tpl b/server/resource/plugin/web/view/view.vue.tpl index 8363bdbdb..f5b8547a1 100644 --- a/server/resource/plugin/web/view/view.vue.tpl +++ b/server/resource/plugin/web/view/view.vue.tpl @@ -388,8 +388,8 @@ const searchInfo = ref({}) // 排序 const sortChange = ({ prop, order }) => { const sortMap = { - CreatedAt:"CreatedAt", - ID:"ID", + CreatedAt:"created_at", + ID:"id", {{- range .Fields}} {{- if .Table}} {{- if and .Sort}} diff --git a/server/utils/autocode/template_funcs.go b/server/utils/autocode/template_funcs.go index 70b297886..157c992ac 100644 --- a/server/utils/autocode/template_funcs.go +++ b/server/utils/autocode/template_funcs.go @@ -46,7 +46,8 @@ func GenerateField(field systemReq.AutoCodeField) string { gormTag += "column:" + field.ColumnName + ";" - if field.DataTypeLong != "" && field.FieldType != "enum" { + // 对于int类型，根据DataTypeLong决定具体的Go类型，不使用size标签 + if field.DataTypeLong != "" && field.FieldType != "enum" && field.FieldType != "int" { gormTag += fmt.Sprintf("size:%s;", field.DataTypeLong) } @@ -85,8 +86,27 @@ func GenerateField(field systemReq.AutoCodeField) string { tagContent := fmt.Sprintf(`json:"%s" form:"%s" gorm:"%s"`, field.FieldJson, field.FieldJson, gormTag) + // 对于int类型，根据DataTypeLong决定具体的Go类型 + var fieldType string + if field.FieldType == "int" { + switch field.DataTypeLong { + case "1", "2", "3": + fieldType = "int8" + case "4", "5": + fieldType = "int16" + case "6", "7", "8", "9", "10": + fieldType = "int32" + case "11", "12", "13", "14", "15", "16", "17", "18", "19", "20": + fieldType = "int64" + default: + fieldType = "int64" + } + } else { + fieldType = field.FieldType + } + result = fmt.Sprintf(`%s *%s `+"`"+`%s`+"`"+``, - field.FieldName, field.FieldType, tagContent) + field.FieldName, fieldType, tagContent) } if field.Require { diff --git a/web/limit.js b/web/limit.js index 6ba9d4623..f23fa5121 100644 --- a/web/limit.js +++ b/web/limit.js @@ -1,6 +1,6 @@ // 运行项目前通过node执行此脚本 （此脚本与 node_modules 目录同级） -const fs = require('fs') -const path = require('path') +import fs from 'fs' +import path from 'path' const wfPath = path.resolve(__dirname, './node_modules/.bin') fs.readdir(wfPath, (err, files) => { diff --git a/web/openDocument.js b/web/openDocument.js index 1693eeebd..03a886b46 100644 --- a/web/openDocument.js +++ b/web/openDocument.js @@ -3,7 +3,7 @@ 未经授权的商用使用可能会被我们的资产搜索引擎爬取，并可能导致后续索赔。索赔金额将不低于高级授权费的十倍。请您遵守版权法律法规，尊重知识产权。 */ -var child_process = require('child_process') +import child_process from 'child_process' var url = 'https://www.gin-vue-admin.com' var cmd = '' diff --git a/web/package.json b/web/package.json index 5cc38ccbd..da978d87b 100644 --- a/web/package.json +++ b/web/package.json @@ -1,6 +1,6 @@ { "name": "gin-vue-admin", - "version": "2.8.4", + "version": "2.8.5", "private": true, "scripts": { "serve": "node openDocument.js && vite --host --mode development", @@ -9,10 +9,12 @@ "preview": "vite preview", "fix-memory-limit": "cross-env LIMIT=4096 increase-memory-limit" }, + "type": "module", "dependencies": { "@element-plus/icons-vue": "^2.3.1", "@form-create/designer": "^3.2.6", "@form-create/element-ui": "^3.2.10", + "@unocss/transformer-directives": "^66.4.2", "@vue-office/docx": "^1.6.2", "@vue-office/excel": "^1.7.11", "@vue-office/pdf": "^2.0.2", @@ -39,10 +41,9 @@ "screenfull": "^6.0.2", "sortablejs": "^1.15.3", "spark-md5": "^3.0.2", - "tailwindcss": "^3.4.10", "universal-cookie": "^7", "vform3-builds": "^3.0.10", - "vite-auto-import-svg": "^1.7.0", + "vite-auto-import-svg": "^1.9.0", "vue": "^3.5.7", "vue-cropper": "^1.1.4", "vue-echarts": "^7.0.3", @@ -55,6 +56,8 @@ "devDependencies": { "@babel/eslint-parser": "^7.25.1", "@eslint/js": "^8.56.0", + "@unocss/extractor-svelte": "^66.4.2", + "@unocss/preset-wind3": "^66.4.2", "@vitejs/plugin-legacy": "^6.0.0", "@vitejs/plugin-vue": "^5.0.3", "@vue/cli-plugin-babel": "~5.0.8", @@ -71,6 +74,7 @@ "eslint-plugin-vue": "^9.19.2", "sass": "^1.78.0", "terser": "^5.31.6", + "unocss": "^66.4.2", "vite": "^6.2.3", "vite-plugin-banner": "^0.8.0", "vite-plugin-importer": "^0.2.5", diff --git a/web/postcss.config.js b/web/postcss.config.js deleted file mode 100644 index 85f717cc0..000000000 --- a/web/postcss.config.js +++ /dev/null @@ -1,6 +0,0 @@ -module.exports = { - plugins: { - tailwindcss: {}, - autoprefixer: {} - } -} diff --git a/web/src/components/errorPreview/index.vue b/web/src/components/errorPreview/index.vue index dd08402af..d3d99b0f8 100644 --- a/web/src/components/errorPreview/index.vue +++ b/web/src/components/errorPreview/index.vue @@ -7,13 +7,13 @@

{{ displayData.title }}

- +
+ +
-
+
错误类型
@@ -45,16 +45,16 @@
- +
diff --git a/web/src/view/init/index.vue b/web/src/view/init/index.vue index 211ec4a88..5d7697648 100644 --- a/web/src/view/init/index.vue +++ b/web/src/view/init/index.vue @@ -136,7 +136,7 @@ // @ts-ignore import { initDB } from '@/api/initdb' import { reactive, ref } from 'vue' - import { ElLoading, ElMessage } from 'element-plus' + import { ElLoading, ElMessage, ElMessageBox } from 'element-plus' import { useRouter } from 'vue-router' defineOptions({ @@ -274,7 +274,25 @@ type: 'success', message: res.msg }) - router.push({ name: 'Login' }) + + // 显示AI助手配置提示弹窗 + ElMessageBox.confirm( + '已经完成基础数据库初始化！建议先进行编辑器AI助手配置，以获得更好的开发体验。', + '配置完成', + { + confirmButtonText: '查看AI配置文档', + cancelButtonText: '稍后配置', + type: 'success', + center: true + } + ).then(() => { + // 点击确认按钮，打开AI配置文档 + window.open('https://www.gin-vue-admin.com/guide/server/mcp.html', '_blank') + router.push({ name: 'Login' }) + }).catch(() => { + // 点击取消按钮或关闭弹窗，直接跳转到登录页 + router.push({ name: 'Login' }) + }) } loading.close() } catch (_) { diff --git a/web/src/view/layout/aside/combinationMode.vue b/web/src/view/layout/aside/combinationMode.vue index 3e588ce60..5584e8913 100644 --- a/web/src/view/layout/aside/combinationMode.vue +++ b/web/src/view/layout/aside/combinationMode.vue @@ -7,7 +7,7 @@ @@ -34,7 +34,7 @@ :collapse="isCollapse" :collapse-transition="false" :default-active="active" - class="border-r-0 w-full" + class="!border-r-0 w-full" unique-opened @select="(index, _, ele) => selectMenuItem(index, _, ele, false)" > diff --git a/web/src/view/layout/aside/headMode.vue b/web/src/view/layout/aside/headMode.vue index 78318ba4e..db48fc9d5 100644 --- a/web/src/view/layout/aside/headMode.vue +++ b/web/src/view/layout/aside/headMode.vue @@ -6,7 +6,7 @@ diff --git a/web/src/view/layout/aside/sidebarMode.vue b/web/src/view/layout/aside/sidebarMode.vue index 032a2537f..128c655ca 100644 --- a/web/src/view/layout/aside/sidebarMode.vue +++ b/web/src/view/layout/aside/sidebarMode.vue @@ -2,7 +2,7 @@
@@ -74,7 +74,7 @@ :collapse="isCollapse" :collapse-transition="false" :default-active="active" - class="border-r-0 w-full" + class="!border-r-0 w-full" unique-opened @select="selectMenuItem" > diff --git a/web/src/view/layout/header/tools.vue b/web/src/view/layout/header/tools.vue index deba8d8c7..1176debda 100644 --- a/web/src/view/layout/header/tools.vue +++ b/web/src/view/layout/header/tools.vue @@ -8,7 +8,7 @@ @@ -29,7 +29,7 @@ @@ -37,7 +37,7 @@ @@ -46,7 +46,7 @@ @@ -61,14 +61,14 @@ > diff --git a/web/src/view/layout/index.vue b/web/src/view/layout/index.vue index 43342024c..77f115fa7 100644 --- a/web/src/view/layout/index.vue +++ b/web/src/view/layout/index.vue @@ -11,7 +11,7 @@ :content="userStore.userInfo.nickName" /> -
+
+
- +
diff --git a/web/src/view/layout/tabs/index.vue b/web/src/view/layout/tabs/index.vue index 4ad54f371..6a6ad8ad6 100644 --- a/web/src/view/layout/tabs/index.vue +++ b/web/src/view/layout/tabs/index.vue @@ -8,7 +8,7 @@ v-model="activeValue" :closable="!(historys.length === 1 && $route.name === defaultRouter)" type="card" - class="bg-white text-slate-700 dark:text-slate-500 dark:bg-slate-900" + class="bg-white text-slate-700 dark:text-slate-500 dark:bg-slate-900 pt-1" @contextmenu.prevent="openContextMenu($event)" @tab-click="changeTab" @tab-remove="removeTab" diff --git a/web/src/view/superAdmin/authority/components/menus.vue b/web/src/view/superAdmin/authority/components/menus.vue index 2dd571dc5..fd00f8d28 100644 --- a/web/src/view/superAdmin/authority/components/menus.vue +++ b/web/src/view/superAdmin/authority/components/menus.vue @@ -23,7 +23,7 @@