代码评审出问题时的排查顺序:从现象到根因

开发 · 3 分钟阅读· 200 次阅读

把格式问题交给 lint 后,人工评论里讲空格的占比能从三成降到 5% 以下

正确的第一步是分类:起不来、连不上、跑得慢,三条路完全不同。

先说结论

先分三类,再由外向内查:网络、进程、配置、依赖、资源。

  • 先确认现象能复现,且能描述清楚
  • 由外向内:端口、进程、配置、依赖、资源
  • 读第一条错误,不是最后一条
  • 改一个变量,验证一次,别一次改五处
  • 留下记录:现象、假设、验证、结论

第一类:起不来

先看进程在不在,再看它为什么退出:把格式问题交给 lint 后,人工评论里讲空格的占比能从三成降到 5% 以下。

  • 查看服务状态与最近日志(不是全部日志)
  • 确认端口是否被占用、权限是否足够
  • 确认配置文件语法(多数服务支持 test 模式)
  • 确认依赖的数据目录存在且可写

第二类:连不上

按「本机、网络、代理、应用」四层查:

层级 验证方式 典型原因
本机 本机 curl / telnet 端口 没监听、只听 127.0.0.1
网络 从另一台机器访问 防火墙、安全组、VLAN
代理 检查反代配置与证书 路径、超时、头部大小
应用 看访问日志与错误日志 鉴权、限流、连接池耗尽

第三类:跑得慢

评论要区分「必须改」和「可以讨论」,否则作者无法判断优先级。

慢的问题先分清是「等」还是「算」:CPU 高是算,CPU 低但延迟高是等(IO、锁、网络)。

代码评审出问题时的排查顺序

这个服务的高频故障点

同类的坑基本集中在这些位置:

  • 评审等待超过一天,上下文切换的成本会让作者宁愿推倒重写
  • 把格式问题交给 lint 后,人工评论里讲空格的占比能从三成降到 5% 以下
  • 评论要区分「必须改」和「可以讨论」,否则作者无法判断优先级
  • 同一个 PR 混入重构和功能改动,diff 会放大 2-3 倍

别做的事

只评论「这里可以更好」不说为什么,作者改不动

在 PR 里顺手重构无关文件,真正的改动被淹没

一次改多个参数,会让下一次故障更难查。

把结论写下来

排查记录不是给别人看的,是给三个月后的自己看的。同一个 PR 混入重构和功能改动,diff 会放大 2-3 倍。

还有几处容易忽略的

都是小地方,但出问题时往往就卡在这里。

  • 单次评审超过 400 行时缺陷发现率明显下降,超过 1000 行基本只剩风格意见
  • 评审记录是团队知识的载体,三个月后翻记录比翻文档有效
  • PR 攒了一周才提,两千行 diff 没人看得下去

排障能力不是知道更多命令,是知道先查什么。

评论 (3)

阿
阿哲

排查顺序那段直接抄进值班手册了。

K
Kevin

版本差异要强调,我照着做结果参数名全变了。

老
老吴

备份没验证过等于没有,这条我认。

发表评论

验证码

提交后需站长审核,通过后才会显示。