KVC定義
KVC（Key-value coding）鍵值編碼桥嗤，就是指iOS的開(kāi)發(fā)中，可以允許開(kāi)發(fā)者通過(guò)Key名直接訪問(wèn)對(duì)象的屬性，或者給對(duì)象的屬性賦值。而不需要調(diào)用明確的存取方法朝卒。這樣就可以在運(yùn)行時(shí)動(dòng)態(tài)地訪問(wèn)和修改對(duì)象的屬性。而不是在編譯時(shí)確定乐埠，這也是iOS開(kāi)發(fā)中的黑魔法之一抗斤。很多高級(jí)的iOS開(kāi)發(fā)技巧都是基于KVC實(shí)現(xiàn)的。
KVC的定義都是對(duì)NSObject的擴(kuò)展來(lái)實(shí)現(xiàn)的丈咐，Objective-C中有個(gè)顯式的NSKeyValueCoding類別名瑞眼，所以對(duì)于所有繼承了NSObject的類型，都能使用KVC(一些純Swift類和結(jié)構(gòu)體是不支持KVC的棵逊，因?yàn)闆](méi)有繼承NSObject)伤疙，下面是KVC最為重要的四個(gè)方法：
- (nullable id)valueForKey:(NSString *)key; //直接通過(guò)Key來(lái)取值
- (void)setValue:(nullable id)value forKey:(NSString *)key; //通過(guò)Key來(lái)設(shè)值
- (nullable id)valueForKeyPath:(NSString *)keyPath; //通過(guò)KeyPath來(lái)取值
- (void)setValue:(nullable id)value forKeyPath:(NSString *)keyPath; //通過(guò)KeyPath來(lái)設(shè)值
- setValue forkey 和 setValue forKeyPath 的區(qū)別在于，forKeyPath 是可以多深層次訪問(wèn)的辆影。例如：有兩個(gè)類 Psrson 和Student掩浙，Psrson 類里面有個(gè)Student 類型的對(duì)象，Student 類里面有個(gè) score 屬性秸歧。那么就可以這么使用：[person setValue:@80 forKeyPath:@"student.score" ]
KVC使用
- 動(dòng)態(tài)地取值和設(shè)值厨姚。利用KVC動(dòng)態(tài)的取值和設(shè)值是最基本的用途了。
- 用KVC來(lái)訪問(wèn)和修改私有變量键菱。對(duì)于類里的私有屬性谬墙，Objective-C是無(wú)法直接訪問(wèn)的今布，但是KVC是可以的。
- Model和字典轉(zhuǎn)換拭抬。這是KVC強(qiáng)大作用的又一次體現(xiàn)部默，KVC和Objc的runtime組合可以很容易的實(shí)現(xiàn)Model和字典的轉(zhuǎn)換。
- 修改一些控件的內(nèi)部屬性造虎。最常用的就是個(gè)性化UITextField中的placeHolderText了傅蹂。
- 操作集合。Apple對(duì)KVC的valueForKey:方法作了一些特殊的實(shí)現(xiàn)算凿，比如說(shuō)NSArray和NSSet這樣的容器類就實(shí)現(xiàn)了這些方法份蝴。所以可以用KVC很方便地操作集合。
- 用KVC實(shí)現(xiàn)高階消息傳遞氓轰。當(dāng)對(duì)容器類使用KVC時(shí)婚夫，valueForKey:將會(huì)被傳遞給容器中的每一個(gè)對(duì)象，而不是容器本身進(jìn)行操作署鸡。結(jié)果會(huì)被添加進(jìn)返回的容器中案糙，這樣，開(kāi)發(fā)者可以很方便的操作集合來(lái)返回另一個(gè)集合靴庆。
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[]) {
@autoreleasepool {
NSArray* arrStr = @[@"english",@"franch",@"chinese"];
NSArray* arrCapStr = [arrStr valueForKey:@"capitalizedString"];
for (NSString* str in arrCapStr) {
NSLog(@"%@",str);
}
NSArray* arrCapStrLength = [arrStr valueForKeyPath:@"capitalizedString.length"];
for (NSNumber* length in arrCapStrLength) {
NSLog(@"%ld",(long)length.integerValue);
}
}
return 0;
}
打印結(jié)果：
2018-05-05 17:16:21.975983+0800 KVCKVO[35824:6395514] English
2018-05-05 17:16:21.976296+0800 KVCKVO[35824:6395514] Franch
2018-05-05 17:16:21.976312+0800 KVCKVO[35824:6395514] Chinese
2018-05-05 17:16:21.976508+0800 KVCKVO[35824:6395514] 7
2018-05-05 17:16:21.976533+0800 KVCKVO[35824:6395514] 6
2018-05-05 17:16:21.976550+0800 KVCKVO[35824:6395514] 7
方法capitalizedString被傳遞到NSArray中的每一項(xiàng)时捌，這樣，NSArray的每一員都會(huì)執(zhí)行capitalizedString并返回一個(gè)包含結(jié)果的新的NSArray炉抒。
從打印結(jié)果可以看出奢讨，所有String都成功以轉(zhuǎn)成了大寫(xiě)。
同樣如果要執(zhí)行多個(gè)方法也可以用valueForKeyPath:方法端礼。它先會(huì)對(duì)每一個(gè)成員調(diào)用 capitalizedString方法禽笑，然后再調(diào)用length入录，因?yàn)閘enth方法返回是一個(gè)數(shù)字蛤奥，所以返回結(jié)果以NSNumber的形式保存在新數(shù)組里。
NSKeyValueCoding類別中其他的一些方法：
+ (BOOL)accessInstanceVariablesDirectly;
//默認(rèn)返回YES僚稿，表示如果沒(méi)有找到Set<Key>方法的話凡桥，會(huì)按照_key，_iskey蚀同，key缅刽，iskey的順序搜索成員，設(shè)置成NO就不這樣搜索
- (BOOL)validateValue:(inout id __nullable * __nonnull)ioValue forKey:(NSString *)inKey error:(out NSError **)outError;
//KVC提供屬性值正確性驗(yàn)證的API蠢络，它可以用來(lái)檢查set的值是否正確衰猛、為不正確的值做一個(gè)替換值或者拒絕設(shè)置新值并返回錯(cuò)誤原因。
- (NSMutableArray *)mutableArrayValueForKey:(NSString *)key;
//這是集合操作的API刹孔，里面還有一系列這樣的API啡省，如果屬性是一個(gè)NSMutableArray，那么可以用這個(gè)方法來(lái)返回。
- (nullable id)valueForUndefinedKey:(NSString *)key;
//如果Key不存在卦睹，且沒(méi)有KVC無(wú)法搜索到任何和Key有關(guān)的字段或者屬性畦戒，則會(huì)調(diào)用這個(gè)方法，默認(rèn)是拋出異常结序。
- (void)setValue:(nullable id)value forUndefinedKey:(NSString *)key;
//和上一個(gè)方法一樣障斋，但這個(gè)方法是設(shè)值。
- (void)setNilValueForKey:(NSString *)key;
//如果你在SetValue方法時(shí)面給Value傳nil徐鹤，則會(huì)調(diào)用這個(gè)方法
- (NSDictionary<NSString *, id> *)dictionaryWithValuesForKeys:(NSArray<NSString *> *)keys;
//輸入一組key,返回該組key對(duì)應(yīng)的Value垃环，再轉(zhuǎn)成字典返回，用于將Model轉(zhuǎn)到字典凳干。
KVC設(shè)值順序
- 查找setKey 方法晴裹，有則調(diào)用，沒(méi)有則查找看有沒(méi)有_setKey方法救赐，有則調(diào)用涧团。
- 沒(méi)有則查看 accessInstanceVariablesDirectly 這個(gè)類方法的返回值，是yes則按照_key 经磅、_isKey 泌绣、key 、iskey 順序查找成員變量预厌。如果沒(méi)有找到系統(tǒng)則將會(huì)執(zhí)行該對(duì)象的setValue：forUndefinedKey：方法阿迈，默認(rèn)是拋出異常NSUnknownKeyException 。
- 如果accessInstanceVariablesDirectly返回值是 NO轧叽，則程序拋出異常苗沧，會(huì)直接用setValue：forUndefinedKey：方法。
簡(jiǎn)單來(lái)說(shuō)就是如果沒(méi)有找到Set<Key>方法的話炭晒，會(huì)按照_key待逞，_iskey，key网严，iskey的順序搜索成員并進(jìn)行賦值操作识樱。
#import <Foundation/Foundation.h>
@interface Test: NSObject {
NSString *_name;
}
@end
@implementation Test
@end
int main(int argc, const char * argv[]) {
@autoreleasepool {
// insert code here...
//生成對(duì)象
Test *obj = [[Test alloc] init];
//通過(guò)KVC賦值name
[obj setValue:@"xiaoming" forKey:@"name"];
//通過(guò)KVC取值name打印
NSLog(@"obj的名字是%@", [obj valueForKey:@"name"]);
}
return 0;
}
打印結(jié)果：
2018-05-05 15:36:52.354405+0800 KVCKVO[35231:6116188] obj的名字是xiaoming
可以看到通過(guò)- (void)setValue:(nullable id)value forKey:(NSString *)key;和- (nullable id)valueForKey:(NSString *)key;成功設(shè)置和取出obj對(duì)象的name值。
- 再看一下設(shè)置accessInstanceVariablesDirectly為NO的效果：
#import <Foundation/Foundation.h>
@interface Test: NSObject {
NSString *_name;
}
@end
@implementation Test
+ (BOOL)accessInstanceVariablesDirectly {
return NO;
}
- (id)valueForUndefinedKey:(NSString *)key {
NSLog(@"出現(xiàn)異常震束，該key不存在%@",key);
return nil;
}
- (void)setValue:(id)value forUndefinedKey:(NSString *)key {
NSLog(@"出現(xiàn)異常怜庸，該key不存在%@", key);
}
@end
int main(int argc, const char * argv[]) {
@autoreleasepool {
// insert code here...
//生成對(duì)象
Test *obj = [[Test alloc] init];
//通過(guò)KVC賦值name
[obj setValue:@"xiaoming" forKey:@"name"];
//通過(guò)KVC取值name打印
NSLog(@"obj的名字是%@", [obj valueForKey:@"name"]);
}
return 0;
}
打印結(jié)果:
2018-05-05 15:45:22.399021+0800 KVCKVO[35290:6145826] 出現(xiàn)異常，該key不存在name
2018-05-05 15:45:22.399546+0800 KVCKVO[35290:6145826] 出現(xiàn)異常垢村，該key不存在name
2018-05-05 15:45:22.399577+0800 KVCKVO[35290:6145826] obj的名字是(null)
可以看到accessInstanceVariablesDirectly為NO的時(shí)候KVC只會(huì)查詢setter和getter這一層割疾，下面尋找key的相關(guān)變量執(zhí)行就會(huì)停止，直接報(bào)錯(cuò)嘉栓。
- 設(shè)置accessInstanceVariablesDirectly為YES宏榕，再修改_name為_(kāi)isName驰凛，看看執(zhí)行是否成功。
#import <Foundation/Foundation.h>
@interface Test: NSObject {
NSString *_isName;
}
@end
@implementation Test
+ (BOOL)accessInstanceVariablesDirectly {
return YES;
}
- (id)valueForUndefinedKey:(NSString *)key {
NSLog(@"出現(xiàn)異常担扑，該key不存在%@",key);
return nil;
}
- (void)setValue:(id)value forUndefinedKey:(NSString *)key {
NSLog(@"出現(xiàn)異常恰响，該key不存在%@", key);
}
@end
int main(int argc, const char * argv[]) {
@autoreleasepool {
// insert code here...
//生成對(duì)象
Test *obj = [[Test alloc] init];
//通過(guò)KVC賦值name
[obj setValue:@"xiaoming" forKey:@"name"];
//通過(guò)KVC取值name打印
NSLog(@"obj的名字是%@", [obj valueForKey:@"name"]);
}
return 0;
}
打印結(jié)果：
2018-05-05 15:49:53.444350+0800 KVCKVO[35303:6157671] obj的名字是xiaoming
從打印可以看到設(shè)置accessInstanceVariablesDirectly為YES，KVC會(huì)繼續(xù)按照順序查找涌献，并成功設(shè)值和取值了胚宦。
KVC 取值
- 先按照 get<Key> 、<key> 燕垃、is<Key> 枢劝、_key 順序查找getter方法取值，找到的話會(huì)直接調(diào)用卜壕。如果是BOOL或者Int等值類型您旁， 會(huì)將其包裝成一個(gè)NSNumber對(duì)象。
- 如果沒(méi)有找到方法則查看accessInstanceVariablesDirectly 類方法的返回值轴捎，如果返回的是 NO鹤盒，那么會(huì)直接調(diào)用valueForUndefinedKey:方法，默認(rèn)是拋出異常侦副。
- 如果返回的是YES侦锯，按照_key 、_isKey 秦驯、key 尺碰、isKey 順序查找成員變量，如果沒(méi)有找到译隘，則拋出異常亲桥。這里不推薦這么做，因?yàn)檫@樣直接訪問(wèn)實(shí)例變量破壞了封裝性固耘，使代碼更脆弱题篷。
#import <Foundation/Foundation.h>
@interface Test: NSObject {
}
@end
@implementation Test
- (NSUInteger)getAge {
return 10;
}
@end
int main(int argc, const char * argv[]) {
@autoreleasepool {
// insert code here...
//生成對(duì)象
Test *obj = [[Test alloc] init];
//通過(guò)KVC取值age打印
NSLog(@"obj的年齡是%@", [obj valueForKey:@"age"]);
}
return 0;
}
打印結(jié)果：
2018-05-05 16:00:04.207857+0800 KVCKVO[35324:6188613] obj的年齡是10
可以看到[obj valueForKey:@"age"]，找到了getAge方法玻驻，并且取到了值悼凑。其他順序的偿枕，可以把getAge改成age 璧瞬，或者改成isAge 看下打印結(jié)果。
KVC使用keyPath
KVC提供了一個(gè)解決方案渐夸，那就是鍵路徑keyPath嗤锉。顧名思義，就是按照路徑尋找key墓塌。
- (nullable id)valueForKeyPath:(NSString *)keyPath; //通過(guò)KeyPath來(lái)取值
- (void)setValue:(nullable id)value forKeyPath:(NSString *)keyPath; //通過(guò)KeyPath來(lái)設(shè)值
用代碼實(shí)現(xiàn)如下：
#import <Foundation/Foundation.h>
@interface Test1: NSObject {
NSString *_name;
}
@end
@implementation Test1
@end
@interface Test: NSObject {
Test1 *_test1;
}
@end
@implementation Test
@end
int main(int argc, const char * argv[]) {
@autoreleasepool {
// insert code here...
//Test生成對(duì)象
Test *test = [[Test alloc] init];
//Test1生成對(duì)象
Test1 *test1 = [[Test1 alloc] init];
//通過(guò)KVC設(shè)值test的"test1"
[test setValue:test1 forKey:@"test1"];
//通過(guò)KVC設(shè)值test的"test1的name"
[test setValue:@"xiaoming" forKeyPath:@"test1.name"];
//通過(guò)KVC取值age打印
NSLog(@"test的\"test1的name\"是%@", [test valueForKeyPath:@"test1.name"]);
}
return 0;
}
打印結(jié)果：
2018-05-05 16:19:02.613394+0800 KVCKVO[35436:6239788] test的"test1的name"是xiaoming
KVC處理異常
KVC中最常見(jiàn)的異常就是不小心使用了錯(cuò)誤的key瘟忱，或者在設(shè)值中不小心傳遞了nil的值奥额，KVC中有專門(mén)的方法來(lái)處理這些異常。
- 通常情況下访诱，KVC不允許你要在調(diào)用setValue：屬性值 forKey：(或者keyPath)時(shí)對(duì)非對(duì)象傳遞一個(gè)nil的值垫挨。很簡(jiǎn)單，因?yàn)橹殿愋褪遣荒転閚il的触菜。如果你不小心傳了九榔，KVC會(huì)調(diào)用setNilValueForKey:方法。這個(gè)方法默認(rèn)是拋出異常涡相，所以一般而言最好還是重寫(xiě)這個(gè)方法哲泊。
#import <Foundation/Foundation.h>
@interface Test: NSObject {
NSUInteger age;
}
@end
@implementation Test
- (void)setNilValueForKey:(NSString *)key {
NSLog(@"不能將%@設(shè)成nil", key);
}
@end
int main(int argc, const char * argv[]) {
@autoreleasepool {
// insert code here...
//Test生成對(duì)象
Test *test = [[Test alloc] init];
//通過(guò)KVC設(shè)值test的age
[test setValue:nil forKey:@"age"];
//通過(guò)KVC取值age打印
NSLog(@"test的年齡是%@", [test valueForKey:@"age"]);
}
return 0;
}
打印結(jié)果：
2018-05-05 16:24:30.302134+0800 KVCKVO[35470:6258307] 不能將age設(shè)成nil
2018-05-05 16:24:30.302738+0800 KVCKVO[35470:6258307] test的年齡是0
- 通常情況下，KVC不允許你要在調(diào)用setValue：屬性值 forKey：(或者keyPath)時(shí)對(duì)不存在的key進(jìn)行操作催蝗。
不然切威，會(huì)報(bào)錯(cuò)forUndefinedKey發(fā)生崩潰，重寫(xiě)forUndefinedKey方法避免崩潰丙号。
#import <Foundation/Foundation.h>
@interface Test: NSObject {
}
@end
@implementation Test
- (id)valueForUndefinedKey:(NSString *)key {
NSLog(@"出現(xiàn)異常先朦，該key不存在%@",key);
return nil;
}
- (void)setValue:(id)value forUndefinedKey:(NSString *)key {
NSLog(@"出現(xiàn)異常，該key不存在%@", key);
}
@end
int main(int argc, const char * argv[]) {
@autoreleasepool {
// insert code here...
//Test生成對(duì)象
Test *test = [[Test alloc] init];
//通過(guò)KVC設(shè)值test的age
[test setValue:@10 forKey:@"age"];
//通過(guò)KVC取值age打印
NSLog(@"test的年齡是%@", [test valueForKey:@"age"]);
}
return 0;
}
打印結(jié)果：
2018-05-05 16:30:18.564680+0800 KVCKVO[35487:6277523] 出現(xiàn)異常犬缨，該key不存在age
2018-05-05 16:30:18.565190+0800 KVCKVO[35487:6277523] 出現(xiàn)異常烙无，該key不存在age
2018-05-05 16:30:18.565216+0800 KVCKVO[35487:6277523] test的年齡是(null)
KVC處理數(shù)值和結(jié)構(gòu)體類型屬性
不是每一個(gè)方法都返回對(duì)象，但是valueForKey：總是返回一個(gè)id對(duì)象遍尺，如果原本的變量類型是值類型或者結(jié)構(gòu)體截酷，返回值會(huì)封裝成NSNumber或者NSValue對(duì)象。
這兩個(gè)類會(huì)處理從數(shù)字乾戏，布爾值到指針和結(jié)構(gòu)體任何類型迂苛。然后開(kāi)以者需要手動(dòng)轉(zhuǎn)換成原來(lái)的類型。
盡管valueForKey：會(huì)自動(dòng)將值類型封裝成對(duì)象鼓择，但是setValue：forKey：卻不行三幻。你必須手動(dòng)將值類型轉(zhuǎn)換成NSNumber或者NSValue類型，才能傳遞過(guò)去呐能。
因?yàn)閭鬟f進(jìn)去和取出來(lái)的都是id類型念搬，所以需要開(kāi)發(fā)者自己擔(dān)保類型的正確性，運(yùn)行時(shí)Objective-C在發(fā)送消息的會(huì)檢查類型摆出，如果錯(cuò)誤會(huì)直接拋出異常朗徊。
KVC處理字典
當(dāng)對(duì)NSDictionary對(duì)象使用KVC時(shí)，valueForKey:的表現(xiàn)行為和objectForKey:一樣偎漫。所以使用valueForKeyPath:用來(lái)訪問(wèn)多層嵌套的字典是比較方便的爷恳。
- (NSDictionary<NSString *, id> *)dictionaryWithValuesForKeys:(NSArray<NSString *> *)keys;
- (void)setValuesForKeysWithDictionary:(NSDictionary<NSString *, id> *)keyedValues;
dictionaryWithValuesForKeys:是指輸入一組key，返回這組key對(duì)應(yīng)的屬性象踊，再組成一個(gè)字典温亲。
setValuesForKeysWithDictionary是用來(lái)修改Model中對(duì)應(yīng)key的屬性棚壁。下面直接用代碼會(huì)更直觀一點(diǎn):
#import <Foundation/Foundation.h>
@interface Address : NSObject
@end
@interface Address()
@property (nonatomic, copy)NSString* country;
@property (nonatomic, copy)NSString* province;
@property (nonatomic, copy)NSString* city;
@property (nonatomic, copy)NSString* district;
@end
@implementation Address
@end
int main(int argc, const char * argv[]) {
@autoreleasepool {
//模型轉(zhuǎn)字典
Address* add = [Address new];
add.country = @"China";
add.province = @"Guang Dong";
add.city = @"Shen Zhen";
add.district = @"Nan Shan";
NSArray* arr = @[@"country",@"province",@"city",@"district"];
NSDictionary* dict = [add dictionaryWithValuesForKeys:arr]; //把對(duì)應(yīng)key所有的屬性全部取出來(lái)
NSLog(@"%@",dict);
//字典轉(zhuǎn)模型
NSDictionary* modifyDict = @{@"country":@"USA",@"province":@"california",@"city":@"Los angle"};
[add setValuesForKeysWithDictionary:modifyDict]; //用key Value來(lái)修改Model的屬性
NSLog(@"country:%@ province:%@ city:%@",add.country,add.province,add.city);
}
return 0;
}
打印結(jié)果：
2018-05-05 17:08:48.824653+0800 KVCKVO[35807:6368235] {
city = "Shen Zhen";
country = China;
district = "Nan Shan";
province = "Guang Dong";
}
2018-05-05 17:08:48.825075+0800 KVCKVO[35807:6368235] country:USA province:california city:Los angle
訪問(wèn)集合屬性
-
mutableArrayValueForKey:和mutableArrayValueForKeyPath:
它們返回一個(gè)行為類似于NSMutableArray對(duì)象的代理對(duì)象。 -
mutableSetValueForKey:和mutableSetValueForKeyPath:
它們返回一個(gè)行為類似于NSMutableSet對(duì)象的代理對(duì)象栈虚。 -
mutableOrderedSetValueForKey:和mutableOrderedSetValueForKeyPath:
它們返回一個(gè)行為類似于NSMutableOrderedSet對(duì)象的代理對(duì)象袖外。
參考文章：iOS KVC和KVO詳解
注意：以上對(duì)KVC的理解是個(gè)人學(xué)習(xí)記錄
