Skip to content

阅读路径 ​

这个知识库有 100 多页。不要从头读:先认领一个角色,沿一条路线走到底,再按需跳到别的层。

三条路线共用同一套页面,区别只在「读什么、读多深、读完要能做什么」:

路线适合谁预计时长读完能做什么
A 产品经理不写代码,但要判断需求能不能落、落哪个模块90 分钟独立读懂功能卡,写出可评审的需求与验收标准
B 后端开发要上手改代码、加接口、加表4 小时(分两次)从功能卡追到类与表,按仓库约定加一个 CRUD
C 架构 / 运维接手部署、排障、评估启用新模块2.5 小时说清请求与租户链路,定位 80% 的环境与配置问题

读法约定:每一步都按「读哪页 → 带着什么问题 → 读完能回答什么」组织。先看问题再看页面,答不上来就回到问题,不要顺读。

1. 路线 A:产品经理(不懂代码也能走) ​

适合谁:产品经理、业务分析师、项目经理;不需要 Java 基础,但要愿意看表格和接口清单。

预计时长:90 分钟(可分 2 次)。

第 1 步 · 产品定位 ​

  • 读:产品定位
  • 带着问题读:这个平台服务谁?它明确「不做什么」?和低代码/脚手架的区别在哪?
  • 读完能回答:用一句话说清定位,并列出 3 条能力边界。

第 2 步 · 能力地图 ​

  • 读:能力地图
  • 带着问题读:我要的功能在哪个模块?是 ✅ 已实现、⏸ 预留还是 🚧 规划?113 项是怎么算出来的?
  • 读完能回答:任意指一个功能点,说出它的模块归属与状态;解释「40 + 67 + 6 = 113」。

第 3 步 · 角色与场景 ​

  • 读:角色与场景
  • 带着问题读:谁在用系统?同一个功能对不同角色看到的东西为什么不同?
  • 读完能回答:说出 3 个核心业务角色,以及「业务角色」与平台「权限角色」的区别。

第 4 步 · 关键流程 ​

  • 读:关键流程
  • 带着问题读:从开通租户到用户能登录,中间经过哪些配置?一次「建用户」在业务上真正发生了什么?
  • 读完能回答:画出「租户 → 套餐 → 角色 → 菜单 → 用户」的开通链路。

第 5 步 · 功能卡 ​

第 6 步 · PM 知识框架 ​

  • 读:项目管理知识框架、方法论与平台能力映射
  • 带着问题读:WBS、里程碑、风险、度量这些方法论,哪些已经变成平台功能,哪些还只是「规划」?
  • 读完能回答:把一条 PM 方法论映射到具体功能点,并指出缺口。

路线 A 检查点 ​

  • [ ] 能用 3 句话讲清平台定位与边界
  • [ ] 能说出 3 个已实现功能点及其所属模块
  • [ ] 能解释「业务角色」与「权限角色」不是一回事
  • [ ] 能只看功能卡就写出一个接口的入参、出参与权限点
  • [ ] 能指出一个「规划中」能力,并说明它缺的是代码还是决策

2. 路线 B:后端开发(上手改代码) ​

适合谁:Java 后端;熟悉 Spring Boot / MyBatis-Plus 更好,不熟也能跟,但第 2、4 步要慢读。

预计时长:4 小时(建议拆成「读链路 2h + 读模块 2h」)。

第 1 步 · 分层与依赖 ​

  • 读:分层与依赖、框架总览
  • 带着问题读:Controller / Service / DAL 各管什么?为什么 *CommonApi 放在 framework 的 common 里?可选模块怎么做到「不引依赖也能编译」?
  • 读完能回答:新功能该落在哪一层;为什么业务模块不能反向依赖 server。

第 2 步 · 请求处理链路 ​

  • 读:请求处理链路
  • 带着问题读:/admin-api 前缀是谁加的?一个请求依次经过哪些 Filter?异常怎么变成统一 JSON?
  • 读完能回答:按顺序说出租户、令牌、XSS、访问日志、Spring Security 的相对位置。

第 3 步 · 鉴权与权限点 ​

  • 读:鉴权与权限点、starter-security
  • 带着问题读:@PreAuthorize("@ss.hasPermission(...)") 背后查了什么?为什么权限点必须先在菜单表登记?
  • 读完能回答:401 与 403 分别在哪个类产生;超管为什么能跳过权限判断。

第 4 步 · 数据访问约定 ​

  • 读:数据访问约定、数据访问与多租户基线
  • 带着问题读:为什么 DO 继承 BaseDO 就自动有审计字段和逻辑删除?分页 count SQL 为什么也带 tenant_id?
  • 读完能回答:三个 MyBatis 拦截器的顺序,以及「新表不生效」时先查哪一处。

