mirror of
https://gitee.com/san-bing/JChargePointProtocol
synced 2026-05-10 21:10:00 +08:00
46 lines
1.9 KiB
Markdown
46 lines
1.9 KiB
Markdown
|
# JChargePointProtocol 文档中心
|
|||
|
|
|
|||
|
|
本目录用于沉淀项目的架构、开发、运维与接口文档，建议按“先总览、再开发、后专项”的顺序阅读。
|
|||
|
|
|
|||
|
|
## 快速导航
|
|||
|
|
|
|||
|
|
- `系统概述.md`：项目边界、核心能力、运行形态与关键链路
|
|||
|
|
- `开发者指南.md`：本地开发、构建、启动、调试与提交流程
|
|||
|
|
- `技术栈与依赖.md`：后端/前端/中间件依赖与版本约束
|
|||
|
|
- `部署与配置.md`：部署模式、配置项与环境差异
|
|||
|
|
- `监控与运维.md`：监控指标、日志排障、常见运维操作
|
|||
|
|
- `API接口参考/`：REST 与 gRPC 接口说明
|
|||
|
|
- `架构设计/`：架构模式、微服务拆分与数据流分析
|
|||
|
|
- `核心模块详解/`：协议处理、设备管理、具体协议实现细节
|
|||
|
|
- `数据模型与数据库设计.md`：核心实体、关系与表结构设计
|
|||
|
|
- `缓存架构.md`：缓存分层、键设计、失效与一致性策略
|
|||
|
|
- `消息队列集成.md`：Kafka 主题、消息流转与消费模型
|
|||
|
|
- `安全机制.md`：认证、鉴权与安全边界
|
|||
|
|
- `代码审查/`：阶段性 CR 报告与改进建议
|
|||
|
|
|
|||
|
|
## 推荐阅读路径
|
|||
|
|
|
|||
|
|
### 新同学入项
|
|||
|
|
|
|||
|
|
1. 读 `系统概述.md` 理解系统边界与整体链路
|
|||
|
|
2. 读 `开发者指南.md` 完成本地环境启动
|
|||
|
|
3. 读 `架构设计/架构设计.md` 与 `核心模块详解/核心模块详解.md` 理解代码分层
|
|||
|
|
|
|||
|
|
### 进行协议开发
|
|||
|
|
|
|||
|
|
1. 读 `核心模块详解/协议处理框架.md`
|
|||
|
|
2. 读 `核心模块详解/协议实现模块/` 下目标协议文档
|
|||
|
|
3. 对照 `API接口参考/` 与 `消息队列集成.md` 联调
|
|||
|
|
|
|||
|
|
### 运维与排障
|
|||
|
|
|
|||
|
|
1. 读 `监控与运维.md`
|
|||
|
|
2. 结合 `部署与配置.md` 与 `缓存架构.md` 定位问题
|
|||
|
|
3. 必要时查看 `代码审查/` 中的已知风险与修复建议
|
|||
|
|
|
|||
|
|
## 文档维护约定
|
|||
|
|
|
|||
|
|
- 优先更新原有文档，避免新建同主题重复文档
|
|||
|
|
- 关键改动（架构、链路、接口）必须同步更新对应文档
|
|||
|
|
- 代码评审建议放入 `代码审查/`，并标明日期与影响范围
|