3.4 KiB
3.4 KiB
ruoyi-ccdi 模块重命名设计文档
概述
将 ruoyi-ccdi 模块重命名为 ruoyi-info-collection,以更清晰地表达"信息采集"功能,同时保持与其他功能模块的命名一致性。
设计决策
方案选择:混合命名(方案 A)
| 项目 | 当前命名 | 目标命名 |
|---|---|---|
| Maven 模块 | ruoyi-ccdi |
ruoyi-info-collection |
| Java 包名 | com.ruoyi.ccdi |
com.ruoyi.info.collection |
| 数据库表 | ccdi_* |
ccdi_* (保持不变) |
| API URL | /ccdi/* |
/ccdi/* (保持不变) |
| 权限标识 | ccdi:*:* |
ccdi:*:* (保持不变) |
| 前端文件 | ccdi* |
ccdi* (保持不变) |
选择理由
- 模块名和包名:更清晰表达"信息采集"功能
- 保留 ccdi 前缀:在 URL、表名、前端避免破坏性变更
- 数据库不变:无需迁移数据,降低风险
- API 不变:前端调用无需修改
修改清单
1. Maven 模块重命名
| 文件 | 修改内容 |
|---|---|
pom.xml (根目录) |
<module>ruoyi-ccdi</module> → <module>ruoyi-info-collection</module> |
pom.xml (根目录) |
<artifactId>ruoyi-ccdi</artifactId> → <artifactId>ruoyi-info-collection</artifactId> |
ruoyi-ccdi/pom.xml |
目录重命名为 ruoyi-info-collection/,<artifactId> 同步修改 |
ruoyi-admin/pom.xml |
<artifactId>ruoyi-ccdi</artifactId> → <artifactId>ruoyi-info-collection</artifactId> |
2. Java 包名重命名
- 目录结构:
com/ruoyi/ccdi/→com/ruoyi/info/collection/ - 涉及文件:约 100+ 个 Java 文件
- 修改内容:
- 所有
package com.ruoyi.ccdi→package com.ruoyi.info.collection - 所有
import com.ruoyi.ccdi.*→import com.ruoyi.info.collection.*
- 所有
3. MyBatis XML 命名空间
- 涉及文件:11 个 Mapper XML 文件
- 修改内容:命名空间从
com.ruoyi.ccdi.mapper.*改为com.ruoyi.info.collection.mapper.*
4. 项目文档修改
- 涉及文件:
doc/目录下约 135 个文件 - 修改内容:将
ruoyi-ccdi模块引用改为ruoyi-info-collection
不修改的内容
- 数据库表名 (
ccdi_*) - 数据库名 (
ccdi) - API URL 路径 (
/ccdi/*) - 权限标识 (
ccdi:*:*) - 前端 API 文件和视图目录
- 菜单配置数据
执行步骤
- 重命名模块目录
ruoyi-ccdi/→ruoyi-info-collection/ - 修改 Maven 配置文件
- 批量修改 Java 包名
- 修改 MyBatis XML 命名空间
- 更新项目文档
- 验证编译
mvn clean compile
风险评估
- 风险等级:中
- 主要风险:包名修改涉及大量文件,可能遗漏
- 缓解措施:
- 使用 IDE 的重构功能
- 编译验证确保无遗漏
- 执行单元测试
验收标准
- Maven 编译成功 (
mvn clean compile) - 所有 Java 文件包名正确
- MyBatis XML 命名空间正确
- 文档中模块名称已更新
设计日期:2026-02-24 设计状态:已批准