Observing?KVO?Key-Value基本使用原理示例詳解

更新時間：2022年08月08日 14:52:55 作者：小橘爺

這篇文章主要為大家介紹了Observing?KVO?Key-Value基本使用原理示例詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪

正文

Key-Value Observing(KVO) 是一種機制，它允許對象在其他對象的指定屬性發(fā)生更改時得到通知。要使用 KVO，首先你必須確保被觀察對象是 KVO 兼容的。通常，如果你的對象繼承自 NSObject 并且你以通常的方式創(chuàng)建屬性，那么你的對象及其屬性將自動兼容 KVO。

KVO 的主要好處是你不必實現(xiàn)自己的方案來在每次屬性更改時發(fā)送通知，其定義良好的基礎(chǔ)架構(gòu)具有框架級別的支持。

KVO 的基本使用

你必須執(zhí)行以下步驟以使對象能夠接收 KVO 兼容屬性的 KVO 通知：

使用方法 addObserver:forKeyPath:options:context: 將觀察者注冊到被觀察對象。
在觀察者內(nèi)部實現(xiàn) observeValueForKeyPath:ofObject:change:context: 以接受更改通知消息。
使用 removeObserver:forKeyPath: 方法取消注冊觀察者，當它不再應(yīng)該接收消息時。至少，在觀察者從內(nèi)存中釋放之前調(diào)用此方法。

注冊為觀察者

被觀察對象首先通過發(fā)送 addObserver:forKeyPath:options:context: 消息將觀察者注冊到被觀察對象，并將觀察者和要觀察的屬性的 keyPath 傳遞。觀察者還指定了一個選項參數(shù)和一個上下文指針來管理通知的各個方面。

Options

options 參數(shù)為常量選項的按位或，它會影響通知中提供的 change 字典的內(nèi)容以及生成通知的方式。可選的值有如下四個：

typedef NS_OPTIONS(NSUInteger, NSKeyValueObservingOptions) {
    NSKeyValueObservingOptionNew = 0x01, // 新值
    NSKeyValueObservingOptionOld = 0x02, // 舊值
    // 屬性的初始值
    NSKeyValueObservingOptionInitial API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0)) = 0x04,
    // 在變化前發(fā)送通知
    // change 字典通過包含鍵 NSKeyValueChangeNotificationIsPriorKey 和 NSNumber 包裝 YES 的值來表示更改前通知。
    NSKeyValueObservingOptionPrior API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0)) = 0x08
};

Context

addObserver:forKeyPath:options:context: 消息中的 context 指針包含任意數(shù)據(jù)，這些數(shù)據(jù)將在相應(yīng)的更改通知中傳遞回觀察者。你可以指定 NULL 并完全依賴 keyPath 字符串來確定更改通知的來源，但這種方法可能會導致父類出于不同原因也觀察相同 keyPath 的對象出現(xiàn)問題。

一種更安全、更可擴展的方法是使用上下文來確保你收到的通知是發(fā)給你的觀察者而不是父類的。

類中唯一命名的靜態(tài)變量的地址是一個很好的上下文。在父類或子類中以類似方式選擇的上下文不太可能重疊。你可以為整個類選擇一個上下文，并依靠通知消息中的 keyPath 字符串來確定發(fā)生了什么變化?；蛘撸憧梢詾槊總€觀察到的 keyPath 創(chuàng)建一個不同的上下文，這完全繞過了字符串比較的需要，從而提高了通知解析的效率。

