[OC学习笔记]KVC原理
Posted Billy Miracle
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了[OC学习笔记]KVC原理相关的知识，希望对你有一定的参考价值。
KVC的全称是Key-Value Coding，翻译成中文是键值编码，键值编码是由NSKeyValueCoding非正式协议启用的一种机制，对象采用该协议来间接访问其属性。可以通过一个字符串key来访问某个属性。这种间接访问机制补充了实例变量及其相关的访问器方法所提供的直接访问。关于这部分内容，我之前有过简单介绍：[iOS开发]KVC。
KVC介绍
键值编码是由 NSKeyValueCoding 非正式协议启用的一种机制，对象采用该协议来提供对其属性的间接访问。当对象符合键值编码时，其属性可通过简洁、统一的消息传递接口通过字符串参数进行寻址。此间接访问机制补充了实例变量及其关联的访问器方法提供的直接访问。
通常使用访问器方法来访问对象的属性。get 访问器（或 getter）返回属性的值。set 访问器（或 setter）设置属性的值。在 Objective-C 中，您还可以直接访问属性的基础实例变量。以这些方式中的任何一种访问对象属性都很简单，但需要调用特定于属性的方法或变量名称。随着属性列表的增长或更改，访问这些属性的代码也必须如此。相反，符合键值编码的对象提供了一个简单的消息传递接口，该接口在其所有属性中都是一致的。
键值编码是许多其他 Cocoa 技术的基础，例如键值观察、Cocoa 绑定、Core Data 和 AppleScript-ability。在某些情况下，键值编码还有助于简化代码。
KVC相关API
常用方法
通过key设值/取值
//直接通过Key来取值
- (nullable id)valueForKey:(NSString *)key;
//通过Key来设值
- (void)setValue:(nullable id)value forKey:(NSString *)key;
通过keyPath设值/取值
//通过KeyPath来取值
- (nullable id)valueForKeyPath:(NSString *)keyPath;
//通过KeyPath来设值
- (void)setValue:(nullable id)value forKeyPath:(NSString *)keyPath;
其他方法
// 默认返回YES，表示如果没有找到Set<Key>方法的话，会按照_key，_iskey，key，iskey的顺序搜索成员，设置成NO就不这样搜索
+ (BOOL)accessInstanceVariablesDirectly;
// KVC提供属性值正确性验证的API，它可以用来检查set的值是否正确、为不正确的值做一个替换值或者拒绝设置新值并返回错误原因。
- (BOOL)validateValue:(inout id __nullable * __nonnull)ioValue forKey:(NSString *)inKey error:(out NSError **)outError;
// 这是集合操作的API，里面还有一系列这样的API，如果属性是一个NSMutableArray，那么可以用这个方法来返回。
- (NSMutableArray *)mutableArrayValueForKey:(NSString *)key;
// 如果Key不存在，且KVC无法搜索到任何和Key有关的字段或者属性，则会调用这个方法，默认是抛出异常。
- (nullable id)valueForUndefinedKey:(NSString *)key;
// 和上一个方法一样，但这个方法是设值。
- (void)setValue:(nullable id)value forUndefinedKey:(NSString *)key;
// 如果你在SetValue方法时面给Value传nil，则会调用这个方法
- (void)setNilValueForKey:(NSString *)key;
// 使用字典为Model赋值
- (void)setValuesForKeysWithDictionary:(NSDictionary<NSString *, id> *)keyedValues;
// 输入一组key,返回该组key对应的Value，再转成字典返回，用于将Model转到字典。
- (NSDictionary<NSString *, id> *)dictionaryWithValuesForKeys:(NSArray<NSString *> *)keys;
KVC底层原理探索
KVC设值底层原理
在日常开发中，针对对象属性的赋值，一般有以下两种方式：
- 直接通过
setter方法赋值 - 通过KVC键值编码的相关API赋值
Person *me = [[Person alloc] init];
// setter
me.name = @"Billy";
NSLog(@"%@", me.name);
// KVC
[me setValue:@"BILLY" forKey:@"name"];
NSLog(@"%@", [me valueForKey:@"name"]);
下面针对较常使用的KVC设值方法：setValue:forKey，来进行其底层原理的探索。点进其声明，发现它在Foundation框架里，而Foundation框架是不开源的。像前面文章里提到的，可以通过Hopper反汇编查看，但我没看懂（hhh），接下来我们就通过阅读苹果官方文档来学习：Key-Value Coding Programming Guide。
针对设值流程，当调用setValue:forKey:设置属性value时，其底层的执行流程为：
- 【第一步】首先查找是否有这三种
setter方法，按照查找顺序为set<Key>:->_set<Key>->setIs<Key>如果有其中任意一个setter方法，则直接设置属性的value（主注意：key是指成员变量名，首字符大小写需要符合KVC的命名规范）
如果都没有，则进入【第二步】 - 【第二步】：如果没有第一步中的三个简单的
setter方法，则查找accessInstanceVariablesDirectly是否返回YES如果返回YES，则查找间接访问的
成员变量进行赋值，查找顺序为：_<key>->_is<Key>-><key>->is<Key>
如果找到其中任意一个实例变量，则赋值
如果都没有，则进入【第三步】
如果返回NO，则进入【第三步】 - 【第三步】如果
setter方法 或者 实例变量都没有找到，系统会执行该对象的setValue:forUndefinedKey:方法，默认抛出NSUndefinedKeyException类型的异常
我们可以试着验证一下，先来验证一下第一步：
[me setValue:@"BILLY" forKey:@"name"];
可以发现，优先进入set<Key>:，
再者是_set<Key>，
最后是setIs<Key>。
第一步验证完毕。注意第二步，官方文档写的是instance variable，实际上应该是成员变量。我们试验一下。
@interface Person : NSObject
NSString *_name;
NSString *_isName;
NSString *name;
NSString *isName;
输出结果：
删除_name成员变量，输出：
继续删除_isName成员变量，输出：
继续删除name成员变量，输出：
接下来验证第三步，重写setValue:forUndefinedKey:方法：
- (void)setValue:(id)value forUndefinedKey:(NSString *)key
NSLog(@"setValue:forUndefinedKey:");
打印输出：
在网路上看到一张图片非常好：
KVC取值底层原理
同样的，我们可以通过官方文档分析KVC取值的底层原理
当调用valueForKey:时，其底层的执行流程如下
- 【第一步】首先查找
getter方法，按照get<Key>-><key>->is<Key>->_<key>的方法顺序查找如果找到，则进入【第五步】
如果没有找到，则进入【第二步】 - 【第二步】如果第一步中的
getter方法没有找到，KVC会查找countOf<Key>和objectIn<Key>AtIndex:和<key>AtIndexes:如果找到
countOf<Key>和其他两个中的一个，则会创建一个响应所有NSArray方法的集合代理对象，并返回该对象，即NSKeyValueArray，是NSArray的子类。代理对象随后将接收到的所有NSArray消息转换为countOf<Key>，objectIn<Key>AtIndex:和<key>AtIndexes:消息的某种组合，用来创建键值编码对象。如果原始对象还实现了一个名为get<Key>:range:之类的可选方法，则代理对象也将在适当时使用该方法（注意：方法名的命名规则要符合KVC的标准命名方法，包括方法签名。）
如果没有找到这三个访问数组的，请继续进入【第三步】 - 【第三步】如果没有找到上面的几种方法，则会同时查找
countOf<Key>，enumeratorOf<Key>和memberOf<Key>这三个方法如果这三个方法都找到，则会创建一个响应所有
NSSet方法的集合代理对象，并返回该对象，此代理对象随后将其收到的所有NSSet消息转换为countOf<Key>，enumeratorOf<Key>和memberOf<Key>:消息的某种组合，用于创建它的对象
如果还是没有找到，则进入【第四步】 - 【第四步】如果还没有找到，检查类方法
InstanceVariablesDirectly是否YES，依次搜索_<key>，_is<Key>，<key>或is<Key>的实例变量如果搜到，直接获取实例变量的值，进入【第五步】
- 【第五步】根据搜索到的属性值的类型，返回不同的结果
如果是对象指针，则直接返回结果
如果是NSNumber支持的标量类型，则将其存储在NSNumber实例中并返回它
如果是是NSNumber不支持的标量类型，请转换为NSValue对象并返回该对象 - 【第六步】如果上面5步的方法均失败，系统会执行该对象的
valueForUndefinedKey:方法，默认抛出NSUndefinedKeyException类型的异常
接下来试验一下：
- (NSString *)getName
NSLog(@"getName");
return nil;
- (NSString *)name
NSLog(@"name");
return nil;
- (NSString *)isName
NSLog(@"isName");
return nil;
- (NSString *)_name
NSLog(@"_name");
return nil;
输出：
注释掉，继续看：
第一步验证完了，接下来看第二步，随便实现一下我们也同时试着查看对应的类型：
- (int)countOfName
return 3;
- (id)objectInNameAtIndex:(NSUInteger)index
return [NSString stringWithFormat:@"name%ld", index];
- (int)countOfName
return 3;
- (NSArray *)nameAtIndexes:(NSIndexSet *)indexes
NSArray *array = @[@"name1", @"name2", @"name3"];
return [array objectsAtIndexes:indexes];
接着试第三步：
- (int)countOfName
return 3;
- (NSEnumerator *)enumeratorOfName
NSSet *set = [[NSSet alloc] initWithArray:@[@"name1", @"name2", @"name3"]];
return set.objectEnumerator;
- (id)memberOfName:(NSString *)name
NSSet *set = [[NSSet alloc] initWithArray:@[@"name1", @"name2", @"name3"]];
return [set member:name];
输出结果：
可以发现，实现的方法不同，KVC帮我们“取到”东西类型也不同，因为取到的这个实际上是它为我们创建的。接下来看四五步可以轻易验证：
NSString *_name;
NSNumber *_isName;
NSInteger name;
NSString *isName;
再用一下在网路上看到的图片来总结过程：
自定义KVC
原理：通过给NSObject添加分类MYKVC，实现自定义的billy_setValue:forKey:和billy_valueForKey:方法，仿照苹果官方文档提供的查找规则进行实现。
@interface NSObject (MYKVC)
- (void)billy_setValue:(nullable id)value forKey:(NSString *)key;
- (nullable id)billy_valueForKey:(NSString *)key;
@end
自定义KVC设值
自定义KVC设置流程，主要分为以下几个步骤：
- 判断
key非空 - 查找
setter方法，顺序是：setXXX、_setXXX、setIsXXX - 判断是否响应
accessInstanceVariablesDirectly方法，即间接访问实例变量
(1) 返回YES，继续下一步设值
(2) 如果是NO，则崩溃 - 间接访问变量赋值（只会走一次），顺序是：
_key、_isKey、key、isKey
(1) 定义一个收集实例变量的可变数组
(2) 通过class_getInstanceVariable方法，获取相应的ivar
(3) 通过object_setIvar方法，对相应的ivar设置值 - 如果找不到相关实例变量，则抛出异常
下面给出代码：
- (void)billy_setValue:(id)value forKey:(NSString *)key
//1、判断key 是否存在
if (key == nil || key.length == 0) return;
//2、找setter方法，顺序是：setXXX、_setXXX、 setIsXXX
// key 首字母要大写 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 billy_performSelectorWithMethodName:setKey value:value])
NSLog(@"My KVC goes: %@", setKey);
return;
else if ([self billy_performSelectorWithMethodName:_setKey value:value])
NSLog(@"My KVC goes: %@", _setKey);
return;
else if ([self billy_performSelectorWithMethodName:setIsKey value:value])
NSLog(@"My KVC goes: %@", setIsKey);
return;
//3、判断是否响应`accessInstanceVariablesDirectly`方法，即间接访问实例变量，返回YES，继续下一步设值，如果是NO，则崩溃
if (![self.class accessInstanceVariablesDirectly])
@throw [NSException exceptionWithName:@"BillyUnKnownKeyException" reason:[NSString stringWithFormat:@"****[%@ valueForUndefinedKey:]: this class is not key value coding-compliant for the key name.****",self] userInfo:nil];
//4、间接访问变量赋值，顺序为：_key、_isKey、key、isKey
// 4.1 定义一个收集实例变量的可变数组
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 获取相应的 ivar
Ivar ivar = class_getInstanceVariable([self class], _key.UTF8String);
// 4.3 对相应的 ivar 设置值
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:@"BillyUnknownKeyException" reason:[NSString stringWithFormat:@"****[%@ %@]: this class is not key value coding-compliant for the key name.****",self,NSStringFromSelector(_cmd)] userInfo:nil];
- (BOOL)billy_performSelectorWithMethodName:(NSString *)name value:(nullable id)value
SEL selecter = NSSelectorFromString(name);
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Warc-performSelector-leaks"
if ([self respondsToSelector:selecter])
[self performSelector:selecter withObject:value];
return YES;
else
return NO;
#pragma clang diagnostic pop
- (NSMutableArray *)getIvarListName
unsigned int outCount = 0;
Ivar *ivars = class_copyIvarList([self class], &outCount);
NSMutableArray *array = [NSMutableArray array];
for (int i = 0; i < outCount; i++)
Ivar ivar = ivars[i];
//获取实例变量名
const char*cName = ivar_getName(ivar);
NSString *ivarName = [NSString stringWithUTF8String:cName];
[array addObject:ivarName];
return array;
自定义KVC取值
自定义KVC取值分为以下几步
- 判断
key非空 - 查找相应方法，顺序是：
get<Key>、<key>、countOf<Key>、objectIn<Key>AtIndex - 判断是否能够直接赋值实例变量，即判断是否响应
accessInstanceVariablesDirectly方法，间接访问实例变量，
(1) 返回YES，继续下一步取值
(2) 如果是NO，则崩溃 - 间接访问实例变量，顺序是：
_<key>、_is<Key>、<key>、is<Key>
(1) 定义一个收集实例变量的可变数组
(2) 通过class_getInstanceVariable方法，获取相应的ivar
(3) 通过object_getIvar方法，返回相应的ivar的值
- (nullable id)billy_valueForKey:(NSString *)key
// 1、判断非空
if (key == nil || key.length == 0)
return nil;
// 2、找到相关方法：get<Key> <key> countOf<Key> objectIn<Key>AtIndex
// key 首字母要大写 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 = (NSInteger)[self performSelector:NSSelectorFromString(countOfKey)];
NSMutableArray *mArray = [NSMutableArray arrayWithCapacity:1];
for (int i = 0; i < num - 1; i++)
num = (NSInteger)[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、判断是否响应`accessInstanceVariablesDirectly`方法，即间接访问实例变量，返回YES，继续下一步设值，如果是NO，则崩溃
if (![以上是关于[OC学习笔记]KVC原理的主要内容，如果未能解决你的问题，请参考以下文章