原文鏈接
瞭解 KVO/KVC
KVO/KVC 是觀察者模式在 Objective-C 中的實現,以非正式協議(Category)的形式被定義在 NSObject 中。從協議的角度看,是定義了一套讓開發者遵守的規範和使用的方法。在 Cocoa 的 MVC 框架中,架起 ViewController 和 Model 溝通的橋樑。
// "NSKeyValueObserving.h"
@interface NSObject(NSKeyValueObserving)
// "NSKeyValueCoding.h"
@interface NSObject(NSKeyValueCoding)
KVO 即 Key-Value-Observing,顧名思義用於觀察鍵值
//通過此方法即可添加對象的觀察者
- (void)addObserver:(NSObject *)observer
forKeyPath:(NSString *)keyPath
options:(NSKeyValueObservingOptions)options
context:(void *)context;
KVC 即 Key-Value-Coding,用於鍵值編碼
- (id)valueForKey:(NSString *)key;
- (void)setValue:(id)value forKey:(NSString *)key;
- (id)valueForKeyPath:(NSString *)keyPath;
- (void)setValue:(id)value forKeyPath:(NSString *)keyPath;
如何使用 KVO/KVC
簡單使用
爲了讓各位童鞋更好的理解,下面主要使用例子講解 KVO/KVC 的使用
先定義一個 Persson
類,當做被觀察的對象
//Person.h
#import <Foundation/Foundation.h>
@interface Person : NSObject
@end
// Person.m
#import "Person.h"
@interface Person () {
NSString *address; //地址
CGFloat weight; //體重
}
@property (nonatomic, copy) NSString *name; //名字
@property (nonatomic, assign) NSInteger age; //年齡
@end
@implementation Person
@end
再定義一個 PersonObserver
類,用於觀察 Person
//PersonObserver.h
#import <Foundation/Foundation.h>
@interface PersonObserver : NSObject
@end
//PersonObserver.m
#import "PersonObserver.h"
@implementation PersonObserver
//觀察者需要實現的方法
- (void)observeValueForKeyPath:(NSString *)keyPath ofObject:(id)object change:(NSDictionary *)change context:(void *)context
{
NSLog(@"old: %@", [change objectForKey:NSKeyValueChangeOldKey]);
NSLog(@"old: %@", [change objectForKey:NSKeyValueChangeNewKey]);
NSLog(@"context: %@", context);
}
@end
觀察者和被觀察者準備就緒,即可進行測試
// 測試 KVO & KVC
- (void)testMethod
{
Person *aPerson = [[Person alloc] init];
PersonObserver *aPersonObserver = [[PersonObserver alloc] init];
//添加觀察者
//也可以觀察 age、address、weight
[aPerson addObserver:aPersonObserver
forKeyPath:@"name"
options:(NSKeyValueObservingOptionNew|NSKeyValueObservingOptionOld)
context:@"this is a context"];
//設置key的value值,aPersonObserver接收到通知
[aPerson setValue:@"LiLei" forKey:@"name"];
NSLog(@"name: %@", [aPerson valueForKey:@"name"]);
//移除觀察者
[aPerson removeObserver:aPersonObserver forKeyPath:@"name"];
}
當代碼執行到第16行時,aPersonObserver
接收到通知,打印 change
和 context
值。整個代碼的執行結果如下:
2015-01-30 01:26:41.997 HelloWorld[4132:1588732] old: <null>
2015-01-30 01:26:41.997 HelloWorld[4132:1588732] new: LiLei
2015-01-30 01:26:41.997 HelloWorld[4132:1588732] context: this is a context
2015-01-30 01:26:41.997 HelloWorld[4132:1588732] name: LiLei
如果 Person
類裏面還有個 Job
的屬性
@property (nonautomic, strong) Job *aJob; //工作
#import <Foundation/Foundation.h>
@interface Job : NSObject
@property (nonautomic, copy) NSString *companyName; //公司名字
@property (nonautomic, assign) CGFloat salary; //薪水
@end
要觀察和設置 Person
的薪水,只要這麼寫就可以
// 觀察 salary
[aPerson addObserver:aPersonObserver
forKeyPath:@"aJob.salary"
options:(NSKeyValueObservingOptionNew | NSKeyValueObservingOptionOld)
context:@"this is a context"];
//設置月薪:20k
[aPerson setValue:@"20000.0" forKey:@"aJob.salary"];
操作集合
如果 Person
需要車,就添加 cars
屬性,於是就有了很多車
@property (nonautomic, copy) NSArray *cars; //很多車
對 NSArray *cars
這種有序集合屬性的操作有兩種方法
- 使用
valueForKey
將cars
直接取出來,再對集合元素進行操作 - 通過下面的方法直接操作;
/**
* 有序集合的操作
* 將所有方法 <Key> 替換成 Cars,且首字母大寫
*/
//必須實現,對應於NSArray的基本方法count:
-countOf<Key>
//這兩個必須實現一個,對應於 NSArray 的方法 objectAtIndex: 和 objectsAtIndexes:
-objectIn<Key>AtIndex:
-<Key>AtIndexes:
//不是必須實現的,但實現後可以提高性能,其對應於 NSArray 方法 getObjects:range:
-get<Key>:range:
//兩個必須實現一個,類似 NSMutableArray 的方法 insertObject:atIndex: 和 insertObjects:atIndexes:
-insertObject:in<Key>AtIndex:
-insert<Key>:atIndexes:
//兩個必須實現一個,類似於 NSMutableArray 的方法 removeObjectAtIndex: 和 removeObjectsAtIndexes:
-removeObjectFrom<Key>AtIndex:
-remove<Key>AtIndexes:
//可選的,如果在此類操作上有性能問題,就需要考慮實現之
-replaceObjectIn<Key>AtIndex:withObject:
-replace<Key>AtIndexes:with<Key>:
相對應的,像 NSSet 這種無序集合同樣也有如下的方法可以使用
/**
* 無序集合的操作
* 將所有方法 <Key> 替換成 Cars,且首字母大寫
*/
//必須實現,對應於NSArray的基本方法count:
-countOf<Key>
//這兩個必須實現一個,對應於 NSArray 的方法 objectAtIndex: 和 objectsAtIndexes:
-objectIn<Key>AtIndex:
-<key>AtIndexes:
//不是必須實現的,但實現後可以提高性能,其對應於 NSArray 方法 getObjects:range:
-get<Key>:range:
//兩個必須實現一個,類似 NSMutableArray 的方法 insertObject:atIndex: 和 insertObjects:atIndexes:
-insertObject:in<Key>AtIndex:
-insert<Key>:atIndexes:
//兩個必須實現一個,類似於 NSMutableArray 的方法 removeObjectAtIndex: 和 removeObjectsAtIndexes:
-removeObjectFrom<Key>AtIndex:
-remove<Key>AtIndexes:
//這兩個都是可選的,如果在此類操作上有性能問題,就需要考慮實現之
-replaceObjectIn<Key>AtIndex:withObject:
-replace<Key>AtIndexes:with<Key>:
但是,如果要使用這些方法,開發者需自己實現一遍,所以使用上相對麻煩。
鍵值驗證(KVV,Key-Value Validate)
KVC 提供了鍵值驗證(KVV)機制,讓開發者有機會能夠挽回錯誤,保證數據的一致性。開發者需先調用下面
- (BOOL)validateValue:(inout id *)ioValue forKey:(NSString *)inKey error:(out NSError **)outError;
這個方法會默認調用的實現方法如下
- (BOOL)validate<Key>:error:
舉個例子,上面的例子中,希望能夠驗證 Person
的屬性 name
不爲空,就可以這麼寫
// 測試 KVV
- (void)testMethod
{
Person *aPerson = [[Person alloc] init];
PersonObserver *aPersonObserver = [[PersonObserver alloc] init];
//添加觀察者
[aPerson addObserver:aPersonObserver
forKeyPath:@"name"
options:(NSKeyValueObservingOptionNew|NSKeyValueObservingOptionOld)
context:@"this is a context"];
NSString *name = @"LiLei";
NSString *key = @"name";
NSError *error = nil;
// KVV 驗證
BOOL isLegalName = [aPerson validateValue:&name forKey:key error:&error];
if (isLegalName) {
NSLog(@"it's a legal name.");
[aPerson setValue:name forKey:key];
}else{
NSLog(@"the name is illegal.");
}
//移除觀察者
[aPerson removeObserver:aPersonObserver forKeyPath:@"name"];
}
//Person.m
//Person.m 文件新增驗證名字的KVV方法
@implementation Person
- (BOOL)validateName:(NSString **)name error:(NSError * __autoreleasing *)outError
{
if ((*name).length == 0)
{
(*name) = @"default name";
return NO;
}
return YES;
}
@end
集合操作符(Collection Operator)
集合運算符是一種特殊的 key path,通過 - (id)valueForKeyPath:(NSString *)keyPath
方法獲取集合中的信息,其格式如下:
由數值組成的集合,總共有 5 中操作符
- sum:集合中所有數值的和
- avg:集合中所有數值的平均數
- max:集合中的最大數值
- min:集合中的最小數值
- count:集合元素的數量
使用示例
//假設在 Person 類中還有個存儲數值的數組 array
//獲取array 中的所有數值的和
CGFloat sum = [aPerson valueForKeyPath:@"@sum.array"];
//獲取 array 中所有數值的平均數
CGFloat avg = [aPerson valueForKeyPath:@"@avg.array"];
由對象組成的集合有 2 種操作符
- unionOfObjects:返回集合中的所有元素
- distinctUnionOfObjects:返回集合去重後的所有元素
由數組組成的集合(集合中有集合)有如下 3 種操作符。
- unionOfArrays:用於Array集合,返回集合中的所有元素
- distinctUnionOfArrays:用於Array集合,返回集合中去重後的所有元素
- distinctUnionOfSets:用於Set集合,返回集合中(去重後)的所有元素
由於 Set 中的元素本身就是不重複的,所以沒有 unionOfSets 操作符。
手動鍵值觀察
通過自動屬性,建立鍵值觀察,都屬於自動鍵值觀察。因爲使用這種方法,只要設置鍵值,就會自動發出通知。而手動鍵值觀察,不能使用自動化屬性,需要自己寫 setter/getter 方法,手動發送通知。
//手動通知的實現
@interface Person : NSObject
{
NSString *name;
}
- (NSString *)name;
- (void)setName:(int)theName;
@end
@implementation Person
- (id) init
{
self = [super init];
if (nil != self) {
name = @"LiLei";
}
return self;
}
- (NSString *)name
{
return name;
}
- (void)setName:(NSString *)theName
{
//發送通知:鍵值即將改變
[self willChangeValueForKey:@"name"];
name = theName;
//發送通知:鍵值已經修改
[self didChangeValueForKey:@"name"];
}
/**
* 當設置鍵值之後,通過此方法,決定是否發送通知
*/
+ (BOOL) automaticallyNotifiesObserversForKey:(NSString *)key
{
//當 key 爲 name時,手動發送通知
if ([key isEqualToString:@"age"]) {
return NO;
}
//當爲其他key時,自動發送通知
return [super automaticallyNotifiesObserversForKey:key];
}
@end
設置屬性之間的依賴
假如有個 Person
類,類裏有三個屬性,fullName
、firstName
、lastName
。按照之前的知識,如果需要觀察名字的變化,就要分別添加 fullName
、firstName
、lastName
三次觀察,非常麻煩。如果能夠只觀察 fullName
,並建立 fullName
和 firstName
、lastName
的某種依賴關係,當發生變化時,也受到通知,那該多好啊!
KVC 剛好提供這種鍵之間的依賴方法,格式如下
+ (NSSet *)keyPathsForValuesAffecting<Key>;
這方法使得 Key 之間能夠建立依賴關係,爲了便於說明,直接用 屬性依賴 這個詞代替 Key 之間的依賴。含義不同,結果一致。
下面就使用這種方法解決 Key 之間的依賴關係。
Person
類爲被觀察者
//Person.h
#import <Foundation/Foundation.h>
@interface Person : NSObject
@end
//Person.m
#import "Person.h"
@interface Person ()
@property (nonatomic, copy) NSString *fullName; //名字,依賴於firstName、lastName
@property (nonatomic, copy) NSString *firstName;
@property (nonatomic, copy) NSString *lastName;
@end
@implementation Person
//設置屬性依賴:fullName屬性依賴於firstName、lastName
//如果觀察name,當firstName、lastName發生變化時,觀察者也會收到name變化通知
+ (NSSet *)keyPathsForValuesAffectingFullName
{
NSSet *set = [NSSet setWithObjects:@"firstName", @"lastName", nil];
return set;
}
@end
PersonObserver
類爲觀察者
//PersonObserver.h
#import <Foundation/Foundation.h>
@interface PersonObserver : NSObject
@end
//PersonObserver.m
#import "PersonObserver.h"
@implementation PersonObserver
//觀察者需要實現的方法
- (void)observeValueForKeyPath:(NSString *)keyPath ofObject:(id)object change:(NSDictionary *)change context:(void *)context
{
NSLog(@"observer receive change infomation");
}
@end
準備就緒,就可以測試依賴的屬性了
- (void)testMethod
{
Person *aPerson = [[Person alloc] init];
PersonObserver *aPersonObserver = [[PersonObserver alloc] init];
//觀察fullName屬性
[aPerson addObserver:aPersonObserver
forKeyPath:@"fullName"
options:(NSKeyValueObservingOptionNew|NSKeyValueObservingOptionOld)
context:@"this is a context"];
//設置firstName時,aPersonObserver仍然會收到name變化的通知
[aPerson setValue:@"LiLei" forKey:@"firstName"];
//移除觀察者
[aPerson removeObserver:aPersonObserver forKeyPath:@"fullName"];
}
輸出結果,發現雖然觀察的是 fullName
,但是當修改 firstName
的時候,觀察者也會收到 fullName
變化的通知,達到了我們的期望。
2015-01-30 06:32:20.527 HelloWorld[28005:130136] observer receive change infomation
理解 KVO/KVC 的實現
KVO 是通過 isa-swizzling 實現的。
基本的流程就是編譯器自動爲被觀察對象創造一個派生類,並將被觀察對象的isa 指向這個派生類。如果用戶註冊了對某此目標對象的某一個屬性的觀察,那麼此派生類會重寫這個方法,並在其中添加進行通知的代碼。Objective-C 在發送消息的時候,會通過 isa 指針找到當前對象所屬的類對象。而類對象中保存着當前對象的實例方法,因此在向此對象發送消息時候,實際上是發送到了派生類對象的方法。由於編譯器對派生類的方法進行了 override,並添加了通知代碼,因此會向註冊的對象發送通知。注意派生類只重寫註冊了觀察者的屬性方法。