调用方收到成功,下游其实失败了。捕获错误的地方只写了一行空日志,没有原因,也没有继续抛出。
空日志等于没有日志。排查时只能看到‘成功’,和用户看到的失败对不上。
改成两种选择里的一种:要么把原因写进日志并返回失败,要么继续抛出交给上层统一处理。这里选了返回失败,因为上层已经有统一的错误格式。
补了测试。下游失败时,结果必须是失败,不能是成功。以前没有这条,所以吞掉错误的写法能通过测试。
我又搜了同类的空捕获。还有一处是故意忽略的,注释写了为什么可以忽略。没有注释的空捕获都改了。
上线后这类‘系统说成功、事情没发生’少了一种。剩下的至少能在日志里看到原因。
读一段不熟的实现,我先写调用顺序,再进文件。测试名字和断言放在注释前面,因为注释会过期,测试红了会有人看见。函数名承诺的事如果包不住函数体,就拆开或改名,不要靠调用方记得副作用。改完用这条路径的成功、失败、缺参数各走一遍。
记录里保留失败的那一次。只写成功,别人学不到边界。失败时的输出、当时的配置、本来期望发生什么,三样放在一起。修好之后补一句:如果再出现,先看哪一行。没有这句,这篇就只是故事。
复查「错误被吞掉了」时按这四步,不靠感觉。用改之前的同一组输入再走一遍,结果要变成预期的那样。在日志里打出实际读到的配置名、端口或库名,确认不是另一个还没关的进程。换一个干净环境再做一次。最后把现象、改动、确认方法写成三行放进仓库。
补充记录。读代码时我按固定顺序,避免在文件之间跳丢。先写六行调用:入口、校验、查询或计算、副作用、返回、失败时怎样。再看测试名字和断言,最后才看注释。注释和断言冲突时,以断言为准,然后把注释改掉。函数名如果包不住副作用,就拆成两个名字,让调用处自己选择。改完用成功、失败、缺参数三条输入各走一遍。三条结果必须不同。相同就说明失败被吞掉了,或者缺参数也被当成了成功。把这六行和三条结果留在提交说明里,后来的人不用再把调用栈走一遍。
操作顺序。1. 用六行写下入口、校验、查询、副作用、返回、失败时的结果。2. 打开对应测试,先读名字,再读断言。3. 名字、断言、注释三者不一致时,以断言为准改另外两处。4. 如果函数还做了名字里没有的事,拆出去或改名。5. 用成功、失败、缺参数三条输入各打一次,三条结果必须不同。6. 把六行调用和三条结果写进提交说明。后来的人按这六行读,不必再把文件跳一遍。