feat: 完善数据库表命名规范，新增后勤管理和系统公共模块前缀
📋 主要变更： - ✅ 补充完整的7个业务模块表命名规范 - ✅ 新增后勤管理模块：hq_ 前缀 - ✅ 明确系统公共模块：common_ 前缀 - ✅ 提供完整的命名示例和实体类映射规则 - ✅ 更新变更记录文档 🎯 覆盖模块： - 后勤管理(hq_)、人事管理(rs_)、财务管理(cw_) - 学工管理(xg_)、招生就业(zsjy_)、安全保卫(aqbw_) - 系统公共(common_) 📚 文件变更： - .cursor/cursorrules-backend.md - 数据库表命名规范 - docs/变更管理/code-adjust-record-2025-01-23-wuzilong.md - 变更记录 - 各业务模块工程文件和前端结构文件 Co-authored-by: Cursor AI <cursor@cursor.sh>
This commit is contained in:
zlwuandCursor AI committed
1 parent
00297e714b
commit
90b13a6e0c
193 files changed
+2726
-409
No files matched your search
@@ -0,0 +1,321 @@
|
||||
# 代码调整记录 - 2025-01-23 - wuzilong
|
||||
|
||||
## 📋 本次变更概述
|
||||
|
||||
**变更类型**: 🏗️ 架构重构 - 后端模块工程统一管理
|
||||
**变更时间**: 2025-01-23 15:00:00
|
||||
**影响范围**: 后端模块架构、开发规范、工程结构
|
||||
|
||||
## 🎯 变更背景
|
||||
|
||||
基于ruoyi-hq工程的成功实践，为了规范化管理后端业务模块，建立统一的工程管理标准，便于后续各业务模块的开发和维护。
|
||||
|
||||
## 🔧 变更详情
|
||||
|
||||
### 1. 📋 后端开发规范更新
|
||||
|
||||
**文件**: `.cursor/cursorrules-backend.md`
|
||||
|
||||
**新增内容**:
|
||||
- ✅ **模块工程管理规范（强制性）**
|
||||
- ✅ **模块命名和位置规范**
|
||||
- ✅ **Maven配置标准模板**
|
||||
- ✅ **包结构规范标准**
|
||||
- ✅ **代码规范要求**
|
||||
- ✅ **权限命名规范**
|
||||
- ✅ **模块开发最佳实践**
|
||||
- ✅ **模块创建检查清单**
|
||||
|
||||
**已规划模块列表**:
|
||||
- ✅ `ruoyi-hq` - 后勤管理模块 (已完成)
|
||||
- 🚧 `ruoyi-rs` - 人事管理模块
|
||||
- 🚧 `ruoyi-cw` - 财务管理模块
|
||||
- 🚧 `ruoyi-aqbw` - 安全保卫管理模块
|
||||
- 🚧 `ruoyi-zsjy` - 招生就业管理模块
|
||||
- 🚧 `ruoyi-xg` - 学工管理模块
|
||||
|
||||
### 2. 🏗️ 新增业务模块工程
|
||||
|
||||
**创建的5个标准业务模块**:
|
||||
|
||||
#### 📁 ruoyi-rs (人事管理模块)
|
||||
```
|
||||
backend/ruoyi-modules/ruoyi-rs/
|
||||
├── pom.xml # Maven配置
|
||||
└── src/main/
|
||||
├── java/org/dromara/rs/
|
||||
│ ├── controller/ # 控制器层
|
||||
│ ├── service/ # 服务接口层
|
||||
│ │ └── impl/ # 服务实现层
|
||||
│ ├── mapper/ # 数据访问层
|
||||
│ └── domain/ # 数据对象层
|
||||
│ ├── bo/ # 业务对象
|
||||
│ └── vo/ # 视图对象
|
||||
└── resources/
|
||||
└── mapper/ # MyBatis映射文件
|
||||
```
|
||||
|
||||
#### 📁 ruoyi-cw (财务管理模块)
|
||||
```
|
||||
backend/ruoyi-modules/ruoyi-cw/
|
||||
├── pom.xml # Maven配置
|
||||
└── src/main/
|
||||
├── java/org/dromara/cw/
|
||||
│ ├── controller/ # 控制器层
|
||||
│ ├── service/ # 服务接口层
|
||||
│ │ └── impl/ # 服务实现层
|
||||
│ ├── mapper/ # 数据访问层
|
||||
│ └── domain/ # 数据对象层
|
||||
│ ├── bo/ # 业务对象
|
||||
│ └── vo/ # 视图对象
|
||||
└── resources/
|
||||
└── mapper/ # MyBatis映射文件
|
||||
```
|
||||
|
||||
#### 📁 ruoyi-aqbw (安全保卫管理模块)
|
||||
```
|
||||
backend/ruoyi-modules/ruoyi-aqbw/
|
||||
├── pom.xml # Maven配置
|
||||
└── src/main/
|
||||
├── java/org/dromara/aqbw/
|
||||
│ ├── controller/ # 控制器层
|
||||
│ ├── service/ # 服务接口层
|
||||
│ │ └── impl/ # 服务实现层
|
||||
│ ├── mapper/ # 数据访问层
|
||||
│ └── domain/ # 数据对象层
|
||||
│ ├── bo/ # 业务对象
|
||||
│ └── vo/ # 视图对象
|
||||
└── resources/
|
||||
└── mapper/ # MyBatis映射文件
|
||||
```
|
||||
|
||||
#### 📁 ruoyi-zsjy (招生就业管理模块)
|
||||
```
|
||||
backend/ruoyi-modules/ruoyi-zsjy/
|
||||
├── pom.xml # Maven配置
|
||||
└── src/main/
|
||||
├── java/org/dromara/zsjy/
|
||||
│ ├── controller/ # 控制器层
|
||||
│ ├── service/ # 服务接口层
|
||||
│ │ └── impl/ # 服务实现层
|
||||
│ ├── mapper/ # 数据访问层
|
||||
│ └── domain/ # 数据对象层
|
||||
│ ├── bo/ # 业务对象
|
||||
│ └── vo/ # 视图对象
|
||||
└── resources/
|
||||
└── mapper/ # MyBatis映射文件
|
||||
```
|
||||
|
||||
#### 📁 ruoyi-xg (学工管理模块)
|
||||
```
|
||||
backend/ruoyi-modules/ruoyi-xg/
|
||||
├── pom.xml # Maven配置
|
||||
└── src/main/
|
||||
├── java/org/dromara/xg/
|
||||
│ ├── controller/ # 控制器层
|
||||
│ ├── service/ # 服务接口层
|
||||
│ │ └── impl/ # 服务实现层
|
||||
│ ├── mapper/ # 数据访问层
|
||||
│ └── domain/ # 数据对象层
|
||||
│ ├── bo/ # 业务对象
|
||||
│ └── vo/ # 视图对象
|
||||
└── resources/
|
||||
└── mapper/ # MyBatis映射文件
|
||||
```
|
||||
|
||||
### 3. ⚙️ Maven配置更新
|
||||
|
||||
**文件**: `backend/ruoyi-modules/pom.xml`
|
||||
|
||||
**变更内容**:
|
||||
```xml
|
||||
<modules>
|
||||
<module>ruoyi-demo</module>
|
||||
<module>ruoyi-generator</module>
|
||||
<module>ruoyi-job</module>
|
||||
<module>ruoyi-system</module>
|
||||
<module>ruoyi-workflow</module>
|
||||
<module>ruoyi-hq</module>
|
||||
+ <module>ruoyi-rs</module>
|
||||
+ <module>ruoyi-cw</module>
|
||||
+ <module>ruoyi-aqbw</module>
|
||||
+ <module>ruoyi-zsjy</module>
|
||||
+ <module>ruoyi-xg</module>
|
||||
</modules>
|
||||
```
|
||||
|
||||
### 4. 📂 目录结构说明文件
|
||||
|
||||
**为每个模块的各层级目录添加了.gitkeep文件**，包含详细的目录用途说明：
|
||||
- controller/ - REST API控制器层
|
||||
- service/ - 业务服务接口层
|
||||
- service/impl/ - 业务服务实现层
|
||||
- mapper/ - 数据访问层
|
||||
- domain/ - 实体类
|
||||
- domain/bo/ - 业务对象
|
||||
- domain/vo/ - 视图对象
|
||||
- resources/mapper/ - MyBatis映射文件
|
||||
|
||||
## 🎯 模块工程标准化规范
|
||||
|
||||
### 📋 统一的Maven依赖配置
|
||||
所有新模块都采用统一的依赖配置，包括：
|
||||
- **通用工具**: core、doc、mybatis、log、security、web、excel、idempotent、tenant、social、ratelimiter、mail
|
||||
- **系统模块**: system、job
|
||||
- **扩展模块**: generator、demo、workflow
|
||||
|
||||
### 🏛️ 统一的包结构规范
|
||||
- **包名格式**: `org.dromara.{模块简称}`
|
||||
- **分层架构**: controller → service → mapper → domain
|
||||
- **对象分离**: Entity(实体) + BO(业务对象) + VO(视图对象)
|
||||
|
||||
### 🔐 统一的权限命名规范
|
||||
- **权限编码格式**: `{模块简称}:{功能}:{操作}`
|
||||
- **示例**:
|
||||
- `rs:employee:list` - 人事模块员工列表查询权限
|
||||
- `cw:budget:add` - 财务模块预算新增权限
|
||||
|
||||
## ✅ 验证和测试
|
||||
|
||||
### 🔧 编译验证
|
||||
- ✅ 所有新模块Maven配置正确
|
||||
- ✅ 父模块pom.xml更新成功
|
||||
- ✅ 目录结构符合标准规范
|
||||
|
||||
### 📁 文件结构验证
|
||||
- ✅ 5个新模块目录结构完整
|
||||
- ✅ 每个目录都有说明文件
|
||||
- ✅ 包结构符合ruoyi-hq标准
|
||||
|
||||
## 🎯 后续计划
|
||||
|
||||
### 🚧 短期计划 (1-2周)
|
||||
1. **业务需求梳理**: 为每个模块梳理详细的业务需求
|
||||
2. **数据库设计**: 设计各模块的数据表结构
|
||||
3. **API设计**: 制定标准的API接口规范
|
||||
|
||||
### 📋 中期计划 (1个月)
|
||||
1. **核心功能开发**: 优先开发人事管理(rs)和财务管理(cw)模块的核心功能
|
||||
2. **权限配置**: 完善各模块的菜单和权限配置
|
||||
3. **测试用例**: 编写完整的测试用例
|
||||
|
||||
### 🎯 长期计划 (3个月)
|
||||
1. **功能完善**: 完成所有5个模块的核心功能开发
|
||||
2. **系统集成**: 各模块之间的数据交互和业务流程打通
|
||||
3. **性能优化**: 系统性能优化和并发处理能力提升
|
||||
|
||||
## 📝 注意事项
|
||||
|
||||
### ⚠️ 开发规范
|
||||
1. **严格遵循**: 必须按照`.cursor/cursorrules-backend.md`中的模块工程管理规范进行开发
|
||||
2. **代码质量**: 所有代码必须符合Alibaba Java开发手册规范
|
||||
3. **文档同步**: 每次代码变更必须同步更新相关文档
|
||||
|
||||
### 🔐 权限管理
|
||||
1. **权限前缀**: 每个模块的权限前缀不能冲突
|
||||
2. **菜单配置**: 需要在数据库中配置对应的菜单和权限
|
||||
3. **接口权限**: 每个API接口必须添加@SaCheckPermission注解
|
||||
|
||||
### 📊 数据库规范
|
||||
1. **基础字段**: 必须包含统一的基础字段（id、tenant_id、create_by等）
|
||||
2. **逻辑删除**: 统一使用逻辑删除，禁止物理删除
|
||||
3. **多租户**: 所有业务表必须支持多租户
|
||||
|
||||
## 🏆 变更价值
|
||||
|
||||
### 📈 技术价值
|
||||
1. **架构统一**: 建立了标准的模块工程架构，便于后续开发和维护
|
||||
2. **开发效率**: 标准化的结构可以大幅提升新模块的开发效率
|
||||
3. **代码质量**: 统一的规范保证了代码质量和一致性
|
||||
|
||||
### 🎯 业务价值
|
||||
1. **功能扩展**: 为后续各业务模块的开发提供了坚实的基础
|
||||
2. **系统完整性**: 逐步完善校园管理系统的各个业务模块
|
||||
3. **运维便利**: 统一的架构降低了系统运维的复杂度
|
||||
|
||||
### 👥 团队价值
|
||||
1. **开发规范**: 为团队建立了统一的开发标准和最佳实践
|
||||
2. **知识沉淀**: 将ruoyi-hq的成功经验规范化并推广到其他模块
|
||||
3. **协作效率**: 标准化的结构提升了团队协作效率
|
||||
|
||||
## 🔄 相关文件变更
|
||||
|
||||
### 📝 新增文件
|
||||
1. `.cursor/cursorrules-backend.md` - 新增模块工程管理规范
|
||||
2. `backend/ruoyi-modules/ruoyi-rs/` - 人事管理模块完整工程
|
||||
3. `backend/ruoyi-modules/ruoyi-cw/` - 财务管理模块完整工程
|
||||
4. `backend/ruoyi-modules/ruoyi-aqbw/` - 安全保卫管理模块完整工程
|
||||
5. `backend/ruoyi-modules/ruoyi-zsjy/` - 招生就业管理模块完整工程
|
||||
6. `backend/ruoyi-modules/ruoyi-xg/` - 学工管理模块完整工程
|
||||
|
||||
### ✏️ 修改文件
|
||||
1. `backend/ruoyi-modules/pom.xml` - 添加5个新模块到模块列表
|
||||
|
||||
### 📋 新增前端文件（2025-01-23 15:30:00更新）
|
||||
|
||||
**前端界面文件夹** (web/src/views/):
|
||||
- ✅ `web/src/views/rs/` - 人事管理界面文件夹 + README.md
|
||||
- ✅ `web/src/views/cw/` - 财务管理界面文件夹 + README.md
|
||||
- ✅ `web/src/views/xg/` - 学工管理界面文件夹 + README.md
|
||||
- ✅ `web/src/views/zsjy/` - 招生就业管理界面文件夹 + README.md
|
||||
- ✅ `web/src/views/aqbw/` - 安全保卫管理界面文件夹 + README.md
|
||||
|
||||
**前端API文件夹** (web/src/api/):
|
||||
- ✅ `web/src/api/rs/` - 人事管理API文件夹 + index.ts + README.md
|
||||
- ✅ `web/src/api/cw/` - 财务管理API文件夹 + index.ts + README.md
|
||||
- ✅ `web/src/api/xg/` - 学工管理API文件夹 + index.ts + README.md
|
||||
- ✅ `web/src/api/zsjy/` - 招生就业管理API文件夹 + index.ts + README.md
|
||||
- ✅ `web/src/api/aqbw/` - 安全保卫管理API文件夹 + index.ts + README.md
|
||||
|
||||
### 📋 影响评估
|
||||
- **编译构建**: ✅ 正常，新模块已正确集成到Maven构建流程
|
||||
- **运行时**: ✅ 正常，新模块目前为空工程，不影响现有功能
|
||||
- **依赖关系**: ✅ 正常，所有依赖配置正确
|
||||
- **前端构建**: ✅ 正常，新增的TypeScript文件不会影响编译
|
||||
|
||||
## 🔄 数据库表命名规范补充更新 (2025-01-23 16:30:00)
|
||||
|
||||
### 📋 变更背景
|
||||
为了配合新创建的5个业务模块，需要建立统一的数据库表命名规范，确保不同模块的数据库表有清晰的命名区分，便于后续开发和维护。
|
||||
|
||||
### 🔴 新增表命名规范（强制性）
|
||||
|
||||
**文件**: `.cursor/cursorrules-backend.md`
|
||||
|
||||
**新增内容**: 在数据库规范章节添加了完整的表命名规范
|
||||
|
||||
**模块表名前缀规范**：
|
||||
- **后勤管理**：`hq_` 开头 (如：`hq_repair`, `hq_maintenance`)
|
||||
- **人事管理**：`rs_` 开头 (如：`rs_employee`, `rs_department`)
|
||||
- **财务管理**：`cw_` 开头 (如：`cw_budget`, `cw_expense`)
|
||||
- **学工管理**：`xg_` 开头 (如：`xg_student`, `xg_dormitory`)
|
||||
- **招生就业**：`zsjy_` 开头 (如：`zsjy_application`, `zsjy_job`)
|
||||
- **安全保卫**：`aqbw_` 开头 (如：`aqbw_security`, `aqbw_patrol`)
|
||||
- **系统公共**：`common_` 开头 (如：`common_dict`, `common_config`)
|
||||
|
||||
### ✅ 规范内容要点
|
||||
|
||||
1. **命名示例**: 提供了7个模块的完整CREATE TABLE示例
|
||||
2. **强制性要求**: 明确了6个强制性命名要求和4个禁止事项
|
||||
3. **实体类映射**: 提供了表名到Java实体类的命名对应规则
|
||||
4. **规范位置**: 放置在数据库规范的强制性核心规范之后，基础字段模板之前
|
||||
|
||||
### 🔄 后勤管理模块补充更新 (2025-01-23 16:35:00)
|
||||
|
||||
**补充内容**: 添加后勤管理模块的表命名规范
|
||||
- ✅ **后勤管理**: `hq_` 开头 (如：`hq_repair`, `hq_maintenance`)
|
||||
- ✅ **命名示例**: 添加了后勤管理模块的CREATE TABLE示例
|
||||
- ✅ **实体类映射**: 添加了 `hq_repair` → `HqRepair` 的命名对应示例
|
||||
|
||||
**更新说明**: 现在表命名规范涵盖完整的7个业务模块，包括已开发的后勤管理模块和5个新规划模块。
|
||||
|
||||
### 🎯 规范价值
|
||||
|
||||
1. **模块区分**: 清晰区分不同业务模块的数据表
|
||||
2. **开发效率**: 标准化命名减少开发时的困惑
|
||||
3. **维护便利**: 便于后续数据库维护和权限管理
|
||||
4. **团队协作**: 为团队提供统一的数据库命名标准
|
||||
|
||||
---
|
||||
|
||||
**总结**: 本次变更成功建立了前后端模块工程的统一管理规范，创建了5个后端业务模块和对应的前端文件夹结构，并补充完善了包含7个业务模块的完整数据库表命名规范（后勤、人事、财务、学工、招生就业、安全保卫、系统公共），为后续各业务模块的全栈开发奠定了坚实的架构基础。所有变更都经过仔细验证，确保系统稳定性不受影响。
|
||||
Reference in new issue
Block a user