您现在的位置: IOS教程網 >> IOS系統 >  >> iOS 程式開發 >> iOS 開發基礎

深入談談 KVO:從用法到原理,再到自己動手實現

編輯:iOS 開發基礎

作者:鄧凱輝

本文結構如下:Why(為何用 KVO)、What(KVO 是什麼)、How(怎麼用)、More(更多細節)、原理,以及自己實現 KVO。

上一篇《淺談 iOS Notification》講了 iOS 中觀察者模式的一種實現——NSNotification,這次我們來談另一種:KVO。

Why?

假設有一個 Person 類和一個 Account 類,Account 有兩個公開屬性 balance 和 interestRate。當它們變化時,需要通知到 Person——這要求很正常,銀行賬戶的錢增減了,我當然要及時知道。有人可能想每隔一段時間輪詢一次 Account 的這兩個屬性,一旦變化就通知 Person,但這樣既低效、通知也不及時。

這時 KVO 就派上用場了。

What?

說 KVO 之前得先說 KVC。KVC(Key-Value Coding)是一種基於 NSKeyValueCoding 非正式協議的機制,讓我們能用字符串標識符直接訪問、操作類的屬性。常用方法有:

- (nullable id)valueForKey:(NSString *)key;
- (void)setValue:(nullable id)value forKey:(NSString *)key;
- (nullable id)valueForKeyPath:(NSString *)keyPath;
- (void)setValue:(nullable id)value forKeyPath:(NSString *)keyPath;

配合正確的標識符(一般與屬性同名),就能直接讀寫屬性,甚至輕易跨越多個類的層級結構直取目標屬性。

KVC 還提供集合操作,取到集合屬性的同時能求和、求平均、取最大最小值等。以下為求和,具體可查蘋果官方文檔:

NSNumber *amountSum = [self.transactions valueForKeyPath:@"@sum.amount"];

KVO:Key-Value Observing 是 Cocoa 提供的一種基於 KVC 的機制,允許一個對象監聽另一個對象的某個屬性,當該屬性改變時,系統會通知監聽者(注意:通知的是監聽者,而非被監聽者)。用上面的例子說,就是用 Person 的對象去監聽 Account 對象的屬性,Account 相應屬性改變時,Person 對象就會收到通知。這也是 iOS 中觀察者模式的一種實現。一般來說,任何一個對象都能監聽任何一個對象(也包括自己)的任意屬性,並在其變化後收到通知。

How?

KVO 的使用主要分三步:添加監聽、接收通知、移除監聽。

1. 添加監聽

- (void)addObserver:(NSObject *)observer forKeyPath:(NSString *)keyPath options:(NSKeyValueObservingOptions)options context:(nullable void *)context;

重點看四個參數:

  • observer:監聽者對象,屬性改變時會通知它。它必須實現 observeValueForKeyPath:ofObject:change:context:,否則通知發出卻無接收方,程序會拋異常。
  • keyPath:被監聽的屬性,規則同 KVC,但不能傳 nil。通常傳與屬性同名的字符串,但拼寫出錯會導致監聽失敗;推薦寫法 NSStringFromSelector(@selector(propertyName))——把 getter 轉成字符串,寫錯時 Xcode 會給警告。
  • options:配置項,指明通知時機與 change 字典包含哪些值,取值有四個,可用 | 連接:
    ① NSKeyValueObservingOptionNew:change 中包含新值;
    ② NSKeyValueObservingOptionOld:包含舊值;
    ③ NSKeyValueObservingOptionInitial:addObserver 發出後監聽者會立即收到一次通知(只發一次),可用於獲取初始值;若同時指定前三個,此通知的 change 只含新值;
    ④ NSKeyValueObservingOptionPrior:在屬性改變「前」就發一次通知,change 會帶一個 NSNumber 型的 YES;若同時指定該值、new、old,則 change 含舊值不含新值。此通知中可調用 willChangeValueForKey:。
  • context:可選參數,可傳任意數據,最終傳到響應方法裡,用於區分不同通知或傳值。若用它區分通知,推薦聲明一個保持自身地址的靜態變量:
