KVC的全稱是Key-Value Coding挠乳，翻譯成中文是 鍵值編碼馍资，鍵值編碼是由NSKeyValueCoding非正式協(xié)議啟用的一種機(jī)制救湖，對(duì)象采用該協(xié)議來(lái)間接訪問(wèn)其屬性逆瑞。既可以通過(guò)一個(gè)字符串key來(lái)訪問(wèn)某個(gè)屬性糠雨。這種間接訪問(wèn)機(jī)制補(bǔ)充了實(shí)例變量及其相關(guān)的訪問(wèn)器方法所提供的直接訪問(wèn)蛙奖。
KVC 相關(guān)API
常用方法
主要有以下四個(gè)常用的方法
- 通過(guò)
key設(shè)值/取值
//直接通過(guò)Key來(lái)取值
- (nullable id)valueForKey:(NSString *)key;
//通過(guò)Key來(lái)設(shè)值
- (void)setValue:(nullable id)value forKey:(NSString *)key;
- 通過(guò)
keyPath（即路由）設(shè)值/取值
//通過(guò)KeyPath來(lái)取值
- (nullable id)valueForKeyPath:(NSString *)keyPath;
//通過(guò)KeyPath來(lái)設(shè)值
- (void)setValue:(nullable id)value forKeyPath:(NSString *)keyPath;
其他方法
//默認(rèn)返回YES亮垫，表示如果沒(méi)有找到Set<Key>方法的話，會(huì)按照_key躺涝，_iskey厨钻，key，iskey的順序搜索成員坚嗜，設(shè)置成NO就不這樣搜索
+ (BOOL)accessInstanceVariablesDirectly;
//KVC提供屬性值正確性驗(yàn)證的API夯膀，它可以用來(lái)檢查set的值是否正確、為不正確的值做一個(gè)替換值或者拒絕設(shè)置新值并返回錯(cuò)誤原因苍蔬。
- (BOOL)validateValue:(inout id __nullable * __nonnull)ioValue forKey:(NSString *)inKey error:(out NSError **)outError;
//這是集合操作的API诱建，里面還有一系列這樣的API，如果屬性是一個(gè)NSMutableArray碟绑，那么可以用這個(gè)方法來(lái)返回俺猿。
- (NSMutableArray *)mutableArrayValueForKey:(NSString *)key;
//如果Key不存在，且KVC無(wú)法搜索到任何和Key有關(guān)的字段或者屬性格仲，則會(huì)調(diào)用這個(gè)方法押袍，默認(rèn)是拋出異常。
- (nullable id)valueForUndefinedKey:(NSString *)key;
//和上一個(gè)方法一樣凯肋，但這個(gè)方法是設(shè)值谊惭。
- (void)setValue:(nullable id)value forUndefinedKey:(NSString *)key;
//如果你在SetValue方法時(shí)面給Value傳nil，則會(huì)調(diào)用這個(gè)方法
- (void)setNilValueForKey:(NSString *)key;
//輸入一組key,返回該組key對(duì)應(yīng)的Value侮东，再轉(zhuǎn)成字典返回圈盔，用于將Model轉(zhuǎn)到字典。
- (NSDictionary<NSString *, id> *)dictionaryWithValuesForKeys:(NSArray<NSString *> *)keys;
KVC 設(shè)值 底層原理
在日常開(kāi)發(fā)中悄雅，針對(duì)對(duì)象屬性的賦值驱敲，一般有以下兩種方式
- 直接通過(guò)
setter方法賦值 - 通過(guò)KVC鍵值編碼的相關(guān)API賦值
LGPerson *person = [[LGPerson alloc] init];
// 1、一般setter 方法
person.name = @"CJL_哈哈";
// 2煤伟、KVC方式
[person setValue:@"CJL_嘻嘻" forKey:@"name"];
下面針對(duì)使用最多的KVC設(shè)值方法：setValue:forKey癌佩，來(lái)進(jìn)行其底層原理的探索木缝。
首先進(jìn)入setValue:forKey的聲明，發(fā)現(xiàn)是在Foundation框架中围辙，而Foundation框架是不開(kāi)源的我碟，有以下幾種方式可以去探索底層
- 通過(guò)
Hopper反匯編，查看偽代碼 - 通過(guò)蘋果
官方文檔 -
Github搜索是否有相關(guān)的demo
在這里姚建，我們通過(guò)Key-Value Coding Programming Guide蘋果官方文檔來(lái)研究矫俺，針對(duì)設(shè)值流程，有如下說(shuō)明
當(dāng)調(diào)用setValue:forKey:設(shè)置屬性value時(shí)掸冤，其底層的執(zhí)行流程為
-
【第一步】首先查找是否有這三種
setter方法厘托，按照查找順序?yàn)?code>set<Key>：-> _set<Key> -> setIs<Key>如果
有其中任意一個(gè)setter方法，則直接設(shè)置屬性的value（主注意：key是指成員變量名稿湿，首字符大小寫需要符合KVC的命名規(guī)范）如果都
沒(méi)有铅匹，則進(jìn)入【第二步】
-
【第二步】：如果沒(méi)有第一步中的三個(gè)簡(jiǎn)單的setter方法，則查找
accessInstanceVariablesDirectly是否返回YES饺藤，- 如果返回
YES包斑，則查找間接訪問(wèn)的實(shí)例變量進(jìn)行賦值，查找順序?yàn)椋?code>_<key> -> _is<Key> -> <key> -> is<Key>如果找到其中任意一個(gè)實(shí)例變量涕俗，則賦值
如果都沒(méi)有罗丰，則進(jìn)入【第三步】
- 如果返回
NO，則進(jìn)入【第三步】
- 如果返回
【第三步】如果setter方法 或者 實(shí)例變量都沒(méi)有找到再姑，系統(tǒng)會(huì)執(zhí)行該對(duì)象的
setValue：forUndefinedKey:方法萌抵，默認(rèn)拋出NSUndefinedKeyException類型的異常
綜上所述，KVC通過(guò) setValue:forKey: 方法設(shè)值的流程以設(shè)置LGPerson的對(duì)象person的屬性name為例元镀，如下圖所示
KVC 取值 底層原理
同樣的绍填，我們可以通過(guò)官方文檔分析KVC取值的底層原理
當(dāng)調(diào)用valueForKey：時(shí)，其底層的執(zhí)行流程如下
- 【第一步】首先查找getter方法栖疑，按照
get<Key> -> <key> -> is<Key> -> _<key>的方法順序查找沐兰，如果
找到，則進(jìn)入【第五步】如果
沒(méi)有找到蔽挠，則進(jìn)入【第二步】
- 【第二步】如果第一步中的getter方法沒(méi)有找到，KVC會(huì)查找
countOf <Key>和objectIn <Key> AtIndex :和<key> AtIndexes :如果找到
countOf <Key>和其他兩個(gè)中的一個(gè)瓜浸，則會(huì)創(chuàng)建一個(gè)響應(yīng)所有NSArray方法的集合代理對(duì)象澳淑，并返回該對(duì)象，即NSKeyValueArray插佛，是NSArray的子類杠巡。代理對(duì)象隨后將接收到的所有NSArray消息轉(zhuǎn)換為countOf<Key>，objectIn<Key> AtIndex：和<key>AtIndexes：消息的某種組合雇寇，用來(lái)創(chuàng)建鍵值編碼對(duì)象氢拥。如果原始對(duì)象還實(shí)現(xiàn)了一個(gè)名為get<Key>：range：之類的可選方法蚌铜，則代理對(duì)象也將在適當(dāng)時(shí)使用該方法（注意：方法名的命名規(guī)則要符合KVC的標(biāo)準(zhǔn)命名方法，包括方法簽名嫩海。）如果沒(méi)有找到這三個(gè)訪問(wèn)數(shù)組的冬殃，請(qǐng)繼續(xù)進(jìn)入【第三步】
- 【第三步】如果沒(méi)有找到上面的幾種方法，則會(huì)同時(shí)查找
countOf <Key>叁怪，enumeratorOf<Key>和memberOf<Key>這三個(gè)方法如果這三個(gè)方法都找到审葬，則會(huì)創(chuàng)建一個(gè)響應(yīng)
所有NSSet方法的集合代理對(duì)象，并返回該對(duì)象奕谭，此代理對(duì)象隨后將其收到的所有NSSet消息轉(zhuǎn)換為countOf<Key>涣觉，enumeratorOf<Key>和memberOf<Key>：消息的某種組合，用于創(chuàng)建它的對(duì)象如果還是沒(méi)有找到血柳，則進(jìn)入【第四步】
- 【第四步】如果還沒(méi)有找到官册，檢查類方法
InstanceVariablesDirectly是否YES，依次搜索_<key>难捌，_is<Key>膝宁，<key>或is<Key>的實(shí)例變量- 如果搜到，
直接獲取實(shí)例變量的值栖榨，進(jìn)入【第五步】
- 如果搜到，
- 【第五步】根據(jù)搜索到的
屬性值的類型昆汹，返回不同的結(jié)果如果是
對(duì)象指針，則直接返回結(jié)果如果是
NSNumber支持的標(biāo)量類型婴栽，則將其存儲(chǔ)在NSNumber實(shí)例中并返回它如果是是
NSNumber不支持的標(biāo)量類型满粗，請(qǐng)轉(zhuǎn)換為NSValue對(duì)象并返回該對(duì)象
- 【第六步】如果上面5步的方法
均失敗，系統(tǒng)會(huì)執(zhí)行該對(duì)象的valueForUndefinedKey:方法愚争，默認(rèn)拋出NSUndefinedKeyException類型的異常
綜上所述映皆，KVC通過(guò) valueForKey： 方法取值的流程以設(shè)置LGPerson的對(duì)象person的屬性name為例，如下圖所示
自定義KVC
原理：通過(guò)給NSObject添加分類CJLKVC轰枝，實(shí)現(xiàn)自定義的cjl_setValue:forKey:和cjl_valueForKey:方法捅彻，根據(jù)蘋果官方文檔提供的查找規(guī)則進(jìn)行實(shí)現(xiàn)
@interface NSObject (CJLKVC)
//設(shè)值
- (void)cjl_setValue:(nullable id)value forKey:(NSString *)key;
//取值
- (nullable id)cjl_valueForKey:(NSString *)key;
@end
自定義KVC設(shè)值
自定義KVC設(shè)置流程，主要分為以下幾個(gè)步驟：
- 1鞍陨、判斷
key非空 - 2步淹、查找
setter方法，順序是：setXXX诚撵、_setXXX缭裆、 setIsXXX - 3、判斷是否響應(yīng)
accessInstanceVariablesDirectly方法寿烟，即間接訪問(wèn)實(shí)例變量澈驼，- 返回
YES，繼續(xù)下一步設(shè)值筛武， - 如果是
NO缝其，則崩潰
- 返回
- 4挎塌、間接訪問(wèn)變量賦值（只會(huì)走一次），順序是：
_key内边、_isKey榴都、key、isKey- 4.1 定義一個(gè)收集實(shí)例變量的可變數(shù)組
- 4.2 通過(guò)
class_getInstanceVariable方法假残，獲取相應(yīng)的 ivar - 4.3 通過(guò)
object_setIvar方法缭贡，對(duì)相應(yīng)的 ivar 設(shè)置值
- 5、如果找不到相關(guān)實(shí)例變量辉懒，則拋出異常
//設(shè)值
- (void)cjl_setValue:(nullable id)value forKey:(NSString *)key{
// 1阳惹、判斷key 是否存在
if (key == nil || key.length == 0) return;
// 2、找setter方法眶俩，順序是：setXXX莹汤、_setXXX、 setIsXXX
// key 要大寫
NSString *Key = key.capitalizedString;
// key 要大寫
NSString *setKey = [NSString stringWithFormat:@"set%@:", Key];
NSString *_setKey = [NSString stringWithFormat:@"_set%@:", Key];
NSString *setIsKey = [NSString stringWithFormat:@"setIs%@:", Key];
if ([self cjl_performSelectorWithMethodName:setKey value:value]) {
NSLog(@"*************%@*************", setKey);
return;
}else if([self cjl_performSelectorWithMethodName:_setKey value:value]){
NSLog(@"*************%@*************", _setKey);
return;
}else if([self cjl_performSelectorWithMethodName:setIsKey value:value]){
NSLog(@"*************%@*************", setIsKey);
return;
}
// 3颠印、判斷是否響應(yīng)`accessInstanceVariablesDirectly`方法纲岭，即間接訪問(wèn)實(shí)例變量，返回YES线罕，繼續(xù)下一步設(shè)值止潮，如果是NO，則崩潰
if (![self.class accessInstanceVariablesDirectly]) {
@throw [NSException exceptionWithName:@"CJLUnKnownKeyException" reason:[NSString stringWithFormat:@"****[%@ valueForUndefinedKey:]: this class is not key value coding-compliant for the key name.****",self] userInfo:nil];
}
// 4钞楼、間接訪問(wèn)變量賦值喇闸，順序?yàn)椋篲key、_isKey询件、key燃乍、isKey
// 4.1 定義一個(gè)收集實(shí)例變量的可變數(shù)組
NSMutableArray *mArray = [self getIvarListName];
// _<key> _is<Key> <key> is<Key>
NSString *_key = [NSString stringWithFormat:@"_%@", key];
NSString *_isKey = [NSString stringWithFormat:@"_is%@", key];
NSString *isKey = [NSString stringWithFormat:@"is%@", key];
if ([mArray containsObject:_key]) {
// 4.2 獲取相應(yīng)的 ivar
Ivar ivar = class_getInstanceVariable([self class], _key.UTF8String);
// 4.3 對(duì)相應(yīng)的 ivar 設(shè)置值
object_setIvar(self, ivar, value);
return;
}else if ([mArray containsObject:_isKey]) {
Ivar ivar = class_getInstanceVariable([self class], _isKey.UTF8String);
object_setIvar(self, ivar, value);
return;
}else if ([mArray containsObject:key]) {
Ivar ivar = class_getInstanceVariable([self class], key.UTF8String);
object_setIvar(self, ivar, value);
return;
}else if ([mArray containsObject:isKey]) {
Ivar ivar = class_getInstanceVariable([self class], isKey.UTF8String);
object_setIvar(self, ivar, value);
return;
}
// 5、如果找不到則拋出異常
@throw [NSException exceptionWithName:@"CJLUnknownKeyException" reason:[NSString stringWithFormat:@"****[%@ %@]: this class is not key value coding-compliant for the key name.****",self,NSStringFromSelector(_cmd)] userInfo:nil];
}
自定義KVC取值
取值的自定義代碼如下宛琅，分為以下幾步
1刻蟹、判斷
key非空2、查找相應(yīng)方法嘿辟，順序是：
get<Key>舆瘪、 <key>、 countOf<Key>红伦、 objectIn<Key>AtIndex-
3介陶、判斷是否能夠直接賦值實(shí)例變量，即判斷是否響應(yīng)
accessInstanceVariablesDirectly方法色建，間接訪問(wèn)實(shí)例變量，返回
YES舌缤，繼續(xù)下一步取值如果是
NO箕戳，則崩潰
-
4、間接訪問(wèn)實(shí)例變量，順序是
：_<key> _is<Key> <key> is<Key>4.1 定義一個(gè)收集實(shí)例變量的
可變數(shù)組4.2 通過(guò)
class_getInstanceVariable方法瓤的，獲取相應(yīng)的 ivar4.3 通過(guò)
object_getIvar方法呐芥，返回相應(yīng)的 ivar 的值
//取值
- (nullable id)cjl_valueForKey:(NSString *)key{
// 1、判斷非空
if (key == nil || key.length == 0) {
return nil;
}
// 2壮虫、找到相關(guān)方法：get<Key> <key> countOf<Key> objectIn<Key>AtIndex
// key 要大寫
NSString *Key = key.capitalizedString;
// 拼接方法
NSString *getKey = [NSString stringWithFormat:@"get%@",Key];
NSString *countOfKey = [NSString stringWithFormat:@"countOf%@",Key];
NSString *objectInKeyAtIndex = [NSString stringWithFormat:@"objectIn%@AtIndex:",Key];
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Warc-performSelector-leaks"
if ([self respondsToSelector:NSSelectorFromString(getKey)]) {
return [self performSelector:NSSelectorFromString(getKey)];
}else if ([self respondsToSelector:NSSelectorFromString(key)]){
return [self performSelector:NSSelectorFromString(key)];
}
//集合類型
else if ([self respondsToSelector:NSSelectorFromString(countOfKey)]){
if ([self respondsToSelector:NSSelectorFromString(objectInKeyAtIndex)]) {
int num = (int)[self performSelector:NSSelectorFromString(countOfKey)];
NSMutableArray *mArray = [NSMutableArray arrayWithCapacity:1];
for (int i = 0; i<num-1; i++) {
num = (int)[self performSelector:NSSelectorFromString(countOfKey)];
}
for (int j = 0; j<num; j++) {
id objc = [self performSelector:NSSelectorFromString(objectInKeyAtIndex) withObject:@(num)];
[mArray addObject:objc];
}
return mArray;
}
}
#pragma clang diagnostic pop
// 3澳厢、判斷是否響應(yīng)`accessInstanceVariablesDirectly`方法，即間接訪問(wèn)實(shí)例變量囚似，返回YES剩拢，繼續(xù)下一步設(shè)值，如果是NO饶唤，則崩潰
if (![self.class accessInstanceVariablesDirectly]) {
@throw [NSException exceptionWithName:@"CJLUnKnownKeyException" reason:[NSString stringWithFormat:@"****[%@ valueForUndefinedKey:]: this class is not key value coding-compliant for the key name.****",self] userInfo:nil];
}
// 4.找相關(guān)實(shí)例變量進(jìn)行賦值徐伐，順序?yàn)椋篲<key>、 _is<Key>募狂、 <key>办素、 is<Key>
// 4.1 定義一個(gè)收集實(shí)例變量的可變數(shù)組
NSMutableArray *mArray = [self getIvarListName];
// 例如：_name -> _isName -> name -> isName
NSString *_key = [NSString stringWithFormat:@"_%@",key];
NSString *_isKey = [NSString stringWithFormat:@"_is%@",Key];
NSString *isKey = [NSString stringWithFormat:@"is%@",Key];
if ([mArray containsObject:_key]) {
Ivar ivar = class_getInstanceVariable([self class], _key.UTF8String);
return object_getIvar(self, ivar);;
}else if ([mArray containsObject:_isKey]) {
Ivar ivar = class_getInstanceVariable([self class], _isKey.UTF8String);
return object_getIvar(self, ivar);;
}else if ([mArray containsObject:key]) {
Ivar ivar = class_getInstanceVariable([self class], key.UTF8String);
return object_getIvar(self, ivar);;
}else if ([mArray containsObject:isKey]) {
Ivar ivar = class_getInstanceVariable([self class], isKey.UTF8String);
return object_getIvar(self, ivar);;
}
return @"";
return @"";
}
使用路由訪問(wèn)，即keyPath
在日常開(kāi)發(fā)中祸穷，一個(gè)類的成員變量有可能是自定義類或者其他的復(fù)雜數(shù)據(jù)類型性穿，一般的操作是，我們可以先通過(guò)KVC獲取該屬性雷滚，然后再通過(guò)KVC獲取自定義類的屬性需曾，就是比較麻煩，還有另一種比較簡(jiǎn)便的方法揭措，就是使用KeyPath即路由胯舷，涉及以下兩個(gè)方法：setValue:forKeyPath: 和 valueForKeyPath:
//通過(guò)KeyPath來(lái)取值
- (nullable id)valueForKeyPath:(NSString *)keyPath;
//通過(guò)KeyPath來(lái)設(shè)值
- (void)setValue:(nullable id)value forKeyPath:(NSString *)keyPath;
參考如下的案例
//CJLPerson類
@interface CJLPerson : NSObject
@property (nonatomic, copy) NSString *age;
@property (nonatomic, strong) CJLStudent *student;
@end
//CJLStudent類
@interface CJLStudent : NSObject
@property (nonatomic, copy) NSString *name;
@end
int main(int argc, const char * argv[]) {
@autoreleasepool {
CJLPerson *person = [[CJLPerson alloc] init];
CJLStudent *student = [CJLStudent alloc];
student.name = @"CJL";
person.student = student;
//根據(jù)kvc - keyPath路由修改student的subject屬性的值
[person setValue:@"嘻嘻" forKeyPath:@"student.name"];
NSLog(@"%@",[person valueForKeyPath:@"student.name"]);
}
return 0;
}
//*************打印結(jié)果*************
2020-10-27 09:55:08.512833+0800 001-KVC簡(jiǎn)介[58089:6301894] 改變前：CJL
2020-10-27 09:55:08.512929+0800 001-KVC簡(jiǎn)介[58089:6301894] 改變后：嘻嘻
KVC 使用場(chǎng)景
1、動(dòng)態(tài)設(shè)值和取值
常用的可以通過(guò)
setValue:forKey:和valueForKey:也可以通過(guò)
路由的方式setValue:forKeyPath:和valueForKeyPath:
2绊含、通過(guò)KVC訪問(wèn)和修改私有變量
在日常開(kāi)發(fā)中桑嘶，對(duì)于類的私有屬性，在外部定義的對(duì)象躬充，是無(wú)法直接訪問(wèn)私有屬性的逃顶，但是對(duì)于KVC而言，一個(gè)對(duì)象沒(méi)有自己的隱私充甚，所以可以通過(guò)KVC修改和訪問(wèn)任何私有屬性
3以政、多值操作（model和字典互轉(zhuǎn)）
model和字典的轉(zhuǎn)換可以通過(guò)下面兩個(gè)KVC的API實(shí)現(xiàn)
//字典轉(zhuǎn)模型
- (void)setValuesForKeysWithDictionary:(NSDictionary<NSString *, id> *)keyedValues;
//模型轉(zhuǎn)字典
- (NSDictionary<NSString *, id> *)dictionaryWithValuesForKeys:(NSArray<NSString *> *)keys;
4、修改一些系統(tǒng)空間的內(nèi)部屬性
在日常開(kāi)發(fā)中伴找，我們知道盈蛮，很多UI控件都是在其內(nèi)部由多個(gè)UI空間組合而成，這些內(nèi)部控件蘋果并沒(méi)有提供訪問(wèn)的API技矮，但是使用KVC可以解決這個(gè)問(wèn)題抖誉，常用的就是自定義tabbar殊轴、個(gè)性化UITextField中的placeHolderText
5、用KVC實(shí)現(xiàn)高階消息傳遞
在對(duì)容器類使用KVC時(shí)袒炉，valueForKey:將會(huì)被傳遞給容器中的每一個(gè)對(duì)象旁理，而不是對(duì)容器本身進(jìn)行操作，結(jié)果會(huì)被添加到返回的容器中我磁，這樣孽文，可以很方便的操作集合 來(lái)返回 另一個(gè)集合
如下所示
//KVC實(shí)現(xiàn)高階消息傳遞
- (void)transmitMsg{
NSArray *arrStr = @[@"english", @"franch", @"chinese"];
NSArray *arrCapStr = [arrStr valueForKey:@"capitalizedString"];
for (NSString *str in arrCapStr) {
NSLog(@"%@", str);
}
NSArray *arrCapStrLength = [arrCapStr valueForKeyPath:@"capitalizedString.length"];
for (NSNumber *length in arrCapStrLength) {
NSLog(@"%ld", (long)length.integerValue);
}
}
//********打印結(jié)果********
2020-10-27 11:33:43.377672+0800 CJLCustom[60035:6380757] English
2020-10-27 11:33:43.377773+0800 CJLCustom[60035:6380757] Franch
2020-10-27 11:33:43.377860+0800 CJLCustom[60035:6380757] Chinese
2020-10-27 11:33:43.378233+0800 CJLCustom[60035:6380757] 7
2020-10-27 11:33:43.378327+0800 CJLCustom[60035:6380757] 6
2020-10-27 11:33:43.378417+0800 CJLCustom[60035:6380757] 7
附錄
自定義KVC的完整代碼見(jiàn)Github-CustomKVC_KVO，喜歡的可以點(diǎn)個(gè)?
