diff --git b/.githooks/pre-push a/.githooks/pre-push new file mode 100755 index 0000000..8289050 --- /dev/null +++ a/.githooks/pre-push @@ -0,0 +1,9 @@ +#!/usr/bin/env bash +# .githooks/pre-push — run scripts/test.sh before every push. +# No --no-verify: the claude-code hook deny-no-verify.sh also blocks it. + +set -euo pipefail + +cd "$(git rev-parse --show-toplevel)" + +./scripts/test.sh diff --git b/.gitignore a/.gitignore new file mode 100644 index 0000000..ac39aa6 --- /dev/null +++ a/.gitignore @@ -0,0 +1,32 @@ +# ==== ERP 插件推荐忽略项（skeleton-gen 追加） ==== +# 本地运行时配置（含真实凭据，严禁入库） +.env.local +.env.*.local + +# Java / Maven +target/ +*.class + +# Node / 前端构建产物 +node_modules/ +dist/ +build/ +coverage/ + +# IDE +.idea/ +.vscode/ +*.iml + +# OS +.DS_Store +Thumbs.db + +# 日志 +*.log +logs/ + +# 插件运行时临时文件 +.tmp/ +*.raw +# ==== 结束 ==== diff --git b/CLAUDE.md a/CLAUDE.md new file mode 100644 index 0000000..44398a7 --- /dev/null +++ a/CLAUDE.md @@ -0,0 +1,218 @@ +# CLAUDE.md — ERP项目 Claude Code 主指令文件 + +> 本文件是 Claude Code 的"操作手册"。Claude Code 启动时会自动读取此文件。 + +--- + +## 🎯 项目概述 + +- **项目名称**: 小羚羊 +- **项目简述**: 测试ERP +- **目标用户**: 企业内部管理人员 +- **部署方式**: 私有化部署 + +--- + +## 🔄 B 阶段开发流程（模块循环 + 功能循环） + +两层嵌套循环**全部固化到 skills**。入口：`/erp-workflow:coding-start`。 + +- **模块循环（外）**：`module-start` → `test-gate` → `module-report` → `mr-create` → 人工 Approve MR → 下一模块 +- **功能循环（内，每 REQ-XXX-NNN 一遍）**：`feature-brainstorm` → `feature-plan` → `feature-tdd` → `feature-verify` → `feature-review` + +MR 前测试闸门： + - `test-gate`（子会话跑 `scripts/test.sh` 全量——本模块所有 REQ + 已完成模块回归）； + - `.githooks/pre-push` 兜底 + - `git push --no-verify` 被 `deny-no-verify.sh` 硬拦。 + +--- + +## ✅ 模块完成判定规则 + +`docs/08-模块任务管理.md § 二` 是**模块元数据表**——每个模块记录依赖 / 路径 / MR iid / 功能（REQ）子项清单。**模块完成由 `MR:` 字段 + `GitLab API state=merged` 判定**；功能子项勾选只作可视化进度，不参与模块完成判定。 + +### 规则定义 + +每个模块在 docs/08 § 二 中长这样： + +```markdown +- module_0 系统管理 + - 依赖: — + - 路径: backend/module/sys/, frontend/pages/sys/ + - MR: — + - 功能: + - [ ] REQ-SYS-001 用户登录 + - [ ] REQ-SYS-002 用户注册 +``` + +- `MR:` 字段由 `mr-create` 在创建 MR 时从 `—` 改为 `!`。 +- 每个 `REQ-*` 子项由 `feature-review` 在 `verdict=approve` 时自动勾选为 `[x]` +- 子项全部勾选不等于模块完成，模块完成判定仍以 `MR:` + GitLab API state 为准。 + +### 模块状态语义 + +| `MR:` 字段 | `GitLab API state` | 含义 | 你（Claude Code）的行为 | +|---|---|---|---| +| `—` | — | 模块未开始（未创建 MR） | ✅ 开始本模块开发 | +| `!` | `opened` / `closed` | 模块开发中 / 打回 | ✅ 继续推进该模块 | +| `!` | `merged` | 模块**已完成** | 🟢 进入下一未完成模块 | + +### 模块完成报告 + +由 `module-report` skill 产出，模板位于 由 module-report skill 持有（12 节标准化，含跨模块改动等 CLAUDE.md 软规则映射节）。CC 不手写模块报告，仅填模板。 + +--- + +## 🏷️ 占位符统一约定 + +项目文档里有 **2 种填写占位** + **1 种提示占位**： + +| 格式 | 谁填 | 使用阶段 | 说明 | +|------|-----|---------|------| +| `【人工填写：<简短说明>】` | 人 | 仅 A 阶段文档 | 密钥 / 账密 / 包名 / 命名约定 / 小版本号等人工才能决定的值；B 阶段 plan/spec 禁止出现，查不到真值时用 `AskUserQuestion` 问用户 | +| `TBD(<责任人>)` | CC 自动 | A 或 B | 后缀附带责任方（如 `TBD(A3 自动补)` / `TBD(A5 自动补)`）；由对应 skill 就地补填，`module-report` § ⑦ 检查 `TBD(CC 补)` 残留 | + +**HTML 注释 ``**：提示占位，是**插件内部大纲模板**里给 LLM 的**填空提示 / 章节引导**，指引 LLM 按结构填实际内容。skill 生成时会**剥除**这些注释，最终产物里注释不会保留。 + +--- + +## 📐 编码行为约束 + +### 你必须做的 ✅ + +1. **严格遵循** `docs/04-技术规范.md`——命名 / 编码 / 统一响应 / 异常处理 / 数据访问 / 配置与安全 等项目专属技术规约全部在此 +2. **严格遵循** `docs/09-项目目录结构.md`——文件放对位置 +3. **每个后端接口** 必须先在 `docs/05-API接口契约.md` 定义，再编码实现 +4. **每个功能可追溯到 `REQ-XXX-NNN`**——commit tag + 代码注释（如 `// REQ-SYS-001: 用户登录`）+ plan/spec 文件名均用此 tag +5. **遇到跨模块改动**（动到非当前模块的代码）——按 § 🟡 软规则 **S2** 执行（允许改，但必须留痕） +6. **遇到技术栈外组件引入**（`docs/04 § 零` 技术栈表外的框架 / 中间件 / 关键库），按 § 🟡 软规则 **S1** 执行（允许引入，但必须先 AskUserQuestion） + +### 你禁止做的 🚫 + +1. **主会话直接 `mysql -e` 跑业务 DDL**（只读查询 / 临时本地调试除外）——业务 schema 必须走 `sql/migrations/V_n__*.sql`，详见下方 Schema 演化规约 +2. **手动 Edit `docs/08 § 二` 的 `MR:` 字段**，必须要由 `mr-create` 自动回写 + +### Schema 演化规约（Flyway migration） + +1. **文件命名**：`sql/migrations/V__.sql`，例：`V5__add_user_email_unique_index.sql` +2. **版本号分配**：建文件前 `ls sql/migrations/V*.sql` 查当前最大 n，新文件 `n_max + 1` +3. **Apply 方式**：Spring Boot 启动 / 测试启动时 Flyway 自动 apply（项目必须在 `pom.xml` 声明 `flyway-core` + `flyway-mysql` 依赖）。`scripts/setup-test-db.sh` 只负责清空库，不做 apply +4. **已合并的 migration 永不修改**：发现错了写一个补救 migration（如 `V7__fix_V5_index_name.sql`），旧 `V_n.sql` +5. **临时调试 DDL**：临时在本地试字段/索引可手动 `mysql -e`，但不写 migration；下次 `setup-test-db.sh` 会 drop+create 清掉 +6. **A4 生成的 V1**：`V1__initial_schema.sql` 是 A 阶段由 `db-init` 从 `docs/03-数据库设计文档.md`（A3 正向设计的 schema SSoT）翻译生成的初始版本；后续 V2/V3/... 由 B 阶段每个 REQ 按需写入，**同时**反向同步更新 docs/03 对应表小节以保持 SSoT 一致 + +--- + +## 🗂️ Git 提交规范 + +每次提交必须遵循以下格式： + +``` +(): +``` + +- `scope`: 模块名，如 `user` / `inventory` / `order` +- `subject`: 简短描述；业务类（feat / fix / test）必须带 `REQ-XXX-NNN` 后缀 + +`type` 含义： + +| type | 看到它意味着 | +|-----|-------------| +| `feat` | **新能力上线**——用户多了一个功能、接口、页面或业务规则 | +| `fix` | **修 bug**——原来行为错了，这次改对 | +| `refactor` | **重构**——外部行为不变，只改代码结构 / 命名 / 抽象 | +| `docs` | **文档改动**——只动 Markdown / 代码注释，不动实现 | +| `style` | **格式调整**——空白 / 缩进 / import 顺序，逻辑 0 变化 | +| `test` | **只动测试代码**——补用例 / 修 fixture，不碰实现 | +| `chore` | **流程维护**——构建 / 依赖 / 工具 / 证据档案 / MR 元数据等非业务动作 | + +--- + +## 🚩 中断机制 + +功能循环（每个功能 REQ-XXX 的 Brainstorm → Plan → TDD → Verify → AI 自审）默认 **静默编程**，但触发以下任何一条必须**立刻停下、记录原因、等人决策**，不得自行绕过： + +| # | 中断 | 例子 | +| - | --- | --- | +| 1 | **测试反复失败** | 同一测试同一功能内连续 **10 次**修复失败 | +| 2 | **要改密钥 / 账密 / 包名** | `docs/07-环境配置.md` 里由人工标注必须填的字段 | +| 3 | **外部接口不可达** | 第三方 API 无法连接、证书失效等环境问题，并无法自行解决 | + +> 其余需要人类判断的场景一律走普通 `AskUserQuestion` Q&A，不中断、不写 Blocker 文件。 + +**触发中断时的固定动作：** + +1. 在当前功能的 plan 文件里追加一节 `## 🚩 Blocker`（报告格式由 `interrupt-check` 的 `interrupt-block-template.md` 持有） +2. 停止后续所有功能的静默执行 +3. 在主会话输出一句话摘要 + 指向 blocker 文件的路径，等人回复 + +--- + +## 🟡 软规则（允许继续，但有强制后续动作） + +以下情况 **不触发中断**，CC 可自行继续推进，但必须在约定位置留痕，模块完成时统一审计。 + +| # | 软规则 | 允许动作 | 强制后续 | +| - | ----- | ------- | ------- | +| S1 | **技术栈外组件引入** | 用 `AskUserQuestion` 给用户三选一：接受引入 / 换方案 / 拒绝 | ① **接受** → 同会话直接在 `docs/04 § 零` 追加一行 → 继续流程 ② **换方案 / 拒绝** → 视为常规歧义澄清，继续 Q&A 收敛 ③ 不写 Blocker、不中断流程 | +| S2 | **跨模块改动** | **默认不改**，仅为当前模块实现所必需时允许修改 | ① hook `log-cross-module.sh` 自动落存根 ② `module-report` 一次性调用 `cross-module-log` skill 批量补齐「原因 / 影响评估」+ 「跨模块改动」节完整贴入《模块完成报告》 | + +--- + +## 🧭 通用工作准则（General Principles） + +### 1. Think Before Coding + +**Don't assume. Don't hide confusion. Surface tradeoffs.** + +Before implementing: +- State your assumptions explicitly. If uncertain, ask. +- If multiple interpretations exist, present them - don't pick silently. +- If a simpler approach exists, say so. Push back when warranted. +- If something is unclear, stop. Name what's confusing. Ask. + +### 2. Simplicity First + +**Minimum code that solves the problem. Nothing speculative.** + +- No features beyond what was asked. +- No abstractions for single-use code. +- No "flexibility" or "configurability" that wasn't requested. +- No error handling for impossible scenarios. +- If you write 200 lines and it could be 50, rewrite it. + +Ask yourself: "Would a senior engineer say this is overcomplicated?" If yes, simplify. + +### 3. Surgical Changes + +**Touch only what you must. Clean up only your own mess.** + +When editing existing code: +- Don't "improve" adjacent code, comments, or formatting. +- Don't refactor things that aren't broken. +- Match existing style, even if you'd do it differently. +- If you notice unrelated dead code, mention it - don't delete it. + +When your changes create orphans: +- Remove imports/variables/functions that YOUR changes made unused. +- Don't remove pre-existing dead code unless asked. + +The test: Every changed line should trace directly to the user's request. + +### 4. Goal-Driven Execution + +**Define success criteria. Loop until verified.** + +Transform tasks into verifiable goals: +- "Add validation" → "Write tests for invalid inputs, then make them pass" +- "Fix the bug" → "Write a test that reproduces it, then make it pass" +- "Refactor X" → "Ensure tests pass before and after" + +For multi-step tasks, state a brief plan: +``` +1. [Step] → verify: [check] +2. [Step] → verify: [check] +3. [Step] → verify: [check] +``` + +Strong success criteria let you loop independently. Weak criteria ("make it work") require constant clarification. diff --git b/docs/01-需求清单/MOD-模块管理/REQ-MOD-001.md a/docs/01-需求清单/MOD-模块管理/REQ-MOD-001.md new file mode 100644 index 0000000..0df3434 --- /dev/null +++ a/docs/01-需求清单/MOD-模块管理/REQ-MOD-001.md @@ -0,0 +1,31 @@ +### REQ-MOD-001 模块新增 + +**目标**: 新增一个 ERP 业务模块定义，作为系统功能与权限分组的基础单位 + +- **输入**: + + - **表1**： + + | 字段 | 类型 | 必填 | 输入方式 | 显示来源 | 默认值 | 业务规则 | + | -------- | ---- | --- | ---- | ----------- | ---- | -------- | + | 显示类型 | 文本 | 是 | 下拉单选 | 手机端/前端业务/系统配置/接口 | 手机端 | — | + | 存储过程（审核）名称 | 文本 | 是 | 手工输入 | — | — | — | + | 模块类型 | 文本 | 是 | 手工输入 | — | — | — | + | 管理部门英文 | 文本 | 是 | 手工输入 | — | — | — | + | 权限是否显示 | 布尔 | 否 | 复选框 | — | 否 | — | + | 界面名称中文 | 文本 | 是 | 手工输入 | — | — | — | + +- **输出**: + + - **表1**： + + | 字段 | 类型 | 显示来源 | + | ----- | ---- | ----- | + | 模块 id | 文本 | `模块表` | + +- **跨字段规则**: - +- **边界**: 必填项不能为空 +- **验收**: 提交后模块记录持久化并返回新模块 id；字段格式错误或必填缺失时返回明确错误码并定位字段 +- **依赖表**: `tModule`（写） +- **依赖接口**: — + diff --git b/docs/01-需求清单/MOD-模块管理/REQ-MOD-002.md a/docs/01-需求清单/MOD-模块管理/REQ-MOD-002.md new file mode 100644 index 0000000..5421239 --- /dev/null +++ a/docs/01-需求清单/MOD-模块管理/REQ-MOD-002.md @@ -0,0 +1,30 @@ +### REQ-MOD-002 模块修改 + +**目标**: 在不破坏唯一性的前提下，更新已有模块的可编辑信息 + +- **输入**: 选中目标 + + - **表1**： + + | 字段 | 类型 | 必填 | 输入方式 | 显示来源 | 默认值 | 业务规则 | + | -------- | ---- | --- | ---- | ----------- | ---- | -------- | + | 显示类型 | 文本 | 是 | 下拉单选 | 手机端/前端业务/系统配置/接口 | 原值 | — | + | 存储过程（审核）名称 | 文本 | 是 | 手工输入 | — | 原值 | — | + | 模块类型 | 文本 | 是 | 手工输入 | — | 原值 | — | + | 管理部门英文 | 文本 | 是 | 手工输入 | — | 原值 | — | + | 权限是否显示 | 布尔 | 否 | 复选框 | — | 原值 | — | + | 界面名称中文 | 文本 | 是 | 手工输入 | — | 原值 | — | + +- **输出**: + + - **表1**： + + | 字段 | 类型 | 显示来源 | + | ----- | ---- | ----- | + | 模块 id | 文本 | `模块表` | + +- **跨字段规则**: - +- **边界**: 必须传入有效模块 id；字段格式与新增一致 +- **验收**: 提交后字段更新成功并返回模块 id；非法 id 或必填缺失时返回明确错误码并定位字段 +- **依赖表**: `tModule`（写） +- **依赖接口**: — diff --git b/docs/01-需求清单/MOD-模块管理/REQ-MOD-003.md a/docs/01-需求清单/MOD-模块管理/REQ-MOD-003.md new file mode 100644 index 0000000..fbae890 --- /dev/null +++ a/docs/01-需求清单/MOD-模块管理/REQ-MOD-003.md @@ -0,0 +1,21 @@ +### REQ-MOD-003 模块删除 + +**目标**: 删除一个已有模块，且不破坏数据引用完整性 + +- **输入**: + + - **表1**： + + | 字段 | 类型 | 必填 | 输入方式 | 显示来源 | 默认值 | 业务规则 | + | ----- | ---- | --- | ----- | ----- | --- | -------- | + | 模块 id | 文本 | — | 点击按钮 | — | — | — | + +- **输出**: 成功/失败 + +- **跨字段规则**: 已被业务引用（菜单 / 权限 / 用户角色等）的模块不允许直接删除；建议软删除并记录删除时间与操作人 +- **边界**: 必须传入有效模块 id；删除接口需具备相应权限并支持二次确认 +- **验收**: 合法删除返回成功状态；存在引用时返回拒绝原因与冲突来源；非法 id 给出明确错误码 +- **依赖表**: `tModule`（软删除写：`bDeleted` / `tDeletedDate` / `sDeletedBy`；删除前在 service 层检查子模块或外部引用） +- **依赖接口**: — + + diff --git b/docs/01-需求清单/MOD-模块管理/REQ-MOD-004.md a/docs/01-需求清单/MOD-模块管理/REQ-MOD-004.md new file mode 100644 index 0000000..11d39fb --- /dev/null +++ a/docs/01-需求清单/MOD-模块管理/REQ-MOD-004.md @@ -0,0 +1,32 @@ +### REQ-MOD-004 模块查询 + +**目标**: 按关键字检索模块，并以树形结构展示匹配结果 + +- **输入**: + + - **表1**： + + | 字段 | 类型 | 必填 | 输入方式 | 显示来源 | 默认值 | 业务规则 | + | --- | ---- | --- | ---- | ---- | --- | -------------- | + | 关键字 | 文本 | 否 | 手工输入 | — | — | 对界面名称模糊匹配；空为匹配所有 | + +- **输出**: + + - **表1**： + + | 字段 | 类型 | 显示来源 | + | ------ | ---- | ----- | + | 模块 id | 文本 | `模块表` | + | 界面名称中文 | 文本 | `模块表` | + | 显示类型 | 文本 | `模块表` | + | 管理部门英文 | 文本 | `模块表` | + | 父级 id | 文本 | `模块表` | + | 序号 | 数字 | `模块表` | + +- **跨字段规则**: - +- **边界**: 查询为只读，不产生写副作用；空关键字返回完整模块树 +- **验收**: 查询结果与库内数据一致；按界面名称模糊匹配生效；空结果返回空列表而非错误 +- **依赖表**: `tModule`（读，按 `sModuleNameZh` 模糊匹配 + 按 `iParentId` 拼装树形） +- **依赖接口**: — + + diff --git b/docs/01-需求清单/MOD-模块管理/_module.md a/docs/01-需求清单/MOD-模块管理/_module.md new file mode 100644 index 0000000..ed2914a --- /dev/null +++ a/docs/01-需求清单/MOD-模块管理/_module.md @@ -0,0 +1,5 @@ +# MOD-模块管理 + +- **模块简述**: 业务模块管理模块，负责系统功能模块的增加、修改、删除和查询，支撑菜单与权限分配 +- **依赖模块**: — +- **涉及表**: `tModule` diff --git b/docs/01-需求清单/USR-用户管理/REQ-USR-001.md a/docs/01-需求清单/USR-用户管理/REQ-USR-001.md new file mode 100644 index 0000000..6f6e19a --- /dev/null +++ a/docs/01-需求清单/USR-用户管理/REQ-USR-001.md @@ -0,0 +1,41 @@ +### REQ-USR-001 用户新增 + +**目标**: 录入新用户的基本信息并完成账户初始化，便于后续登录与权限分配 + +- **输入**: + + - **表1**： + + | 字段 | 类型 | 必填 | 输入方式 | 显示来源 | 默认值 | 业务规则 | + | -------- | ---- | --- | ---- | ----------------- | --------- | ------------------- | + | 创建时间 | 日期时间 | — | 系统生成 | — | 当前日期 | 保存后自动生成；只读 | + | 制单人 | 文本 | — | 系统生成 | — | 当前登录用户 | 保存后自动生成；只读 | + | 员工名 | 文本 | 否 | 下拉单选 | `职员表` | — | 关联职员（可选） | + | 用户号 | 文本 | 是 | 手工输入 |— | — | 关联职员选择后自动输入员工姓名 | + | 用户名 | 文本 | 是 | 手工输入 |— | — | 关联职员选择后自动输入员工姓名 | + | 类型 | 文本 | 是 | 下拉单选 | 普通用户/超级管理员 | 普通用户 | — | + | 语言 | 文本 | 是 | 下拉单选 | 中文/英文/繁体 | — | — | + | 单据修改权限 | 布尔 | 否 | 复选框 | — | 否 | — | + | 密码 | 文本 | - | 系统生成 | 不显示 | 666666 | 保存后自动设为初始化 | + + - **表2** - 权限组： + + | 字段 | 类型 | 必填 | 输入方式 | 显示来源 | 默认值 | 业务规则 | + | -------- | ---- | --- | ---- | ----------------- | --------- | ------------------- | + | 复选框 | 布尔 | 否 | 复选框 | — | 否 | 是否选择当前行权限 | + | 权限分类 | 文本 | — | — | — | — | — | + + +- **输出**: + + - **表1**： + + | 字段 | 类型 | 显示来源 | + | --- | --- | --- | + | 用户号 | 文本 | - | + +- **跨字段规则**: 用户名在系统内全局唯一；角色取值受系统配置约束 +- **边界**: 密码以哈希形式存储 +- **验收**: 提交合法表单后系统持久化用户记录并返回新用户 id；唯一性冲突或字段格式错误时返回明确错误码并定位到具体字段 +- **依赖表**: `tUser`（写）、`tStaff`（员工名下拉读）、`tPermissionCategory`（权限分类下拉读）、`tUserPermission`（写权限组关联） +- **依赖接口**: — diff --git b/docs/01-需求清单/USR-用户管理/REQ-USR-002.md a/docs/01-需求清单/USR-用户管理/REQ-USR-002.md new file mode 100644 index 0000000..07b4df5 --- /dev/null +++ a/docs/01-需求清单/USR-用户管理/REQ-USR-002.md @@ -0,0 +1,46 @@ +### REQ-USR-002 用户修改 + +**目标**: 在不破坏唯一性的前提下，更新已有用户的可编辑信息 + +- **输入**: 选中目标 + + - **表1**： + + | 字段 | 类型 | 必填 | 输入方式 | 显示来源 | 默认值 | 业务规则 | + | -------- | ---- | --- | ---- | ----------------- | --------- | ------------------- | + | 创建时间 | 日期时间 | — | 系统生成 | — | 原值 | 保存后自动生成；只读 | + | 制单人 | 文本 | — | 系统生成 | — | 原值 | 保存后自动生成；只读 | + | 员工名 | 文本 | 否 | 下拉单选 | `职员表` | 原值 | 关联职员（可选） | + | 用户号 | 文本 | 是 | 手工输入 |— | 原值 | 关联职员选择后自动输入员工姓名 | + | 用户名 | 文本 | 是 | 手工输入 |— | 原值 | 关联职员选择后自动输入员工姓名 | + | 类型 | 文本 | 是 | 下拉单选 | 普通用户/超级管理员 | 原值 | — | + | 语言 | 文本 | 是 | 下拉单选 | 中文/英文/繁体 | 原值 | — | + | 单据修改权限 | 布尔 | 否 | 复选框 | — | 原值 | — | + | 密码 | 文本 | - | 系统生成 | 不显示 | 原值 | 保存后自动设为初始化 | + + - **表2** - 权限组： + + | 字段 | 类型 | 必填 | 输入方式 | 显示来源 | 默认值 | 业务规则 | + | -------- | ---- | --- | ---- | ----------------- | --------- | ------------------- | + | 复选框 | 布尔 | 否 | 复选框 | — | 原值 | 是否选择当前行的权限 | + | 权限分类 | 文本 | — | — | — | — | — | + +- **输出**: + + - **表1**： + + | 字段 | 类型 | 显示来源 | + | --- | --- | --- | + | 用户 id | 文本 | `职员表` | + +- **跨字段规则**: 密码不在该接口修改；角色变更需具备相应权限 +- **边界**: 必须传入有效用户 id；字段格式与新增一致 +- **验收**: 提交后字段更新成功并返回最新用户数据；非法 id、唯一冲突或格式错误返回明确错误码并定位字段 +- **依赖表**: `tUser`（写）、`tStaff`（员工名下拉读）、`tPermissionCategory`（权限分类下拉读）、`tUserPermission`（写权限组关联） +- **依赖接口**: — + + + + + | 创建时间 | 日期时间 | — | — | — | 原值 | 不变；只读 | + | 制单人 | 文本 | — | — | — | 原值 | 不变；只读 | \ No newline at end of file diff --git b/docs/01-需求清单/USR-用户管理/REQ-USR-003.md a/docs/01-需求清单/USR-用户管理/REQ-USR-003.md new file mode 100644 index 0000000..3f2836f --- /dev/null +++ a/docs/01-需求清单/USR-用户管理/REQ-USR-003.md @@ -0,0 +1,37 @@ +### REQ-USR-003 用户查询 + +**目标**: 按条件检索用户列表，并支持查看单个用户的详情 + +- **输入**: + + - **表1**： + + | 字段 | 类型 | 必填 | 输入方式 | 显示来源 | 默认值 | 业务规则 | + | ---- | ---- | --- | ---- | ----------------------------------------------- | ------- | --------------- | + | 查询字段 | 文本 | 否 | 下拉单选 | 用户名/员工名/用户号/部门/用户类型/作废/登录日期/制单人 | 用户名 | — | + | 匹配方式 | 文本 | 否 | 下拉单选 | 包含/不包含/等于 | 包含 | — | + | 查询值 | 文本 | 否 | 手工输入 | — | — | 与「查询字段」配合使用，空为选择全部 | + +- **输出**: + + - **表1**： + + | 字段 | 类型 | 显示来源 | + | ---- | ---- | ----- | + | 序号 | 数字 | 系统生成 | + | 用户名 | 文本 | `用户表` | + | 员工名 | 文本 | `职员表` | + | 用户号 | 文本 | `用户表` | + | 部门 | 文本 | `职员表` | + | 用户类型 | 文本 | `用户表` | + | 语言 | 文本 | `用户表` | + | 作废 | 布尔 | `用户表` | + | 登录日期 | 日期时间 | `用户表` | + | 制单人 | 文本 | `用户表` | + | 制单日期 | 日期时间 | `用户表` | + +- **跨字段规则**: - +- **边界**: 单页最大条数受限（默认 100）；密码与敏感字段不返回；查询为只读，不产生写副作用 +- **验收**: 查询结果与库内数据一致；分页 / 排序 / 过滤参数生效；空结果返回空列表而非错误 +- **依赖表**: `tUser`（读）、`tStaff`（读，员工名 / 部门显示来源） +- **依赖接口**: — diff --git b/docs/01-需求清单/USR-用户管理/REQ-USR-004.md a/docs/01-需求清单/USR-用户管理/REQ-USR-004.md new file mode 100644 index 0000000..9f3a3cb --- /dev/null +++ a/docs/01-需求清单/USR-用户管理/REQ-USR-004.md @@ -0,0 +1,21 @@ +### REQ-USR-004 用户登录 + +**目标**: 用户使用账号密码完成身份认证并获取访问凭证 + +- **输入**: + + - **表1**： + + | 字段 | 类型 | 必填 | 输入方式 | 显示来源 | 默认值 | 业务规则 | + | --- | ---- | --- | ---- | ------- | --- | ------------------- | + | 用户名 | 文本 | 是 | 手工输入 | — | — | - | + | 密码 | 文本 | 是 | 手工输入 | — | — | 输入显示星号 | + | 版本 | 文本 | 是 | 下拉单选 | 标准版/- | 标准版 | | + +- **输出**: 成功/失败 + +- **跨字段规则**: 校验用户名 + 密码哈希；连续失败达到阈值临时锁定账号；登录成功签发限时 token 并返回基本用户信息 +- **边界**: token 设置合理过期时间；接口需具备防暴力破解保护 +- **验收**: 正确凭据返回 token + 用户基本信息；错误凭据返回明确错误码；账号锁定状态返回剩余冷却时间 +- **依赖表**: `tUser`（读 + 写 `tLastLoginDate`）；登录失败计数走 Redis（不入 DB） +- **依赖接口**: — diff --git b/docs/01-需求清单/USR-用户管理/_module.md a/docs/01-需求清单/USR-用户管理/_module.md new file mode 100644 index 0000000..f2c957e --- /dev/null +++ a/docs/01-需求清单/USR-用户管理/_module.md @@ -0,0 +1,5 @@ +# USR-用户管理 + +- **模块简述**: 用户管理模块，负责系统用户的增加、修改、查询和登录认证 +- **依赖模块**: — +- **涉及表**: `tUser`、`tStaff`、`tPermissionCategory`、`tUserPermission` diff --git b/docs/01-需求清单/index.md a/docs/01-需求清单/index.md new file mode 100644 index 0000000..062ab90 --- /dev/null +++ a/docs/01-需求清单/index.md @@ -0,0 +1,16 @@ +# 需求清单 + +> 本目录按模块组织所有功能需求。每个模块一个子目录，含 `_module.md`（模块头）和 `REQ-XXX-NNN.md`（每张 REQ 卡片一个文件）。下方核心功能点供 CC 拆分出 REQ 编号 + 标题 + 草拟规则；卡片内输入 / 输出的简述句和 N 张字段表由人工编辑。 + +## 模块索引 + +| 模块代码 | 模块名称 | 核心功能点（简要） | +| ---- | ---- | ------------------- | +| USR | 用户管理 | 增加用户，修改用户，查询用户，登录用户 | +| MOD | 模块管理 | 增加模块，修改模块，删除模块，查询模块 | + +## 填写说明 + +1. 每个模块占一行，`模块代码` 用大写英文缩写（如 SYS / PUR / INV / SAL / FIN / HR） +2. `核心功能点` 只需列关键词，CC 会基于此拆分出 N 张 REQ 卡片骨架（卡片内输入 / 输出的简述句和字段表仍由人工编辑） +3. 填完后运行 `/erp-workflow:plan-start`，CC 会自动检测并进入需求生成阶段 diff --git b/docs/02-开发计划.md a/docs/02-开发计划.md new file mode 100644 index 0000000..43568e7 --- /dev/null +++ a/docs/02-开发计划.md @@ -0,0 +1,34 @@ +# 02-开发计划 + +## 一、模块依赖表 + +| 模块 ID | 模块名 | 依赖模块 | 依赖表 | +|---|---|---|---| +| module_mod | 模块管理 | — | `tModule` | +| module_usr | 用户管理 | — | `tUser`、`tStaff`、`tPermissionCategory`、`tUserPermission` | + +> 说明：MOD 与 USR 之间无 schema 级外键依赖；按 `module_id` 字母序铺开。USR 业务上的"权限分类"未来可能与 MOD 维护的模块树打通（多对多授权），届时如需新增 FK 再以 V_n migration 引入。 + +## 二、开发顺序清单（CC 分发权威） + +> 本清单由 A5 `downstream-gen` 一次性生成。**每行是一个 REQ**，不是模块。CC 按表格行序从上到下扫描，对每个 REQ 所属模块查 `docs/08 § 二` 的 `MR:` 字段 + GitLab API `state`：`merged` 跳过，其他（`—` / opened / closed / 查不到）选为当前模块；`module-start` 会把该模块的所有 REQ 一次做完。 +> +> **约束**：同一模块的所有 REQ 必须**连续排列**。允许打破依赖拓扑（如环依赖、业务必须先做），但必须在「备注」列写明原因。 + +| # | REQ | 所属模块 | 选中理由 | 备注 | +|---|-----|---------|---------|------| +| 1 | **REQ-MOD-001** | module_mod | 所属模块无依赖，基础模块；同模块第一个 REQ | — | +| 2 | **REQ-MOD-002** | module_mod | 同模块前序 REQ-MOD-001 已在前 | — | +| 3 | **REQ-MOD-003** | module_mod | 同模块前序 REQ-MOD-001/002 已在前 | — | +| 4 | **REQ-MOD-004** | module_mod | 同模块前序 REQ-MOD-001~003 已在前 | — | +| 5 | **REQ-USR-001** | module_usr | 所属模块无依赖；module_mod 已在前 | — | +| 6 | **REQ-USR-002** | module_usr | 同模块前序 REQ-USR-001 已在前 | — | +| 7 | **REQ-USR-003** | module_usr | 同模块前序 REQ-USR-001/002 已在前 | — | +| 8 | **REQ-USR-004** | module_usr | 同模块前序 REQ-USR-001 已在前；登录依赖已存在用户记录 | — | + +## 三、关键说明 + +- **模块顺序**：MOD 与 USR 模块互无 schema 级依赖，按 `module_id` 字母序排（module_mod → module_usr）。任一模块均可作为第一个被开发的模块；本清单选 module_mod 在前以保持稳定的字母序，避免后续追加模块时出现行序漂移。 +- **REQ 顺序**：每模块内部按 CRUD + 业务流程的自然依赖排（增 → 改 → 删 → 查；登录置最后，依赖已有用户记录）。无环依赖。 +- **基础设施 REQ**：本期未单列基础设施 REQ（鉴权拦截器 / 全局异常处理器 / 统一响应封装等横切组件由 `module_usr` 的 REQ-USR-004 触发首次落地，并复用到其他模块）。 +- **数据准备**：REQ-USR-001 实施前需在 `tStaff` / `tPermissionCategory` 中预置基础字典数据（业务运营提供，不在本计划中作为独立 REQ）。 diff --git b/docs/03-数据库设计文档.md a/docs/03-数据库设计文档.md new file mode 100644 index 0000000..e497740 --- /dev/null +++ a/docs/03-数据库设计文档.md @@ -0,0 +1,231 @@ +# 03-数据库设计文档 + +Schema: `xlyweberp_vibe_erp_test` +Migration 清单: `sql/migrations/V*.sql`（由 Flyway 顺序 apply） +生成方式: 由 A3 `db-design-gen` 基于 `docs/01-需求清单//REQ-*.md` REQ 卡片正向设计生成（schema SSoT）。 + +## 项目标准列约定 + +下文每张业务表的字段清单都自动包含以下 5 个标准列（匈牙利前缀 `i` int / `s` varchar / `t` datetime）。渲染时由 `docs-03-table-template.md` 模板内置原样输出。 + +| 列名 | 类型 | 可空 | 主键 | 说明 | +|---|---|---|---|---| +| `iIncrement` | int | 否 | 是 | 整数主键 ID（自增方式由实现决定：DB `AUTO_INCREMENT` 或应用 / 触发器分配） | +| `sId` | varchar(100) | 是 | — | 业务 ID（对外暴露的字符串标识，如 UUID / 人类可读编号） | +| `sBrandsId` | varchar(100) | 是 | — | 品牌 ID（多租户隔离） | +| `sSubsidiaryId` | varchar(100) | 是 | — | 子公司 ID（组织层级隔离） | +| `tCreateDate` | datetime | 否 | — | 记录创建时间 | + +字典 / 辅助表如有豁免，在该表业务注记里注明豁免原因。 + +## ER 关系概览 + +本期共 5 张业务表，分布在 USR / MOD 两个模块： + +- **`tUser`** 是用户账户主表，可选关联 `tStaff`（员工）；与 `tPermissionCategory` 通过 `tUserPermission` 形成多对多权限授权关系。登录失败计数走 Redis，不入库。 +- **`tStaff`** 是职员维度表，作为 `tUser` 的员工来源（员工名 / 部门下拉）。 +- **`tPermissionCategory`** 是权限分类树（自引用 `iParentId`），由 `tUserPermission` 关联到具体用户。 +- **`tUserPermission`** 是 `tUser` × `tPermissionCategory` 的关联表（多对多）。 +- **`tModule`** 是 ERP 业务模块定义表（自引用 `iParentId` 形成模块树），与本期其他表无外键关系。 + +软删除统一使用 `bDeleted` / `tDeletedDate` / `sDeletedBy` 三件套；查询接口默认过滤 `bDeleted = 0`。 + +## 表清单 + +- `tUser` — 系统用户账户与登录凭据 +- `tStaff` — 职员维度（员工名 / 部门 / 编号） +- `tPermissionCategory` — 权限分类树 +- `tUserPermission` — 用户与权限分类的关联 +- `tModule` — ERP 业务模块元数据树 + +--- + +## `tUser` — 系统用户账户与登录凭据 + +### 字段 + +| 字段 | 类型 | Nullable | 默认 | 业务含义 | +|---|---|---|---|---| +| `iIncrement` | int | 否 | — | 整数主键 ID（标准列） | +| `sId` | varchar(100) | 是 | — | 业务 ID（标准列） | +| `sBrandsId` | varchar(100) | 是 | — | 品牌 ID（多租户隔离，标准列） | +| `sSubsidiaryId` | varchar(100) | 是 | — | 子公司 ID（组织层级隔离，标准列） | +| `tCreateDate` | datetime | 否 | — | 创建时间（标准列） | +| `sUserNo` | varchar(50) | 否 | — | 用户号；系统内唯一 | +| `sUserName` | varchar(50) | 否 | — | 用户名（登录账号）；系统内唯一 | +| `iStaffId` | int | 是 | NULL | 关联职员 ID（可选，外键 → `tStaff.iIncrement`） | +| `sUserType` | varchar(20) | 否 | `普通用户` | 用户类型；枚举：`普通用户` / `超级管理员` | +| `sLanguage` | varchar(10) | 否 | `zh` | 语言偏好；枚举：`zh` / `en` / `zh-TW` | +| `bCanModifyDocs` | bit(1) | 否 | 0 | 单据修改权限；0 否 / 1 是 | +| `sPasswordHash` | varchar(255) | 否 | — | 密码哈希值（BCrypt 等强哈希算法），新增默认初始密码 `666666` 的哈希 | +| `tLastLoginDate` | datetime | 是 | NULL | 最后登录时间 | +| `sCreatedBy` | varchar(50) | 是 | — | 制单人（创建用户的操作员用户号） | +| `bDeleted` | bit(1) | 否 | 0 | 软删除标记；0 有效 / 1 已作废 | +| `tDeletedDate` | datetime | 是 | NULL | 软删除时间 | +| `sDeletedBy` | varchar(50) | 是 | NULL | 软删除操作人 | + +### 索引 + +- `uk_user_no` (UNIQUE): (`sUserNo`) +- `uk_user_name` (UNIQUE): (`sUserName`) +- `idx_staff_id` (NORMAL): (`iStaffId`) +- `idx_brand_subsidiary` (NORMAL): (`sBrandsId`, `sSubsidiaryId`) +- `idx_deleted_login` (NORMAL): (`bDeleted`, `tLastLoginDate`) + +### 外键 + +- `fk_user_staff`: `iStaffId` → `tStaff.iIncrement` (ON DELETE SET NULL, ON UPDATE CASCADE) + +### 业务注记 + +- 用户名 / 用户号在系统内全局唯一（含已软删除记录是否计入唯一性，需在 service 层用部分唯一索引或代码校验决定，本设计取代码校验，唯一索引仅约束未删除部分由应用层保证）。 +- 密码哈希存储；登录失败次数 / 临时锁定不入库，由 Redis 维护。 +- REQ-USR-003 查询接口的「作废」字段直接映射 `bDeleted`；「制单日期」即 `tCreateDate`；「制单人」即 `sCreatedBy`。 +- 未关联职员的用户允许 `iStaffId = NULL`（如系统管理员账号）。 + +--- + +## `tStaff` — 职员维度（员工名 / 部门 / 编号） + +### 字段 + +| 字段 | 类型 | Nullable | 默认 | 业务含义 | +|---|---|---|---|---| +| `iIncrement` | int | 否 | — | 整数主键 ID（标准列） | +| `sId` | varchar(100) | 是 | — | 业务 ID（标准列） | +| `sBrandsId` | varchar(100) | 是 | — | 品牌 ID（多租户隔离，标准列） | +| `sSubsidiaryId` | varchar(100) | 是 | — | 子公司 ID（组织层级隔离，标准列） | +| `tCreateDate` | datetime | 否 | — | 创建时间（标准列） | +| `sStaffNo` | varchar(50) | 是 | — | 职员编号；系统内唯一 | +| `sStaffName` | varchar(50) | 否 | — | 职员姓名 | +| `sDepartment` | varchar(100) | 是 | NULL | 所属部门（本期暂用字符串，未来如需独立 `tDepartment` 字典表再另行重构） | +| `sCreatedBy` | varchar(50) | 是 | — | 制单人 | +| `bDeleted` | bit(1) | 否 | 0 | 软删除标记 | +| `tDeletedDate` | datetime | 是 | NULL | 软删除时间 | +| `sDeletedBy` | varchar(50) | 是 | NULL | 软删除操作人 | + +### 索引 + +- `uk_staff_no` (UNIQUE): (`sStaffNo`) +- `idx_staff_name` (NORMAL): (`sStaffName`) +- `idx_department` (NORMAL): (`sDepartment`) + +### 外键 + +（无） + +### 业务注记 + +- USR 模块通过 `tUser.iStaffId` 引用本表；REQ-USR-003 列表的「员工名 / 部门」均来自本表。 +- 部门当前以字符串保存，便于本期快速落地；后续若需独立部门字典表（如审批流引用部门），改为 `iDepartmentId` 外键。 + +--- + +## `tPermissionCategory` — 权限分类树 + +### 字段 + +| 字段 | 类型 | Nullable | 默认 | 业务含义 | +|---|---|---|---|---| +| `iIncrement` | int | 否 | — | 整数主键 ID（标准列） | +| `sId` | varchar(100) | 是 | — | 业务 ID（标准列） | +| `sBrandsId` | varchar(100) | 是 | — | 品牌 ID（多租户隔离，标准列） | +| `sSubsidiaryId` | varchar(100) | 是 | — | 子公司 ID（组织层级隔离，标准列） | +| `tCreateDate` | datetime | 否 | — | 创建时间（标准列） | +| `sCategoryCode` | varchar(50) | 否 | — | 权限分类编码；系统内唯一 | +| `sCategoryName` | varchar(100) | 否 | — | 权限分类名称（界面展示） | +| `iParentId` | int | 是 | NULL | 父分类 ID（自引用，根节点为 NULL） | +| `iSortOrder` | int | 否 | 0 | 同级排序号 | +| `sCreatedBy` | varchar(50) | 是 | — | 制单人 | +| `bDeleted` | bit(1) | 否 | 0 | 软删除标记 | +| `tDeletedDate` | datetime | 是 | NULL | 软删除时间 | +| `sDeletedBy` | varchar(50) | 是 | NULL | 软删除操作人 | + +### 索引 + +- `uk_category_code` (UNIQUE): (`sCategoryCode`) +- `idx_parent` (NORMAL): (`iParentId`) + +### 外键 + +- `fk_category_parent`: `iParentId` → `tPermissionCategory.iIncrement` (ON DELETE RESTRICT, ON UPDATE CASCADE) + +### 业务注记 + +- REQ-USR-001 / 002 表 2「权限组 - 权限分类」下拉来源即本表（`bDeleted = 0` 过滤）。 +- 自引用形成权限分类树；删除前须确保无子分类、无 `tUserPermission` 引用。 + +--- + +## `tUserPermission` — 用户与权限分类关联 + +### 字段 + +| 字段 | 类型 | Nullable | 默认 | 业务含义 | +|---|---|---|---|---| +| `iIncrement` | int | 否 | — | 整数主键 ID（标准列） | +| `sId` | varchar(100) | 是 | — | 业务 ID（标准列） | +| `sBrandsId` | varchar(100) | 是 | — | 品牌 ID（多租户隔离，标准列） | +| `sSubsidiaryId` | varchar(100) | 是 | — | 子公司 ID（组织层级隔离，标准列） | +| `tCreateDate` | datetime | 否 | — | 创建时间（标准列） | +| `iUserId` | int | 否 | — | 关联用户 ID（外键 → `tUser.iIncrement`） | +| `iCategoryId` | int | 否 | — | 关联权限分类 ID（外键 → `tPermissionCategory.iIncrement`） | +| `sCreatedBy` | varchar(50) | 是 | — | 授权操作人 | + +### 索引 + +- `uk_user_category` (UNIQUE): (`iUserId`, `iCategoryId`) +- `idx_category` (NORMAL): (`iCategoryId`) + +### 外键 + +- `fk_up_user`: `iUserId` → `tUser.iIncrement` (ON DELETE CASCADE, ON UPDATE CASCADE) +- `fk_up_category`: `iCategoryId` → `tPermissionCategory.iIncrement` (ON DELETE RESTRICT, ON UPDATE CASCADE) + +### 业务注记 + +- 关联表保留标准列以保持设计一致性，无独立软删除字段——授权撤销直接物理删除关联行（CASCADE 也会随用户删除而清理）。 +- REQ-USR-001 / 002 提交时按表 2 选中行重建本表 `iUserId` 下的关联（先删后插或差异同步）。 + +--- + +## `tModule` — ERP 业务模块元数据树 + +### 字段 + +| 字段 | 类型 | Nullable | 默认 | 业务含义 | +|---|---|---|---|---| +| `iIncrement` | int | 否 | — | 整数主键 ID（标准列） | +| `sId` | varchar(100) | 是 | — | 业务 ID（标准列） | +| `sBrandsId` | varchar(100) | 是 | — | 品牌 ID（多租户隔离，标准列） | +| `sSubsidiaryId` | varchar(100) | 是 | — | 子公司 ID（组织层级隔离，标准列） | +| `tCreateDate` | datetime | 否 | — | 创建时间（标准列） | +| `sDisplayType` | varchar(20) | 否 | `手机端` | 显示类型；枚举：`手机端` / `前端业务` / `系统配置` / `接口` | +| `sProcedureName` | varchar(100) | 否 | — | 存储过程（审核）名称；系统内唯一 | +| `sModuleType` | varchar(50) | 否 | — | 模块类型（本期按自由文本处理，VARCHAR(50)；如未来收敛到枚举再加 CHECK 约束） | +| `sManageDeptEn` | varchar(50) | 否 | — | 管理部门英文标识 | +| `bShowPermission` | bit(1) | 否 | 0 | 权限是否显示；0 否 / 1 是 | +| `sModuleNameZh` | varchar(100) | 否 | — | 界面名称（中文，模糊查询用） | +| `iParentId` | int | 是 | NULL | 父模块 ID（自引用，根节点为 NULL） | +| `iSortOrder` | int | 否 | 0 | 同级排序号 | +| `sCreatedBy` | varchar(50) | 是 | — | 制单人 | +| `bDeleted` | bit(1) | 否 | 0 | 软删除标记 | +| `tDeletedDate` | datetime | 是 | NULL | 软删除时间 | +| `sDeletedBy` | varchar(50) | 是 | NULL | 软删除操作人 | + +### 索引 + +- `uk_procedure_name` (UNIQUE): (`sProcedureName`) +- `idx_module_name_zh` (NORMAL): (`sModuleNameZh`) +- `idx_parent` (NORMAL): (`iParentId`) +- `idx_display_type` (NORMAL): (`sDisplayType`) + +### 外键 + +- `fk_module_parent`: `iParentId` → `tModule.iIncrement` (ON DELETE RESTRICT, ON UPDATE CASCADE) + +### 业务注记 + +- REQ-MOD-004 查询按 `sModuleNameZh` 模糊匹配（`LIKE '%关键字%'`，`bDeleted = 0` 过滤），结果按 `iParentId` 拼装树形。 +- REQ-MOD-003 删除策略：仅软删除（写入 `bDeleted` / `tDeletedDate` / `sDeletedBy`）；service 层先校验「无未删除子模块」「未被外部业务引用」再执行。 +- `sProcedureName` 假定系统内唯一，若实际允许同名请在审阅时移除该唯一索引。 diff --git b/docs/04-技术规范.md a/docs/04-技术规范.md new file mode 100644 index 0000000..68dbc64 --- /dev/null +++ a/docs/04-技术规范.md @@ -0,0 +1,169 @@ +# 04-技术规范 + +## 零、技术栈总览 + +| 分层模块 | 技术 | 版本要求 | 说明 | +|---|---|---|---| +| 前端基础框架 | React | 18.x | 构建前端应用 | +| 前端 UI 组件 | Ant Design | 5.x | 页面组件与交互控件 | +| 前端状态管理 | Redux Toolkit | 最新稳定版 | 管理全局状态 | +| 前端路由管理 | React Router | v6 | 页面路由与导航 | +| 前端工程化构建 | Vite | 最新稳定版 | 前端开发与打包构建 | +| 前端接口通信 | Axios | 最新稳定版 | 调用后端 API | +| 后端基础框架 | Spring Boot | 3.x | 构建后端服务 | +| 后端数据访问 | MyBatis-Plus | 最新稳定版 | 数据库访问与 ORM 增强 | +| 工作流引擎 | Activiti | 6.x | 审批流、流程流转 | +| 缓存服务 | Redis | 最新稳定版 | 缓存、会话、分布式能力 | +| 报表打印 | JXLS | 2.8.1 | 基于 Excel 模板生成报表 | +| Excel 导入导出 | EasyExcel | 4.0.3 | Excel 数据导入导出 | +| 关系型数据库 | MySQL | 8.x | 核心业务数据存储 | +| 数据库 schema 迁移 | Flyway (`flyway-core` + `flyway-mysql`) | 10.x / 最新稳定版 | `sql/migrations/V_n__*.sql` 顺序 apply；Spring Boot 启动时自动应用 | +| 接口风格 | RESTful API | 统一规范 | 前后端接口设计规范 | +| 权限认证 | Spring Security / JWT | 最新稳定版 | 登录认证、权限控制 | +| API 文档 | OpenAPI / Swagger | 最新稳定版 | 接口文档与调试 | +| 项目构建管理 | Maven | 3.9.x | Java 项目依赖与构建 | +| JDK 运行环境 | Java | 17 / 21 | Spring Boot 3 推荐版本 | +| 部署容器 | Docker | 最新稳定版 | 容器化部署 | +| Web 服务器 / 反向代理 | Nginx | 最新稳定版 | 前端托管、反向代理、负载分发 | +| 日志管理 | Logback | 默认集成 / 最新稳定版 | 应用日志输出 | +| 对象映射工具 | MapStruct | 最新稳定版 | DTO / VO / Entity 转换 | +| 工具类库 | Hutool / Apache Commons | 最新稳定版 | 常用工具方法支持 | + +> 本表由 scope-lock 锁定。后续所有规范基于此表推导。 + +## 一、后端规范 + +### 1.1 分层结构 + +| 层 | 职责 | +|---|---| +| `controller` | REST 入口，参数绑定 / 校验 / 调用 service，**不写业务逻辑** | +| `service` | 业务编排，事务边界，跨模块调用通过 service 接口完成 | +| `mapper` | MyBatis-Plus 接口 + XML，仅做 CRUD，不写业务规则 | +| `entity` | 与表 1:1 的 PO，仅作 ORM 映射 | +| `dto` / `vo` | 入参 DTO（Controller ↔ Service） / 出参 VO（Service → 前端） | +| `common` | 统一响应 / 全局异常 / 工具方法 | +| `config` | Spring 配置类（Security / Redis / Swagger / Web） | + +### 1.2 命名约定 + +- **包名**：全小写，根包 `com.xly.erp`，业务模块下按 `module..` 划分。 +- **类名**：大驼峰，如 `UserController` / `UserServiceImpl` / `UserMapper`。 +- **方法名**：小驼峰动宾式，如 `createUser` / `pageUsers`。 +- **常量**：全大写下划线，如 `MAX_PAGE_SIZE` / `JWT_TOKEN_HEADER`。 +- 示例： + - `.module.usr.controller.UserController#createUser` + - `.module.mod.service.ModuleService#pageModules` + +### 1.3 统一响应格式 + +```json +{ + "code": "0", + "message": "ok", + "data": { /* 业务数据 */ } +} +``` + +- 成功 `code=0`；失败按段位划分： + - `1xxx` 通用错误（参数 / 鉴权 / 权限） + - `2xxx` USR 模块业务错误 + - `3xxx` MOD 模块业务错误 + - 后续模块按段位顺延，由 `downstream-gen` 在 docs/05 中登记。 + +### 1.4 异常处理 + +- 使用 `@RestControllerAdvice` 注册全局异常处理器，统一捕获 `BizException` / `BindException` / `Exception`。 +- 业务异常抛 `BizException(code, message)`；参数校验由 Spring `@Valid` 触发。 +- **接口响应禁止回显后端异常堆栈**——堆栈只入 Logback 日志，响应只返回友好错误码 + 文案。 + +### 1.5 事务 + +- 事务边界统一在 `service` 层，使用 `@Transactional(rollbackFor = Exception.class)`。 +- **禁止跨服务远程调用包在事务内**；本项目暂无远程依赖，跨模块调用通过本地 service 接口同步完成。 +- 长耗时操作（导入导出、批处理）拆分为多个短事务，必要时入异步任务。 + +### 1.6 认证 + +- 基于 Spring Security + JWT 无状态认证： + - 登录返回 `accessToken`（HS256，过期 2 小时）+ `refreshToken`（过期 7 天）。 + - `accessToken` 通过 `Authorization: Bearer ` 请求头携带。 + - `refreshToken` 仅用于换新 `accessToken`，存于 Redis 用于黑名单 / 撤销。 +- JWT 密钥放 `.env.local`，启动期注入，**禁止硬编码**。 + +## 二、前端规范 + +### 2.1 目录约定 + +| 目录 | 职责 | +|---|---| +| `src/api/` | Axios 封装 + 模块接口；**前端禁止直接写 SQL / 操作 DB**，所有数据访问走 api/ 层 | +| `src/components/` | 通用组件（UI 组合、无业务） | +| `src/pages/` | 业务页面（按模块代码 usr / mod 分子目录） | +| `src/store/` | Redux Toolkit slices | +| `src/hooks/` | 通用 hooks | +| `src/utils/` | 纯函数工具（日期 / 金额 / 校验） | +| `src/router/` | React Router 配置 | +| `src/styles/` | 全局样式 + Design Token | + +### 2.2 状态管理 + +- 使用 Redux Toolkit + RTK Query（按需）管理服务端数据缓存。 +- 全局状态：登录用户信息、菜单树、权限码集合、全局加载态。 +- 局部 / 短生命周期状态：放组件 `useState` / `useReducer`，不进 store。 +- 服务端数据：列表 / 详情等"远程状态"放 `store/api`（RTK Query slice）或 React Query 替代。 + +### 2.3 请求封装 + +- `src/api/request.ts` 单例 Axios，注册： + - **请求拦截器**：注入 `Authorization` 头；请求超时默认 15 s。 + - **响应拦截器**：剥离 `data` 字段；遇 401 触发 token 刷新或跳登录；业务错误码统一抛出。 +- 不在业务代码里直接 `import axios`，统一走 `request.get/post`。 + +### 2.4 错误处理 + +- **网络错误**（无 response）：`message.error("网络异常，请检查连接")`，不重试。 +- **业务错误**（response.code !== 0）：`message.error(response.message)`；权限类错误（401 / 403）跳登录或 403 页。 +- **页面级错误**（路由级 `ErrorBoundary`）：渲染 `Result` 组件，提供"返回首页"链接。 + +### 2.5 样式与主题 + +- CSS 变量命名：`--color---` + - `scope` ∈ {`form`, `table-row`, `button`, `panel`, ...} + - `role` ∈ {`bg`, `fg`, `border`} + - `state` ∈ {`edit`, `readonly`, `hover`, `selected`, `disabled`} +- 文件位置：`src/styles/tokens.css`，由 skeleton-gen 生成空骨架，色值由 docs/06 § 四锁定后填入。 +- 组件样式中只用 `var(--color-xxx)`，**禁止硬编码 hex / rgba**。 +- 与 Ant Design ConfigProvider 对接：在 App 根读取 `tokens.css` 变量映射到 `theme.token`（如 `colorPrimary` 取自 `getComputedStyle(document.documentElement).getPropertyValue('--color-primary')`）。 +- 具体 token 表见 `docs/06 § 四`。 + +## 三、共同约定 + +### 3.1 Git 提交 + +`(): REQ-XXX-NNN` + +### 3.2 分页查询 + +- **后端入参**：`PageRequest { pageNum: int (≥1), pageSize: int (1-100), keyword?: string, sort?: string }` +- **后端出参**：`PageResult { total: long, list: List, pageNum, pageSize }` +- **前端**：使用 Ant Design `Table` 受控分页，`current / pageSize` 与后端 `pageNum / pageSize` 对齐。 + +### 3.3 日期与金额 + +- **后端日期**：`LocalDateTime`（数据库 `DATETIME`），统一序列化为 ISO 8601（`yyyy-MM-dd'T'HH:mm:ss`）。 +- **后端金额**：`BigDecimal`，数据库 `DECIMAL(18,4)`，业务展示精度由前端统一 `utils/money.ts` 处理。 +- **前端展示**：日期使用 `dayjs` 格式化；金额使用 `toFixed(2)` + 千分位分隔。 + +### 3.4 数据访问规约 + +- SELECT 字段**显式列举**，禁止 `SELECT *`。 +- 循环中**不得执行 DB 查询**（N+1 反模式），改用批量查 / `IN` 子句 / `JOIN`。 +- Mapper XML 字段名 / 表名使用 `` 复用，避免散落字符串拼接。 +- 使用 MyBatis-Plus 的 `LambdaQueryWrapper` 时，字段引用通过方法引用（如 `User::getId`），不允许直接传字符串字段名。 + +### 3.5 配置与安全 + +- **配置**：DB 连接 / Redis 地址 / JWT 密钥 / 第三方 URL 一律放 `application.yml` 占位 + `.env.local` 真值，**代码里禁止硬编码**。 +- **前端安全**：`localStorage` **不存敏感信息**（token / 身份 / 个人数据），推荐 HttpOnly Cookie 或 内存 + refresh token 模式。 +- 接口响应禁止回显后端异常堆栈（与 § 1.4 一致）。 diff --git b/docs/05-API接口契约.md a/docs/05-API接口契约.md new file mode 100644 index 0000000..632d8a9 --- /dev/null +++ a/docs/05-API接口契约.md @@ -0,0 +1,166 @@ +# 05-API接口契约 + +BasePath: `/api` +端口: `8080` + +## 全局约定 + +### 响应格式 +```json +{"code": 200, "message": "操作成功", "data": {}, "timestamp": 1700000000000} +``` + +### 错误码 +| 范围 | 含义 | +|---|---| +| 200 | 成功 | +| 400xx | 客户端参数错误 | +| 401xx | 认证/授权错误 | +| 403xx | 权限不足 | +| 404xx | 资源不存在 | +| 500xx | 服务端内部错误 | + +### 鉴权 + +除登录接口（`POST /api/auth/login`）外，所有接口要求 `Authorization: Bearer ` 请求头。token 由 `POST /api/auth/login` 签发，HS256，有效期 2 小时；过期返回 `40101`，前端需用 refreshToken 换新或重新登录。 + +### 分页参数 + +- 入参（query）：`pageNum`（≥1，默认 1）、`pageSize`（1~100，默认 20）、`keyword`（可选模糊查询）、`sort`（可选，形如 `field,asc|desc`）。 +- 出参（data）：`{ "total": 0, "list": [], "pageNum": 1, "pageSize": 20 }`。 + +## 接口清单 + +（各模块接口段落见下方，由 `downstream-gen` 按 REQ 填入） + +--- + +## module_mod 模块管理 + +### REQ-MOD-001 模块新增 + +- **Method**: POST +- **Path**: `/api/modules` +- **Auth**: 需要 +- **Permission**: `MOD:CREATE` +- **请求**: JSON body：`sDisplayType`（必填，枚举：手机端 / 前端业务 / 系统配置 / 接口）、`sProcedureName`（必填，唯一）、`sModuleType`（必填）、`sManageDeptEn`（必填）、`bShowPermission`（可选，默认 false）、`sModuleNameZh`（必填）、`iParentId`（可选）、`iSortOrder`（可选，默认 0） +- **响应**: `data.iIncrement` 新模块主键 + 完整模块对象（VO） + +#### 错误码 +- `40010` — 参数缺失或格式错误 +- `40911` — `sProcedureName` 已存在（唯一性冲突） +- `40411` — `iParentId` 指向的父模块不存在或已删除 + +--- + +### REQ-MOD-002 模块修改 + +- **Method**: PUT +- **Path**: `/api/modules/{id}` +- **Auth**: 需要 +- **Permission**: `MOD:UPDATE` +- **请求**: 路径参数 `id` = `iIncrement`；JSON body 同新增（`sProcedureName` 不可改），未提供字段保持原值 +- **响应**: `data` = 更新后的模块 VO + +#### 错误码 +- `40010` — 参数缺失或格式错误 +- `40421` — 模块不存在或已删除 +- `40921` — 同级名称冲突或不能将自身/后代设为父模块 +- `40911` — `sProcedureName` 冲突（如尝试修改） + +--- + +### REQ-MOD-003 模块删除 + +- **Method**: DELETE +- **Path**: `/api/modules/{id}` +- **Auth**: 需要 +- **Permission**: `MOD:DELETE` +- **请求**: 路径参数 `id` = `iIncrement` +- **响应**: `data` = `{ "iIncrement": , "bDeleted": 1 }`（软删除标记） + +#### 错误码 +- `40421` — 模块不存在或已被删除 +- `40912` — 存在子模块或外部业务引用，禁止删除（响应附 `data.references`） + +--- + +### REQ-MOD-004 模块查询 + +- **Method**: GET +- **Path**: `/api/modules` +- **Auth**: 需要 +- **Permission**: `MOD:READ` +- **请求**: query 参数 `keyword`（可选，对 `sModuleNameZh` 模糊匹配）；返回完整树而非分页 +- **响应**: `data` = 模块树数组，节点结构：`{ iIncrement, sModuleNameZh, sDisplayType, sManageDeptEn, iParentId, iSortOrder, children: [] }` + +#### 错误码 +- `40010` — `keyword` 长度超限 + +--- + +## module_usr 用户管理 + +### REQ-USR-001 用户新增 + +- **Method**: POST +- **Path**: `/api/users` +- **Auth**: 需要 +- **Permission**: `USR:CREATE` +- **请求**: JSON body：`sUserNo`（必填）、`sUserName`（必填）、`iStaffId`（可选）、`sUserType`（必填）、`sLanguage`（必填）、`bCanModifyDocs`（可选，默认 false）、`permissionCategoryIds`（数组，对应 REQ-USR-001 表 2 选中行写入 `tUserPermission`）；密码不在请求中传，后端使用初始密码 `666666` 经 BCrypt 哈希后落库 +- **响应**: `data.iIncrement` 新用户主键 + 用户 VO（不含密码哈希） + +#### 错误码 +- `40020` — 参数缺失或格式错误 +- `40921` — `sUserName` 或 `sUserNo` 唯一性冲突 +- `40421` — `iStaffId` 不存在或已软删除 +- `40422` — `permissionCategoryIds` 含不存在的权限分类 + +--- + +### REQ-USR-002 用户修改 + +- **Method**: PUT +- **Path**: `/api/users/{id}` +- **Auth**: 需要 +- **Permission**: `USR:UPDATE` +- **请求**: 路径参数 `id` = `iIncrement`；JSON body 同新增（`sUserNo` 不可改）；`permissionCategoryIds` 重新覆盖当前权限关联（先删后插） +- **响应**: `data` = 更新后的用户 VO + +#### 错误码 +- `40020` — 参数缺失或格式错误 +- `40431` — 用户不存在或已软删除 +- `40931` — `sUserName` 唯一性冲突 +- `40331` — 当前操作员无权变更目标角色 + +--- + +### REQ-USR-003 用户查询 + +- **Method**: GET +- **Path**: `/api/users` +- **Auth**: 需要 +- **Permission**: `USR:READ` +- **请求**: query 参数：`pageNum` / `pageSize`（标准分页）、`queryField`（枚举：`username` / `staffname` / `userno` / `department` / `usertype` / `deleted` / `lastLoginDate` / `createdBy`）、`matchType`（`contains` / `notContains` / `equals`）、`queryValue`（可空） +- **响应**: `data` = `PageResult`，VO 字段：`iIncrement`、`sUserName`、`sStaffName`（join `tStaff`）、`sUserNo`、`sDepartment`（join `tStaff`）、`sUserType`、`sLanguage`、`bDeleted`、`tLastLoginDate`、`sCreatedBy`、`tCreateDate` + +#### 错误码 +- `40020` — `queryField` / `matchType` 非枚举值 +- `40021` — `pageSize` 超出 1~100 + +--- + +### REQ-USR-004 用户登录 + +- **Method**: POST +- **Path**: `/api/auth/login` +- **Auth**: 不需要 +- **Permission**: 无 +- **请求**: JSON body：`sUserName`（必填）、`sPassword`（必填，明文，HTTPS 传输）、`sVersion`（必填，枚举：`standard`） +- **响应**: `data` = `{ "accessToken": "...", "refreshToken": "...", "expiresIn": 7200, "user": { "iIncrement", "sUserNo", "sUserName", "sUserType", "sLanguage" } }`；登录成功同时回写 `tUser.tLastLoginDate` + +#### 错误码 +- `40101` — 用户名或密码错误（统一提示，不区分原因） +- `40102` — 账号已禁用 / 已软删除 +- `40301` — 账号被临时锁定（响应附 `data.cooldownSeconds` 剩余秒数） +- `40020` — 参数缺失或格式错误 diff --git b/docs/06-UI交互规范.md a/docs/06-UI交互规范.md new file mode 100644 index 0000000..fb7690e --- /dev/null +++ a/docs/06-UI交互规范.md @@ -0,0 +1,144 @@ +# 06-UI交互规范 + +## 一、整体布局 + +### 1.1 页面框架 + +采用 Ant Design 5.x 的 `Layout` 组件构建整体骨架，分三段： + +- **Header（顶部导航）**：左侧 Logo + 系统名（"小羚羊 ERP"），右侧用户头像下拉（个人信息 / 修改密码 / 退出登录）。 +- **Sider（侧边菜单）**：固定左侧，使用 `Menu` 组件以树形展示由 MOD 模块管理维护的功能菜单，支持折叠。 +- **Content（主区域）**：路由出口，渲染各业务页面，外包 `Breadcrumb` + `PageHeader` 上下文容器。 + +整体使用 `ConfigProvider` 注入主题与中文 `zh_CN` locale。 + +### 1.2 布局参数 + +| 项 | 默认值 | 说明 | +|---|---|---| +| Header 高度 | 56 px | 紧凑信息密度，留出更多内容区 | +| Sidebar 展开宽度 | 220 px | 菜单文案完整可见 | +| Sidebar 折叠宽度 | 56 px | 仅图标 | +| Content 内边距 | 16 px | 与 Card / Table 的内边距对齐 | +| 最小分辨率 | 1366 × 768 | ERP 桌面端为主，不做移动端适配 | + +## 二、标准页面类型 + +基于 USR / MOD 模块均为典型主数据维护场景，列表 / 表单 / 详情 三类页面足以覆盖；用户与模块均为扁平或浅层树结构，再补一个树形管理页用于 MOD。 + +### 2.1 列表页 + +自上而下三段： + +- **顶部操作区**：左侧批量动作（启用 / 停用 / 删除），右侧主操作（"新增 X"）。 +- **搜索栏**：`Form` 行内布局，含关键字 + 1~2 个枚举筛选；提交触发请求，"重置"清空。 +- **表格 + 分页**：`Table` + 服务端分页（`Pagination`），列尾固定 `操作` 列（编辑 / 详情 / 删除）。 +- 删除等危险操作需 `Modal.confirm` 二次确认。 + +### 2.2 表单页 + +新建 / 编辑统一使用右侧 `Drawer`（宽度 600 px），不跳页： + +- 字段使用 Ant Design `Form` + `Form.Item`，校验时机 `onBlur`，提交前再 `validateFields` 全量校验。 +- 提交按钮固定在 Drawer 右下角，主按钮"保存"在右、"取消"在左。 +- 提交期间按钮 `loading=true`，避免重复提交。 + +### 2.3 详情页 + +使用 `Descriptions`（`bordered + column={2}`）展示主数据，必要时 `Tabs` 切分"基本信息 / 关联资源 / 操作日志"等子页签；详情页只读，编辑动作回到 Drawer 表单。 + +### 2.4 树形管理页 + +仅 MOD 模块管理使用：左侧 `Tree` 展示模块层级，右侧 `Descriptions` + `Form` 展示选中节点详情；新增子模块使用节点上的"+"按钮直接打开 Drawer。 + +## 三、通用交互规则 + +### 3.1 操作反馈 + +- **成功**：`message.success`，文案 "<动作>成功"，自动消失 2 秒。 +- **失败**：`message.error` 或 `Modal.error`，文案优先取后端返回的 `message`，缺省"操作失败，请稍后重试"。 +- **危险操作**：删除 / 停用使用 `Modal.confirm` 二次确认，确认按钮使用 `danger` 色。 +- **长耗时按钮**：超过 300 ms 的请求按钮 `loading=true`，禁用重复点击。 + +### 3.2 数据展示 + +- **空状态**：`Empty` 组件，文案统一 "暂无数据"。 +- **加载**：列表整体 `Spin`；局部加载使用 Skeleton。 +- **异常**：请求失败统一 `Result` 组件 + "重试"按钮，错误码 / 错误信息以小字置于副标题。 + +### 3.3 权限控制（前端） + +- **菜单级**：登录返回的菜单树驱动 `Sider Menu`，未授权模块不渲染。 +- **按钮级**：自定义 `` 包装组件，按权限码控制按钮可见 / 禁用。 +- **路由级**：`` 高阶组件，未授权路由重定向到 403 页。 +- 所有权限码与后端 RBAC 对齐，前端不做信任决策，仅做展示控制。 + +## 四、Design Tokens + +### 4.1 全局调色板 + +与 Ant Design 5.x 主题 token 对齐，统一以 CSS 变量定义于 `src/styles/tokens.css`，并通过 `ConfigProvider.theme.token` 映射。 + +| 语义 | 变量名 | 默认值 | 用途 | +|---|---|---|---| +| 主色 | `--color-primary` | `#1677ff` | 主按钮 / 链接 / 高亮 | +| 成功 | `--color-success` | `#52c41a` | 成功消息 / 正向状态标签 | +| 警告 | `--color-warning` | `#faad14` | 提醒类反馈 | +| 错误 | `--color-error` | `#ff4d4f` | 错误消息 / 危险按钮 | +| 主文字 | `--color-text` | `rgba(0,0,0,0.88)` | 正文文字 | +| 次文字 | `--color-text-secondary` | `rgba(0,0,0,0.65)` | 辅助说明 | +| 边框 | `--color-border` | `#d9d9d9` | 表单边框 / 分割线 | +| 背景 | `--color-bg` | `#ffffff` | 主体背景 | +| 容器背景 | `--color-bg-container` | `#fafafa` | Card / Sider 等容器 | + +### 4.2 组件级状态色 + +| 序号 | 组件 | 编辑 bg | 只读 bg | 悬浮 bg | 编辑 fg | 只读 fg | 悬浮 fg | 备注 | +|---|---|---|---|---|---|---|---|---| +| 1 | Form Input | `var(--color-bg)` | `var(--color-bg-container)` | `var(--color-bg)` | `var(--color-text)` | `var(--color-text-secondary)` | `var(--color-text)` | 只读使用 `disabled` 样式 | +| 2 | Table Row | `var(--color-bg)` | `var(--color-bg)` | `var(--color-row-hover)` | `var(--color-text)` | `var(--color-text)` | `var(--color-text)` | 选中行另用 `--color-row-selected` | +| 3 | Button Primary | `var(--color-primary)` | — | `var(--color-primary-hover)` | `#fff` | — | `#fff` | 危险按钮用 `--color-error` 系 | + +**Token 默认值**： + +| Token | 默认值 | +|---|---| +| `--color-row-hover` | `#f5f5f5` | +| `--color-row-selected` | `#e6f4ff` | +| `--color-primary-hover` | `#4096ff` | + +### 4.3 引用约定 + +- 组件样式只用 `var(--color-xxx)`，禁止硬编码 hex / rgba。 +- 新增 token 须先登记到 § 4.1 / 4.2 再补 `tokens.css`。 +- 修改色值只改 `tokens.css` 一处，不允许组件覆盖。 + +## 五、页面清单 + +### module_mod 模块管理 + +- **模块列表 / 树形管理** (`/mod/list`) + - 类型: 树形管理页（左 Tree 右 Form/Descriptions） + - 对应 REQ: REQ-MOD-001 / REQ-MOD-002 / REQ-MOD-003 / REQ-MOD-004 + - 入口菜单: 系统配置 → 模块管理 + - 主要交互: 关键字搜索 `sModuleNameZh` 模糊匹配；左侧 Tree 选中节点 → 右侧 Descriptions 展示详情；节点上 "+" 打开 Drawer 新增子模块；"编辑" 按钮打开 Drawer 修改；"删除" 按钮触发 Modal.confirm 二次确认软删除（存在子节点时禁用并提示） + +### module_usr 用户管理 + +- **用户列表** (`/usr/list`) + - 类型: 列表页 + - 对应 REQ: REQ-USR-003（查询）/ REQ-USR-001（新增入口）/ REQ-USR-002（编辑入口） + - 入口菜单: 系统配置 → 用户管理 + - 主要交互: 顶部搜索栏（查询字段下拉 + 匹配方式下拉 + 查询值文本框）；右上 "新增用户" 主按钮；表格列尾 "编辑 / 详情" 操作；分页器（20/页 默认） + +- **用户表单（新增 / 编辑）** (`/usr/list?drawer=user`) + - 类型: 表单页（Drawer 形式，与列表页同路由用 query 控制开合） + - 对应 REQ: REQ-USR-001 / REQ-USR-002 + - 入口菜单: 列表页"新增用户"按钮 / 列表行"编辑"按钮 + - 主要交互: 基本字段表单（用户号 / 用户名 / 员工 / 类型 / 语言 / 单据修改权限）+ 权限组多选 Table；保存触发后端校验，唯一性冲突在字段下方红字提示；初始密码不在表单展示，由后端默认 `666666` + +- **登录页** (`/login`) + - 类型: 表单页（独立全屏布局，不走 Layout 框架） + - 对应 REQ: REQ-USR-004 + - 入口菜单: 未登录时所有路由重定向到此 + - 主要交互: 用户名 + 密码（星号显示）+ 版本下拉；提交登录返回 token 写入内存 / Cookie；连续失败锁定后展示剩余冷却时间并禁用按钮 diff --git b/docs/07-环境配置.md a/docs/07-环境配置.md new file mode 100644 index 0000000..5e554ba --- /dev/null +++ a/docs/07-环境配置.md @@ -0,0 +1,48 @@ +# 07-环境配置 + +## 一、依赖清单 + +| 层 | 依赖 | 版本 | 说明 | +|---|---|---|---| +| 运行时 | JDK | Java 17 / 21 | Spring Boot 3 推荐版本 | +| 运行时 | MySQL | 8.x | 关系型数据库 | +| 运行时 | Redis | 最新稳定版 | 缓存 / 会话 | +| 运行时 | Node.js | 20 LTS | 前端构建运行时 | +| 运行时 | Nginx | 最新稳定版 | 前端托管 / 反向代理 | +| 构建 | Maven | 3.9.x | 后端依赖与构建 | +| 构建 | Vite | 最新稳定版 | 前端开发与打包 | +| 构建 | npm / pnpm | 最新稳定版 | 前端依赖管理 | +| 容器 | Docker | 最新稳定版 | 容器化部署 | +| 容器 | Docker Compose | 最新稳定版 | 本地多服务编排 | +| CLI | git | 最新稳定版 | 源码管理 | +| CLI | mysql-client | 8.x | 命令行连接数据库 | +| CLI | redis-cli | 最新稳定版 | 命令行操作 Redis | +| CLI | glab | 最新稳定版 | 创建 / 管理 GitLab MR | + +## 二、端口约定 + +| 服务 | 端口 | 说明 | +|---|---|---| +| 后端 HTTP | 8080 | Spring Boot 默认端口 | +| 前端 dev | 5173 | Vite 默认端口 | +| MySQL | 3306 | 数据库 | +| Redis | 6379 | 缓存 | +| Nginx | 80 / 443 | 反向代理 / HTTPS | + +## 三、环境变量 + +运行时凭据（数据库连接、Redis 连接、JWT 密钥等）全部放在仓库根的 `.env.local`，不入 git。 +字段清单与占位符见该文件，真实值由开发者本地填写。 + +## 四、常用命令 + +| 命令 | 说明 | +|---|---| +| `cd backend && mvn spring-boot:run` | 启动后端服务 | +| `cd frontend && npm run dev` | 启动前端 dev 服务 | +| `cd backend && mvn clean package -DskipTests` | 后端打包 | +| `cd frontend && npm run build` | 前端打包 | +| `bash scripts/test.sh` | 全量测试（后端 + 前端 + E2E） | +| `bash scripts/setup-test-db.sh` | 重置测试数据库（DROP + CREATE） | +| `glab mr create` | 创建 GitLab MR | +| `git push` | 推送（pre-push 钩子会预跑后端测试） | diff --git b/docs/08-模块任务管理.md a/docs/08-模块任务管理.md new file mode 100644 index 0000000..c0d985e --- /dev/null +++ a/docs/08-模块任务管理.md @@ -0,0 +1,76 @@ +# 08-工作流进度 + +> 全流程进度跟踪。CC 每完成一项产出就勾选一项。 +> - **§ 一 Plan（A0~A5）**：`plan-start` 找第一个未勾 A 子项分发到对应 skill +> - **§ 二 Coding（模块）**：分发以 `docs/02-开发计划.md § 二 开发顺序清单` 为准；`coding-start` 按 docs/02 顺序扫描，对每个 REQ 所属模块查询本 § 二的 `MR:` 字段 + GitLab API `state`，找第一个非 merged 模块分发。本 § 二 行序无语义，仅作模块元数据表 + +## 一、Plan 阶段（一次性） + +- [x] A0 项目初始化 — project-init + - [x] 依赖检查通过 + - [x] 项目文件骨架已创建（CLAUDE.md + docs/01-需求清单/index.md + docs/04-技术规范.md） + - [x] Git 已初始化 + +- [x] A1 范围锁定 — scope-lock + - [x] 项目概述已填写（CLAUDE.md § 🎯 项目概述） + - [x] 技术栈已确认（docs/04 § 零） + - [x] 需求清单索引已填写（docs/01-需求清单/index.md） + - [x] REQ 卡片骨架已生成（docs/01-需求清单//REQ-*.md，业务内容留待人工填写） + +- [x] A2 骨架生成 — skeleton-gen + - [x] 架构文档已生成（docs/04 § 一+、docs/06、docs/07、docs/09） + - [x] 工具脚本已生成（scripts/*.sh、.githooks/pre-push、.env.local） + - [x] .gitignore 已配置 + +- [x] A3 DB 设计 + REQ 回填 — db-design-gen + - [x] docs/03-数据库设计文档.md 已生成 + - [x] docs/01 各 REQ 卡片"依赖表" + 模块头"涉及表" 已回填 + +- [x] A4 DB 初始化 — db-init + - [x] sql/migrations/V1__initial_schema.sql 已生成 + - [x] DDL 与 docs/03 全量一致 + - [x] .env.local 凭据已验证（mysql -e "SELECT 1" OK） + - [x] setup-test-db.sh 防护通过 + DROP+CREATE + apply V1 已执行 + - [x] SHOW TABLES 行数 == docs/03 表数量 + +- [x] A5 下游文档生成 — downstream-gen + - [x] docs/02 开发计划已生成 + - [x] docs/05 API 契约已生成 + - [x] docs/06 § 五 页面清单已填入 + - [x] docs/10 验收清单已生成 + - [x] 下方模块列表已填入 + - [x] REQ 卡片依赖接口已回填 + +## 二、Coding 阶段（按模块循环） + +（A5 填入后，每行一个模块。每个模块的 `MR:` 字段在 `—` 和 `!` 之间变化，完成由 GitLab API `state=merged` 判定。`coding-start` 每次按 docs/02 REQ 序扫每模块的 MR state 决定派发。） + + + +- module_mod 模块管理 + - 依赖: — + - 路径: backend/src/main/java/com/xly/erp/module/mod/, frontend/src/pages/mod/ + - MR: — + - 功能: + - [ ] REQ-MOD-001 模块新增 + - [ ] REQ-MOD-002 模块修改 + - [ ] REQ-MOD-003 模块删除 + - [ ] REQ-MOD-004 模块查询 + +- module_usr 用户管理 + - 依赖: — + - 路径: backend/src/main/java/com/xly/erp/module/usr/, frontend/src/pages/usr/ + - MR: — + - 功能: + - [ ] REQ-USR-001 用户新增 + - [ ] REQ-USR-002 用户修改 + - [ ] REQ-USR-003 用户查询 + - [ ] REQ-USR-004 用户登录 diff --git b/docs/09-项目目录结构.md a/docs/09-项目目录结构.md new file mode 100644 index 0000000..9e9f728 --- /dev/null +++ a/docs/09-项目目录结构.md @@ -0,0 +1,122 @@ +# 09-项目目录结构 + +## 一、仓库顶层 + +``` +. +├── CLAUDE.md # Claude Code 主指令 +├── README.md +├── .env.local # 本地凭据，不入 git +├── .gitignore +├── .githooks/ +│ └── pre-push # 推送前测试闸门 +├── scripts/ +│ ├── test.sh # 全量测试 +│ └── setup-test-db.sh # 重置测试数据库 +├── sql/ +│ └── migrations/ # Flyway V_n__*.sql +├── docs/ # 项目文档（见 § 四） +├── backend/ # 后端 Spring Boot 模块 +└── frontend/ # 前端 Vite + React 模块 +``` + +## 二、后端目录 + +根包名 `com.xly.erp`，本节以 `` 代指。 + +``` +backend/ +├── pom.xml +├── src/ +│ ├── main/ +│ │ ├── java// +│ │ │ ├── ErpApplication.java # Spring Boot 启动类 +│ │ │ ├── common/ # 统一响应 / 异常 / 工具 +│ │ │ │ ├── response/ # ApiResponse / ErrorCode +│ │ │ │ ├── exception/ # 全局异常处理器 +│ │ │ │ └── util/ # Hutool 二次封装等 +│ │ │ ├── config/ # SecurityConfig / RedisConfig / SwaggerConfig +│ │ │ ├── security/ # JWT 过滤器 / RBAC +│ │ │ └── module/ +│ │ │ ├── usr/ # USR 用户管理 +│ │ │ │ ├── controller/ +│ │ │ │ ├── service/ +│ │ │ │ ├── mapper/ +│ │ │ │ ├── entity/ +│ │ │ │ ├── dto/ +│ │ │ │ └── vo/ +│ │ │ └── mod/ # MOD 模块管理 +│ │ │ ├── controller/ +│ │ │ ├── service/ +│ │ │ ├── mapper/ +│ │ │ ├── entity/ +│ │ │ ├── dto/ +│ │ │ └── vo/ +│ │ └── resources/ +│ │ ├── application.yml +│ │ ├── application-dev.yml +│ │ ├── logback-spring.xml +│ │ └── mapper/ # MyBatis-Plus XML +│ └── test/ +│ └── java// # 单元 / 集成测试 +└── target/ # 构建产物，git 忽略 +``` + +## 三、前端目录 + +``` +frontend/ +├── package.json +├── vite.config.ts +├── index.html +├── src/ +│ ├── main.tsx # 入口 +│ ├── App.tsx # 路由总配置 +│ ├── api/ # axios 封装 + 各模块接口 +│ │ ├── request.ts +│ │ ├── usr.ts +│ │ └── mod.ts +│ ├── components/ # 通用组件 +│ ├── pages/ +│ │ ├── usr/ # USR 页面 +│ │ └── mod/ # MOD 页面 +│ ├── store/ # Redux Toolkit slices +│ ├── hooks/ +│ ├── utils/ +│ ├── styles/ +│ │ ├── tokens.css # Design Token CSS 变量 +│ │ └── index.css +│ └── router/ # React Router 配置 +└── public/ +``` + +## 四、docs/ 结构 + +``` +docs/ +├── 01-需求清单/ # 每模块一子目录（_module.md 模块头 + REQ-*.md 卡片） +├── 02-开发计划.md +├── 03-数据库设计文档.md +├── 04-技术规范.md +├── 05-API接口契约.md +├── 06-UI交互规范.md +├── 07-环境配置.md +├── 08-模块任务管理.md +├── 09-项目目录结构.md +├── 10-验收检查清单.md +└── superpowers/ # CC 运行时产物 +``` + +## 五、命名与放置约定 + +- **根包名**：`com.xly.erp`，所有 Java 类位于此包及其子包下。 +- **前端命名空间**：以 `@/` 别名映射 `frontend/src/`（在 `vite.config.ts` 中配置）。 +- **Controller**：`.module..controller.XxxController`，REST 入口；不包含业务逻辑。 +- **Service**：`.module..service.XxxService` + `service.impl.XxxServiceImpl`，业务编排，事务边界。 +- **Mapper**：`.module..mapper.XxxMapper`（接口）+ `resources/mapper//XxxMapper.xml`（XML）。 +- **Entity**：`.module..entity.Xxx`，1:1 映射数据库表。 +- **DTO**：`.module..dto.XxxDTO`，入参传输对象（Controller ↔ Service）。 +- **VO**：`.module..vo.XxxVO`，出参视图对象（Service → Controller → 前端）。 +- **前端组件**：`frontend/src/components/<域>/XxxComponent.tsx`，复用粒度。 +- **前端页面**：`frontend/src/pages//<功能>.tsx`，与 REQ 卡片功能一一对应。 +- **API 模块**：`frontend/src/api/.ts` 一个文件汇集该模块所有后端接口调用。 diff --git b/docs/10-验收检查清单.md a/docs/10-验收检查清单.md new file mode 100644 index 0000000..3a9c860 --- /dev/null +++ a/docs/10-验收检查清单.md @@ -0,0 +1,16 @@ +# 10-验收检查清单 + +通用验收项（全项目适用）： + +- [ ] `scripts/test.sh` 本地全绿 +- [ ] 所有 schema 改动都有对应 `sql/migrations/V_n__.sql` +- [ ] 所有新接口在 `docs/05` 中有契约定义 +- [ ] 所有新功能代码注释含 REQ-XXX-NNN +- [ ] 统一响应格式 `{code, message, data, timestamp}` +- [ ] 异常走全局处理器，不暴露堆栈到前端 +- [ ] 前端不存敏感信息到 localStorage + +> 本文档仅维护项目级验收 SOP。粒度更细的验收信息分散在： +> - **每 REQ 的业务验收点**：`docs/01-需求清单//.md § 验收` +> - **每模块的实测验收（数据 / UI / 自动化用例位置）**：由 B 阶段 `module-report` 在该模块完成时填入模块完成报告 +> - **REQ 开发进度（feature-review approve 状态）**：`docs/08 § 二` diff --git b/scripts/setup-test-db.sh a/scripts/setup-test-db.sh new file mode 100755 index 0000000..41a3970 --- /dev/null +++ a/scripts/setup-test-db.sh @@ -0,0 +1,65 @@ +#!/usr/bin/env bash +# scripts/setup-test-db.sh — 数据库重置脚本：drop + create 空库。 +# schema apply 由 Flyway 在 Spring Boot 启动时自动处理（见 docs/04 技术栈 + sql/migrations/V*.sql）。 +# seed 数据由测试框架负责（Spring @Sql / Flyway R__seed.sql / data.sql）。 +# +# 使用场景： +# - scripts/test.sh 开头：清空库，让 Spring 启动时 Flyway 从 V1 开始重放所有 migration +# - scripts/test.sh 结尾：清空库，避免测试遗留污染下次运行 +# - 手动调试时：reset 到零状态 +# +# 防护：本脚本只允许在本地 host + 测试库名上执行；非预期目标会被拒绝， +# 避免 .env.local 误指向 staging/prod 时触发不可逆 DROP。 + +set -euo pipefail + +ENV_FILE="$(dirname "$0")/../.env.local" +[ -f "$ENV_FILE" ] || { echo "[setup-test-db] ⚠️ .env.local 不存在（$ENV_FILE）" >&2; exit 1; } + +# 用 set -a 加载，让 KEY=VALUE 导出为环境变量；密码中含特殊字符时 .env.local 请用单引号包裹 +set -a; . "$ENV_FILE"; set +a + +# 防护 1：默认只允许本地 host（localhost / 127.0.0.1 / ::1）。 +# 若要为本项目额外允许某些远程 host（如公司测试 MySQL），在 .env.local 里设： +# TEST_DB_ALLOWED_HOSTS="118.178.19.35 test-mysql.internal" # 空格或逗号分隔 +# 被列入者可直接 DROP CREATE，不再需要 TEST_DB_ALLOW_REMOTE=1。 +ALLOWED_HOSTS="localhost 127.0.0.1 ::1 ${TEST_DB_ALLOWED_HOSTS//,/ }" +host_allowed=0 +for h in $ALLOWED_HOSTS; do + [ "${DB_HOST:-}" = "$h" ] && { host_allowed=1; break; } +done +if [ "$host_allowed" -ne 1 ]; then + echo "[setup-test-db] ⚠️ 拒绝在非白名单 host (${DB_HOST}) 上执行 DROP DATABASE" >&2 + echo " 当前白名单：${ALLOWED_HOSTS}" >&2 + echo " 加入 host：在 .env.local 追加 TEST_DB_ALLOWED_HOSTS=\" \"" >&2 + echo " 一次性绕过：TEST_DB_ALLOW_REMOTE=1 $0" >&2 + [ "${TEST_DB_ALLOW_REMOTE:-0}" = "1" ] || exit 1 +fi + +# 防护 2：schema 名需像测试/开发库（含 test / _dev / _local），否则要求显式确认 +case "${DB_SCHEMA:-}" in + *test*|*_dev|*_local|*_ci) + ;; + *) + echo "[setup-test-db] ⚠️ schema '${DB_SCHEMA}' 不像测试库（期望命名含 test / _dev / _local / _ci）" >&2 + echo " 如确为期望行为，请显式声明：TEST_DB_ALLOW_PROD_NAME=1 $0" >&2 + [ "${TEST_DB_ALLOW_PROD_NAME:-0}" = "1" ] || exit 1 + ;; +esac + +# 防护 3：显式 banner，让人看见自己在 drop 什么；远程 host 额外提示白名单内容 +echo "[setup-test-db] 即将 DROP + CREATE \`${DB_SCHEMA}\` on ${DB_HOST}:${DB_PORT}" +case "${DB_HOST:-}" in + localhost|127.0.0.1|::1) ;; + *) + echo "[setup-test-db] ⚠️ 目标是 **远程** host（已在 TEST_DB_ALLOWED_HOSTS 白名单中，每次 test.sh 都会 DROP）" + echo "[setup-test-db] 当前白名单: ${ALLOWED_HOSTS}" + echo "[setup-test-db] 若不希望每次自动 DROP，从 .env.local 的 TEST_DB_ALLOWED_HOSTS 删掉此 host" + ;; +esac + +MYSQL_CMD="mysql -h${DB_HOST} -P${DB_PORT} -u${DB_USER} -p${DB_PASSWORD}" + +$MYSQL_CMD -e "DROP DATABASE IF EXISTS \`${DB_SCHEMA}\`; CREATE DATABASE \`${DB_SCHEMA}\` CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;" + +echo "[setup-test-db] done — schema will be applied by Flyway when Spring Boot starts" diff --git b/scripts/test.sh a/scripts/test.sh new file mode 100755 index 0000000..1625250 --- /dev/null +++ a/scripts/test.sh @@ -0,0 +1,40 @@ +#!/usr/bin/env bash +# scripts/test.sh —— 合并到默认分支（main / master）前的测试闸门。 +# 顺序：detect → setup-db → build → lint → unit+integration → e2e → reset-db +# 由 .githooks/pre-push 和 test-gate skill（通过子会话）调用。 + +set -euo pipefail + +PROJECT_ROOT="$(cd "$(dirname "$0")/.." && pwd)" +cd "$PROJECT_ROOT" + +# Stack detection (runtime, mode-agnostic) +HAS_BACKEND=0; [ -d backend ] && HAS_BACKEND=1 +HAS_FRONTEND=0; [ -d frontend ] && HAS_FRONTEND=1 +if [ $HAS_BACKEND -eq 0 ] && [ $HAS_FRONTEND -eq 0 ]; then + echo "[test.sh] FATAL: neither backend/ nor frontend/ exists" >&2 + exit 1 +fi + +echo "[test.sh] 1/6 setup test db" +./scripts/setup-test-db.sh + +echo "[test.sh] 2/6 build" +if [ $HAS_BACKEND -eq 1 ]; then (cd backend && mvn -B clean package -DskipTests); else echo "[test.sh] skip backend build"; fi +if [ $HAS_FRONTEND -eq 1 ]; then (cd frontend && npm run build); else echo "[test.sh] skip frontend build"; fi + +echo "[test.sh] 3/6 lint" +if [ $HAS_BACKEND -eq 1 ]; then (cd backend && mvn -B compile); else echo "[test.sh] skip backend lint"; fi +if [ $HAS_FRONTEND -eq 1 ]; then (cd frontend && npm run lint); else echo "[test.sh] skip frontend lint"; fi + +echo "[test.sh] 4/6 unit + integration" +if [ $HAS_BACKEND -eq 1 ]; then (cd backend && mvn -B test); else echo "[test.sh] skip backend test"; fi +if [ $HAS_FRONTEND -eq 1 ]; then (cd frontend && npm test -- --run); else echo "[test.sh] skip frontend test"; fi + +echo "[test.sh] 5/6 E2E" +echo "[test.sh] e2e 略" + +echo "[test.sh] 6/6 reset test db" +./scripts/setup-test-db.sh + +echo "[test.sh] GREEN" diff --git b/sql/migrations/.gitkeep a/sql/migrations/.gitkeep new file mode 100644 index 0000000..e69de29 --- /dev/null +++ a/sql/migrations/.gitkeep diff --git b/sql/migrations/V1__initial_schema.sql a/sql/migrations/V1__initial_schema.sql new file mode 100644 index 0000000..1ad40e4 --- /dev/null +++ a/sql/migrations/V1__initial_schema.sql @@ -0,0 +1,165 @@ +-- Flyway migration V1 — initial schema for 小羚羊 +-- Generated: 2026-05-06T08:30:00Z +-- Source: 由 A4 db-init 从 docs/03-数据库设计文档.md 翻译生成（schema SSoT 是 docs/03） +-- This is the FIRST migration; subsequent schema changes must be written as new files sql/migrations/V2__.sql, V3__... etc. +-- Apply: Flyway runs this automatically at Spring Boot startup. +-- Do not hand-edit this file after it is committed; write a new migration instead. + +-- ============================================================ +-- 1) tUser — 系统用户账户与登录凭据 +-- ============================================================ +CREATE TABLE `tUser` ( + `iIncrement` int NOT NULL AUTO_INCREMENT COMMENT '整数主键 ID（标准列）', + `sId` varchar(100) NULL COMMENT '业务 ID（标准列）', + `sBrandsId` varchar(100) NULL COMMENT '品牌 ID（多租户隔离，标准列）', + `sSubsidiaryId` varchar(100) NULL COMMENT '子公司 ID（组织层级隔离，标准列）', + `tCreateDate` datetime NOT NULL COMMENT '创建时间（标准列）', + `sUserNo` varchar(50) NOT NULL COMMENT '用户号；系统内唯一', + `sUserName` varchar(50) NOT NULL COMMENT '用户名（登录账号）；系统内唯一', + `iStaffId` int NULL DEFAULT NULL COMMENT '关联职员 ID（可选，外键 → tStaff.iIncrement）', + `sUserType` varchar(20) NOT NULL DEFAULT '普通用户' COMMENT '用户类型；枚举：普通用户 / 超级管理员', + `sLanguage` varchar(10) NOT NULL DEFAULT 'zh' COMMENT '语言偏好；枚举：zh / en / zh-TW', + `bCanModifyDocs` bit(1) NOT NULL DEFAULT b'0' COMMENT '单据修改权限；0 否 / 1 是', + `sPasswordHash` varchar(255) NOT NULL COMMENT '密码哈希值（BCrypt 等强哈希算法），新增默认初始密码 666666 的哈希', + `tLastLoginDate` datetime NULL DEFAULT NULL COMMENT '最后登录时间', + `sCreatedBy` varchar(50) NULL COMMENT '制单人（创建用户的操作员用户号）', + `bDeleted` bit(1) NOT NULL DEFAULT b'0' COMMENT '软删除标记；0 有效 / 1 已作废', + `tDeletedDate` datetime NULL DEFAULT NULL COMMENT '软删除时间', + `sDeletedBy` varchar(50) NULL DEFAULT NULL COMMENT '软删除操作人', + PRIMARY KEY (`iIncrement`) +) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci COMMENT='系统用户账户与登录凭据'; + +-- ============================================================ +-- 2) tStaff — 职员维度（员工名 / 部门 / 编号） +-- ============================================================ +CREATE TABLE `tStaff` ( + `iIncrement` int NOT NULL AUTO_INCREMENT COMMENT '整数主键 ID（标准列）', + `sId` varchar(100) NULL COMMENT '业务 ID（标准列）', + `sBrandsId` varchar(100) NULL COMMENT '品牌 ID（多租户隔离，标准列）', + `sSubsidiaryId` varchar(100) NULL COMMENT '子公司 ID（组织层级隔离，标准列）', + `tCreateDate` datetime NOT NULL COMMENT '创建时间（标准列）', + `sStaffNo` varchar(50) NULL COMMENT '职员编号；系统内唯一', + `sStaffName` varchar(50) NOT NULL COMMENT '职员姓名', + `sDepartment` varchar(100) NULL DEFAULT NULL COMMENT '所属部门（本期暂用字符串，未来如需独立 tDepartment 字典表再另行重构）', + `sCreatedBy` varchar(50) NULL COMMENT '制单人', + `bDeleted` bit(1) NOT NULL DEFAULT b'0' COMMENT '软删除标记', + `tDeletedDate` datetime NULL DEFAULT NULL COMMENT '软删除时间', + `sDeletedBy` varchar(50) NULL DEFAULT NULL COMMENT '软删除操作人', + PRIMARY KEY (`iIncrement`) +) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci COMMENT='职员维度（员工名 / 部门 / 编号）'; + +-- ============================================================ +-- 3) tPermissionCategory — 权限分类树 +-- ============================================================ +CREATE TABLE `tPermissionCategory` ( + `iIncrement` int NOT NULL AUTO_INCREMENT COMMENT '整数主键 ID（标准列）', + `sId` varchar(100) NULL COMMENT '业务 ID（标准列）', + `sBrandsId` varchar(100) NULL COMMENT '品牌 ID（多租户隔离，标准列）', + `sSubsidiaryId` varchar(100) NULL COMMENT '子公司 ID（组织层级隔离，标准列）', + `tCreateDate` datetime NOT NULL COMMENT '创建时间（标准列）', + `sCategoryCode` varchar(50) NOT NULL COMMENT '权限分类编码；系统内唯一', + `sCategoryName` varchar(100) NOT NULL COMMENT '权限分类名称（界面展示）', + `iParentId` int NULL DEFAULT NULL COMMENT '父分类 ID（自引用，根节点为 NULL）', + `iSortOrder` int NOT NULL DEFAULT 0 COMMENT '同级排序号', + `sCreatedBy` varchar(50) NULL COMMENT '制单人', + `bDeleted` bit(1) NOT NULL DEFAULT b'0' COMMENT '软删除标记', + `tDeletedDate` datetime NULL DEFAULT NULL COMMENT '软删除时间', + `sDeletedBy` varchar(50) NULL DEFAULT NULL COMMENT '软删除操作人', + PRIMARY KEY (`iIncrement`) +) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci COMMENT='权限分类树'; + +-- ============================================================ +-- 4) tUserPermission — 用户与权限分类关联 +-- ============================================================ +CREATE TABLE `tUserPermission` ( + `iIncrement` int NOT NULL AUTO_INCREMENT COMMENT '整数主键 ID（标准列）', + `sId` varchar(100) NULL COMMENT '业务 ID（标准列）', + `sBrandsId` varchar(100) NULL COMMENT '品牌 ID（多租户隔离，标准列）', + `sSubsidiaryId` varchar(100) NULL COMMENT '子公司 ID（组织层级隔离，标准列）', + `tCreateDate` datetime NOT NULL COMMENT '创建时间（标准列）', + `iUserId` int NOT NULL COMMENT '关联用户 ID（外键 → tUser.iIncrement）', + `iCategoryId` int NOT NULL COMMENT '关联权限分类 ID（外键 → tPermissionCategory.iIncrement）', + `sCreatedBy` varchar(50) NULL COMMENT '授权操作人', + PRIMARY KEY (`iIncrement`) +) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci COMMENT='用户与权限分类关联'; + +-- ============================================================ +-- 5) tModule — ERP 业务模块元数据树 +-- ============================================================ +CREATE TABLE `tModule` ( + `iIncrement` int NOT NULL AUTO_INCREMENT COMMENT '整数主键 ID（标准列）', + `sId` varchar(100) NULL COMMENT '业务 ID（标准列）', + `sBrandsId` varchar(100) NULL COMMENT '品牌 ID（多租户隔离，标准列）', + `sSubsidiaryId` varchar(100) NULL COMMENT '子公司 ID（组织层级隔离，标准列）', + `tCreateDate` datetime NOT NULL COMMENT '创建时间（标准列）', + `sDisplayType` varchar(20) NOT NULL DEFAULT '手机端' COMMENT '显示类型；枚举：手机端 / 前端业务 / 系统配置 / 接口', + `sProcedureName` varchar(100) NOT NULL COMMENT '存储过程（审核）名称；系统内唯一', + `sModuleType` varchar(50) NOT NULL COMMENT '模块类型（本期按自由文本处理，VARCHAR(50)；如未来收敛到枚举再加 CHECK 约束）', + `sManageDeptEn` varchar(50) NOT NULL COMMENT '管理部门英文标识', + `bShowPermission` bit(1) NOT NULL DEFAULT b'0' COMMENT '权限是否显示；0 否 / 1 是', + `sModuleNameZh` varchar(100) NOT NULL COMMENT '界面名称（中文，模糊查询用）', + `iParentId` int NULL DEFAULT NULL COMMENT '父模块 ID（自引用，根节点为 NULL）', + `iSortOrder` int NOT NULL DEFAULT 0 COMMENT '同级排序号', + `sCreatedBy` varchar(50) NULL COMMENT '制单人', + `bDeleted` bit(1) NOT NULL DEFAULT b'0' COMMENT '软删除标记', + `tDeletedDate` datetime NULL DEFAULT NULL COMMENT '软删除时间', + `sDeletedBy` varchar(50) NULL DEFAULT NULL COMMENT '软删除操作人', + PRIMARY KEY (`iIncrement`) +) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci COMMENT='ERP 业务模块元数据树'; + +-- ============================================================ +-- 索引 +-- ============================================================ +-- tUser +CREATE UNIQUE INDEX `uk_user_no` ON `tUser` (`sUserNo`); +CREATE UNIQUE INDEX `uk_user_name` ON `tUser` (`sUserName`); +CREATE INDEX `idx_staff_id` ON `tUser` (`iStaffId`); +CREATE INDEX `idx_brand_subsidiary` ON `tUser` (`sBrandsId`, `sSubsidiaryId`); +CREATE INDEX `idx_deleted_login` ON `tUser` (`bDeleted`, `tLastLoginDate`); + +-- tStaff +CREATE UNIQUE INDEX `uk_staff_no` ON `tStaff` (`sStaffNo`); +CREATE INDEX `idx_staff_name` ON `tStaff` (`sStaffName`); +CREATE INDEX `idx_department` ON `tStaff` (`sDepartment`); + +-- tPermissionCategory +CREATE UNIQUE INDEX `uk_category_code` ON `tPermissionCategory` (`sCategoryCode`); +CREATE INDEX `idx_parent` ON `tPermissionCategory` (`iParentId`); + +-- tUserPermission +CREATE UNIQUE INDEX `uk_user_category` ON `tUserPermission` (`iUserId`, `iCategoryId`); +CREATE INDEX `idx_category` ON `tUserPermission` (`iCategoryId`); + +-- tModule +CREATE UNIQUE INDEX `uk_procedure_name` ON `tModule` (`sProcedureName`); +CREATE INDEX `idx_module_name_zh` ON `tModule` (`sModuleNameZh`); +CREATE INDEX `idx_parent` ON `tModule` (`iParentId`); +CREATE INDEX `idx_display_type` ON `tModule` (`sDisplayType`); + +-- ============================================================ +-- 外键 +-- ============================================================ +ALTER TABLE `tUser` + ADD CONSTRAINT `fk_user_staff` + FOREIGN KEY (`iStaffId`) REFERENCES `tStaff` (`iIncrement`) + ON DELETE SET NULL ON UPDATE CASCADE; + +ALTER TABLE `tPermissionCategory` + ADD CONSTRAINT `fk_category_parent` + FOREIGN KEY (`iParentId`) REFERENCES `tPermissionCategory` (`iIncrement`) + ON DELETE RESTRICT ON UPDATE CASCADE; + +ALTER TABLE `tUserPermission` + ADD CONSTRAINT `fk_up_user` + FOREIGN KEY (`iUserId`) REFERENCES `tUser` (`iIncrement`) + ON DELETE CASCADE ON UPDATE CASCADE; + +ALTER TABLE `tUserPermission` + ADD CONSTRAINT `fk_up_category` + FOREIGN KEY (`iCategoryId`) REFERENCES `tPermissionCategory` (`iIncrement`) + ON DELETE RESTRICT ON UPDATE CASCADE; + +ALTER TABLE `tModule` + ADD CONSTRAINT `fk_module_parent` + FOREIGN KEY (`iParentId`) REFERENCES `tModule` (`iIncrement`) + ON DELETE RESTRICT ON UPDATE CASCADE; diff --git b/src/styles/tokens.css a/src/styles/tokens.css new file mode 100644 index 0000000..bc8a542 --- /dev/null +++ a/src/styles/tokens.css @@ -0,0 +1,43 @@ +/* + * src/styles/tokens.css — Design Tokens + * 命名规范见 docs/04-技术规范.md § 2.5 + * 色值锁定见 docs/06-UI交互规范.md § 四 + * + * 命名格式：--color--- + * 组件域：form / table-row / table-header / ... + * 作用：bg（背景）/ fg（前景/字体）/ border + * 状态：edit / readonly / hover / selected（无状态时省略） + * + * 约束： + * - 组件样式中只用 var(--color-xxx)，禁止硬编码 hex / rgba + * - 修改色值只改本文件，不允许在组件级覆盖 + * - 新增 token 须先登记到 docs/06 § 4.1 / 4.2，再补到此处 + */ + +:root { + /* === 1. 全局调色板（与 Ant Design 主题对齐） === */ + --color-primary: #1890ff; + --color-success: #52c41a; + --color-warning: #faad14; + --color-error: #ff4d4f; + --color-text: rgba(0, 0, 0, 0.85); + --color-text-secondary: rgba(0, 0, 0, 0.45); + --color-border: #d9d9d9; + --color-bg-base: #f0f2f5; + + /* === 2. 组件级状态色（与 docs/06 § 4.2 一一对应） === */ + + /* form：输入框 / 备注框 / 时间框 / 下拉框共用 */ + --color-form-bg-edit: #ffffff; + --color-form-bg-readonly: #f1f2f8; + --color-form-bg-hover: #f5f5f5; /* 仅下拉框使用 */ + --color-form-fg: #000000; + + /* table */ + --color-table-row-bg-selected: #86d5fb; + --color-table-row-bg-hover: #fff7e6; + --color-table-row-bg-readonly: #f1f2f8; /* = rgb(241, 242, 248) */ + --color-table-row-fg: #000000; + --color-table-header-bg: #f5f5f5; + --color-table-header-fg: rgba(0, 0, 0, 0.85); /* = #000000D9 */ +}