static void *PersonAccountBalanceContext = &PersonAccountBalanceContext;
static void *PersonAccountInterestRateContext = &PersonAccountInterestRateContext;
- (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:forKeyPath:options:context: 方法不維護對觀察對象、被觀察對象或 context 的強引用。你應(yīng)該確保根據(jù)需要維護對觀察對象和觀察對象以及 context 的強引用。

接收變更通知

當對象的被觀察屬性的值發(fā)生變化時，觀察者會收到一個 observeValueForKeyPath:ofObject:change:context: 消息。所有的觀察者都必須實現(xiàn)這個方法。

被觀察對象提供觸發(fā)通知的 keyPath、被觀察對象、包含有關(guān)更改的詳細信息的字典以及在為該 keyPath 注冊觀察者時提供的上下文指針。

change 字典的 NSKeyValueChangeKindKey 提供有關(guān)發(fā)生的更改類型的信息：

如果被觀察對象的值發(fā)生了變化，則 NSKeyValueChangeKindKey 對應(yīng)的值為 NSKeyValueChangeSetting。根據(jù)觀察者注冊時指定的選項，change 字典中的 NSKeyValueChangeOldKey 和 NSKeyValueChangeNewKey 條目包含更改之前和之后的屬性值。如果屬性是對象，則直接提供值。如果屬性是基本數(shù)據(jù)類型或 C 結(jié)構(gòu)，則將值包裝在 NSValue 對象中。
如果觀察到的屬性是一對多關(guān)系，則 NSKeyValueChangeKindKey 條目還通過分別返回 NSKeyValueChangeInsertion、NSKeyValueChangeRemoval 或 NSKeyValueChangeReplacement 指示關(guān)系中的對象是否被插入、刪除或替換。
change 字典的 NSKeyValueChangeIndexesKey 條目是一個 NSIndexSet 對象，用于指定更改的關(guān)系中的索引。如果在注冊觀察者時將 NSKeyValueObservingOptionNew 或 NSKeyValueObservingOptionOld 指定為選項，則 change 字典中的 NSKeyValueChangeOldKey 和 NSKeyValueChangeNewKey 條目是包含更改前后相關(guān)對象值的數(shù)組。

- (void)observeValueForKeyPath:(NSString *)keyPath
                      ofObject:(id)object
                        change:(NSDictionary *)change
                       context:(void *)context {
    if (context == PersonAccountBalanceContext) {
        // Do something with the balance…
    } else if (context == PersonAccountInterestRateContext) {
        // Do something with the interest rate…
    } else {
        // Any unrecognized context must belong to super
        [super observeValueForKeyPath:keyPath
                             ofObject:object
                               change:change
                               context:context];
    }
}

如果你在注冊觀察者時指定了 NULL 上下文，則將通知的 keyPath 與你正在觀察的 keyPath 進行比較以確定發(fā)生了什么變化。如果你對所有觀察到的 keyPath 使用單個上下文，則首先根據(jù)通知的 context 對其進行測試，并找到匹配項，然后使用 keyPath 字符串比較來確定具體發(fā)生了什么變化。如果你為每個 keyPath 提供了唯一的 context，如上述代碼所示，一系列簡單的指針比較會同時告訴你通知是否針對此觀察者，如果是，則哪些 keyPath 已更改。

在任何情況下，觀察者應(yīng)該總是調(diào)用父類的 observeValueForKeyPath:ofObject:change:context: 實現(xiàn)，當它不能識別 context（或者在簡單的情況下，任何 keyPath），因為這意味著一個父類已經(jīng)注冊了相關(guān)通知。

移除觀察者

你可以通過向被觀察對象發(fā)送 removeObserver:forKeyPath:context: 消息來移除觀察者，并指定觀察者、keyPath 和 context。

- (void)unregisterAsObserverForAccount:(Account*)account {
    [account removeObserver:self
                 forKeyPath:@"balance"
                    context:PersonAccountBalanceContext];
    [account removeObserver:self
                 forKeyPath:@"interestRate"
                    context:PersonAccountInterestRateContext];
}

移除觀察者時，請記住以下幾點：

如果尚未注冊為觀察者，則要求將其作為觀察者移除會導致 NSRangeException。你可以只調(diào)用一次 removeObserver:forKeyPath:context: 來對應(yīng)調(diào)用 addObserver:forKeyPath:options:context:，或者如果這在你的應(yīng)用程序中不可行，請將 removeObserver:forKeyPath:context: 調(diào)用放在 try/catch 塊中處理潛在的異常。
觀察者在釋放時不會自動移除自己。被觀察對象繼續(xù)發(fā)送通知，而忽略了觀察者的狀態(tài)。但是，與任何其他消息一樣，發(fā)送到已釋放對象的更改通知會觸發(fā)內(nèi)存訪問異常。因此，你要確保觀察者在從內(nèi)存中消失之前將自己移除。
該協(xié)議無法詢問對象是觀察者還是被觀察者。構(gòu)建你的代碼以避免發(fā)生相關(guān)的錯誤。一個典型的模式是在觀察者初始化期間注冊為觀察者（例如在 init 或 viewDidLoad 中）并在釋放期間取消注冊（通常在 dealloc 中），確保正確配對和有序的添加和刪除消息，并且觀察者在它被內(nèi)存釋放之前取消注冊觀察。

KVO 的觸發(fā)方式

KVO 觸發(fā)的方式有兩種：

自動觸發(fā)：NSObject 提供了自動觸發(fā) KVO 的基本實現(xiàn)。
手動觸發(fā)：由開發(fā)者自行控制哪些屬性會觸發(fā) KVO

自動觸發(fā)

// 使用訪問器方法
[account setName:@"Savings"];
// 使用 setValue:forKey:.
[account setValue:@"Savings" forKey:@"name"];
// 使用 setValue:forKeyPath:
[document setValue:@"Savings" forKeyPath:@"account.name"];
// 使用 mutableArrayValueForKey: 檢索關(guān)系代理對象。
Transaction *newTransaction = <#Create a new transaction for the account#>;
NSMutableArray *transactions = [account mutableArrayValueForKey:@"transactions"];
[transactions addObject:newTransaction];

手動觸發(fā)

在某些情況下，你可能希望控制通知過程，例如，盡量減少因應(yīng)用程序特定原因而不必要的觸發(fā)通知，或?qū)⒍鄠€更改組合到單個通知中。手動觸發(fā)通知提供了執(zhí)行此操作的方法。

手動和自動通知并不相互排斥。除了已經(jīng)存在的自動通知之外，你還可以自由發(fā)布手動通知。更典型的是，你可能希望完全控制特定屬性的通知。