static void *PersonAccountBalanceContext = &PersonAccountBalanceContext;
static void *PersonAccountInterestRateContext = &PersonAccountInterestRateContext;

結合 Person、Account 的例子,給 Account 對象添加監聽:

- (void)registerAsObserverForAccount:(Account *)account {
    [account addObserver:self
             forKeyPath:@"balance"
                options:(NSKeyValueObservingOptionNew | NSKeyValueObservingOptionOld)
                context:PersonAccountBalanceContext];
    [account addObserver:self
             forKeyPath:@"interestRate"
                options:(NSKeyValueObservingOptionNew | NSKeyValueObservingOptionOld)
                context:PersonAccountInterestRateContext];
}

注意:addObserver 不會對監聽者、被監聽者及 context 做強引用,你要自己保證它們在監聽期間不被釋放。

2. 接收通知

每個監聽者都必須實現:

- (void)observeValueForKeyPath:(nullable NSString *)keyPath ofObject:(nullable id)object change:(nullable NSDictionary *)change context:(nullable void *)context;

keyPath、object、context 與監聽時一致。change 是個字典,有五個常量作為鍵:

  • NSKeyValueChangeKindKey:變更類型,值為 NSKeyValueChange 枚舉(Setting=1、Insertion=2、Removal=3、Replacement=4),一般為 Setting;若監聽的是集合對象,插入/刪除/替換時分別返回對應值。
  • NSKeyValueChangeNewKey:新值;當監聽集合且 Kind 不為 Setting 時,返回一個數組,含插入、替換後的新值(刪除不返回新值)。
  • NSKeyValueChangeOldKey:舊值;此時返回數組,含刪除、替換前的舊值(插入不返回舊值)。
  • NSKeyValueChangeIndexesKey:當 Kind 為 Insertion/Removal/Replacement 時,其值是個 NSIndexSet,記錄增刪替換的 index。
  • NSKeyValueChangeNotificationIsPriorKey:若 options 指定了 Prior,change 會帶此鍵,值為 NSNumber 型的 YES。

完整的 change 字典大致如下:

NSDictionary *change = @{
    NSKeyValueChangeKindKey : @(NSKeyValueChange枚舉值),
    NSKeyValueChangeNewKey : newValue,
    NSKeyValueChangeOldKey : oldValue,
    NSKeyValueChangeIndexesKey : @[NSIndexSet, NSIndexSet],
    NSKeyValueChangeNotificationIsPriorKey : @1,
};

用上面的例子實現接收通知:

- (void)observeValueForKeyPath:(NSString *)keyPath
                      ofObject:(id)object
                        change:(NSDictionary *)change
                       context:(void *)context {
    if (context == PersonAccountBalanceContext) {
        // 處理 balance
    } else if (context == PersonAccountInterestRateContext) {
        // 處理 interestRate
    } else {
        // 無法識別的 context 交給父類
        [super observeValueForKeyPath:keyPath ofObject:object change:change context:context];
    }
}

你可以用 context 或 keyPath 區分不同通知,但要注意:遇到無法識別的 context 或 keyPath 時,需調用父類的 observeValueForKeyPath:ofObject:change:context:。

3. 移除監聽

監聽任務完成後要註銷,通常在 dealloc 或 observeValueForKeyPath 方法中調用:

- (void)removeObserver:(NSObject *)observer forKeyPath:(NSString *)keyPath context:(nullable void *)context;
// 或
- (void)removeObserver:(NSObject *)observer forKeyPath:(NSString *)keyPath;

幾點注意:向非監聽者發送 remove(或重複 remove)會拋 NSRangeException,保險起見可放進 try/catch;監聽者銷毀時不會自動註銷,給已銷毀對象發通知會造成野指針錯誤,所以至少要保證釋放前完成 remove——有 add 就要有 remove。

