36 lines
1.5 KiB
Markdown
36 lines
1.5 KiB
Markdown
# 后端项目知识库
|
||
|
||
> 工程：<工程名> ｜ 技术栈：Spring Boot <x.y.z> / JDK <n> / <ORM> ｜ 最近更新：<YYYY-MM-DD>
|
||
> 维护规则：发生重大功能变化、或收到"更新后端项目知识库"指令时更新。
|
||
|
||
## 一、项目概览
|
||
- 定位：
|
||
- 技术栈与版本（Spring Boot / JDK / JPA-MyBatis / 构建工具）：
|
||
- 启动 / 运行方式（端口、profile、入口类）：
|
||
|
||
## 二、模块与包结构
|
||
（各层 / 各 package 的职责，例如 controller 负责接口、service 负责业务、repository 负责数据访问）
|
||
|
||
## 三、核心领域模型与关系
|
||
（实体、关键字段、相互关系；若存在逻辑外键请注明"无物理外键，靠业务字段关联"）
|
||
|
||
## 四、关键业务流程
|
||
（主要用例 / 请求链路，例如登录、授权、数据集成）
|
||
|
||
## 五、工程约定与模式
|
||
（仅记录本项目真实存在的约定，不臆造）
|
||
- 异常返回结构（如统一 HTTP 200 + `{code,msg,data}`）：
|
||
- 鉴权方式（如 CAS SSO / JWT / header 触发式 CORS）：
|
||
- 缓存（如 Redis 序列化需注册 JavaTimeModule）：
|
||
- 事务边界：
|
||
- 分页查询约定（如 BasePageQuery / BasePageResult）：
|
||
|
||
## 六、集成点
|
||
（数据库 / Redis / 消息队列 / 配置中心 Nacos / SSO-CAS / 外部 API，写明用途，不写密钥）
|
||
|
||
## 七、重要设计决策与原因
|
||
（为何这样分层、关键取舍，例如"去 L1/L2 分层配置、回归单层 + 重启兜底"）
|
||
|
||
## 八、待办与已知坑
|
||
（未完成的白名单策略、待修项、历史踩坑）
|