这个回调是谁注册的

搜索函数名有十几处调用,看不出是谁在启动时把它登记进去的。断点打在函数里面,能看到调用栈,但登记发生在更早。

我改去看进程启动时加载配置的那一段。回调按配置里的名字注册,业务代码里只是被调到。

弄清之后,把‘去启动配置里找登记处’写进了这个函数顶部的注释。注释只写找它的方法,不复述函数在做什么。

配置里可以关掉这个回调。关掉之后再走一遍相关操作,确认没有人假设它一定存在。

同类回调还有两个,也是启动时注册的。我列在同一段注释里,避免下一个又全文搜索一轮。

现在要改行为,先改登记,再改函数。顺序反了就会觉得‘代码改了却没生效’。

读一段不熟的实现,我先写调用顺序,再进文件。测试名字和断言放在注释前面,因为注释会过期,测试红了会有人看见。函数名承诺的事如果包不住函数体,就拆开或改名,不要靠调用方记得副作用。改完用这条路径的成功、失败、缺参数各走一遍。

判断分两层。第一层是现象:什么时候开始、影响谁、能不能再出现。第二层才是原因。很多时间浪费在还没写清现象就改代码。原因确定之后,改动尽量小,并写明怎样一分钟内确认它生效。确认不了的改动先不要合。

复查「这个回调是谁注册的」时按这四步,不靠感觉。用改之前的同一组输入再走一遍,结果要变成预期的那样。在日志里打出实际读到的配置名、端口或库名,确认不是另一个还没关的进程。换一个干净环境再做一次。最后把现象、改动、确认方法写成三行放进仓库。

补充记录。读代码时我按固定顺序,避免在文件之间跳丢。先写六行调用:入口、校验、查询或计算、副作用、返回、失败时怎样。再看测试名字和断言,最后才看注释。注释和断言冲突时,以断言为准,然后把注释改掉。函数名如果包不住副作用,就拆成两个名字,让调用处自己选择。改完用成功、失败、缺参数三条输入各走一遍。三条结果必须不同。相同就说明失败被吞掉了,或者缺参数也被当成了成功。把这六行和三条结果留在提交说明里,后来的人不用再把调用栈走一遍。

操作顺序。1. 用六行写下入口、校验、查询、副作用、返回、失败时的结果。2. 打开对应测试,先读名字,再读断言。3. 名字、断言、注释三者不一致时,以断言为准改另外两处。4. 如果函数还做了名字里没有的事,拆出去或改名。5. 用成功、失败、缺参数三条输入各打一次,三条结果必须不同。6. 把六行调用和三条结果写进提交说明。后来的人按这六行读,不必再把文件跳一遍。

3 个赞

回调别先全文搜索。先看启动时按配置注册的那一段,范围小很多。

1 个赞