那一行是为了旧数据

有一行看起来多余,条件永远像是真的。我差点把它当垃圾删掉。

看提交说明才知道,它是为了两年前导入的一批数据。那些行的字段组合,新数据不会再出现。

删掉的话,旧数据在一次读取时会走错分支。不是马上爆,是结果悄悄不对。

我把说明补进代码旁边:兼容哪类旧数据,新数据不依赖这行。提交说明里只有当时的人能看见,代码旁边谁都能看见。

同时加了一条用旧数据样本做的测试。样本放在测试夹具里,字段和说明一致。

这行留下来了。下次有人想删,会先看见原因和那条测试。

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

先留现场,再动手。把当时的输入、输出、配置名抄下来,确认同一条路径还能再出现一次。不能再出现的现象,改完也不知道是不是改对了。确认之后只改一处。改两处的话,结果变了也分不清是哪一处。改完用同一组输入再走,结果要变成预期的那样,而不是仅仅没有报错。

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

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

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

6 个赞

看着多余的代码先看提交说明。有些是为了旧数据,删掉会在特定日期才爆。

1 个赞