修复每个 bug 后都要问这 3 个问题

你是否曾经修复了一个 bug ,随后又发现了一个跟刚修复 bug 有关的 bug ,又或是修复 bug 的方式引起了另一个 bug ?当我修改 bug 时,我会问自己三个问题,以确保我已经仔细考虑了它的意义。每次你认为发现并修改了一个 bug 时,可以使用这些问题来提高生产力和代码质量。

99-bugs-in-the-code

这些问题背后的主要思想就是:每一个 bug 都是底层进程的一个不良表现。你必须处理这些症状,但如果你仅仅是处理这些外在症状,你就会有永远解决不完的问题。你应该找到产生 bug 的进程,并且修复这个进程。当你确定究竟发生了什么和发生这些的原因时,也许你就会明白产生 bug 的基础进程不是随机的,而是可控的。

在问这三个问题前,你需要克服面对 bug 的这种天生的抗拒,仔细分析 bug 。查看代码并解释出错的原因,从能观察到的现象开始,向后分析,不断地问为什么,直到你可以找到产生 bug 的模式。通常,你该跟同事一起做这件事, 因为解释你认为会发生的事情,将迫使你面对一些假设——这些程序是做什么的。

“它溢出了,因为下标J越界了。”

“为什么?”

“J 是 10,但数组最大下标为 9。”

“为什么?”

“J 是一个字符串长度,数组的起始下标是 0,所以字符串长度为 1 的最后一个字符的索引是 0。”

找到 bug 后,查找其他意外情况。检查程序出错时主要的程序变量的值,是否可以解释这些值。

“为什么 name 是 null?”

“为什么它总是输出错误信息呢?”

记录下你做了哪些操作,发生了哪些变化。你需要知道究竟发生了什么,这样做就意味着你时刻有一把标尺和历史记录。

当完成这些步骤后,你可以准备问第一个问题了。

1. 其他地方也会出现这个错误吗?

查看代码中使用相同模式的地方,系统地改变模式找出类似的 bug 。

“我还在其他什么地方使用长度作为下标的吗?”

“所有数组的起始下标都一样吗?”

“对于一个长度为 0 的字符串会发生什么?”

试着描述这部分代码中应该是正确的,但是这些 bug 没有遵循的规则。寻找这个不变量 [ 1 ]的过程将帮助你找到其他潜在的 bug 。

“起始偏移加上长度减去1就是结束的下标,除非数组长度为 0”。

对于你发现的每一个 bug ,你都可以解决一批 bug ,这是非常高效的。尝试用概括性的语言描述这些 bug 也能提升你对程序的理解程度,并帮助您避免在程序中引入更多的 bug 。

2. 这个 bug 后面隐藏着什么其它的 bug ?

一旦你确定了如何修复这个 bug ,你就需要考虑一下修复后会发生什么。这个执行失败的语句后面的语句也可能有问题,但是程序还没有执行到此就不知道有没有 bug ,或者有些代码因为你修复 bug 而第一次出现在程序中,这些代码也可能有问题。查看这些未执行的语句,检查代码中的 bug 。

“下一条语句会正常运行吗?”

当你在想程序的控制流的时候,可以弄清楚还有哪些地方程序没有执行到。

“是否有我从来没有测试过的功能组合?”

在程序中插桩(instrumentation)并不会耗费太多时间,在运行程序各个部分的过程中就可以进行检查,但是你会惊讶地发现开发者测试过的代码还有很多都不能正常运行。

“我可以测试出所有的错误信息吗?”

注意一个地方的改动可能会引起其他地方的 bug 。一些变量的局部改动可能会在执行时违反后来的假设。

“如果仅是从 J 中减去 1,当长度为 0 时,后面的语句会操作数组中 -1 位置的元素。”

如果程序已经做了大量改动,就要仔细考虑是否有必要增加另外一个补丁,或者是时候考虑重新设计和重新实现了。

(有时候调 Bug 就是这样的)

3.我应该做些什么防止类似 bug 的产生呢?

问问自己如何改变编程方法,根据定义避免 bug 的出现,通过改变方法或者工具,经常可以移除整个类的错误而不用一个一个的解决 bug 。

从“ bug 是何时引入的”这个问题开始:在程序开发生命周期的哪一个阶段可以阻止 bug 的产生?

“设计是没问题的;我在编程时引入了 bug 。”

仔细检查 bug 产生的原因,考虑 bug 产生时正在运行的进程,并想想怎么改变它来阻止 bug 的产生。

“将偏移的数据类型和长度分离出来将会在编译时捕获这个错误。”

“每一个文本项可以用隐藏了下标计算的宏输出,然后我就可以一次找到它。”

