本文介紹 Xcode 8 新增的多執行緒除錯工具 Thread Sanitizer,它能在 App 執行時主動揪出線程競態問題。
《iOS 10 day by day》是 shinobicontrols 撰寫的系列文章,逐週介紹開發者需要掌握的 iOS 10 新特性。本系列翻譯已取得官方授權。
想像一下:App 幾乎完成,介面打磨過了,單元測試也全綠。只剩一個問題——某個很嚴重的 bug 偶爾會出現,你花了幾個小時試圖修復,卻一無所獲。
這種情況,十之八九是多個執行緒同時存取同一塊記憶體所導致的。多執行緒的 bug 是很多工程師的惡夢:難以定位、只在特定條件下重現,找原因簡直像大海撈針。
而兇手通常就是所謂的「線程競態」。引用 ThreadSanitizer 文件的說法:
兩個線程同時存取同一個變數,且其中至少一個是寫入操作,這種情況就稱為競態。
好消息是,Xcode 釋出了名為 Thread Sanitizer 的執行期檢測工具,它能在你察覺之前就先把問題攤在陽光下。
我們做了一個極簡的 App:使用者可以存錢、取錢,每次固定 $100。完整專案已放在 GitHub。
import Foundation
class Account {
var balance: Int = 0
func withdraw(amount: Int, completed: () -> ()) {
let newBalance = self.balance - amount
if newBalance < 0 {
print("You don't have enough money to withdraw \(amount)")
return
}
// 模擬銀行的防偽驗證過程
sleep(2)
self.balance = newBalance
completed()
}
func deposit(amount: Int, completed: () -> ()) {
let newBalance = self.balance + amount
self.balance = newBalance
completed()
}
}deposit 立刻返回,withdraw 則會耗上一段時間。名義上是因為銀行要做防偽驗證,實際上就是讓線程 sleep 兩秒——這也正好給了我們一個使用多執行緒的理由。另外要注意 completed 這個 callback,會在存取成功後被呼叫。
介面上有存錢、取錢兩個按鈕,還有一個顯示餘額的 label。

import UIKit
class ViewController: UIViewController {
@IBOutlet var balanceLabel: UILabel!
let account = Account()
override func viewDidLoad() {
super.viewDidLoad()
updateBalanceLabel()
}
@IBAction func withdraw(_ sender: UIButton) {
self.account.withdraw(amount: 100, onSuccess: updateBalanceLabel)
}
@IBAction func deposit(_ sender: UIButton) {
self.account.deposit(amount: 100, onSuccess: updateBalanceLabel)
}
func updateBalanceLabel() {
balanceLabel.text = "Balance: $\(account.balance)"
}
}跑起來會發現,取錢的過程卡卡的。

原因很明顯:withdraw 裡的「防偽驗證」會一直 block 主線程。但我們希望使用者能連續快速操作,延遲越低越好。
把 withdraw 從主線程移開就能解決延遲問題,這裡用上 Swift 3 全新包裝的 GCD:
func withdraw(amount: Int, onSuccess: () -> ()) {
DispatchQueue(label: "com.shinobicontrols.balance-moderator").async {
let newBalance = self.balance - amount
if newBalance < 0 {
print("You don't have enough money to withdraw \(amount)")
return
}
// 模擬銀行的防偽驗證過程
sleep(2)
self.balance = newBalance
DispatchQueue.main.async {
onSuccess()
}
}
}
等等,我們的錢呢?餘額明明是 $100,先取 $100 再存 $100,結果餘額變成 0?
存、取方法單獨測試都沒問題,所以問題顯然出在「把 withdraw 丟到另一條線程」這一步。
啟用方式很簡單:點開 target 的 Edit Scheme…,在 Diagnostics 分頁勾選 Thread Sanitizer,再順手把 Pause on issues 也打勾,方便逐步除錯。


由於 Thread Sanitizer 只在執行期運作,需要重新編譯並跑一次。
WWDC 的場次中,Apple 建議在所有單元測試裡都開啟 Thread Sanitizer。它必須等程式真的執行到該段邏輯才會檢測出競態,因此測試覆蓋率越高,能揪出的問題就越多。
另外要注意:這個工具對 Swift 僅支援 Swift 3 的程式碼(Objective-C 亦可),而且只能在 64 位元模擬器上執行。
重複剛才的操作——先取錢,再立刻存錢——這次 App 被暫停了,Thread Sanitizer 抓到了競態,並清楚呈現衝突發生時的呼叫堆疊。

搭配呼叫堆疊與控制台輸出的資訊,問題一秒定位:Account.deposit 與 Account.withdraw 會同時存取 Account.balance,於是產生競態。看來存錢跟取錢應該放在同一條線程上才對。
我們替 Account 類別加上一個共用的 queue:
class Account {
var balance: Int = 0
private let queue = DispatchQueue(label: "com.shinobicontrols.balance-moderator")
func withdraw(amount: Int, onSuccess: () -> ()) {
queue.async {
// 跟之前一樣...
}
}
func deposit(amount: Int, onSuccess: () -> ()) {
queue.async {
let newBalance = self.balance + amount
self.balance = newBalance
DispatchQueue.main.async {
onSuccess()
}
}
}
}再跑一次,競態還在,只是這回換成 ViewController 在主線程讀取 balance 造成的。

解法是把 balance 改成私有,只允許在 Account 內部存取,並透過 queue 同步回傳結果:
private var _balance: Int = 0
var balance: Int {
return queue.sync {
return _balance
}
}先前所有對 balance 的寫入,都要改成私有的 _balance。這次無論怎麼快速連點「取錢」與「存錢」,Thread Sanitizer 都再也沒有跳出警告。
Thread Sanitizer 外表不起眼,卻很可能成為 iOS 開發者口袋裡最重要的工具之一。它能在程式「看起來沒出錯」的時候就找出競態,替你省下大量 debug 間歇性多執行緒問題的時間。
Sanitizer 是 Clang 編譯器的一部分,想深入了解可以參考 LLVM 官網,以及 Google 開發團隊撰寫的 wiki(裡面有對多執行緒檢測演算法的簡介)。另外,Apple 在 Swift 3 的 GCD 併發編程場次中介紹了新語法,Roy Marmelstein 也寫過一篇精簡的轉換說明,都值得一看。
原文作者:Sam Burnstone @sam_burnstone,ShinobiControls 官網 shinobicontrols.com
文章轉自 戴倉薯的簡書