超时 5 秒、重试 3 次,在三个文件里各写了一遍。改超时的人只找到两处,第三处仍是 5 秒,故障表现成‘有的请求快失败,有的会多等’。
收到一处常量里,三处都引用它。数字本身没变,变的是以后只会改一个地方。
常量旁边写了单位和原因。5 秒是给上游的响应时间,不是随便写的。没有这句话,下次还会有人改成 30 秒来‘消除失败’。
测试里也不再写死 5。用同一个常量,避免测试和生产各说各的。
我用搜索确认仓库里没有留下裸的 5 秒和 3 次。搜索词要带单位,否则会误伤别的数字。
上线后那条不一致的失败没有再出现。日志里的超时值也统一了。
读一段不熟的实现,我先写调用顺序,再进文件。测试名字和断言放在注释前面,因为注释会过期,测试红了会有人看见。函数名承诺的事如果包不住函数体,就拆开或改名,不要靠调用方记得副作用。改完用这条路径的成功、失败、缺参数各走一遍。
收尾只留三行在仓库里:现象,改了哪一处,怎样确认。聊天记录会沉,仓库还在。三行对不上,就还没完,先不要告诉别人已经好了。对得上,别人才能在不找作者的情况下把同一件事再做一遍。
复查「魔法数字提出来之后」时按这四步,不靠感觉。用改之前的同一组输入再走一遍,结果要变成预期的那样。在日志里打出实际读到的配置名、端口或库名,确认不是另一个还没关的进程。换一个干净环境再做一次。最后把现象、改动、确认方法写成三行放进仓库。
补充记录。读代码时我按固定顺序,避免在文件之间跳丢。先写六行调用:入口、校验、查询或计算、副作用、返回、失败时怎样。再看测试名字和断言,最后才看注释。注释和断言冲突时,以断言为准,然后把注释改掉。函数名如果包不住副作用,就拆成两个名字,让调用处自己选择。改完用成功、失败、缺参数三条输入各走一遍。三条结果必须不同。相同就说明失败被吞掉了,或者缺参数也被当成了成功。把这六行和三条结果留在提交说明里,后来的人不用再把调用栈走一遍。
操作顺序。1. 用六行写下入口、校验、查询、副作用、返回、失败时的结果。2. 打开对应测试,先读名字,再读断言。3. 名字、断言、注释三者不一致时,以断言为准改另外两处。4. 如果函数还做了名字里没有的事,拆出去或改名。5. 用成功、失败、缺参数三条输入各打一次,三条结果必须不同。6. 把六行调用和三条结果写进提交说明。后来的人按这六行读,不必再把文件跳一遍。