不要满足于肤浅的答案。假如你对于一个 bug 的解释是,“我记不清了”,那还怎么改进这个过程,让你不再需要记住它?你可以更改编程语言,使被忽略的细节可以完全隐藏,否则你遗漏的部分会被检测到从而导致编译问题。对这个问题域,你可能使用了预处理器或者智能的编辑器,有默认值,错误检查,智能提示和快速文档。这个 bug 可能是编程团队沟通的问题,亦或是需要讨论的设计冲突。

思考发现 bug 的方式,并问问自己如何能更早发现它。测试怎么可以更严密一些?能否进行自动化测试?是否要添加代码实时检测功能,以便可以及时捕获错误信息?

“我应该在我的测试单元中尝试长度为 0 的数组”。

“我应该进行下标检查,提前捕获不符合的下标”。

有必要创建一些系统方法和自动化工具,用于编译、构建和测试,它们可以减少长时间的调试和查明具体事实的过程。

这个技巧的应用

养成这样一种习惯:每当你发现一个 bug 时,问自己这三个问题,甚至你不必等到有 bug 时才使用这三个问题。

在设计和审查过程中,你都可以用这三个问题来处理你得到的每一条意见。审阅意见是潜在的沟通过程的结果,使你可以有所改进。如果你认为读者评论是错误的,比如,你可能会问是什么使你的文章没被理解,如何更好地与审稿人沟通。

设计评审和代码审查[2]是找出 bug 的强有力手段,你可以对审查过程出现的每一个缺陷都提出三个问题。如果审查彻底,前两个问题不会出现太多新的 bug ,但第三个问题可以帮助你找到方法,用来避免未来可能会出现的 bug 。

致谢:感谢那些教给我这些经验,丰富了我生活和工作的朋友和同事。感谢Jay O’Dell、Rick Berman 和 Tom DeMarco 对本文早期版本的宝贵的批评和建议。

参考
[1] Hoare, C. A. R, Proof of a Program: FIND, Comm. ACM 14, 39-45, Jan 1971.
[2] Fagan, M. E., Design and Code Inspections to Reduce Errors in Program Development, IBM Systems Journal 15(3), 1976.
[3] Saltzer, J. H., Repaired Security Holes in Multics, MIT CSR-RFC-5, Feb 27 1973.

1 6 收藏 17 评论

关于作者:BJdaxiang

完善思想,独立人格,做一个热爱生活、喜欢思考的程序猿! 个人主页 · 我的文章 · 10

相关文章

可能感兴趣的话题



直接登录
最新评论
  • 大刀 家庭教师 11/17

    延伸到工作也可以的,特别是程序员,这次代码还有什么可以优化,下次再做能不能快一些

  • 这样做很棒!看似会花很多时间,其实为以后节省了更多的时间,也让程序更完美。

  • BLRogers   11/20

    刚加班回来,加班的时候同事就在说,我改完1个bug又冒出3个bug,明天改不完了...感觉还得提高自己的代码设计的水平,才能避免出这么多不好修改的bug...

  • 大唐   11/22

    注重设计,注重品质~

  • 樱桃   11/22

    全局核对有无类似bug,修复引发新问题,怎么防止再发生。思路很清晰,开发人员必须注意的几点。

  • 浪子哥   11/23

    这个漫画太搞笑了

  • 翼枪 开发 11/24

    我突然想到,很多政绩工程是需要你留下很Bug然后慢慢修复,以配合整体烧钱进度与开发周期成本(*^_^*)

  • 星光 工程师 11/25

    提议很好,有助于提高思考习惯,完善自己的思维

  • xinwu web前端 11/25

    说到一些越来越被广泛使用的计算机语言,像Java和Objective-C,库文件的数量也不断增加。很明显可以看出,构建一个框架就需要许多的基础库,甚至一些Java的插件也需要很多大量的附加文件。有时候这些乱七八糟的东西会很让人心烦,但是至少它能运行。

  • Allen   11/27

    文章说的很好,补充一点自己的想法,就是改完bug一定要测试,测试过来这次修改bug才算成功

  • 峰景 软件开发 11/27

    一般分析原因,复现这个bug,修复,再测试。

  • EDIAGD 后端开发 11/28

    很有道理,每次解决完bug,应该总结,同类的问题、要反馈给开发和测试,让问题一次过

  • 我执   11/28

    工作中也是经常遇到bug,因为偏向业务,更多是查看日志

  • dhqcl 程序员 11/28

    说的相当靠谱

    第一点:收集所有批次的bug,整理,总结,从根源推演出现象,再从现象反推出根源,你就有调试bug的直觉了.

    第三点:想办法让编译器,宏断言等工具来自动发现错误,极力避免手写错误;

  • BUG遇的越多,码龄也就越长,经验也就越多,技术水平越高

  • Lsow 著名英语爱好者 12/01

    每改一次bug,都是一次提升

  • 木佳佳公子   5 天前

    如果时间不是太赶,解bug挺有意思的,感觉自己化身为侦探,排除各种可疑的情况,最后揪出罪魁祸首

跳到底部
返回顶部