本文整理自《Effective Objective-C 2.0:編寫高品質 iOS 與 OS X 程式碼的 52 個有效方法》。
Objective-C 中共有四種遍歷 collection 的方式:for 迴圈、for-in 快速遍歷、NSEnumerator,以及 Block 枚舉。四者各有適用場景,但結論很明確——多數情況下 Block 枚舉是最佳選擇。
NSArray *array = /*...*/;
for (int i = 0; i < anArray.count; i++) {
id object = anArray[i];
// 對 object 做些什麼
}
遍歷陣列時這樣寫還算清爽,但若對象是字典或 set,就得多繞幾步:
// Dictionary
NSDictionary *aDictionary = /*...*/;
NSArray *keys = [aDictionary allKeys];
for (int i = 0; i < keys.count; i++) {
id key = keys[i];
id value = aDictionary[key];
// 對 key 與 value 做些什麼
}
// Set
NSSet *aSet = /*...*/;
NSArray *objects = [aSet allObjects];
for (int i = 0; i < objects.count; i++) {
id object = objects[i];
// 對 object 做些什麼
}
字典與 set 都是無序的,無法用整數索引直接取值。所以必須先取出全部鍵(或全部物件)形成一個陣列,再靠這個有序陣列去訪問原集合。這份中介陣列會帶來額外開銷:多一個物件、多保留一次集合中的所有元素,釋放時也要多跑對應的清理邏輯。其他三種遍歷方式都不需要這種中介陣列。
不過 for 迴圈有個獨一無二的優勢:反向遍歷最簡單。計數器從「元素個數減 1」開始,每次迭代遞減到 0 即可。
NSEnumerator 是個抽象基類,只定義兩個方法供子類實作:
- (NSArray *)allObjects; - (id)nextObject;
關鍵是 nextObject:它回傳枚舉中的下一個物件,每次呼叫時內部資料結構都會更新。等所有物件都回傳完畢,再呼叫就回傳 nil,代表已到枚舉末端。
Foundation 內建的 collection 類別都實作了這套介面。遍歷陣列可以這樣寫:
NSArray *anArray = /* ... */;
NSEnumerator *enumerator = [anArray objectEnumerator];
id object;
while ((object = [enumerator nextObject]) != nil) {
// 對 object 做些什麼
}
功能上等同標準 for 迴圈,程式碼還多了一些。它真正的優勢在於語法統一:不論遍歷哪一種 collection,寫法都一樣。字典與 set 也是同樣套路:
// Dictionary
NSDictionary *aDictionary = /* ... */;
NSEnumerator *enumerator = [aDictionary keyEnumerator];
id key;
while ((key = [enumerator nextObject]) != nil) {
id value = aDictionary[key];
// 對 key 與 value 做些什麼
}
// Set
NSSet *aSet = /* ... */;
NSEnumerator *enumerator = [aSet objectEnumerator];
id object;
while ((object = [enumerator nextObject]) != nil) {
// 對 object 做些什麼
}
遍歷字典的方式與陣列、set 略有不同,因為字典同時有鍵與值,得依鍵把對應的值取出來。
NSEnumerator 還有另一個好處:有多種現成的枚舉器可用。例如反向遍歷陣列:
NSArray *anArray = /* ... */;
NSEnumerator *enumerator = [anArray reverseObjectEnumerator];
id object;
while ((object = [enumerator nextObject]) != nil) {
// 對 object 做些什麼
}
與等效的 for 迴圈寫法相比,這段程式碼讀起來順暢許多。
Objective-C 2.0 引入了快速遍歷。它與 NSEnumerator 遍歷本質相同,但語法簡潔得多——為 for 迴圈加入了 in 關鍵字:
NSArray *anArray = /* ... */;
for (id object in anArray) {
// 對 object 做些什麼
}
若某個類別的物件想支援這種語法,只要宣告遵循 NSFastEnumeration 協議即可。該協議只定義一個方法:
- (NSUInteger)countByEnumeratingWithState:(NSFastEnumerationState *)state
objects:(id *)stackbuffer
count:(NSUInteger)length;
它的實作細節不在此贅述,網上有不少優質講解。重點在於:這個方法允許類別的實例一次回傳多個物件,讓迴圈遍歷更有效率。
遍歷字典與 set 同樣簡單:
// Dictionary
NSDictionary *aDictionary = /* ... */;
for (id key in aDictionary) {
id value = aDictionary[key];
// 對 key 與 value 做些什麼
}
// Set
NSSet *aSet = /* ... */;
for (id object in aSet) {
// 對 object 做些什麼
}
由於 NSEnumerator 也實作了 NSFastEnumeration 協議,所以可以用它做反向遍歷:
NSArray *anArray = /* ... */;
for (id object in [anArray reverseObjectEnumerator]) {
// 對 object 做些什麼
}
到目前為止,這是語法最簡潔、效率也不錯的寫法。但它有兩個明顯短板:遍歷字典時若要同時拿到鍵與值,得多寫一步;而且與傳統 for 迴圈不同,它無法輕易取得當前索引,而索引在很多演算法中是必需的。
這是當前 Objective-C 最先進的遍歷方式。NSArray 提供了最基本的方法:
- (void)enumerateObjectsUsingBlock:(void(^)(id object, NSUInteger idx, BOOL *stop))block;
除此之外還有一系列可傳入 options 的變體,稍後會提到。
每次迭代都會執行傳入的 block,它有三個參數:當前物件、當前索引,以及一個指向 BOOL 的指標。前兩個參數不言自明;第三個參數提供了一個優雅的提前終止機制。
NSArray *anArray = /* ... */;
[anArray enumerateObjectsUsingBlock:^(id object, NSUInteger idx, BOOL *stop) {
// 對 object 做些什麼
if (shouldStop) {
*stop = YES;
}
}];
比 for-in 多了幾行,但依然清晰,而且遍歷時同時能拿到物件與索引。雖然用其他幾種方式也可以透過 break 終止迴圈,效果同樣不錯。
這種方式不只適用於陣列。NSSet 有對應的 block 枚舉方法,NSDictionary 也一樣,只是簽名略有不同:
- (void)enumerateKeysAndObjectsUsingBlock:(void(^)(id key, id object, BOOL *stop))block;
// Dictionary
NSDictionary *aDictionary = /* ... */;
[aDictionary enumerateKeysAndObjectsUsingBlock:^(id key, id object, BOOL *stop) {
// 對 key 與 object 做些什麼
if (shouldStop) {
*stop = YES;
}
}];
// Set
NSSet *aSet = /* ... */;
[aSet enumerateObjectsUsingBlock:^(id object, BOOL *stop) {
// 對 object 做些什麼
if (shouldStop) {
*stop = YES;
}
}];
Block 枚舉勝過其他方式的地方在於:遍歷時能直接拿到更多資訊。遍歷陣列時知道索引,遍歷 NSOrderedSet 時也一樣;遍歷字典時不必額外寫程式碼就能同時取得鍵與值,省掉了「依鍵取值」這一步。這很可能比其他方式快上不少,因為在字典內部的資料結構中,鍵與值本來就是存放在一起的。
用快速遍歷遍歷字典時,若已知物件必定是 NSString,得這樣寫:
NSDictionary *aDictionary = /* ... */;
for (NSString *key in aDictionary) {
NSString *object = (NSString *)aDictionary[key];
// 對 key 與 object 做些什麼
}
改用 block 枚舉,可以直接在方法簽名中完成轉換:
[aDictionary enumerateKeysAndObjectsUsingBlock:^(NSString *key, NSString *obj, BOOL *stop) {
// 對 key 與 obj 做些什麼
}];
之所以行得通,是因為 id 型別相當特殊,可以像這樣被其他型別覆寫。若原本 block 簽名把鍵與值宣告成 NSObject *,就做不到這一點。
這個技巧外表不起眼,實際上很有價值:指定精確型別後,編譯器就能檢查你是否呼叫了該物件不具備的方法,並在發現問題時報錯。只要能確定某個 collection 裡放的是什麼型別,就應該這樣標明。
陣列、字典、set 都實作了可傳入「選項掩碼」的版本:
- (void)enumerateObjectsWithOptions:(NSEnumerationOptions)options
usingBlock:(void(^)(id obj, NSUInteger idx, BOOL *stop))block;
- (void)enumerateKeysAndObjectsWithOptions:(NSEnumerationOptions)options
usingBlock:(void(^)(id key, id obj, BOOL *stop))block;
NSEnumerationOptions 是個 enum,各個取值可用「位元或」串接來表達遍歷方式。
NSEnumerationConcurrent。啟用後底層會透過 GCD 處理並發事宜,實作時很可能會用到 dispatch group。NSEnumerationReverse。要注意:只有遍歷陣列或有序 set 這類有順序的 collection 時這麼做才有意義。整體而言,Block 枚舉法具備其他方式的所有優勢,還多了索引、鍵值同時可得與並發迭代這些額外好處。雖然比快速遍歷多寫一點程式碼,但這個代價非常值得。