第 5 步 · 功能卡 ​

  • 读:SYS-USER-01、INF-CODEGEN-01
  • 带着问题读:卡片里的行号指向哪个文件?15 个接口里哪些有权限点、哪些没有?
  • 读完能回答:从一张卡直接跳到 UserController#L52,并说出它调用的 Service 方法。

第 6 步 · 某个 starter 页 ​

  • 读:starter-web,再按兴趣选 starter-mybatis 或 starter-job
  • 带着问题读:为什么加一个依赖就生效?自动配置类、AutoConfiguration.imports、开关属性三者怎么配合?
  • 读完能回答:说清一个 starter 的 core + config 结构,以及关闭它的开关名。

第 7 步 · 代码生成闭环 ​

  • 读:代码生成闭环
  • 带着问题读:从「导入表」到「生成物落盘」经过哪六步?哪些文件生成后还必须手工改?
  • 读完能回答:errorcode.vm 为什么只产片段;菜单 SQL 为什么要手工执行;目录不匹配怎么处理。

路线 B 检查点 ​

  • [ ] 能画出 /system/user/create 从 Controller 到 system_users 的 5 个节点
  • [ ] 能默写 Filter 顺序里前 4 个(CORS / TRACE / 请求体缓存 / 加解密)
  • [ ] 能解释「权限点没登记菜单 ⇒ 403」的原因
  • [ ] 能说出 BaseDO 的四个审计字段与逻辑删除字段
  • [ ] 能独立完成一次代码生成,并列出 3 个手工收尾步骤

3. 路线 C:架构 / 运维(接手与排障) ​

适合谁:架构师、SRE、接手项目的技术负责人;需要能读配置、看日志、定位跨层问题。

预计时长:2.5 小时。

第 1 步 · 模块化与自动配置 ​

  • 读:模块化与自动配置、预留模块概览
  • 带着问题读:为什么默认只有 system 与 infra 参与构建?启用一个预留模块要动哪几个 pom、哪张表、哪个兜底类?
  • 读完能回答:复述启用清单的 7 个动作,并说明每一步的验证点。

第 2 步 · 多租户 ​

  • 读:多租户
  • 带着问题读:tenant-id 从哪个 Filter 进入上下文?SQL 改写、Redis key、MQ、Job、WebSocket 各自怎么透传?哪条链路最容易丢?
  • 读完能回答:区分 400「租户标识未传递」与 403「无权访问该租户」;说出 @TenantIgnore 的三个落点。

第 3 步 · 数据权限 ​

  • 读:数据权限
  • 带着问题读:功能权限与数据权限的边界在哪?五种数据范围分别拼出什么 SQL?为什么它和租户拦截器同为 0 号顺序?
  • 读完能回答:同一张表,为什么部门经理与超管看到的行数不同;新增一条规则要改哪些类。

第 4 步 · Web 过滤器与统一响应 ​

  • 读:Web过滤器与统一响应
  • 带着问题读:为什么未登录时 HTTP 状态是 200、body 里 code=401?GlobalResponseBodyHandler 到底做不做什么?
  • 读完能回答:按顺序背出 Filter 链;解释异常如何映射成 HTTP 状态;说出 XSS / 加解密 / 访问日志的开关。

第 5 步 · 定时任务与异步 ​

  • 读:定时任务与异步、starter-job
  • 带着问题读:local 环境为什么不跑 Quartz?@TenantJob 怎么让一个任务跑遍所有租户?@Async 为什么会丢租户上下文?
  • 读完能回答:列出「任务不执行」的 3 个检查点;说明重试为什么占用同一个 Quartz 线程。

第 6 步 · 消息与实时推送 ​

  • 读:消息与实时推送、starter-mq、starter-websocket
  • 带着问题读:Redis Stream 与 Pub/Sub 各适合什么?RabbitMQ / RocketMQ / Kafka 为什么是可选装配?WebSocket 五种 sender 在多实例下怎么选?
  • 读完能回答:给一个「站内信实时到达」的方案,说明租户透传、失败重试与幂等。

路线 C 检查点 ​

  • [ ] 能画出「一次请求」的 Filter 顺序,并指出租户校验在令牌校验之后
  • [ ] 能区分租户问题的 400 / 403 / NPE 三种表现
  • [ ] 能说出 Quartz 被禁用的确切配置行,以及启用它的两个前提
  • [ ] 能解释 WebSocket 广播为什么会串租户
  • [ ] 能给一个「多实例 + 多租户」的消息方案,不依赖单机内存

4. 三条路线的核心差异 ​

  • 路线 A 读「能力与边界」:只关心「有什么、给谁、什么状态」,用功能卡作为代码的替身。
  • 路线 B 读「一次请求怎么落地」:从注解追到 SQL,重点是分层约定与可复制的 CRUD 套路。
  • 路线 C 读「横切机制怎么串起来」:租户、权限、过滤器、消息都是横切的,重点是顺序、上下文与失效场景。

5. 读完之后 ​