Files
hzdyjs/docs/变更管理/code-adjust-record-2025-06-30-zlwu.md
T
2025-06-30 21:16:32 +08:00

489 lines
14 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 代码调整记录 - 2025-06-30 - zlwu
> 📅 **记录日期**: 2025-06-30
> 👤 **记录人员**: zlwu
> 📌 **排序说明**: 本文件按照时间倒序排列,最新的变更记录在最上面
## 调整记录 - 2025-06-30 21:06:09
**变更 ID**: CHG-20250630-004
**变更时间**: 2025-06-30 21:06:09
**变更人员**: zlwu/Cursor AI 辅助
**变更类型**: 🔧 重构优化
**影响级别**: 🟢 小变更
### 📋 变更概述
**变更目的**: 进一步简化后端 mapper 目录结构,将 pm 模块的 mapper 文件直接放在 hq 目录下,避免不必要的子目录嵌套
**影响范围**: 后端 mapper XML 文件目录结构
### 📁 涉及文件
**Mapper XML 文件**:
- backend/ruoyi-admin/src/main/resources/mapper/hq/pm/PmRepairOrderMapper.xml → backend/ruoyi-admin/src/main/resources/mapper/hq/PmRepairOrderMapper.xml
- backend/ruoyi-admin/src/main/resources/mapper/hq/pm/PmRepairCategoryMapper.xml → backend/ruoyi-admin/src/main/resources/mapper/hq/PmRepairCategoryMapper.xml
- backend/ruoyi-admin/src/main/resources/mapper/hq/pm/PmRepairProgressMapper.xml → backend/ruoyi-admin/src/main/resources/mapper/hq/PmRepairProgressMapper.xml
- backend/ruoyi-admin/src/main/resources/mapper/hq/pm/PmRepairAttachmentMapper.xml → backend/ruoyi-admin/src/main/resources/mapper/hq/PmRepairAttachmentMapper.xml
### 🔧 变更内容详述
**目录结构调整**:
1. 将 `backend/ruoyi-admin/src/main/resources/mapper/hq/pm/` 目录下的所有 mapper 文件移动到父级目录 `hq/`
2. 删除空的 `pm/` 子目录
3. 所有 hq 相关的 mapper 文件现在都统一在同一个目录下
**文件移动列表**:
- PmRepairOrderMapper.xml
- PmRepairCategoryMapper.xml
- PmRepairProgressMapper.xml
- PmRepairAttachmentMapper.xml
### 📖 文档同步更新记录
**API 文档**:
- [x] ✅ 无需更新(目录结构调整不影响 API)
**业务文档**:
- [x] ✅ 无需更新
**技术文档**:
- [x] ✅ 无需更新数据库设计文档
- [x] ✅ 无需更新架构设计文档
**其他文档**:
- [x] ✅ 无需更新部署文档
- [x] ✅ 无需更新配置文档
**规范文件**:
- [x] ✅ 已检查并确认.cursorrules 文件与项目状态一致
### 🧪 测试验证
**功能测试**:
- [x] ✅ 文件移动操作已完成
- [x] ✅ 目录结构已验证正确
- [ ] 需要验证 MyBatis 是否能正常扫描到 mapper 文件
**文档验证**:
- [x] ✅ 文件位置已确认
- [x] ✅ 目录结构已简化
### 📝 备注
**技术要点**:
1. 使用了 `mv` 命令移动文件
2. 使用了 `rm -rf` 命令删除空目录
3. 简化了目录层级,提高了结构清晰度
**影响评估**:
1. 仅调整 mapper 文件位置,不涉及内容变更
2. MyBatis 默认扫描配置应该能够正常工作
3. 目录结构更加简洁,便于维护
**后续计划**:
1. 验证 MyBatis mapper 扫描是否正常
2. 如有必要,检查 application.yml 中的 mapper-locations 配置
**最终目录结构**:
```
backend/ruoyi-admin/src/main/resources/mapper/hq/
├── HqHallReservationMapper.xml # 报告厅预约
├── HqSatOptionMapper.xml # 满意度选项
├── HqSatSurveyQuestionMapper.xml # 问卷题目
├── HqSatSurveyMapper.xml # 满意度问卷
├── HqSatDetailMapper.xml # 满意度详情
├── HqSatQuestionMapper.xml # 问题
├── HqSatCategoryMapper.xml # 满意度分类
├── HqHallInfoMapper.xml # 报告厅信息
├── HqSatRecordMapper.xml # 满意度记录
├── PmRepairOrderMapper.xml # 报修工单
├── PmRepairCategoryMapper.xml # 维修分类
├── PmRepairProgressMapper.xml # 维修进度
└── PmRepairAttachmentMapper.xml # 报修附件
```
**相关链接**:
- API 文档:docs/开发文档/API.md
- 业务模块文档:docs/业务模块/property-maintenance/
---
## 调整记录 - 2025-06-30 21:02:19
**变更 ID**: CHG-20250630-003
**变更时间**: 2025-06-30 21:02:19
**变更人员**: zlwu/Cursor AI 辅助
**变更类型**: 🔧 重构优化
**影响级别**: 🟡 中等变更
### 📋 变更概述
**变更目的**: 调整后端工程目录结构,将 Java 包结构从 `org.dromara.zhxy` 调整为 `org.dromara.zhxy.hq`,并移动相关 mapper 文件,保持与前端目录结构的一致性
**影响范围**: 后端 Java 包结构、mapper XML 文件、包名引用
### 📁 涉及文件
**后端 Java 文件**:
- backend/ruoyi-admin/src/main/java/org/dromara/zhxy/mapper/ -> backend/ruoyi-admin/src/main/java/org/dromara/zhxy/hq/mapper/
- backend/ruoyi-admin/src/main/java/org/dromara/zhxy/controller/ -> backend/ruoyi-admin/src/main/java/org/dromara/zhxy/hq/controller/
- backend/ruoyi-admin/src/main/java/org/dromara/zhxy/service/ -> backend/ruoyi-admin/src/main/java/org/dromara/zhxy/hq/service/
- backend/ruoyi-admin/src/main/java/org/dromara/zhxy/domain/ -> backend/ruoyi-admin/src/main/java/org/dromara/zhxy/hq/domain/
**Mapper XML 文件**:
- backend/ruoyi-admin/src/main/resources/mapper/pm/ -> backend/ruoyi-admin/src/main/resources/mapper/hq/pm/
- 所有 XML 文件的 namespace 和包引用
### 🔧 变更内容详述
**目录结构调整**:
1. 在 `org.dromara.zhxy` 下创建 `hq` 文件夹
2. 将 `mapper`、`controller`、`service`、`domain` 四个文件夹移动到 `hq` 目录下
3. 在 `src/main/resources/mapper/hq` 下创建 `pm` 子目录
4. 将所有 pm mapper 文件移动到 `hq/pm` 目录下
**包名引用更新**:
1. 更新所有 Java 文件中的包声明:
- `package org.dromara.zhxy.mapper;` -> `package org.dromara.zhxy.hq.mapper;`
- `package org.dromara.zhxy.controller;` -> `package org.dromara.zhxy.hq.controller;`
- `package org.dromara.zhxy.service;` -> `package org.dromara.zhxy.hq.service;`
- `package org.dromara.zhxy.domain;` -> `package org.dromara.zhxy.hq.domain;`
2. 更新所有 Java 文件中的 import 语句:
- `import org.dromara.zhxy.*` -> `import org.dromara.zhxy.hq.*`
**XML 配置更新**:
1. 更新所有 mapper XML 文件中的 namespace:
- `org.dromara.zhxy.mapper.*` -> `org.dromara.zhxy.hq.mapper.*`
2. 更新 XML 文件中的 resultType 和其他包引用:
- `org.dromara.zhxy.domain.*` -> `org.dromara.zhxy.hq.domain.*`
### 📖 文档同步更新记录
**API 文档**:
- [x] ✅ 无需更新(接口路径未变化)
**业务文档**:
- [x] ✅ 已检查业务模块文档,无需更新
**技术文档**:
- [x] ✅ 无需更新数据库设计文档
- [x] ✅ 无需更新架构设计文档
**其他文档**:
- [x] ✅ 无需更新部署文档
- [x] ✅ 无需更新配置文档
**规范文件**:
- [x] ✅ 已检查并确认.cursorrules 文件与项目状态一致
### 🧪 测试验证
**功能测试**:
- [ ] 需要验证后端应用是否正常启动
- [ ] 需要验证所有 mapper 接口是否正常工作
- [ ] 需要验证包扫描配置是否需要调整
**文档验证**:
- [x] ✅ 包名引用已全部更新
- [x] ✅ XML 配置已全部更新
- [x] ✅ 目录结构已正确调整
### 📝 备注
**技术要点**:
1. 使用了 mkdir、mv 命令完成目录移动
2. 使用了 find + sed 命令批量更新 Java 文件中的包名引用
3. 使用了 sed 命令批量更新 XML 文件中的 namespace 和包引用
**影响评估**:
1. 仅调整包结构,不涉及业务逻辑变更
2. 所有包名引用已同步更新,应不会产生编译错误
3. 需要确认 Spring Boot 包扫描配置是否需要调整
**后续计划**:
1. 需要验证后端应用是否正常启动
2. 需要检查 Spring Boot 主类的包扫描配置
3. 建议进行完整的编译和启动测试
**最终目录结构**:
```
backend/ruoyi-admin/src/main/java/org/dromara/zhxy/
└── hq/
├── mapper/
├── controller/
├── service/
└── domain/
backend/ruoyi-admin/src/main/resources/mapper/
└── hq/
├── pm/ # 物业报修 mapper
└── *.xml # 其他 hq 模块 mapper
```
**相关链接**:
- API 文档:docs/开发文档/API.md
- 业务模块文档:docs/业务模块/property-maintenance/
---
## 调整记录 - 2025-06-30 20:54:06
**变更 ID**: CHG-20250630-002
**变更时间**: 2025-06-30 20:54:06
**变更人员**: zlwu/Cursor AI 辅助
**变更类型**: 🔧 重构优化
**影响级别**: 🟡 中等变更
### 📋 变更概述
**变更目的**: 继续优化工程目录结构,将前端页面组件从`web/src/views/pm`移动到`web/src/views/hq/pm`,保持与 API 接口模块的一致性
**影响范围**: 前端页面组件、API 接口路径
### 📁 涉及文件
**前端文件**:
- web/src/views/pm/ -> web/src/views/hq/pm/ (整个目录移动)
- web/src/views/hq/pm/repairOrder/index.vue
- web/src/views/hq/pm/repairCategory/index.vue
- web/src/api/hq/pm/repairOrder.ts (更新 API 路径)
- web/src/api/hq/pm/repairCategory.ts (更新 API 路径)
### 🔧 变更内容详述
**目录结构调整**:
1. 将`web/src/views/pm/`整个目录移动到`web/src/views/hq/pm/`
2. 保持原有文件结构不变,仅调整目录层级
**API 接口路径更新**:
1. 更新 API 文件中的接口路径:
- `/pm/repairOrder/*` -> `/hq/pm/repairOrder/*`
- `/pm/repairCategory/*` -> `/hq/pm/repairCategory/*`
- `/pm/attachment/*` -> `/hq/pm/attachment/*`
**路由配置**:
1. 经检查,该项目使用动态路由生成,无需手动更新路由配置文件
2. 组件路径引用通过动态加载,不受此次移动影响
### 📖 文档同步更新记录
**API 文档**:
- [x] ✅ 上次变更已更新 docs/开发文档/API.md
**业务文档**:
- [x] ✅ 已检查业务模块文档,无需更新
**技术文档**:
- [x] ✅ 无需更新数据库设计文档
- [x] ✅ 无需更新架构设计文档
**其他文档**:
- [x] ✅ 无需更新部署文档
- [x] ✅ 无需更新配置文档
**规范文件**:
- [x] ✅ 已检查并确认.cursorrules 文件与项目状态一致
### 🧪 测试验证
**功能测试**:
- [ ] 需要验证前端页面路由是否正常工作
- [ ] 需要验证页面组件是否正常加载
- [ ] 需要验证 API 调用是否正常工作
**文档验证**:
- [x] ✅ API 接口路径已全部更新
- [x] ✅ 组件引用路径保持正确
### 📝 备注
**技术要点**:
1. 使用了 cp、rm 命令完成目录移动
2. 使用了 sed 命令批量更新 API 文件中的接口路径
3. 项目使用动态路由,无需手动更新路由配置
**影响评估**:
1. 仅调整目录结构,不涉及业务逻辑变更
2. API 接口路径发生变化,需要确保后端路由同步调整
3. 页面组件路径变更,但通过动态加载方式不受影响
**后续计划**:
1. 需要验证前端应用路由和页面加载是否正常
2. 需要确认后端路由配置是否需要同步调整
3. 建议进行完整的功能测试
**相关链接**:
- API 文档:docs/开发文档/API.md
- 业务模块文档:docs/业务模块/property-maintenance/
---
## 调整记录 - 2025-06-30 20:48:55
**变更 ID**: CHG-20250630-001
**变更时间**: 2025-06-30 20:48:55
**变更人员**: zlwu/Cursor AI 辅助
**变更类型**: 🔧 重构优化
**影响级别**: 🟡 中等变更
### 📋 变更概述
**变更目的**: 调整工程目录结构,将前端 API 接口模块从`web/src/api/pm`移动到`web/src/api/hq/pm`,优化项目架构并保持模块归属清晰
**影响范围**: 前端 API 接口模块、相关引用路径、API 文档
### 📁 涉及文件
**前端文件**:
- web/src/api/pm/ -> web/src/api/hq/pm/ (整个目录移动)
- web/src/api/hq/pm/repairOrder.ts
- web/src/api/hq/pm/repairCategory.ts
- web/src/api/hq/pm/types.ts
- web/src/api/hq/pm/index.ts
- web/src/views/pm/repairCategory/index.vue
- web/src/views/pm/repairOrder/index.vue
**文档文件**:
- docs/开发文档/API.md
### 🔧 变更内容详述
**目录结构调整**:
1. 将`web/src/api/pm/`整个目录移动到`web/src/api/hq/pm/`
2. 保持原有文件结构不变,仅调整目录层级
**路径引用更新**:
1. 更新 API 文件内部导入路径:
- `@/api/pm/types` -> `@/api/hq/pm/types`
2. 更新 Vue 组件中的 API 导入路径:
- `@/api/pm/repairOrder` -> `@/api/hq/pm/repairOrder`
- `@/api/pm/repairCategory` -> `@/api/hq/pm/repairCategory`
- `@/api/pm/types` -> `@/api/hq/pm/types`
**API 文档同步更新**:
1. 批量更新所有物业报修相关接口路径:
- `GET /pm/repairCategory/*` -> `GET /hq/pm/repairCategory/*`
- `POST /pm/repairCategory/*` -> `POST /hq/pm/repairCategory/*`
- `GET /pm/repairOrder/*` -> `GET /hq/pm/repairOrder/*`
- `POST /pm/repairOrder/*` -> `POST /hq/pm/repairOrder/*`
- `PUT /pm/repairOrder/*` -> `PUT /hq/pm/repairOrder/*`
- `DELETE /pm/repairOrder/*` -> `DELETE /hq/pm/repairOrder/*`
### 📖 文档同步更新记录
**API 文档**:
- [x] ✅ 已更新 docs/开发文档/API.md (批量更新所有 pm 接口路径为 hq/pm)
**业务文档**:
- [x] ✅ 已检查业务模块文档,无需更新
**技术文档**:
- [x] ✅ 无需更新数据库设计文档
- [x] ✅ 无需更新架构设计文档
**其他文档**:
- [x] ✅ 无需更新部署文档
- [x] ✅ 无需更新配置文档
**规范文件**:
- [x] ✅ 已检查并确认.cursorrules 文件与项目状态一致
### 🧪 测试验证
**功能测试**:
- [ ] 需要验证前端页面是否正常加载
- [ ] 需要验证 API 调用是否正常工作
- [ ] 需要验证构建打包是否成功
**文档验证**:
- [x] ✅ 文档内容与代码实现一致
- [x] ✅ API 文档路径已全部更新
- [x] ✅ 接口文档已验证准确性
### 📝 备注
**技术要点**:
1. 使用了 mkdir、cp、rm 命令完成目录移动
2. 使用了 search_replace 工具更新代码引用路径
3. 使用了 sed 命令批量更新 API 文档中的路径
**影响评估**:
1. 仅调整目录结构,不涉及业务逻辑变更
2. 所有引用路径已同步更新,不会产生引用错误
3. API 接口地址发生变化,后端路由配置需要相应调整
**后续计划**:
1. 需要验证前端应用是否正常工作
2. 需要确认后端路由是否需要同步调整
3. 如有问题,需要及时回滚或修复
**相关链接**:
- API 文档:docs/开发文档/API.md
- 业务模块文档:docs/业务模块/property-maintenance/
---