本文是 Objective-C Runtime 系列的第三篇。如果你對 Runtime 還不熟,建議先看前兩篇:《Objective-C Runtime》與《Method Swizzling 和 AOP 實踐》。
這次要探究 KVO(Key-Value Observing)的實作機制,並實際動手——用 Runtime 自己寫一個 KVO 出來。
KVO 是 Objective-C 對觀察者模式(Observer Pattern)的實作,也是 Cocoa Binding 的基礎。當被觀察物件的某個屬性改變時,觀察者會收到通知。
有意思的是,你不需要替被觀察物件添加任何額外程式碼,就能使用 KVO。這是怎麼辦到的?
KVO 同樣依賴強大的 Objective-C Runtime。Apple 的文件有輕描淡寫地提過:
Automatic key-value observing is implemented using a technique called isa-swizzling... When an observer is registered for an attribute of an object the isa pointer of the observed object is modified, pointing to an intermediate class rather than at the true class ...
唯一有用的線索就是:被觀察物件的 isa 指標會指向一個中間類,而不是它原來真正的類。看來 Apple 並不希望過多暴露細節。但只要用 runtime 提供的方法往下挖,所有被蓋住的東西都會現形——Mike Ash 早在 2009 年就做過這件事。
KVO 的實作,簡單說就是:
當你觀察一個物件時,系統會動態建立一個新類別。這個類別繼承自物件原本的類,並重寫被觀察屬性的 setter。重寫後的 setter 負責在呼叫原 setter 前後,通知所有觀察者數值已變。最後把物件的 isa 指標(它告訴 Runtime 這個物件是什麼類)指向這個新子類,物件就「變成了」新子類的實例。
這個中間類別繼承自原本那個類,不仅如此,Apple 還重寫了 -class 方法,試圖欺騙我們「類別沒變」。更具體的細節,跑一下 Mike Ash 那篇文章裡的程式碼就一清二楚了。
KVO 很強大,沒錯。理解它的內部實作,能幫你用得更好,也能在出問題時更容易除錯。但官方提供的 API 實在算不上好。
比如,你只能透過重寫 -observeValueForKeyPath:ofObject:change:context: 來接收通知。想傳自己的 selector?不行。想傳一個 block?連門都沒有。而且你還得處理父類的情況——父類可能也在觀察同一個物件的同一個屬性。有時候你根本不知道父類對這個訊息有沒有興趣。雖然 context 參數就是為此而生(呼叫 -addObserver:forKeyPath:options:context: 時傳一個父類不認識的 context 即可),但整體寫起來還是很彆扭。至少,也該支援 block 吧。
覺得官方 KVO 不好用的人不少。Mike Ash 的《Key-Value Observing Done Right》與廣受討論的《KVO Considered Harmful》都曾把它拎出來鞭一頓。因此在實際開發中,KVO 的使用場景並不多,更多時候我們還是回到 Delegate 或 NotificationCenter。
找不到理想的,就自己做一個。既然對官方 API 不滿意,又已經知道原理,那就來寫一個簡易版。
首先建立 NSObject 的 Category,在標頭檔中宣告兩個 API:
typedef void(^PGObservingBlock)(id observedObject, NSString *observedKey, id oldValue, id newValue);
@interface NSObject (KVO)
- (void)PG_addObserver:(NSObject *)observer
forKey:(NSString *)key
withBlock:(PGObservingBlock)block;
- (void)PG_removeObserver:(NSObject *)observer forKey:(NSString *)key;
@end接著實作 PG_addObserver:forKey:withBlock:,邏輯並不複雜:
檢查物件的類是否有對應的 setter,沒有就拋例外;
檢查物件 isa 指向的類是否已是 KVO 類,不是就建立一個繼承原類的子類並改指向它;
檢查該 KVO 類是否已重寫這個 setter,沒有就加上;
登記這位觀察者。
- (void)PG_addObserver:(NSObject *)observer
forKey:(NSString *)key
withBlock:(PGObservingBlock)block {
// Step 1: 類別與其所有父類都沒有實作 setter,拋例外
SEL setterSelector = NSSelectorFromString(setterForGetter(key));
Method setterMethod = class_getInstanceMethod([self class], setterSelector);
if (!setterMethod) {
// throw invalid argument exception
}
Class clazz = object_getClass(self);
NSString *clazzName = NSStringFromClass(clazz);
// Step 2: 首次加入觀察者且尚未是 KVO 類時,建立子類
if (![clazzName hasPrefix:kPGKVOClassPrefix]) {
clazz = [self makeKvoClassWithOriginalClassName:clazzName];
object_setClass(self, clazz);
}
// Step 3: 該類自身尚未實作 setter 時,補上重寫版本
if (![self hasSelector:setterSelector]) {
const char *types = method_getTypeEncoding(setterMethod);
class_addMethod(clazz, setterSelector, (IMP)kvo_setter, types);
}
// Step 4: 把觀察資訊存起來
PGObservationInfo *info = [[PGObservationInfo alloc] initWithObserver:observer Key:key block:block];
NSMutableArray *observers = objc_getAssociatedObject(self, (__bridge const void *)(kPGKVOAssociatedObservers));
if (!observers) {
observers = [NSMutableArray array];
objc_setAssociatedObject(self, (__bridge const void *)(kPGKVOAssociatedObservers),
observers, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
}
[observers addObject:info];
}接著逐步細看。
第一步:先用 setterForGetter() 把 key 的首字母大寫、前面加 set、後面加 :,得到 setKey: 這樣的 selector;再用 class_getInstanceMethod 取得對應的 Method。取不到就拋例外。
第二步:先看類名有沒有我們定義的前綴。沒有就建立新的子類,並用 object_setClass() 改寫 isa 指標。
- (Class)makeKvoClassWithOriginalClassName:(NSString *)originalClazzName {
NSString *kvoClazzName = [kPGKVOClassPrefix stringByAppendingString:originalClazzName];
Class clazz = NSClassFromString(kvoClazzName);
if (clazz) {
return clazz;
}
// 還不存在,現在建立
Class originalClazz = object_getClass(self);
Class kvoClazz = objc_allocateClassPair(originalClazz, kvoClazzName.UTF8String, 0);
// 借用原 class 方法的 signature
Method clazzMethod = class_getInstanceMethod(originalClazz, @selector(class));
const char *types = method_getTypeEncoding(clazzMethod);
class_addMethod(kvoClazz, @selector(class), (IMP)kvo_class, types);
objc_registerClassPair(kvoClazz);
return kvoClazz;
}動態建立類別靠的是 objc/runtime.h 中的 objc_allocateClassPair():傳入父類、類名與額外空間(通常為 0),它回傳一個類別。接著就能為它添加方法與變量;這裡我們只重寫了 class 方法——哈哈,跟 Apple 一樣,我們也想藏住這個子類的存在。最後 objc_registerClassPair() 告訴 Runtime 這個類已存在。
第三步:重寫 setter。新的 setter 在呼叫原 setter 之後,通知每一位觀察者(執行先前傳入的 block):
static void kvo_setter(id self, SEL _cmd, id newValue) {
NSString *setterName = NSStringFromSelector(_cmd);
NSString *getterName = getterForSetter(setterName);
if (!getterName) {
// throw invalid argument exception
}
id oldValue = [self valueForKey:getterName];
struct objc_super superclazz = {
.receiver = self,
.super_class = class_getSuperclass(object_getClass(self))
};
// 轉型,免得編譯器抱怨
void (*objc_msgSendSuperCasted)(void *, SEL, id) = (void *)objc_msgSendSuper;
// 呼叫父類的 setter,也就是原類別的實作
objc_msgSendSuperCasted(&superclazz, _cmd, newValue);
// 找出觀察者並執行 block
NSMutableArray *observers = objc_getAssociatedObject(self, (__bridge const void *)(kPGKVOAssociatedObservers));
for (PGObservationInfo *each in observers) {
if ([each.key isEqualToString:getterName]) {
dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
each.block(self, getterName, oldValue, newValue);
});
}
}
}细心的讀者會發現我們對 objc_msgSendSuper 做了型別轉換。在 Xcode 6 裡,新的 LLVM 會對 objc_msgSendSuper 與 objc_msgSend 進行嚴格型別檢查,不轉型的話會報「too many arguments」。(WWDC 2014 的《What's new in LLVM》有提到這個問題。)
最後一步:把觀察資訊存進 associated object。觀察者、被觀察的 key、傳入的 block 都封裝在 PGObservationInfo 裡:
@interface PGObservationInfo : NSObject @property (nonatomic, weak) NSObject *observer; @property (nonatomic, copy) NSString *key; @property (nonatomic, copy) PGObservingBlock block; @end
至此,一個能運作的基本 KVO 就完成了。這只是一天多做出來的小東西,肯定有 bug,也有大量可優化之處;但作為「如何用 Runtime 動態建立類別、如何實作 KVO」的示範,已經足夠。
完整範例可下載:ImplementKVO。
有任何問題或發現 bug,歡迎來信 peng@glowing.com 或私訊我的微博 @no_computer。謝謝閱讀。
參考資料
KVO Implementation/Creating Classes at Runtime in Objective-C/Key-Value Observing Done Right/By your command/Associated Objects