Files
railwaysystem/docs/README.md
T
wangzhibiao b12ef9c9e4 docs(doc): 结构化梳理项目doc与docs文档中心并补齐导航索引
- 厘清 doc(业务与产品需求)与 docs(技术架构与代码审计)的职责边界
- doc 根目录保持一期正式生效基线 PRD V1.0,甲供原始材料归整至 raw_materials/,历史过程稿归档至 archive/
- 规范化接纳 wxy_doc/ 早期原型与技术说明并完善说明
- 为 doc/、docs/ 及项目根目录补齐结构化 README.md 导航索引与一键启动指引
2026-09-14 00:39:39 +08:00

66 lines
5.6 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.
# RailwaySystem 技术架构与代码审计中心(docs)
> **说明**:本目录为 RailwaySystem 智慧培训系统的技术架构设计、代码审计、数据库实测核验及运行环境全景知识库。
>
> **业务基线指针**:所有技术方案与数据库重构均服务于业务需求,业务判断请严格参阅 [doc/RailwaySystem 智慧培训系统一期 PRD V1.0.md](file:///Users/wzb/Desktop/项目/RailwaySystem/doc/RailwaySystem 智慧培训系统一期 PRD V1.0.md) 以及 [doc/README.md](file:///Users/wzb/Desktop/项目/RailwaySystem/doc/README.md)。
---
## 核心技术现状速览(Phase 0 审计结论)
1. **工程架构**:前后端分离架构,后端基于 Spring Boot 2.5 + 若依 (RuoYi-Vue) 单体增强,前端基于 Vue 2.6 + Element UI。
2. **数据库底座**:国产人大金仓 **KingbaseES V009R003C018**(JDBC 驱动 8.6.0,`database_mode=mysql`)。通过跳板机隧道(`127.0.0.1:4321` -> `192.168.139.218:4321`)直连生产实例。
3. **数据库实测**:14 张培训业务表全部就绪,除 `train_teacher` 含有 1 条真实教师记录外,其余 13 张表数据量为 0,具备低包袱重构升级条件。
4. **接口连通性**:已针对 Controller 增加路由别名,涵盖培训管理 14 组业务接口的探测全部达到 HTTP 200 连通。
5. **系统启动**:已在工程根目录提供一键启动脚本 [start-local.sh](file:///Users/wzb/Desktop/项目/RailwaySystem/start-local.sh),集成跳板机隧道打通、本地 Redis 唤醒、Mac 端口清理与前后端一键并发启动。
---
## 代码与数据全景审计报告清单(`codebase-audit/`)
本目录下的 [codebase-audit/](file:///Users/wzb/Desktop/项目/RailwaySystem/docs/codebase-audit/) 包含完整的 18 篇技术审计报告,记录了对工程现状、源码实现、数据库实际 schema 与权限体系的详尽核验:
### 1. 核心综述与基线标准
- [17_phase0_summary.md](file:///Users/wzb/Desktop/项目/RailwaySystem/docs/codebase-audit/17_phase0_summary.md) —— ★★★ **Phase 0 工程与数据库真实基线总结(进入下一阶段前必读)**
- [11_executive_summary.md](file:///Users/wzb/Desktop/项目/RailwaySystem/docs/codebase-audit/11_executive_summary.md) —— 全景代码审计执行摘要
- [12_baseline_classification.md](file:///Users/wzb/Desktop/项目/RailwaySystem/docs/codebase-audit/12_baseline_classification.md) —— 真实代码基线与工程资产可信度分级
- [00_project_overview.md](file:///Users/wzb/Desktop/项目/RailwaySystem/docs/codebase-audit/00_project_overview.md) —— 项目整体技术概况与组件关系
- [01_project_tree.md](file:///Users/wzb/Desktop/项目/RailwaySystem/docs/codebase-audit/01_project_tree.md) —— 项目工程目录结构全貌
### 2. 数据库与数据建模实测
- [13_live_database_snapshot.md](file:///Users/wzb/Desktop/项目/RailwaySystem/docs/codebase-audit/13_live_database_snapshot.md) —— 实时 KingbaseES 数据库实例只读核验快照
- [14_database_code_diff.md](file:///Users/wzb/Desktop/项目/RailwaySystem/docs/codebase-audit/14_database_code_diff.md) —— 实时数据库与当前代码及 PRD V1.0 业务对象的差异比对
- [16_kingbase_readonly_compatibility.md](file:///Users/wzb/Desktop/项目/RailwaySystem/docs/codebase-audit/16_kingbase_readonly_compatibility.md) —— KingbaseES MySQL 模式兼容性实测报告
- [03_database_current_state.md](file:///Users/wzb/Desktop/项目/RailwaySystem/docs/codebase-audit/03_database_current_state.md) —— 数据库静态结构与设计状态分析
### 3. 后端服务与 API 盘点
- [04_api_inventory.md](file:///Users/wzb/Desktop/项目/RailwaySystem/docs/codebase-audit/04_api_inventory.md) —— 后端 Controller 接口现状盘点与路由清单
- [02_training_modules_inventory.md](file:///Users/wzb/Desktop/项目/RailwaySystem/docs/codebase-audit/02_training_modules_inventory.md) —— 培训业务模块 Java 代码资产详尽盘点
- [09_reusable_ruoyi_capabilities.md](file:///Users/wzb/Desktop/项目/RailwaySystem/docs/codebase-audit/09_reusable_ruoyi_capabilities.md) —— 若依(RuoYi)底座可复用框架能力分析
### 4. 前端组件与页面现状
- [05_frontend_inventory.md](file:///Users/wzb/Desktop/项目/RailwaySystem/docs/codebase-audit/05_frontend_inventory.md) —— 前端 Vue 页面、路由及 API 请求层盘点
### 5. 安全、权限与运行配置
- [15_live_permission_snapshot.md](file:///Users/wzb/Desktop/项目/RailwaySystem/docs/codebase-audit/15_live_permission_snapshot.md) —— 生产菜单、角色、权限关系实时状态核验
- [06_security_and_permissions.md](file:///Users/wzb/Desktop/项目/RailwaySystem/docs/codebase-audit/06_security_and_permissions.md) —— 权限体系与若依安全拦截机制分析
- [07_runtime_and_environment.md](file:///Users/wzb/Desktop/项目/RailwaySystem/docs/codebase-audit/07_runtime_and_environment.md) —— 运行环境依赖、配置项与本地部署条件
- [08_git_status.md](file:///Users/wzb/Desktop/项目/RailwaySystem/docs/codebase-audit/08_git_status.md) —— Git 提交历史与版本分支演化
### 6. 业务与技术差距分析
- [10_gap_and_conflict_analysis.md](file:///Users/wzb/Desktop/项目/RailwaySystem/docs/codebase-audit/10_gap_and_conflict_analysis.md) —— 现状与预期目标的差距与冲突分析
---
## 关联子模块技术文档
- Kingbase 兼容模式专题核验:
- [kingbase_compatibility_audit.md](file:///Users/wzb/Desktop/项目/RailwaySystem/RuoYi-Vue/docs/kingbase_compatibility_audit.md)
- [kingbase_fact_check.md](file:///Users/wzb/Desktop/项目/RailwaySystem/RuoYi-Vue/docs/kingbase_fact_check.md)