第 5 章 · 影响面清单怎么看
本章目标:会在 SRX 执行输出里识别 【影响面清单】;把清单当 人工复核 checklist,与 审阅条、任务四要素 配合;改 枢纽文件(models、路由、公共 API)时少漏关联文件。
学时建议:2.5~3 小时(含 1 小时跟练)
前置:srx-v7 ch03(审阅条);ch09 四要素模板可预习。
只讲界面上能看到什么、您该怎么用,不涉及引擎内部实现。
5.1 场景说明:只改了 Service,上线后测试和页面全挂了
你让 SRX「改 OrderService.create 的返回值类型」。审阅条里只 ✓ 了 2 个文件,以为完事。结果:
- views 还在用旧字段
- tests 断言失败
- 前端列表 解析 JSON 报错
若在执行输出里出现过 【影响面清单】,里面可能早就提示:views/、tests/、序列化层等路径——清单不是给您点的按钮,是给您脑子的提醒。
5.2 学完你能
| 能力 | 验收 |
|---|---|
| 识别 | 在执行输出里找到【影响面清单】 |
| 用法 | 把路径当 checklist,改完后人工打开核对 |
| 分工 | 清单(改前/中) vs 审阅条(改后) |
| 边界 | 知简单任务常不出现;清单不全仍要测试 |
| 习惯 | 改枢纽代码必写【范围】+ @ 关键文件 |
5.3 影响面清单是什么
在 多文件、较复杂 的改代码任务里,执行输出区域有时会出现:
【影响面清单】
下面列出:除了您 @ 或点名的文件外,还建议一并查看哪些路径。
您需要知道的:
| 要点 | 说明 |
|---|---|
| 无需点按钮 | 只读提示,对照参考 |
| 常不出现 | 简单小任务、空项目、范围很窄时 —— 正常 |
| 可能不全 | 仍靠审阅条 + 测试 + 您的业务知识 |
| 不是审阅条 | 清单在执行过程;审阅条在改完待确认 |
5.4 长什么样(示例)
常见格式(以软件实际显示为准):
【影响面清单】
触及 `OrderService.create` 时,建议同步关注:
`handlers/order.go`、`handlers/order_test.go`、`api/openapi.yaml` …
技巧:复制路径到记事本,改完后 逐项打开 或 批量搜索 符号名(quick-start ch04 批量搜索)。
5.5 跟练 A:故意触发「枢纽改动」(必做)
步骤 1 — 准备
- 打开 shop-demo 或练习仓根目录(ch01)
- 分支:
git checkout -b try/ch05-impact
步骤 2 — 发任务(略复杂、带符号)
【目标】在 README 的「模块说明」里增加一小节:
说明「若修改 OrderService.create 返回值,需同步检查哪些层」
(用虚构路径举例即可,不必改真实 OrderService)
【范围】优先只改 README.md
【请】若可,列出可能影响面清单式的关联路径(views/tests/api)
【验收】README 有「影响面」示例小节
步骤 3 — 观察执行输出
- 是否出现 【影响面清单】 或 SRX 在正文里列关联路径
- 若无:属正常,继续步骤 4
步骤 4 — 审阅条
- 逐文件 ✓(ch03)
- 对照:清单里提到的路径,README 是否写全
你应该看到:即使无正式清单块,好的任务描述也会促使 AI 在输出里提到关联文件——您要学会自己补 checklist。
5.6 跟练 B:清单 + 审阅条对照(必做)
步骤 1 — 发多文件小任务
【目标】README 增加「API 版本 v2」说明;docs/api.md 增加一行指向 README
【范围】仅 README.md 与 docs/api.md(不存在可新建 docs/api.md)
【不要】修改任何源码与 go.mod
步骤 2 — 执行中
- 留意 【影响面清单】 是否提到 意外路径(如
internal/)
步骤 3 — 审阅条
| 情况 | 操作 |
|---|---|
| 仅 2 个预期文件 | 逐 ✓ |
| 出现第 3 个意外文件 | ✗ 拒绝,任务加强「不要动 xxx」 |
| 清单与审阅条不一致 | 以 审阅条实际 diff 为准,清单作提醒 |
步骤 4 — 人工 checklist
改完后自己列 3 项并打勾:
□ README 链接正确
□ docs/api.md 存在且可读
□ git diff 无多余文件