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:
1 parent
00297e714b
commit
90b13a6e0c
193 files changed
+2726
-409
No files matched your search
@@ -33,6 +33,176 @@
|
||||
- **前端访问**: http://localhost (默认 80 端口)
|
||||
- **后端服务**: http://localhost:8080
|
||||
|
||||
## 🔴 前端模块管理规范(强制性,2025-01-23新增)
|
||||
|
||||
### 📦 前端模块文件夹规范
|
||||
|
||||
**⚠️ 基于后端模块工程统一规划,前端必须建立对应的模块文件夹结构!**
|
||||
|
||||
#### 🏗️ 模块命名和位置规范
|
||||
|
||||
**界面文件夹位置**: `web/src/views/{模块简称}/`
|
||||
**API文件夹位置**: `web/src/api/{模块简称}/`
|
||||
|
||||
**已规划模块列表**:
|
||||
- ✅ `hq` - 后勤管理模块 (已完成)
|
||||
- ✅ `rs` - 人事管理模块
|
||||
- ✅ `cw` - 财务管理模块
|
||||
- ✅ `aqbw` - 安全保卫管理模块
|
||||
- ✅ `zsjy` - 招生就业管理模块
|
||||
- ✅ `xg` - 学工管理模块
|
||||
|
||||
#### 📁 标准目录结构
|
||||
|
||||
**界面文件夹结构** (web/src/views/{模块简称}/):
|
||||
```
|
||||
web/src/views/{模块简称}/
|
||||
├── README.md # 模块说明文档
|
||||
├── {功能模块1}/ # 按功能模块细分
|
||||
│ ├── index.vue # 列表页面
|
||||
│ ├── add.vue # 新增页面
|
||||
│ ├── edit.vue # 编辑页面
|
||||
│ └── detail.vue # 详情页面
|
||||
├── {功能模块2}/
|
||||
│ └── ...
|
||||
└── components/ # 模块内公共组件
|
||||
└── ...
|
||||
```
|
||||
|
||||
**API文件夹结构** (web/src/api/{模块简称}/):
|
||||
```
|
||||
web/src/api/{模块简称}/
|
||||
├── index.ts # API入口文件
|
||||
├── README.md # API接口说明文档
|
||||
├── types.ts # 类型定义文件
|
||||
├── {功能模块1}/ # 按功能模块细分
|
||||
│ └── index.ts # 功能模块API接口
|
||||
├── {功能模块2}/
|
||||
│ └── index.ts
|
||||
└── ...
|
||||
```
|
||||
|
||||
#### 🎯 文件命名规范
|
||||
|
||||
**Vue组件文件**:
|
||||
- 页面组件: PascalCase (如: `UserList.vue`)
|
||||
- 组件文件: kebab-case (如: `user-form.vue`)
|
||||
|
||||
**TypeScript文件**:
|
||||
- API文件: kebab-case (如: `user-api.ts`)
|
||||
- 类型文件: kebab-case (如: `user-types.ts`)
|
||||
|
||||
**路由命名**:
|
||||
- 路由路径: kebab-case (如: `/rs/employee-list`)
|
||||
- 路由名称: camelCase (如: `rsEmployeeList`)
|
||||
|
||||
#### 🔐 权限命名规范
|
||||
|
||||
**前端权限指令格式**: `v-hasPermi="'{模块简称}:{功能}:{操作}'"`
|
||||
|
||||
**示例**:
|
||||
```vue
|
||||
<!-- 人事模块员工新增权限 -->
|
||||
<el-button v-hasPermi="'rs:employee:add'" type="primary">新增员工</el-button>
|
||||
|
||||
<!-- 财务模块预算查看权限 -->
|
||||
<el-button v-hasPermi="'cw:budget:view'" type="primary">查看预算</el-button>
|
||||
|
||||
<!-- 学工模块学生编辑权限 -->
|
||||
<el-button v-hasPermi="'xg:student:edit'" link type="primary">编辑</el-button>
|
||||
```
|
||||
|
||||
#### 📋 路由配置规范
|
||||
|
||||
**路由路径格式**: `/{模块简称}/{功能模块}`
|
||||
|
||||
**router配置示例**:
|
||||
```typescript
|
||||
// router/modules/rs.ts - 人事管理模块路由
|
||||
export default {
|
||||
path: '/rs',
|
||||
name: 'Rs',
|
||||
component: () => import('@/layout/index.vue'),
|
||||
redirect: '/rs/employee',
|
||||
meta: {
|
||||
title: '人事管理',
|
||||
icon: 'peoples',
|
||||
rank: 3
|
||||
},
|
||||
children: [
|
||||
{
|
||||
path: '/rs/employee',
|
||||
name: 'RsEmployee',
|
||||
component: () => import('@/views/rs/employee/index.vue'),
|
||||
meta: {
|
||||
title: '员工管理',
|
||||
keepAlive: true
|
||||
}
|
||||
},
|
||||
{
|
||||
path: '/rs/department',
|
||||
name: 'RsDepartment',
|
||||
component: () => import('@/views/rs/department/index.vue'),
|
||||
meta: {
|
||||
title: '部门管理',
|
||||
keepAlive: true
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
#### 🚨 前端模块开发检查清单
|
||||
|
||||
**创建新模块前必须检查**:
|
||||
- [ ] 模块文件夹是否按规范命名?(`web/src/views/{简称}/`)
|
||||
- [ ] API文件夹是否对应创建?(`web/src/api/{简称}/`)
|
||||
- [ ] 是否创建了模块说明文档?(README.md)
|
||||
- [ ] 路由配置是否符合规范?
|
||||
- [ ] 权限指令是否使用正确的编码格式?
|
||||
- [ ] 是否遵循前端开发规范和UI设计标准?
|
||||
- [ ] 组件和文件命名是否符合规范?
|
||||
- [ ] API接口类型定义是否与后端VO保持一致?
|
||||
|
||||
#### 💡 模块开发最佳实践
|
||||
|
||||
**1. 组件复用**:
|
||||
- 模块内公共组件放在`components/`目录
|
||||
- 跨模块公共组件放在`@/components/`目录
|
||||
- 使用组合式API提高代码复用性
|
||||
|
||||
**2. 状态管理**:
|
||||
- 模块相关状态使用Pinia store管理
|
||||
- Store文件命名:`@/stores/{模块简称}.ts`
|
||||
- 避免不同模块间的状态耦合
|
||||
|
||||
**3. 样式管理**:
|
||||
- 使用SCSS变量和mixin提高样式复用
|
||||
- 遵循Art Design Pro UI设计规范
|
||||
- 统一使用轮廓式按钮设计
|
||||
|
||||
**4. 类型安全**:
|
||||
- 所有API接口必须定义TypeScript类型
|
||||
- 类型定义与后端VO对象保持一致
|
||||
- 使用泛型提高类型复用性
|
||||
|
||||
#### 📝 注意事项
|
||||
|
||||
**模块间解耦**:
|
||||
- 避免模块间直接依赖,通过事件总线或状态管理通信
|
||||
- API接口按模块严格分离
|
||||
- 路由按模块独立配置,避免交叉引用
|
||||
|
||||
**性能优化**:
|
||||
- 页面组件使用懒加载
|
||||
- 合理使用keep-alive缓存页面状态
|
||||
- 图片资源优化和懒加载
|
||||
|
||||
**用户体验**:
|
||||
- 统一的加载状态和错误处理
|
||||
- 合理的页面过渡动画
|
||||
- 响应式设计支持多设备访问
|
||||
|
||||
## 2. Art Design Pro UI 规范
|
||||
|
||||
### 设计理念
|
||||
|
||||
Reference in new issue
Block a user