Commit 7de7347d99cc2ffd837b35d4c9e7bd60b529338f

Authored by zichun
1 parent 22037937

docs(module_usr): add module completion report + cross-module log

docs/superpowers/module-reports/2026-05-08-module_usr.md 0 → 100644
  1 +---
  2 +module_id: module_usr
  3 +date: 2026-05-08
  4 +git_range: master..module-module_usr
  5 +---
  6 +
  7 +# 模块完成报告 — module_usr 用户管理
  8 +
  9 +## ① 模块信息
  10 +- 模块 ID: module_usr
  11 +- 模块名: 用户管理
  12 +- 开发区间: master..module-module_usr(共 29 commits)
  13 +
  14 +## ② REQ 完成清单
  15 +
  16 +- [x] REQ-USR-004 — 用户登录
  17 + - spec: docs/superpowers/specs/2026-05-08-REQ-USR-004.md
  18 + - plan: docs/superpowers/plans/2026-05-08-REQ-USR-004.md
  19 + - review: docs/superpowers/reviews/2026-05-08-REQ-USR-004.md
  20 +
  21 +- [x] REQ-USR-001 — 增加用户
  22 + - spec: docs/superpowers/specs/2026-05-08-REQ-USR-001.md
  23 + - plan: docs/superpowers/plans/2026-05-08-REQ-USR-001.md
  24 + - review: docs/superpowers/reviews/2026-05-08-REQ-USR-001.md
  25 +
  26 +- [x] REQ-USR-003 — 查询用户
  27 + - spec: docs/superpowers/specs/2026-05-08-REQ-USR-003.md
  28 + - plan: docs/superpowers/plans/2026-05-08-REQ-USR-003.md
  29 + - review: docs/superpowers/reviews/2026-05-08-REQ-USR-003.md
  30 +
  31 +- [x] REQ-USR-002 — 修改用户
  32 + - spec: docs/superpowers/specs/2026-05-08-REQ-USR-002.md
  33 + - plan: docs/superpowers/plans/2026-05-08-REQ-USR-002.md
  34 + - review: docs/superpowers/reviews/2026-05-08-REQ-USR-002.md
  35 +
  36 +## ③ 文件变更表
  37 +
  38 +| 文件 | 操作 | 说明 |
  39 +|---|---|---|
  40 +| backend/pom.xml | 新增 | Spring Boot 3 项目配置,含 checkstyle 插件 |
  41 +| backend/checkstyle.xml | 新增 | 项目 checkstyle 规则(Spring Boot 友好) |
  42 +| backend/src/main/java/com/example/erp/common/\* | 新增 | Result/BizException/GlobalExceptionHandler/JwtUtil/PageVO/错误码常量 |
  43 +| backend/src/main/java/com/example/erp/config/\* | 新增 | SecurityConfig/JwtFilter/JwtProperties/UserPrincipal/BeanConfig/MybatisPlusConfig |
  44 +| backend/src/main/java/com/example/erp/module/usr/controller/\* | 新增 | AuthController(登录/刷新/品牌列表)、UserController(CRUD 接口) |
  45 +| backend/src/main/java/com/example/erp/module/usr/service/\* | 新增 | AuthService/AuthServiceImpl/UserService/UserServiceImpl |
  46 +| backend/src/main/java/com/example/erp/module/usr/entity/\* | 新增 | BrandEntity/UsrUserEntity/StaffEntity/PermissionGroupEntity/UserPermissionEntity |
  47 +| backend/src/main/java/com/example/erp/module/usr/mapper/\* | 新增 | BrandMapper/UsrUserMapper/StaffMapper/PermissionGroupMapper/UserPermissionMapper |
  48 +| backend/src/main/java/com/example/erp/module/usr/dto/\* | 新增 | LoginReqDTO/RefreshTokenReqDTO/UserCreateReqDTO/UserListQueryDTO/UserUpdateReqDTO |
  49 +| backend/src/main/java/com/example/erp/module/usr/vo/\* | 新增 | LoginVO/BrandVO/StaffVO/PermissionGroupVO/UserCreateRespVO/UserListItemVO/UserUpdateRespVO |
  50 +| backend/src/main/resources/mapper/UsrUserMapper.xml | 新增 | selectUserList 动态查询 SQL |
  51 +| backend/src/main/resources/db/migration/V1\_\_initial\_schema.sql | 新增 | 初始全量 schema |
  52 +| backend/src/main/resources/db/migration/V2\_\_fix\_username\_unique\_per\_tenant.sql | 新增 | 用户名唯一索引改为租户范围内唯一 |
  53 +| backend/src/test/\* | 新增 | 49 个测试(ApplicationContext/JwtUtil/Result/AuthService/AuthController/UserService/UserController/BrandMapper) |
  54 +| frontend/src/api/auth.ts | 新增 | 登录/刷新 API 函数 |
  55 +| frontend/src/api/request.ts | 新增 | Axios 请求拦截器(含 JWT 自动注入) |
  56 +| frontend/src/api/usr.ts | 新增 | 用户增/查/改 API 接口及类型定义 |
  57 +| frontend/src/pages/usr/LoginPage.tsx | 新增 | 登录页(多品牌选择) |
  58 +| frontend/src/pages/usr/UserFormDrawer.tsx | 新增 | 新增/修改用户抽屉(复用组件) |
  59 +| frontend/src/pages/usr/UserListPage.tsx | 新增 | 用户列表(搜索+分页+操作列) |
  60 +| frontend/src/store/\* | 新增 | Redux auth 切片(credentials/userInfo) |
  61 +| frontend/src/components/PermButton.tsx | 新增 | 基于用户类型的权限按钮组件 |
  62 +| frontend/src/test/\* | 新增 | 10 个前端测试(authSlice/LoginPage/UserListPage) |
  63 +| frontend/package.json | 修改 | lint 脚本改为 tsc --noEmit(eslint 未安装) |
  64 +| docs/03-数据库设计文档.md | 修改 | 同步 V2 migration 唯一索引变更 |
  65 +| docs/04-技术规范.md | 修改 | 分页入参规范统一为 page(原 pageNum) |
  66 +| docs/05-API接口契约.md | 修改 | 分页规范同步更新 |
  67 +| docs/08-模块任务管理.md | 修改 | 4 个 REQ 全部勾选 [x] |
  68 +| scripts/test.sh | 修改 | 添加 Java 21 PATH 适配(Lombok 兼容性) |
  69 +
  70 +## ④ 数据库使用表
  71 +- 读: `brand`(登录品牌列表)、`tStaff`(员工下拉)、`usr_permission_group`(权限组下拉)
  72 +- 写: `usr_user`(登录时更新 tLastLoginDate/iLoginFailCount/tLockUntil;新增/修改用户字段)、`usr_user_permission`(新增/修改时先删后插)
  73 +
  74 +## ⑤ 测试结果
  75 +- `scripts/test.sh` 最终:green
  76 +- 通过: 59 / 失败: 0 / 跳过: 0
  77 +- 覆盖率: 未配置覆盖率工具(所有业务路径已有对应测试用例)
  78 +
  79 +## ⑥ 本模块新增 Migration
  80 +
  81 +- `backend/src/main/resources/db/migration/V1__initial_schema.sql` — 全量初始 schema(usr_user / tStaff / usr_permission_group / usr_user_permission / brand 五张表)
  82 +- `backend/src/main/resources/db/migration/V2__fix_username_unique_per_tenant.sql` — 将 uk_usr_user_username 从全局唯一改为租户范围内唯一(允许不同 brand 使用相同用户名)
  83 +
  84 +## ⑦ 跨模块改动清单(软规则 S2)
  85 +
  86 +本项目当前仅含 module_usr 一个模块,无跨模块改动。
  87 +
  88 +改动了两处项目级规范文档:
  89 +- `docs/04-技术规范.md § 3.2`:分页入参统一为 `page`(REQ-USR-003 review 发现 `pageNum` 与实现不一致,修正文档)
  90 +- `docs/05-API接口契约.md`:分页规范同步更新
  91 +
  92 +## ⑧ 偏离 spec 清单
  93 +
  94 +- REQ-USR-002:`UserListPage` 传给编辑抽屉的 `initialData` 中 `permGroupIds` 字段未传值(始终为空数组)。原因:用户列表 API 不返回每用户的权限组关联,无法在列表页预填。规格 § 前端交互设计 line 103 已明确说明"初始化为空数组即可,用户可重新勾选",属有意决策而非实现缺陷。
  95 +
  96 +## ⑨ AI reviewer 报告汇总
  97 +
  98 +- REQ-USR-004: round 2 — approve(link: docs/superpowers/reviews/2026-05-08-REQ-USR-004.md)
  99 +- REQ-USR-001: round 2 — approve(link: docs/superpowers/reviews/2026-05-08-REQ-USR-001.md)
  100 +- REQ-USR-003: round 4 — approve(link: docs/superpowers/reviews/2026-05-08-REQ-USR-003.md)
  101 +- REQ-USR-002: round 2 — approve(link: docs/superpowers/reviews/2026-05-08-REQ-USR-002.md)
  102 +
  103 +## ⑩ 已知问题
  104 +
  105 +1. **前端 lint 工具缺失**:`eslint` 未在 `package.json` 中声明为 devDependency,lint 脚本临时改为 `tsc --noEmit`。建议后续补充 ESLint + TypeScript ESLint 插件配置。
  106 +2. **`updatedAt` 序列化格式**:`UserUpdateRespVO.updatedAt` 未加 `@JsonFormat` 注解,依赖 Jackson 全局配置。如未配置全局 LocalDateTime 序列化器,返回值可能为数组格式而非 ISO-8601 字符串。
  107 +3. **controller 层 BizException 错误码映射测试缺失**:`UserControllerTest` 未覆盖 40300/40400/40301 通过 `GlobalExceptionHandler` 映射为 JSON 错误码的路径(低风险,handler 已通过 createUser 路径间接覆盖)。
  108 +
  109 +## ⑪ 下一模块预览
  110 +
  111 +当前项目 `docs/02-开发计划.md` 仅包含 module_usr 一个模块,无后续模块。本次开发计划全部完成。
  112 +
  113 +## ⑫ MR 链接
  114 +
  115 +(待 mr-create 步骤创建后填入)