協(xié)議定義
KVC全稱是Key Value Coding,定義在NSKeyValueCoding.h文件中,是一個非正式協(xié)議。KVC提供了一種間接訪問其屬性方法或成員變量的機制,可以通過字符串來訪問對應的屬性方法或成員變量。

在NSKeyValueCoding中提供了KVC通用的訪問方法,分別是getter方法valueForKey:和setter方法setValue:forKey:,以及其衍生的keyPath方法,這兩個方法各個類通用的。并且由KVC提供默認的實現,我們也可以自己重寫對應的方法來改變實現。
基礎操作
KVC主要對三種類型進行操作,基礎數據類型及常量、對象類型、集合類型。
@interface BankAccount : NSObject
@property (nonatomic, strong) NSNumber *currentBalance;
@property (nonatomic, strong) Person *owner;
@property (nonatomic, strong) NSArray<Transaction *> *transactions;
@end
在使用KVC時,直接將屬性名當做key,并設置value,即可對屬性進行賦值。
[myAccount setValue:@(100.0) forKey:@"currentBalance"];
keyPath
除了對當前對象的屬性進行賦值外,還可以對其更“深層”的對象進行賦值。例如對當前對象的address屬性的street屬性進行賦值。KVC進行多級訪問時,直接類似于屬性調用一樣用點語法進行訪問即可。
[myAccount setValue:@"中關村大街" forKeyPath:@"address.street"];
通過keyPath對數組進行取值時,并且數組中存儲的對象類型都相同,可以通過valueForKeyPath:方法指定取出數組中所有對象的某個字段。例如下面例子中,通過valueForKeyPath:將數組中所有對象的name屬性值取出,并放入一個數組中返回。
NSArray *names = [array valueForKeyPath:@"name"];
多值操作
需要注意的是,雖然看到dictionary的字樣,下面兩個方法并不是字典的方法。
KVC還有更強大的功能,可以根據給定的一組key,獲取到一組value,并且以字典的形式返回,獲取到字典后可以通過key從字典中獲取到value。
- (NSDictionary<NSString *, id> *)dictionaryWithValuesForKeys:(NSArray<NSString *> *)keys;
同樣,也可以通過KVC進行批量賦值。在對象調用setValuesForKeysWithDictionary:方法時,可以傳入一個包含key、value的字典進去,KVC可以將所有數據按照屬性名和字典的key進行匹配,并將value給User對象的屬性賦值。
- (void)setValuesForKeysWithDictionary:(NSDictionary<NSString *, id> *)keyedValues;
實用技巧
在項目中經常會遇到字典轉模型的情況,如果在自定義的init方法里逐個賦值,這樣每次數據發(fā)生改變還需要改賦值語句。然而通過KVC為我們提供的賦值API,可以對數據進行批量賦值。假設有以下JSON數據并定義User類,在外界通過setValuesForKeysWithDictionary:方法對User進行賦值。
JSON數據:
{
"username": "lxz",
"age": 25,
"id": 100
}
@interface User : NSObject
@property (nonatomic, copy) NSString *name;
@property (nonatomic, assign) NSString age;
@property (nonatomic, assign) NSInteger userId;
@end
@implementation User
- (void)setValue:(id)value forUndefinedKey:(NSString *)key {
if ([key isEqualToString:@"id"]) {
self.userId = [value integerValue];
}
}
@end
賦值時會遇到一些問題,例如服務器會返回一個id字段,但是對于客戶端來說id是系統(tǒng)保留字段,可以重寫setValue:forUndefinedKey:方法并在內部處理id參數的賦值。
轉換時需要服務器數據和類定義匹配,字段數量和字段名都應該匹配。如果User比服務器數據多,則服務器沒傳的字段為空。如果服務端傳遞的數據User中沒有定義,則會導致崩潰。
在KVC進行屬性賦值時,內部會對基礎數據類型做處理,不需要手動做NSNumber的轉換。需要注意的是,NSArray和NSDictionary等集合對象,value都不能是nil,否則會導致Crash。
異常信息
當根據KVC搜索規(guī)則,沒有搜索到對應的key或者keyPath,則會調用對應的異常方法。異常方法的默認實現,在異常發(fā)生時會拋出一個NSUndefinedKeyException的異常,并且應用程序Crash。
我們可以重寫下面兩個方法,根據業(yè)務需求合理的處理KVC導致的異常。
- (nullable id)valueForUndefinedKey:(NSString *)key;
- (void)setValue:(nullable id)value forUndefinedKey:(NSString *)key;
異常處理
當通過KVC給某個非對象的屬性賦值為nil時,此時KVC會調用屬性所屬對象的setNilValueForKey:方法,并拋出NSInvalidArgumentException的異常,并使應用程序Crash。
我們可以通過重寫下面方法,在發(fā)生這種異常時進行處理。例如給name賦值為nil的時候,就可以重寫setNilValueForKey:方法并表示name是空的。
- (void)setNilValueForKey:(NSString *)key {
if ([key isEqualToString:@"name"]) {
[self setValue:@"" forKey:@”age”];
} else {
[super setNilValueForKey:key];
}
}
集合屬性操作
根據KVO的實現原理,是在運行時生成新的子類并重寫其setter方法,在其內容發(fā)生改變時發(fā)送消息。但這只是對屬性直接進行賦值會觸發(fā),如果屬性是容器對象,對容器對象進行add或remove操作,則不會調用KVO的方法。可以通過KVC對應的API來配合使用,使容器對象內部發(fā)生改變時也能觸發(fā)KVO。
在進行容器對象操作時,先調用下面方法通過key或者keyPath獲取集合對象,然后再對容器對象進行add或remove等操作時,就會觸發(fā)KVO的消息通知了。
- (NSMutableArray *)mutableArrayValueForKey:(NSString *)key;
- (NSMutableOrderedSet *)mutableOrderedSetValueForKey:(NSString *)key API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
- (NSMutableSet *)mutableSetValueForKey:(NSString *)key;
keyPath方法:
- (NSMutableArray *)mutableArrayValueForKeyPath:(NSString *)keyPath;
- (NSMutableOrderedSet *)mutableOrderedSetValueForKeyPath:(NSString *)keyPath API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
- (NSMutableSet *)mutableSetValueForKeyPath:(NSString *)keyPath;
集合運算符
KVC提供的valueForKeyPath:方法非常強大,可以通過該方法對集合對象進行“深入”操作,在其keyPath中嵌套集合運算符,例如求一個數組中對象某個屬性的count。(集合對象主要指NSArray和NSSet,但不包括NSDictionary)

