三問助你Debug

2019 年 12 月 31 日
筆記

譯者按: Debug 也要三省吾身！

原文: Three Questions About Each Bug You Find

本文採用意譯，版權歸原作者所有

你是否發現：有時候，當某個 BUG 被我們修復之後，卻又發現一個由該 BUG 引發的另一個 BUG，或則由於修復演算法的缺陷引入新的 BUG？因此，每一次修復 BUG，我都會問自己三個問題來確保我考慮周全。你也可以使用同樣的方法來提高程式碼的品質。

這些精心設計的問題的核心思想是：每一個 BUG 都是某個隱藏的核心問題的表象。你需要解決這些表面癥狀，但如果只是治標，那麼終究會在其它地方複發，沒有治本；你需要發現導致這個 BUG 的核心問題，並且糾正它。導致出現 BUG 的核心問題一般不會隨機而無法控制，只要你理解了它為什麼會出現以及什麼原因導致它出現。

在你對自己提出這三個問題之前，你需要克服自己的惰性，仔細地去分析產生 BUG 的原因。通過從出現 BUG 的程式碼位置開始，一步一步問自己為什麼會錯，往回倒著查看程式執行步驟，直到你找到出現這個 BUG 的模式。往往和同事一起 Debug 會有助於你證實你的假設。

程式異常是因為下標變數 J 越界了為什麼呢？數組的長度為 10，下標最大為 9，但是下標 J 已經是 10 了為什麼呢？ J 是整個數組的長度，但是可索引的下標為 9。

在尋找 BUG 原因的過程中，同時檢查一下關鍵變數的值，看看能否解釋在此情況下，變數值為何如此。

為什麼 name 是 null？為什麼會列印出一條錯誤資訊？

你需要知道程式到底發生了什麼，也就是說要將這些資訊度都記錄下來方便分析。

現在我們來看是看這三個問題。

1. 這個失誤在其它地方有犯過么？

看看程式碼中其它地方有沒有使用過類似的編程方法，通過適當的發散思維也有助於尋找類似的 BUG。

其它地方有沒有使用數組的長度作為下標？
所有的數組都是源自同一個原始數組嗎？
如果數組長度為 0，是否會出問題？

嘗試描述這段程式碼應當遵循的邏輯，有 BUG 的程式碼會違反該邏輯。

數組起點的初始值加上數組的長度並減去 1 就是最後一個數組元素的下標。如果數組的長度為 0，則不滿足。

如果每次修改一個 BUG 的同時修復了幾個其它潛在 BUG，將大大提高你的工作效率。嘗試將問題用更加抽象的角度去描述將有助於你理解整個程式，以防止引入新的 BUG。

2. 在這個 BUG 後面是否可能隱藏著另一個 BUG？

當你已經弄清楚如何修復這個 BUG，可以預想 BUG 修復後的程式行為。BUG 程式碼行之後的語句也可能隱藏著 BUG，只是程式以前因為 BUG 崩潰而沒有執行到這一步；或則由於修復可能返回其它值，而以前沒有考慮。可以試試向自己提如下問題：

接下來的語句可以成功執行嗎？

當你在查看程式的控制流的時候，你可以弄清楚有哪些程式碼還沒有執行過。

我是否測試過這些屬性的組合

檢查各種屬性可能性的組合併不會花費太多工作精力，而且往往會發現很多情況開發者都沒有考慮到！

我可以測試出所有錯誤資訊嗎？

要注意一個地方的改動可能導致其它地方出現 BUG。在局部對一個變數的更改也許會違背之前的一些假設。

如果我只是將 J 減去 1，如果數組的長度為 0，那麼下一行程式碼會嘗試操作數組中位於-1 位置的元素。

如果你已經對程式做了很多修改，每一次都要仔細考慮做法是否正確，甚至需要重新設計和實現這部分程式碼。

3. 我應該如何做來避免類似的 BUG？

你需要嘗試尋找方法從根源上解決問題。使用新的方法和工具往往可以直接消除該類型的所有 BUG，而不是一個一個去發現和解決。

要找到 BUG 是什麼時候引入的，是否可以在開發階段避免？

設計沒有問題；我在寫程式碼的時候引入了 BUG

仔細檢查 BUG 發生的原因，理清 BUG 發生的程式碼邏輯，然後看看如何糾正。

定義新的不同的類型來區分數組的索引和長度可以在編譯時發現這個錯誤。(索引類型可以限定索引的最大長度)

每一個數組元素輸出的時候都輸出對應的下標的計算方法，這樣我就可以很快找到問題。

假設你對產生某一個 BUG 的理由是「變數太多，我只是忘記了」，那麼你需要做的是如何改進來保證你不需要記住很多變數。

版權聲明

轉載時請註明作者 Fundebug以及本文地址： https://blog.fundebug.com/2017/08/23/three-questions-about-each-bug-you-find/