1
This commit is contained in:
68
_doc/命名规范统一进度.md
Normal file
68
_doc/命名规范统一进度.md
Normal file
@@ -0,0 +1,68 @@
|
||||
# 命名规范统一进度
|
||||
|
||||
## ✅ 已完成
|
||||
|
||||
### 1. OSS服务重命名
|
||||
- ✅ `ossTool.js` → `oss_tool_service.js`
|
||||
- ✅ `OSSTool` → `OSSToolService`
|
||||
- ✅ 更新引用:`api/controller_front/file.js`
|
||||
|
||||
## 📋 待完成
|
||||
|
||||
### 2. 移动并重命名业务服务(middleware/job/ → services/)
|
||||
- ⏳ `jobManager.js` → `services/job_manager_service.js`
|
||||
- 类名:`JobManager` → `JobManagerService`
|
||||
- 更新引用:`api/middleware/schedule/command.js`
|
||||
|
||||
- ⏳ `chatManager.js` → `services/chat_manager_service.js`
|
||||
- 类名:`ChatManager` → `ChatManagerService`
|
||||
- 更新引用:`api/middleware/schedule/command.js`
|
||||
|
||||
- ⏳ `resumeManager.js` → `services/resume_manager_service.js`
|
||||
- 类名:`ResumeManager` → `ResumeManagerService`
|
||||
|
||||
### 3. 合并AI服务
|
||||
- ⏳ 将 `middleware/job/aiService.js` 的功能合并到 `services/ai_service.js`
|
||||
- ⏳ 统一类名为 `AIService`
|
||||
- ⏳ 删除 `middleware/job/aiService.js`
|
||||
- ⏳ 更新所有引用
|
||||
|
||||
### 4. 处理废弃文件
|
||||
- ⏳ `services/task_scheduler.js` - 添加废弃标记或删除
|
||||
|
||||
## 📝 命名规范总结
|
||||
|
||||
### 文件命名规范
|
||||
- ✅ 统一使用 `snake_case` + `_service.js` 后缀
|
||||
- ✅ 示例:`oss_tool_service.js`, `job_manager_service.js`
|
||||
|
||||
### 类命名规范
|
||||
- ✅ 统一使用 `PascalCase` + `Service` 后缀
|
||||
- ✅ 示例:`OSSToolService`, `JobManagerService`
|
||||
|
||||
### 目录结构
|
||||
```
|
||||
api/
|
||||
├── services/ # 业务服务层
|
||||
│ ├── ai_service.js
|
||||
│ ├── job_service.js
|
||||
│ ├── job_manager_service.js # 待移动
|
||||
│ ├── chat_manager_service.js # 待移动
|
||||
│ ├── resume_manager_service.js # 待移动
|
||||
│ ├── pla_account_service.js
|
||||
│ └── oss_tool_service.js # ✅ 已完成
|
||||
│
|
||||
└── middleware/ # 中间件层
|
||||
├── schedule/
|
||||
├── mqtt/
|
||||
└── job/ # 待删除(文件移到services后)
|
||||
```
|
||||
|
||||
## 🔄 下一步操作
|
||||
|
||||
1. 移动并重命名 `middleware/job/` 下的文件
|
||||
2. 合并AI服务
|
||||
3. 更新所有引用
|
||||
4. 统一导出方式
|
||||
5. 删除废弃文件
|
||||
|
||||
Reference in New Issue
Block a user