This commit is contained in:
2026-07-27 17:19:36 +08:00
parent e50d1b8fda
commit 1c7532e0de
132 changed files with 7066 additions and 1241 deletions

108
AGENTS.md
View File

@@ -1,9 +1,11 @@
# AGENTS.md
本文件用于指导 Codex (Codex.ai/code) 在 Saber3 代码仓库中工作时的行为规范。
> 本规范适用于 Saber3 前端工程的所有开发任务,为强制性条款。除非用户显式豁免,任何条目都不得忽视或删减。
>
> 作为 AI 助手参与本项目开发时,你必须:
>
> - 每次输出前深度理解 BladeX 微服务架构体系、Saber3 前端工程结构和 Vue 3 技术栈特征
> - 当回答依赖外部知识时,先查询 Vue 3、Element Plus、Avue、Vite 等官方文档
> - 若需求含糊,先复述已知信息并列出关键澄清问题
@@ -20,18 +22,18 @@
### 1.1 技术栈
| 技术 | 版本 | 用途 |
| ------------------ | -------- | ------------------ |
| Vue | ^3.5.13 | 核心框架 |
| Element Plus | ^2.10.1 | UI 组件库 |
| @smallwei/avue | ^3.7.2 | 增强型 CRUD 组件库 |
| Vue Router | ^4.3.2 | 路由管理 |
| Vuex | ^4.1.0 | 状态管理 |
| Axios | ^1.8.3 | HTTP 客户端 |
| Vite | ^5.4.19 | 构建工具 |
| vue-i18n | ^11.1.3 | 国际化 |
| Sass | ^1.85.1 | CSS 预处理器 |
| crypto-js / sm-crypto | - | 加密AES / SM2 |
| 技术 | 版本 | 用途 |
| --------------------- | ------- | ------------------ |
| Vue | ^3.5.13 | 核心框架 |
| Element Plus | ^2.10.1 | UI 组件库 |
| @smallwei/avue | ^3.7.2 | 增强型 CRUD 组件库 |
| Vue Router | ^4.3.2 | 路由管理 |
| Vuex | ^4.1.0 | 状态管理 |
| Axios | ^1.8.3 | HTTP 客户端 |
| Vite | ^5.4.19 | 构建工具 |
| vue-i18n | ^11.1.3 | 国际化 |
| Sass | ^1.85.1 | CSS 预处理器 |
| crypto-js / sm-crypto | - | 加密AES / SM2 |
---
@@ -91,27 +93,36 @@ Avue 表格/表单配置独立存放于 `src/option/` 目录,与 `views` 和 `
- 命名约定:列表 `getList(current, size, params)`、详情 `getDetail(id)`、新增 `add(row)`、更新 `update(row)`、删除 `remove(ids)`、树形 `getXxxTree()`
- 后端微服务前缀:`/blade-system/``/blade-resource/``/blade-flow/``/blade-desk/``/blade-log/``/blade-develop/`
### 3.4 认证机制
### 3.4 批量导入失败文件下载规范
- 所有批量导入功能如果存在部分数据无法导入、校验失败或后端处理异常,前端必须支持自动下载后端返回的导入失败 Excel。
- 失败 Excel 的字段顺序必须与原导入模板保持一致,并在最后一列追加“导入失败原因”。
- 前端上传接口需支持 `blob` 响应Avue 默认上传无法可靠处理文件流时,应使用 `httpRequest` 或独立 API 方法自定义上传。
- 前端需根据响应 `content-type` 或 Blob 类型区分 JSON 成功响应与 Excel 文件流:成功时提示并刷新列表,失败文件流时下载失败明细并提示“部分数据导入失败,已下载失败明细”。
- 批量导入失败明细文件命名统一包含业务名称、`导入失败明细` 和时间戳,例如 `货物类型导入失败明细YYYY-MM-DD HH:mm:ss.xlsx`
- 批量导入的前端预校验与后端导入校验必须与新增、编辑表单校验保持一致,包括必填、长度、格式、枚举范围、父子级联关系和金额/日期等业务规则;新增、编辑校验调整时,必须同步更新导入校验。
### 3.5 认证机制
- OAuth2`Basic` 头传递 `clientId:clientSecret`Base64 编码)
- Token请求头 `Blade-Auth: bearer {token}`,支持 AES 加密模式
- 存储:`saber3-access-token` / `saber3-refresh-token`(通过 `utils/auth.js` 管理)
- 401 自动刷新 Token并发请求排队等待登录密码使用 SM2 国密加密
### 3.5 路由系统
### 3.6 路由系统
- 静态路由:`router/page/` + `router/views/`
- 动态路由:`avue-router.js` 将后端菜单数据转换为 Vue Router 路由
- 多级路由自动扁平化为二级,支持 keep-alive 跨层级缓存
- 外部链接自动转换为 iframe 路由,支持 Token 透传
### 3.6 权限控制
### 3.7 权限控制
- 路由守卫:`permission.js` 控制登录态、锁屏、标签页
- 按钮权限:`store.getters.permission`,格式 `{module}_{action}`(如 `dict_add`
- 管理员判断:`userInfo.authority.includes('admin')`
### 3.7 多租户
### 3.8 多租户
通过 `website.tenantMode` 控制开关,管理组租户编号 `000000`,后端自动通过请求头传递租户信息。
@@ -124,6 +135,7 @@ Avue 表格/表单配置独立存放于 `src/option/` 目录,与 `views` 和 `
项目同时支持 **Options API**(主流,绝大多数现有页面)和 **Composition API**(新组件可选)。
**选择原则**
- 修改现有页面:保持该页面原有风格,不混用
- 新建 CRUD 页面:调用 `avue-design` Skill 生成,或参考现有页面手动编写
- 新建复杂交互页面:可使用 Composition API + `<script setup>`
@@ -131,14 +143,14 @@ Avue 表格/表单配置独立存放于 `src/option/` 目录,与 `views` 和 `
### 4.2 命名规范
| 类型 | 命名方式 | 示例 |
| -------------- | -------------------------- | ----------------------------- |
| 页面文件 | kebab-case | `notice.vue` |
| 组件文件 | kebab-case 目录 + main.vue | `basic-container/main.vue` |
| API / Option / 工具文件 | camelCase | `dict.js``dictbiz.js` |
| 变量 / 函数 | camelCase | `dictValue``handleDelete` |
| Vuex mutations | UPPER_SNAKE | `SET_IS_MENU``ADD_TAG` |
| Vuex actions | PascalCase | `FedLogOut``RefreshToken` |
| 类型 | 命名方式 | 示例 |
| ----------------------- | -------------------------- | --------------------------- |
| 页面文件 | kebab-case | `notice.vue` |
| 组件文件 | kebab-case 目录 + main.vue | `basic-container/main.vue` |
| API / Option / 工具文件 | camelCase | `dict.js``dictbiz.js` |
| 变量 / 函数 | camelCase | `dictValue``handleDelete` |
| Vuex mutations | UPPER_SNAKE | `SET_IS_MENU``ADD_TAG` |
| Vuex actions | PascalCase | `FedLogOut``RefreshToken` |
### 4.3 代码格式Prettier
@@ -148,6 +160,21 @@ Avue 表格/表单配置独立存放于 `src/option/` 目录,与 `views` 和 `
- 全局 SCSS 变量通过 `styles/variables.scss` 定义Vite 自动注入所有组件
- 编写样式优先使用已有变量和 mixin`styles/mixin.scss`),而非硬编码值
- 系统主色调统一使用 `#409eff`涉及主题变量、Element Plus 主题覆盖、按钮/链接/选中态等品牌色场景均应保持一致
- 各页面搜索栏多行展示时,行与行之间的垂直间距统一为 `8px`
- 搜索组件 label 宽度统一不小于 `160px`label 文本不得换行。
- 搜索组件内部 padding 统一为上、左右 `12px`,底部 `4px`
- 搜索组件需展示轻量阴影,统一使用 `0 2px 8px rgba(0, 0, 0, 0.06)`,不得被局部卡片去样式规则覆盖。
- 表格线条颜色需统一使用 `#EFF1F7`,包括表格外边框、单元格分割线和固定列边线。
- 表格偶数行需统一使用 `#FAFAFA` 背景色,固定列单元格必须与对应行背景保持一致。
- 表格操作列同时展示“查看、编辑、删除”等三个按钮时,操作列宽度统一不小于 `220px`,禁止出现按钮裁切或显示不全。
- `.avue-crud__header` 顶部间距统一为 `12px`
- 分页组件整体靠右展示,必须展示接口返回的数据总条数,`X条/页` 的页容量选择器必须放在总条数右侧。
- `.basic-container__card` 的直接子级 `.el-card__body` 内边距统一去除,保持 `padding: 0`
- 所有 CRUD 页面搜索栏需与下方表格拆分为独立区域,两者垂直间距统一为 `8px`
- 所有 CRUD 页面搜索栏操作按钮(搜索、清空等)需在搜索表单下方独占一行并放置在最右侧;搜索条件超过两行时必须显示“展开/折叠”,默认折叠且仅展示两行搜索条件。
- 所有 CRUD 页面中新增、批量导入等顶部按钮组行不需要背景色,应保持透明背景。
- 所有 `.basic-container__card` 内的 Avue 内层 `el-card` 需去卡片化,仅保留外层容器卡片样式,禁止出现二级卡片边框、阴影或额外内边距。
### 4.5 全局注册组件
@@ -165,8 +192,15 @@ Avue 表格/表单配置独立存放于 `src/option/` 目录,与 `views` 和 `
### 4.8 表单布局规范
- 新增/编辑弹窗中的表单项,若 `label` 文案超过 4 个字,`label` 必须单独占一行展示,表单控件另起一行,避免长标签挤压输入控件或换行错位
- 使用 Avue 配置、Element Plus 表单或自定义弹窗表单时均需遵守该规则;可通过 `label-position="top"`、自定义 `formslot`、局部样式或单项布局调整实现
- 新增编辑弹窗中的表单 `label` 默认必须位于控件左侧Avue 配置统一使用 `labelPosition: 'right'``labelWidth: 'auto'`Element Plus 表单统一使用 `label-position="right"``label-width="auto"`
- 新增、编辑弹窗中的表单 `label` 宽度必须以当前视觉列内最长 `label` 为准;多列表单需按列分别计算 label 宽度,禁止用整张表单的最长 label 统一挤压所有列
- 所有新增、编辑弹窗中的表单 `label` 文本必须右对齐,确保同一列内控件起始位置一致。
- 新增、编辑弹窗标题左侧必须展示 `4px` 宽的主色竖条,竖条与标题文本间距统一为 `8px`
- 复杂布局弹窗中的自定义分区标题、明细表格标题、步骤区标题等承担弹窗内容标题作用时,也必须沿用 `4px` 主色竖条与 `8px` 标题间距;可使用全局 `.dialog-section-title` 或等效局部样式实现。
- 新增、编辑弹窗中的表单项上下间距统一为 `16px`,弹窗内表单布局不得叠加 `.el-col``.el-form-item` 的额外下边距。
- 所有新增、编辑弹窗中的备注字段如果有必须单独占一整行展示禁止与其他字段并列Avue 配置可使用 `span: 24` 或等效布局实现。
- 新增、编辑弹窗底部按钮顺序统一为“取消、提交”,取消按钮在左,提交按钮在右。
- 使用 Avue 配置、Element Plus 表单或自定义弹窗表单时均需遵守该规则;若局部组件因特殊结构无法自动对齐,应通过 `src/utils/dialog-form-label.js` 的全局增强、局部样式或 `formslot` 保证 `label` 左侧展示、按列统一宽度、文本右对齐。
### 4.9 审计字段展示规范
@@ -175,6 +209,10 @@ Avue 表格/表单配置独立存放于 `src/option/` 目录,与 `views` 和 `
- “更新人”列统一使用 `prop: 'updateUserName'`,并通过 `src/utils/audit.js` 中的 `formatUpdateUserName(row)` 做兼容兜底。
- 表单提交仍保留后端审计字段机制,前端不得手动提交或覆盖 `createUser``updateUser`
### 4.10 表格排序规范
- 表格的排序默认按照创建时间降序;分页列表应由后端默认按 `create_time DESC` 返回,前端不得在无明确业务要求时覆盖为其它默认排序。
---
## 5. 新功能开发流程
@@ -225,17 +263,17 @@ pnpm run serve # 预览构建产物
项目采用 **Gitmoji** 风格,中文描述:
| Emoji | 代码 | 场景 |
| ---------- | ------------ | ---------------- |
| Emoji | 代码 | 场景 |
| ---------- | ------------ | ------------------ |
| :sparkles: | `:sparkles:` | 新增功能、优化增强 |
| :bug: | `:bug:` | 修复 Bug |
| :bug: | `:bug:` | 修复 Bug |
| :zap: | `:zap:` | 性能优化、问题修复 |
| :tada: | `:tada:` | 重大版本发布 |
| :lipstick: | `:lipstick:` | 样式调整 |
| :recycle: | `:recycle:` | 代码重构 |
| :wrench: | `:wrench:` | 配置修改 |
| :memo: | `:memo:` | 文档更新 |
| :fire: | `:fire:` | 删除代码/文件 |
| :tada: | `:tada:` | 重大版本发布 |
| :lipstick: | `:lipstick:` | 样式调整 |
| :recycle: | `:recycle:` | 代码重构 |
| :wrench: | `:wrench:` | 配置修改 |
| :memo: | `:memo:` | 文档更新 |
| :fire: | `:fire:` | 删除代码/文件 |
---