在這種情況下，你覆蓋了 automaticNotifiesObserversForKey: 的 NSObject 實現(xiàn)。對于要排除其自動通知的屬性，automaticNotifiesObserversForKey: 的子類實現(xiàn)應(yīng)該返回 NO。子類實現(xiàn)應(yīng)該為任何無法識別的鍵調(diào)用 super。

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

要實現(xiàn)手動觸發(fā)觀察者通知，你在更改值之前調(diào)用 willChangeValueForKey:，并在更改值之后調(diào)用 didChangeValueForKey:。

- (void)setBalance:(double)theBalance {
    [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"];
}

在有序一對多關(guān)系的情況下，你不僅必須指定更改的鍵，還必須指定更改的類型和所涉及對象的索引。更改的類型是指定 NSKeyValueChangeInsertion、NSKeyValueChangeRemoval 或 NSKeyValueChangeReplacement 的 NSKeyValueChange。受影響對象的索引作為 NSIndexSet 對象傳遞。

- (void)removeTransactionsAtIndexes:(NSIndexSet *)indexes {
    [self willChange:NSKeyValueChangeRemoval
        valuesAtIndexes:indexes forKey:@"transactions"];
    // Remove the transaction objects at the specified indexes.
    [self didChange:NSKeyValueChangeRemoval
        valuesAtIndexes:indexes forKey:@"transactions"];
}

注冊依賴鍵

在很多情況下，一個屬性的值取決于另一個對象中的一個或多個其他屬性的值。如果一個屬性的值發(fā)生變化，那么派生屬性的值也應(yīng)該被標記為變化。如何確保為這些依賴屬性發(fā)布 KVO 通知取決于關(guān)系的基數(shù)。

一對一的關(guān)系

要為一對一關(guān)系自動觸發(fā)通知，你應(yīng)該覆蓋 keyPathsForValuesAffectingValueForKey: 或?qū)崿F(xiàn)一個合適的方法，該方法遵循它為注冊相關(guān)鍵定義的模式。

例如，一個人的全名取決于名字和姓氏。返回全名的方法可以寫成如下：

- (NSString *)fullName {
    return [NSString stringWithFormat:@"%@ %@",firstName, lastName];
}

當 firstName 或 lastName 屬性發(fā)生更改時，必須通知觀察 fullName 屬性的應(yīng)用程序，因為它們會影響屬性的值。

一種解決方案是覆蓋 keyPathsForValuesAffectingValueForKey: 指定一個人的 fullName 屬性依賴于 lastName 和 firstName 屬性。

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

你的方法覆寫通常應(yīng)該調(diào)用 super 并返回一個集合，該集合包括該集合中的任何成員（以免干擾父類中此方法的覆蓋）。

你還可以通過實現(xiàn)遵循命名約定 keyPathsForValuesAffecting<Key> 的類方法來實現(xiàn)相同的結(jié)果，其中 <Key> 是依賴于值的屬性的名稱（首字母大寫）。使用這種模式，上述代碼可以重寫為名為 keyPathsForValuesAffectingFullName 的類方法：

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

當你使用 category 將計算屬性添加到現(xiàn)有類時，你不能覆蓋 keyPathsForValuesAffectingValueForKey: 方法，因為你不應(yīng)該覆蓋類中的方法。在這種情況下，實現(xiàn)一個匹配的 keyPathsForValuesAffecting<Key> 類方法來利用這個機制。

KVO 實現(xiàn)細節(jié)

讓我們來首先實現(xiàn)一個簡單的使用了 KVO 的 demo:

@interface Person : NSObject
@property (nonatomic, assign) NSUInteger age;
@end
@implementation Person
@end
@implementation ViewController
- (void)viewDidLoad {
    [super viewDidLoad];
    // Do any additional setup after loading the view.
    self.person = [Person new];
    // 添加監(jiān)聽
    [self.person addObserver:self 
                  forKeyPath:@"age" 
                     options:NSKeyValueObservingOptionNew | NSKeyValueObservingOptionOld 
                     context:nil];
}
- (void)touchesBegan:(NSSet<UITouch *> *)touches withEvent:(UIEvent *)event {
    // 改變對象屬性值
    self.person.age = 18;
}
- (void)dealloc {
    // 移除監(jiān)聽
    [self.person removeObserver:self forKeyPath:@"age"];
}
- (void)observeValueForKeyPath:(NSString *)keyPath ofObject:(id)object change:(NSDictionary<NSKeyValueChangeKey,id> *)change context:(void *)context {
    // 被監(jiān)聽的屬性值改變后的回調(diào)
    NSLog(@"%@", change);
}
@end

在 addObserver:forKeyPath:options:context: 一行打上斷點，會發(fā)現(xiàn)在添加觀察者的前后，person 對象的 isa 指針的指向發(fā)生了變化。

添加觀察者前：

添加觀察者后：

尤其可知，KVO 是通過 runtime 動態(tài)生成 NSKVONotify_Person 類的方式，并將 person 對象的 isa 指針指向了新類，來為我們實現(xiàn) KVO 的，這套技術(shù)稱之為 isa-swizzling。其中，NSKVONotify_Person 類是 Person 類的子類，NSKVONotify_Person 還重寫了 class 方法，用于在我們進行內(nèi)省時，得到的是當前類的準確類。