上面表達式主要分為三部分,left部分是要操作的集合對象,如果調用KVC的對象本來就是集合對象,則left可以為空。中間部分是表達式,表達式一般以@符號開頭。后面是進行運算的屬性。
集合運算符主要分為三類:
- 集合操作符:處理集合包含的對象,并根據操作符的不同返回不同的類型,返回值以
NSNumber為主。 - 數組操作符:根據操作符的條件,將符合條件的對象包含在數組中返回。
- 嵌套操作符:處理集合對象中嵌套其他集合對象的情況,返回結果也是一個集合對象。
example
下面是為了方便模擬KVC操作,而創(chuàng)建的測試代碼。定義Transaction類為模型類,類中包含三種類型的屬性。并定義BankAccount類,其中包含一個數組,下面的代碼示例就都是操作這個數組的,并且數組包含所有Transaction對象。
@interface Transaction : NSObject
@property (nonatomic, strong) NSString *payee;
@property (nonatomic, strong) NSNumber *amount;
@property (nonatomic, strong) NSDate *date;
@end
@interface BankAccount : NSObject
@property (nonatomic, strong) NSArray *transactions;
@end
集合操作符
集合操作符處理NSArray和NSSet及其子類這樣的集合對象,并根據不同的操作符返回不同類型的對象,返回值一般都是NSNumber。
-
@avg用來計算集合中right keyPath指定的屬性的平均值。
NSNumber *transactionAverage = [self.transactions valueForKeyPath:@"@avg.amount"];
-
@count用來計算集合的總數。
NSNumber *numberOfTransactions = [self.transactions valueForKeyPath:@"@count"];
備注:@count操作符比較特殊,它不需要寫right keyPath,即使寫了也會被忽略。
-
@sum用來計算集合中right keyPath指定的屬性的總和。
NSNumber *amountSum = [self.transactions valueForKeyPath:@"@sum.amount"];
-
@max用來查找集合中right keyPath指定的屬性的最大值。
NSDate *latestDate = [self.transactions valueForKeyPath:@"@max.date"];
-
@min用來查找集合中right keyPath指定的屬性的最小值。
NSDate *earliestDate = [self.transactions valueForKeyPath:@"@min.date"];
備注:@max和@min在進行判斷時,都是通過調用compare:方法進行判斷,所以可以通過重寫該方法對判斷過程進行控制。
數組操作符
-
@unionOfObjects將集合對象中,所有payee對象放在一個數組中并返回。
NSArray *payees = [self.transactions valueForKeyPath:@"@unionOfObjects.payee"];
-
@distinctUnionOfObjects將集合對象中,所有payee對象放在一個數組中,并將數組進行去重后返回。
NSArray *distinctPayees = [self.transactions valueForKeyPath:@"@distinctUnionOfObjects.payee"];
注意:以上兩個方法中,如果操作的屬性為nil,在添加到數組中時會導致Crash
嵌套操作符
由于嵌套操作符是需要對嵌套的集合對象進行操作,所以新建一個arrayOfArrays對象,其中包含兩個數組,數組中存儲的都是Transaction類型對象。
NSArray *moreTransactions = ....;
NSArray *arrayOfArrays = @[self.transactions, moreTransactions];
-
@unionOfArrays是用來操作集合內部的集合對象,將所有right keyPath對應的對象放在一個數組中返回。
NSArray *collectedPayees = [arrayOfArrays valueForKeyPath:@"@unionOfArrays.payee"];
-
@distinctUnionOfArrays是用來操作集合內部的集合對象,將所有right keyPath對應的對象放在一個數組中,并進行排重。
NSArray *collectedDistinctPayees = [arrayOfArrays valueForKeyPath:@"@distinctUnionOfArrays.payee"];
-
@distinctUnionOfSets是用來操作集合內部的集合對象,將所有right keyPath對應的對象放在一個set中,并進行排重。
NSSet *collectedPayees = [arrayOfArrays valueForKeyPath:@"@distinctUnionOfSets.payee"];
小技巧
如果在集合對象中操作的屬性,本來就是NSNumber類型,則可以像下面這樣,直接用self代表值自身。
NSArray *array = @[@(productA.price), @(productB.price), @(productC.price), @(productD.price)];
NSNumber *avg = [array valueForKeyPath:@"@avg.self"];
非對象值處理
KVC是支持基礎數據類型和結構體的,可以在setter和getter的時候,通過NSValue和NSNumber來轉換為OC對象。Swift中不存在這樣的需求,因為Swift中所有變量都是對象。
以下是結構體轉換的示例代碼,可以調用initWithBool:方法對基礎數據類型進行包裝,除了調用方法外還可以通過字面量實現,例如@(YES)的調用。通過NSNumber的boolValue屬性轉換為基礎數據類型。
@property (nonatomic, assign, readonly) BOOL boolValue;
- (NSNumber *)initWithBool:(BOOL)value NS_DESIGNATED_INITIALIZER;
結構體轉換的代碼定義在UIGeometry.h中,以NSValue的Category形式存在。NSValue對CGPoint、CGRect等結構體都提供了轉換方法,例如下面是對CGPoint進行轉換的示例代碼。
@property(nonatomic, assign, readonly) CGPoint CGPointValue;
+ (NSValue *)valueWithCGPoint:(CGPoint)point;
需要注意的是,無論什么時候都不應該給setter中傳入nil,會導致Crash并引起NSInvalidArgumentException異常。
屬性驗證
在調用KVC時可以先進行驗證,驗證通過下面兩個方法進行,支持key和keyPath兩種方式。驗證方法默認實現返回YES,可以通過重寫對應的方法修改驗證邏輯。
驗證方法需要我們手動調用,并不會在進行KVC的過程中自動調用。
- (BOOL)validateValue:(inout id _Nullable * _Nonnull)ioValue forKey:(NSString *)inKey error:(out NSError **)outError;
- (BOOL)validateValue:(inout id _Nullable * _Nonnull)ioValue forKeyPath:(NSString *)inKeyPath error:(out NSError **)outError;
下面是使用驗證方法的例子。在validateValue方法的內部實現中,如果傳入的value或key有問題,可以通過返回NO來表示錯誤,并設置NSError對象。
Person *person = [[Person alloc] init];
NSError *error;
NSString *name = @"John";
if (![person validateValue:&name forKey:@"name" error:&error]) {
NSLog(@"%@", error);
}
單獨驗證
KVC還支持對單獨屬性做驗證,可以通過定義validate<Key>:error:格式的方法,并在方法內部實現驗證代碼。在編寫KVC驗證代碼的時候,應該先查找屬性有沒有自定義validate方法,然后再查找validateValue:方法,如果有則調用自己實現的方法,如果兩個方法都沒有實現則默認返回YES。
- (BOOL)validateName:(id *)ioValue error:(NSError * __autoreleasing *)outError{
if ((*ioValue == nil) || ([(NSString *)*ioValue length] < 2)) {
if (outError != NULL) {
*outError = [NSError errorWithDomain:PersonErrorDomain
code:PersonInvalidNameCode
userInfo:@{ NSLocalizedDescriptionKey
: @"Name too short" }];
}
return NO;
}
return YES;
}
我覺得KVC應該支持validateValue自動驗證,在調用setValue或getValue時自動進行驗證,如果不符合驗證規(guī)則,就調用失敗。如果外界使用的地方都先調用一次validateValue的話,這是很麻煩的。當然也有解決方法,可以通過Method Swizzling方法hook住setValue和getValue方法。
搜索規(guī)則
KVC在通過key或者keyPath進行操作的時候,可以查找屬性方法、成員變量等,查找的時候可以兼容多種命名。具體的查找規(guī)則要以官方文檔為主,所以我把官方文檔翻譯了一下寫在下面。
在KVC的實現中,依賴setter和getter的方法實現,所以方法命名應該符合蘋果要求的規(guī)范,否則會導致KVC失敗。
在學習KVC的搜索規(guī)則前,要先弄明白一個屬性的作用,這個屬性在搜索過程中起到很重要的作用。這個屬性表示是否允許讀取實例變量的值,如果為YES則在KVC查找的過程中,從內存中讀取屬性實例變量的值。
@property (class, readonly) BOOL accessInstanceVariablesDirectly;
基礎Getter搜索模式
這是valueForKey:的默認實現,給定一個key當做輸入參數,開始下面的步驟,在這個接收valueForKey:方法調用的類內部進行操作。
通過
getter方法搜索實例,例如get<Key>,<key>,is<Key>,_<key>的拼接方案。按照這個順序,如果發(fā)現符合的方法,就調用對應的方法并拿著結果跳轉到第五步。否則,就繼續(xù)到下一步。如果沒有找到簡單的
getter方法,則搜索其匹配模式的方法countOf<Key>、objectIn<Key>AtIndex:、<key>AtIndexes:。
如果找到其中的第一個和其他兩個中的一個,則創(chuàng)建一個集合代理對象,該對象響應所有NSArray的方法并返回該對象。否則,繼續(xù)到第三步。
代理對象隨后將NSArray接收到的countOf<Key>、objectIn<Key>AtIndex:、<key>AtIndexes:的消息給符合KVC規(guī)則的調用方。
當代理對象和KVC調用方通過上面方法一起工作時,就會允許其行為類似于NSArray一樣。
- 如果沒有找到
NSArray簡單存取方法,或者NSArray存取方法組。則查找有沒有countOf<Key>、enumeratorOf<Key>、memberOf<Key>:命名的方法。
如果找到三個方法,則創(chuàng)建一個集合代理對象,該對象響應所有NSSet方法并返回。否則,繼續(xù)執(zhí)行第四步。
此代理對象隨后轉換countOf<Key>、enumeratorOf<Key>、memberOf<Key>:方法調用到創(chuàng)建它的對象上。實際上,這個代理對象和NSSet一起工作,使得其表象上看起來是NSSet。
- 如果沒有發(fā)現簡單
getter方法,或集合存取方法組,以及接收類方法accessInstanceVariablesDirectly是返回YES的。搜索一個名為_<key>、_is<Key>、<key>、is<Key>的實例,根據他們的順序。
如果發(fā)現對應的實例,則立刻獲得實例可用的值并跳轉到第五步,否則,跳轉到第六步。
如果取回的是一個對象指針,則直接返回這個結果。
如果取回的是一個基礎數據類型,但是這個基礎數據類型是被NSNumber支持的,則存儲為NSNumber并返回。
如果取回的是一個不支持NSNumber的基礎數據類型,則通過NSValue進行存儲并返回。如果所有情況都失敗,則調用
valueForUndefinedKey:方法并拋出異常,這是默認行為。但是子類可以重寫此方法。
基礎Setter搜索模式
這是setValue:forKey:的默認實現,給定輸入參數value和key。試圖在接收調用對象的內部,設置屬性名為key的value,通過下面的步驟:
查找
set<Key>:或_set<Key>命名的setter,按照這個順序,如果找到的話,調用這個方法并將值傳進去(根據需要進行對象轉換)。如果沒有發(fā)現一個簡單的
setter,但是accessInstanceVariablesDirectly類屬性返回YES,則查找一個命名規(guī)則為_<key>、_is<Key>、<key>、is<Key>的實例變量。根據這個順序,如果發(fā)現則將value賦值給實例變量。如果沒有發(fā)現
setter或實例變量,則調用setValue:forUndefinedKey:方法,并默認提出一個異常,但是一個NSObject的子類可以提出合適的行為。
NSMutableArray搜索模式
這是mutableArrayValueForKey:的默認實現,給一個key當做輸入參數。在接收訪問器調用的對象中,返回一個名為key的可變代理數組,這個代理數組就是用來響應外界KVO的對象,通過下面的步驟進行查找:
- 查找一對方法
insertObject:in<Key>AtIndex:和removeObjectFrom<Key>AtIndex:(相當于NSMutableArray的原始方法insertObject:atIndex:和removeObjectAtIndex:)或者方法名是insert<Key>:atIndexes:和remove<Key>AtIndexes:(相當于NSMutableArray的原始方法insertObjects:atIndexes:和removeObjectsAtIndexes:)。
如果找到最少一個insert方法和最少一個remove方法,則返回一個代理對象,來響應發(fā)送給NSMutableArray的組合消息insertObject:in<Key>AtIndex:、removeObjectFrom<Key>AtIndex:、insert<Key>:atIndexes:,和remove<Key>AtIndexes:消息。
當對象接收一個mutableArrayValueForKey:消息并實現可選替換方法,例如replaceObjectIn<Key>AtIndex:withObject:或replace<Key>AtIndexes:with<Key>:方法,代理對象會在適當的情況下使用它們,以獲得最佳性能。
- 如果對象沒有可變數組方法,查找一個替代方法,命名格式為
set<Key>:。在這種情況下,向mutableArrayValueForKey:的原始響應者發(fā)送一個set<Key>:消息,來返回一個代理對象來響應NSMutableArray事件。
提示:
這一步描述的機制遠不如上一步有效,因為它可能重復創(chuàng)建新的集合對象,而不是修改現有的對象。因此,在自己設計的KVC時應該盡量避免它。
- 如果沒有可變數組的方法,也沒有找到訪問器,但接受響應的類
accessInstanceVariablesDirectly屬性返回YES,則查找一個名為_<key>或<key>的實例變量。
按照這個順序,如果找到實例變量,則返回一個代理對象。改對象將接收所有NSMutableArray發(fā)送過來的消息,通常是NSMutableArray或其子類。
- 如果所有情況都失敗,則返回一個可變的集合代理對象。當它接收
NSMutableArray消息時,發(fā)送一個setValue:forUndefinedKey:消息給接收mutableArrayValueForKey:消息的原始對象。
這個setValue:forUndefinedKey:的默認實現是提出一個NSUndefinedKeyException異常,但是子類可以重寫這個實現。
其他搜索模式
還有NSMutableSet和NSMutableOrderedSet兩種搜索模式,這兩種搜索模式和NSMutableArray步驟相同,只是搜索和調用的方法不同。詳細的搜索方法都可以在KVC官方文檔中找到,再套用上面的流程即可理解。
代碼示例
根據上面KVC查找規(guī)則的描述,我們定義一個TestObject類,并指定其他setter和getter,以及合成為其他的成員變量,看KVC是否能夠找到屬性的對象并賦值。
@interface TestObject : NSObject {
NSObject *_newObject;
}
@property (nonatomic, strong, setter=newSetObject:, getter=newObject) NSObject *object;
@property (nonatomic, strong) NSObject *twoObject;
@end
@implementation TestObject
@synthesize object = _newObject;
@end
這里對兩個屬性進行賦值,twoObject屬性賦值沒有任何問題,而第二個屬性賦值則會導致Crash。崩潰信息如上面所述拋出一個NSUnknownKeyException異常,并提示沒有找到object獲取方法和實例對象。
TestObject *object = [[TestObject alloc] init];
[object setValue:[NSObject new] forKey:NSStringFromSelector(@selector(twoObject))];
[object setValue:[NSObject new] forKey:NSStringFromSelector(@selector(object))];
如果將object改為newObject則可以解決這個問題,以此驗證上面的KVC查找規(guī)則。
KVC性能
根據上面KVC的實現原理,我們可以看出KVC的性能并不如直接訪問屬性快,雖然這個性能消耗是微乎其微的。所以在使用KVC的時候,建議最好不要手動設置屬性的setter、getter,這樣會導致搜索步驟變長。
而且盡量不要用KVC進行集合操作,例如NSArray、NSSet之類的,集合操作的性能消耗更大,而且還會創(chuàng)建不必要的對象。
私有訪問
根據上面的實現原理我們知道,KVC本質上是操作方法列表以及在內存中查找實例變量。我們可以利用這個特性訪問類的私有變量,例如下面在.m中定義的私有成員變量和屬性,都可以通過KVC的方式訪問。
這個操作對readonly的屬性,@protected的成員變量,都可以正常訪問。如果不想讓外界訪問類的成員變量,則可以將accessInstanceVariablesDirectly屬性賦值為NO。
TestObject.m文件
@interface TestObject () {
NSObject *_objectOne;
}
@property (nonatomic, strong) NSObject *objectTwo;
@end
KVC在實踐中也有很多用處,例如UITabbar或UIPageControl這樣的控件,系統(tǒng)已經為我們封裝好了,但是對于一些樣式的改變并沒有提供足夠的API,這種情況就需要我們用KVC進行操作了。

可以自定義一個UITabbar對象,然后在內部創(chuàng)建自己想要的視圖,并通過layoutSubviews方法在內部進行重新布局。然后通過KVC的方式,將UITabbarController的tabbar屬性替換為自定義的類即可。
安全性檢查
KVC存在一個問題在于,因為傳入的key或keyPath是一個字符串,這樣很容易寫錯或者屬性自身修改后字符串忘記修改,這樣會導致Crash。
可以利用iOS的反射機制來規(guī)避這個問題,通過@selector()獲取到方法的SEL,然后通過NSStringFromSelector()將SEL反射為字符串。這樣在@selector()中傳入方法名的過程中,編譯器會有合法性檢查,如果方法不存在或未實現會報黃色警告。
[self valueForKey:NSStringFromSelector(@selector(object))];
Swift-KVC構造函數中數據類型和私有屬性
