顺着一个请求往下看

一个接口返回了不该出现的空列表。路由是对的,参数也传了,我在控制器里停了很久,没看到筛选是在更后面做的。

我改成顺着调用写顺序:路由、参数校验、查询、组装返回。写到查询那一行才看见,校验失败时提前返回了空列表,而不是报错。

校验失败却返回成功,调用方无法区分‘没有数据’和‘请求不合法’。我把它改成明确的错误,并在测试里覆盖这两种。

顺序写在笔记上只有六行,但比在文件之间跳着看快。以后我看不熟的接口,都先写这六行再进代码。

提前返回还藏着一个条件:某个可选参数为空时也走了失败分支。文档写的是可选,代码把它当成了必填。两处改成一致。

修完后用合法参数、缺参数、参数为空各打一次。三种结果不同,才算这条链路看完了。

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

给后来的人看,所以写能照着做的步骤,不写感受。每一步写期望看到什么。看不到,就停在这一步,不要继续往下猜。步骤结束以后,用干净环境再做一次。自己的机器上能过,只能说明自己的机器上能过。

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

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

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

8 个赞

我看请求会先在纸上写六行:路由、校验、查询、返回。提前返回经常藏在校验里。

3 个赞