和各種詭異 Bug 打交道 13 年 我總結了 18 個經驗

編碼

01

事件順序

當處理事件時，問以下問題富有成效：事件是否可以以不同的順序到達？如果沒收到這些事件怎麼辦？如果事件在同一行出現兩次怎麼辦？即使這通常不會發生，在系統的其他部分（或交互系統）中的bug也會導致它發生。

02

處理太早

這是上述「事件順序」中的一個特殊情況，但是它已導致了一些棘手的bug，所以它自成一派。例如，如果信令信息接收得過早，在配置和啟動程序完成之前接收，許多奇怪的行為就會發生。另一個例子，當一個連接在被放入空閑列表之前就被標記為斷開。當我們處理這個問題時，我們通常假設它處在空閑列表狀態時被標記為斷開（但是當時它為什麼沒有從這個列表上撤下？） 沒考慮到事情有時發生過早是由於我們沒有想到。

03

隱蔽故障

例如，一些最難找的的 bug 是由於出現了隱蔽故障而繼續執行而不是給出錯誤的代碼導致的。例如，系統調用（如綁定）返回未檢查的錯誤代碼。另一個例子：當遇到一個錯誤元素時，直接返回而不是給出錯誤的解析代碼。調用在故障的狀態下持續了一段時間，使得調試的難度加大。一旦故障被檢測出，最好要及時返回這個錯誤。

04

If語句

含有多個條件的If語句（if (a or b)，尤其是當嵌套時，if (x) else if (y)），給我導致了許多 bug。即使If語句在概念上很簡單，當它有多個條件需要追蹤時，很容易出錯。最近我嘗試重新把代碼寫得簡潔，避免出現複雜的If語句。

05

Else

有一些bug的產生是由於沒有恰當地考慮如果條件為假，什麼應該發生。在幾乎所有的情況下，每個If語句都應該有個else部分。而且，如果你在If語句的一個分支中設置了一個變數，你也許應該在其他分支也設置該變數。與此相關的是標誌（flag）被設定的情況。僅僅添加設定標誌的條件很容易，但是容易忘了添加應該重新設定標誌的條件。任由永久性設定的標誌留在那裡可能會在將來導致 bug。

06

改變假設

一開始最難預防的許多bug是由不斷變化的假設引起的。例如，最初僅僅只有一個客戶，在這個假設下寫了很多代碼。後來某個時候，設計發生了變化，允許每天有多個客戶事件。當這種情況發生，就很難改變受到新設計影響的所有情況。很容易找到顯式依賴該變化的所有項，但是難的部分是，找到隱式依賴舊設計的所有情況。例如，可能有代碼讀取給定某一天的所有客戶事件。一個隱式的假設可能是，結果集中元素的數量絕對不會大於客戶數量。我沒有好的方法可以預防這類問題，歡迎讀者建議。

07

日誌記錄

深入了解程序所做的任務是至關重要的，尤其是當邏輯複雜的時候。確保添加足夠的（但也別太多）日誌記錄。那樣你就能弄清楚為什麼程序在執行它執行的任務。讓一切運轉良好時，它無關緊要。但是只要問題發生（這不可避免），你會很慶幸你添加了合適的日誌記錄。

測試

作為一名開發者，除非進行了測試，否則我不會說完成一項功能。起碼這意味著每一行新代碼或更改后的代碼至少執行了一次。此外，單元測試或功能測試也很好，但不夠。新功能還必須在類似產品的環境下進行測試和探究。唯有這樣，我才可以說完成了一項功能。下面是 bug 在測試方面給予我的一些重要的經驗教訓：

08

零（zero）和空（null）

務必要以零和空（合適的情況下）來進行測試。對於字元串而言，這意味著既指長度為零的字元串，又指內容為空的字元串。另一個例子：在發送任何數據（零位元組）之前，測試 TCP 連接的斷開。沒有使用這些組合來測試是 bug 悄然出現的頭號原因，我在測試時是原本可以發現這些 bug 的。

09

添加和刪除

新功能常常需要能夠為系統添加新配置，比如說用於電話號碼翻譯的新配置文件。我們會自然而然的添加一個配置文件，來驗證功能是否正常。然而，我發現很容易忘了還要測試配置文件的刪除。

10

錯誤處理

處理錯誤的代碼常常很難測試。最好由自動測試來檢查錯誤處理代碼，但有時這不可能。這種情況下，我有時採用的一招就是，臨時修改代碼，讓錯誤處理代碼運行。要做到這一點，最容易的方法就是反轉if語句，比如說將if語句由 error_count > 0反轉為 error_count == 0。另一個例子是誤拼資料庫列名，讓所需的錯誤處理代碼運行。

11

隨機輸入

另一種往往能夠發現 bug 的測試方法是進行隨機輸入。例如，H.323 協議的 ASN.1 解碼可處理二進位數據。通過發送有待解碼的隨機性位元組，我們發現了解碼器中的幾個 bug。另一個例子是使用測試調用生成腳本，其中調用持續時間、回復延遲、第一方掛斷等都是隨機生成的內容。這些測試腳本暴露了無數 bug，尤其是接踵而至的事件引起的干擾。

12

檢查什麼不該發生

通常測試包括檢查一些需要的行為發生。但是很容易忽略他的對立面——檢查不該發生的事確實沒發生。

13

自製工具

通常，我創建了自己的小工具來使測試更簡易。例如，當我處理面向 VoIP 的 SIP 協議時，我寫了一個小的腳本可以返回正標題和值。這個工具使得測試許多個別場景變得簡單。另一個例子是可以調用 API 的命令行工具。從小的開始，逐漸添加一些需要的功能，我最終有許多有用的工具，寫自己的小工具的優勢是我得到我想要的功能。

調試

14

討論

在過去對我幫助最大的調試方法就是與同事討論問題。我常常只要向同事描述問題，就足以認識到問題是什麼。此外，即使同事不是很熟悉相應代碼，常常也能給出好主意，表明哪裡可能有問題。

15

密切注意

往往是當調試一個問題很長時間時，是因為我做了錯誤的假設。例如，我認為這個問題發生在一個特定的方法中，事實上，這個問題甚至根本不會出現在這個方法中。或者拋出的異常並不是我認為的那個。或者我認為最新版的軟體在運行，但它其實是較老的版本。

16

最近的一次改動

本該運行的程序停止了，它通常是由最後的一次變動導致。有一次，最近的一次變動僅僅是日誌，但是日誌中的一個錯誤導致了更大的問題。

17

相信用戶

有時當一個用戶反饋問題時，我的本能反應是:這不可能，他們一定搞錯了。但是我已經意識到我不應該這樣做。我也不想這樣，但更多次，事實證明他們報告的問題實際上發生了。

18

測試修復的效果

如果你已經修復了 bug，還需要再測試。首先運行修復前的代碼，然後觀察 bug。然後運用修復再次測試。現在 bug 的問題應該被消除了。繼續這些步驟確保它確實是一個 bug，確保你的修復已經修復這個問題。簡單但很必要。