More

要讓某類的屬性支持 KVO,需滿足三點:屬性支持 KVC、能發出改變通知、有依賴關係時註冊合適的依賴鍵。

條件一:屬性支持 KVC。即實現對應的 getter/setter 等。所幸 NSObject 已幫我們做好,只要類最終繼承自 NSObject 並以正常方式創建屬性,這些屬性都支持 KVO。支持的類型與 KVC 一致:對象、標量(int、CGFloat)和 struct(CGRect)。

條件二:能發出改變通知。分自動與手動兩種。

自動通知由 NSObject 默認實現,一般無需額外代碼。觸發方式包括:調用 setter、調用 setValue:forKey:、setValue:forKeyPath:,以及用 mutableArrayValueForKey: 取到關系代理對象。最後這個要特別說明:若你 KVO 監聽了一個集合,直接給數組發 addObject: 是不會觸發通知的,但通過 mutableArrayValueForKey: 返回的中間代理對象做增刪替換,則會觸發 KVO——這個代理對象最終會把操作作用回原始對象。

[account setName:@"Savings"];
[account setValue:@"Savings" forKey:@"name"];
[document setValue:@"Savings" forKeyPath:@"account.name"];
NSMutableArray *transactions = [account mutableArrayValueForKey:@"transactions"];
[transactions addObject:newTransaction];

手動通知:當你想控制通知的發送(阻止不必要的通知、或把一組通知合併)時使用。先重寫類方法,指明哪個屬性不自動發通知:

+ (BOOL)automaticallyNotifiesObserversForKey:(NSString *)theKey {
    BOOL automatic = NO;
    if ([theKey isEqualToString:@"balance"]) {
        automatic = NO;
    } else {
        automatic = [super automaticallyNotifiesObserversForKey:theKey];
    }
    return automatic;
}

然後重寫該屬性的 setter,在值改變前後分別調用 willChangeValueForKey: 和 didChangeValueForKey::

- (void)setBalance:(double)theBalance {
    [self willChangeValueForKey:@"balance"];
    _balance = theBalance;
    [self didChangeValueForKey:@"balance"];
}

還可以過濾通知,比如只在值真正改變時才發:

- (void)setBalance:(double)theBalance {
    if (theBalance != _balance) {
        [self willChangeValueForKey:@"balance"];
        _balance = theBalance;
        [self didChangeValueForKey:@"balance"];
    }
}

若一次操作導致多個鍵變化,需嵌套變更通知:

- (void)setBalance:(double)theBalance {
    [self willChangeValueForKey:@"balance"];
    [self willChangeValueForKey:@"itemChanged"];
    _balance = theBalance;
    _itemChanged = _itemChanged + 1;
    [self didChangeValueForKey:@"itemChanged"];
    [self didChangeValueForKey:@"balance"];
}

在 to-many 關系操作中,還要表明變更類型與受影響的索引。下例示範 transactions 的刪除:

- (void)removeTransactionsAtIndexes:(NSIndexSet *)indexes {
    [self willChange:NSKeyValueChangeRemoval
        valuesAtIndexes:indexes forKey:@"transactions"];
    // 刪除指定索引處的 transaction
    [self didChange:NSKeyValueChangeRemoval
        valuesAtIndexes:indexes forKey:@"transactions"];
}

條件三:註冊合適的依賴鍵。有時一個屬性的改變依賴於別的屬性,比如 fullName 由 firstName 和 lastName 組成,任一變化 fullName 就變。可重寫 keyPathsForValuesAffectingValueForKey: 指明依賴:

+ (NSSet *)keyPathsForValuesAffectingValueForKey:(NSString *)key {
    NSSet *keyPaths = [super keyPathsForValuesAffectingValueForKey:key];
    if ([key isEqualToString:@"fullName"]) {
        NSArray *affectingKeys = @[@"lastName", @"firstName"];
        keyPaths = [keyPaths setByAddingObjectsFromArray:affectingKeys];
    }
    return keyPaths;
}

