找 bug 極度耗時;幾乎每個有經驗的開發者都曾在某一個 bug 上耗掉好幾天。在一個平台上寫得越久,通常越容易抓到 bug。然而總是有一些特別難找、難重現的。所以第一步永遠是:想辦法穩定重現它。一旦能重複觸發,後續的排查工作才有立足點。
這篇文章想整理我們在除錯時經常遇到的常見問題。遇到 bug 時,你可以把它當成一份核對清單,逐項對照,或許能更快找到答案。更理想的情況是,這裡的技巧能幫你在第一時間就避開這些 bug。
回呼有在正確的執行緒上嗎?
導致異常行為的一個常見原因,是某些東西跑在錯誤的執行緒上。最典型的就是在非主執行緒更新 UIKit 物件——有時候會僥倖正常,但多數情況下會出現各種怪異現象,甚至直接崩潰。在自己的程式碼裡用斷言檢查「是否在主執行緒」可以有效緩解這類問題。
容易(意外)落到背景執行緒的回呼,通常來自網路請求、計時器、檔案讀取或外部函式庫。另一個解法是把執行緒隔離在一個邊界內:例如你在封裝一個網路 API,就把所有執行緒細節都關在那層裡處理——請求一律在背景執行,回呼一律切回主執行緒。如此一來,呼叫端再也不必擔心執行緒問題。簡單的設計在開發中真的很有價值。
這個物件的類別對嗎?
這個問題基本上只存在於 Objective-C;Swift 有完整的型別系統,能精確保證物件或值的型別安全。在 Objective-C 裡,不小心把型別搞錯實在太常見。
舉例來說,我們在 Deckset 裡加了一個與字型相關的新功能,其中有個陣列屬性取名為 fonts,我理所當然地假設裡面的元素都是 NSFont。結果實際上裝的是 NSString(字型名稱)。我花了不少時間才找到原因——因為在大多數情況下程式碼是能正常跑的。
在 Objective-C 中,檢查型別問題的方式之一是使用斷言。另一個對自己有好處的習慣,是在命名時就把型別資訊編進去(例如把這個陣列取名為 fontNames)。而在 Swift 中,明確標註型別就能避免這類錯誤(寫 [NSFont] 而不是 [AnyObject])。
不確定物件型別時,可以在除錯器中把型別印出來看看。另外,用 isKindOfClass: 搭配斷言來驗證類別也很實用。在 Swift 中,因為 Optional 的存在,你可以在任何需要的地方用 as? 做型別轉換,這比直接用 as 強制轉型安全得多。這些做法都能大幅降低出錯機率。
具體的 Build 設定
另一個常見原因是不同 build 設定之間存在一些不易察覺的差異。例如編譯器在某些配置下會做優化,導致只在正式版出現、除錯版卻完全看不到的 bug。這種情況相對少見,但當時的 Swift 版本就有回報過類似問題。
還有一種情形是某個變數或巨集被以不同方式定義。比如有些程式碼在開發中被註解掉了——我們曾寫了一段會導致崩潰的(錯誤的)使用者行為統計程式碼,但開發時關掉了統計,所以我們在開發 App 時永遠遇不到那些崩潰。
這類 bug 在開發階段極難發現,所以務必詳盡且徹底地測試正式版 App。如果有其他人(例如 QA)能幫忙測試,那更好。
不同裝置
不同裝置的可用性會有差異。如果你只在少數幾台機器上測試,沒覆蓋到的裝置就成了潛在的 bug 來源。經典劇情是「只在模擬器測過、從未在真機跑過」。但即使你在真機測了,也得考慮不同機型與其功能差異。比如在處理內建相機時,總要用 isSourceTypeAvailable: 這類方法先確認輸入源是否可用——你的機器上有相機,使用者的機器上未必有。
可變性
可變性也是常見又難追的原因。例如你在兩個執行緒間共享同一個物件,而它們同時修改它,就可能出現很意外的結果。這類 bug 的痛點在於難以重現。
一個解法是建立不可變物件:這樣當你存取物件時,就能確定這個操作不會改變它的狀態。這主題可以聊很多,更多資訊建議閱讀〈結構體與值類型〉、〈值物件〉、〈物件可變性〉與〈關於可變性〉。
是 nil 嗎?
身為 Objective-C 開發者,我們偶爾會拿 NullPointerException 開 Java 工程師的玩笑。很多時候,對 nil 送訊息確實不會出問題。但也有一些棘手的 bug 正因此而生。如果你改用 Swift,這節大半可以跳過,因為 Optional 已經解決了其中大部分問題。
你有把 nil 當參數傳進函式嗎?
這個原因相當常見。有些方法在你傳入 nil 參數時會直接崩潰。例如:
NSString *name = @""; NSAttributedString *string = [[NSAttributedString alloc] initWithString:name];
如果 name 是 nil,這段程式碼就會崩潰。麻煩的是這往往是個你沒注意到的邊界情況(例如 myObject 在大多數情境下不可能為 nil)。寫自己的方法時,你可以加上自訂標記,讓編譯器幫你確認是否允許 nil 參數:
- (void)doSomethingWithRequiredString:(NSString *)requiredString
bar:(NSString *)optionalString
__attribute((nonnull(1)));(來自 StackOverflow)
加上這個標記後,一旦你傳入 nil,就會出現編譯器警告。這很好,因為你不必再自己守著這個邊界情況,可以讓編譯器代勞。
另一種可行做法是「反轉資訊流」。例如在 NSString 上寫一個自訂分類,加一個 attributedString 的實例方法:
@implementation NSString (Attributes)
- (NSAttributedString*)attributedString {
return [[NSAttributedString alloc] initWithString:self];
}
@end這樣的好處是:現在你可以安全地構造 attributedString。你可以寫 [@"John" attributedString],也可以把這個訊息送給 nil([nil attributedString])——不會崩潰,只是得到 nil。想了解更多,請參考 Graham Lee 的文章〈反轉資訊流〉。
如果你想約束更多必須成立的條件(例如某參數必須是某類別),也可以用 NSParameterAssert。
你確定可以對 nil 送訊息嗎?
這其實不算太常見的原因,但它確實在一個真實的 App 中出現過。有時候,當我們處理純量值時,對 nil 送訊息可能帶來意料之外的結果。看這段乍看無誤的程式碼:
NSString *greeting = @"Hello objc.io";
NSRange range = [greeting rangeOfString:@"objc.io"];
if (range.location != NSNotFound) {
NSLog(@"Found the keyword!");
}如果 greeting 含 "objc.io",訊息會被印出;不含則不會。那如果 greeting 是 nil 呢?range 會變成所有欄位皆為 0 的結構體,location 也就是 0。而 NSNotFound 被定義為 -1,所以後面的訊息還是會被印出來。因此,任何時候當你同時處理純值與 nil,都要把更多情況納入考量。同樣地,Swift 的 Optional 可以避免這個問題。
類別裡有東西沒初始化嗎?
有時候程式跑到某個物件的環節時,因為呼叫了尚未完全初始化的物件而被中斷。由於在 init 裡塞額外程式碼並不常見,所以有時你在使用某個物件前,得先呼叫它的某些方法。一旦忘了呼叫,這個類別就可能處於半初始化狀態而出現各種怪異行為。務必確保在指定的初始化方法跑完之後,物件已處於可用狀態。
如果你確實需要那個帶參數的指定初始化方法被呼叫,又無法設計出只用 init 就能完成初始化的類別,另一個選擇是把 init 改寫成會直接崩潰。缺點是之後萬一你不小心用 init 實例化,得花一點時間才能察覺並修正。
KVO
另一個常見原因是錯誤使用 KVO。壞消息是犯錯並不難,好消息是有不少方法可以避開。
你有移除觀察者嗎?
一個很典型的錯誤是加了觀察者卻沒移除。這種情況下 KVO 會持續送訊息,但接收者可能已被釋放,於是崩潰。繞過它的方式之一是使用成熟框架如 ReactiveCocoa,也有一些輕量級的庫很好用。
另一種做法是:每當你建立一個新觀察者,就立刻在 dealloc 裡寫一行移除。不過這個流程可以自動化——比直接加觀察者更好的做法是建立一個自訂物件,由它代為新增觀察者,並在自己的 dealloc 裡移除。這樣做的好處是:觀察者的生命週期會與這個物件一致,也就是「建立這個物件」等同於「新增一個觀察者」。接著把它存成屬性,當容器物件被銷毀、屬性自動設為 nil 時,觀察者也隨之移除。
關於這個技巧有更詳細的說明與範例程式碼。實作這功能的輕巧庫有 THObserversAndBinders,也可以看看 Facebook 的 KVOController。
另一個 KVO 常見問題是回呼可能從你沒預期到的執行緒返回(就像開頭那節描述的一樣)。同樣的,用一個物件來代理,就能確保所有回呼都在確定的執行緒上觸發。
相依鍵的路徑
如果你觀察的屬性是基於另一個屬性計算出來的,務必記得註冊相依鍵。否則當來源屬性變化時,你可能收不到回呼。不久前我就在相依鍵宣告裡不小心寫出了遞迴相依(屬性依賴自己),然後怪事就發生了。
視圖
Outlet 與 Action
使用 Interface Builder 時有個常見錯誤:忘了連接 outlet 與 action。現在它們通常會在程式碼旁以小圓圈標示出來。想確認所有連接都如預期,可以靠單元測試來驗證(但這可能變成沉重的維護負擔)。
另外,為了在問題發生時盡快發現,也可以用斷言,例如以 NSAssert 驗證你的 outlet 不為 nil。
未釋放的物件
使用 Interface Builder 時,要確保從 nib 載入的物件圖不會被提前釋放。蘋果對這個問題有幾點要點說明,建議讀過並照著做,否則你的物件可能就在眼前消失,或者被過度持有。另外,簡單的 XIB 與 Storyboard 之間也存在一些差異,請務必熟悉。
視圖的生命週期
處理視圖時可能出現的 bug 非常多。一個常見錯誤是在視圖還沒初始化時就使用它;或者視圖雖已初始化,但尺寸尚未設定就已經拿去用了。關鍵在於:在視圖生命週期中找到正確的節點來安排程式碼。花時間理解它們如何運作,相對於日後除錯的時間成本來說,絕對划算。
把既有 App 移植到 iPad 時,這也常常是 bug 來源。你現在可能得開始操心某個視圖控制器是不是子控制器、它們如何回應旋轉事件,還有一些細微差異。這種情況下 Auto Layout 能提供幫助,它能自動處理很多類似變化。
還有一個常見錯誤:我們總是習慣先建立視圖、加好約束,最後才把它加入父視圖。但為了讓大部分約束生效,視圖必須先被放進父視圖的視圖階層中。算是不幸中的好消息:這種情況通常會直接讓程式碼崩潰,你能很快找到問題。
最後
希望以上技巧能幫你擺脫 bug,甚至完全避免它們。此外還有一些自動化的助力:在 Clang 設定中開啟所有警告,能揭露很多潛在問題;另外也請定期執行靜態分析,它一定能找到一些 bug。