另一種等效寫法是實現命名為 keyPathsForValuesAffecting<Key> 的類方法:

+ (NSSet *)keyPathsForValuesAffectingFullName {
    return [NSSet setWithObjects:@"lastName", @"firstName", nil];
}

但在 to-many 關系(如數組屬性)中這招失靈。比如 Department 對 Employee 是 to-many,Employee 有 salary,你想讓 Department 有個 totalSalary 計算全員薪水,此時不能簡單返回 employees.salary。有兩種解法:

其一,用 KVO 讓 parent(Department)作為所有 child(Employee)相關屬性的觀察者,並在增刪 child 時同步增刪觀察關係,再在回調中更新依賴值:

- (void)observeValueForKeyPath:(NSString *)keyPath ofObject:(id)object change:(NSDictionary *)change context:(void *)context {
    if (context == totalSalaryContext) {
        [self updateTotalSalary];
    } else {
        // 處理其他觀察或調用 super
    }
}
- (void)updateTotalSalary {
    [self setTotalSalary:[self valueForKeyPath:@"employees.@sum.salary"]];
}
- (void)setTotalSalary:(NSNumber *)newTotalSalary {
    if (totalSalary != newTotalSalary) {
        [self willChangeValueForKey:@"totalSalary"];
        _totalSalary = newTotalSalary;
        [self didChangeValueForKey:@"totalSalary"];
    }
}

其二,改用 iOS 觀察者模式的另一種實現——通知(NSNotification),相關概念可參考上一篇《淺談 iOS Notification》。

原理

說了這麼多,KVO 的原理究竟是什麼?先看官方文檔:自動 key-value observing 是通過一種叫 isa-swizzling 的技術實現的——當為某對象的屬性註冊觀察者時,該對象的 isa 指針會被修改,指向一個中間類而非真實類,因此 isa 的值不一定反映實例的真實類型。

官方着墨不多,只透露用了 isa-swizzling 這門「黑魔法」。實際上,當某類的對象第一次被觀察時,系統會在運行期動態創建該類的一個派生類(類名在原類名前加 NSKVONotifying_ 前綴),並在派生類中重寫被觀察屬性的 setter。派生類在被重寫的 setter 裡實現真正的通知機制——調用 willChangeValueForKey: 和 didChangeValueForKey:,原理與前面手動實現一致。之所以能這樣做,是因為設置屬性會調用 setter,重寫後就得到了 KVO 所需的通知機制;但前提是必須通過遵循 KVO 的設置方式來改值,若直接改成員變量則無法觸發。

同時派生類還重寫了 class 方法以「偽裝」成原類,系統再把該對象的 isa 指針指向這個新派生類,於是對象就成了派生類的實例,對 setter 的調用自然走到重寫版本,從而激活鍵值通知。此外派生類還重寫了 dealloc 來釋放資源。

自己實現 KVO

說實話,原生 KVO 的 API 不太友好:監聽者與被監聽者要分別實現一些東西,代碼分散;響應通知只能在蘋果指定的方法裡處理,用不了我們熟悉的 block 或 Target-Action;最後還不能忘了 removeObserver,一忘就崩潰。

搞懂了用法與原理後,我們其實可以自己實現一個更便捷、API 更友好的 KVO。這類實現網上很多,GitHub 上也有開源版本,感興趣的讀者可以自行查閱。基本思路與蘋果官方一致:創建原類的派生類作中間類,把原對象指向它,重寫被觀察屬性的 setter,在屬性改變後調用回調通知監聽者。

參考:KVO 官方文檔、KVC 官方文檔、《Objective-C 中的 KVC 和 KVO》、《詳解鍵值觀察(KVO)及其實現機理》。

  1. 上一篇文章:
  2. 下一篇文章:
蘋果刷機越獄教程| IOS教程問題解答| IOS技巧綜合| IOS7技巧| IOS8教程
Copyright © IOS教程網 All Rights Reserved