登录
iOS底层原理：KVC分析
KVC是什么
KVC全称**Key-Value Coding，俗称键值编码。它是一种通过字符串描述符而不是通过调用访问方法或者直接使用实例变量的非直接的访问对象属性的机制。在iOS中，NSObject、NSArray、NSDictionary**等类使用这种机制并采用分类的形式为自身拓展了KVC的能力。常用的Api如下：
- (void)setValue:(nullable id)value forKey:(NSString *)key;
- (nullable id)valueForKey:(NSString *)key;
点方法进去：
我们可以看到，它是在 Foundation 框架下，关于**NSObject、NSArray、NSDictionary等的一个NSKeyValueCoding**的分类。其实这些内容在苹果的官方文档中解释的很清楚，小伙伴们可以自行查阅。Key-Value Coding Programming Guide
KVC设值和取值
KVC的使用我们都不陌生，那么KVC在内部操作时是以怎样的顺序来寻找key的呢？接下来我们就来探索一下。
取值 valueForKey:
先看下苹果官方文档的Setter步骤：
国际惯例，翻译一下：
-
在实例中搜索找到的第一个名称为
get<Key>、<key>、is<Key>、或的访问器方法_<key>，按该顺序。如果找到，则调用它并使用结果继续执行步骤 5。否则继续下一步。 -
如果没有找到简单的访问器方法，则在实例中搜索名称与模式
countOf<Key>和objectIn<Key>AtIndex:（对应于NSArray类定义的原始方法）和<key>AtIndexes:（对应于NSArray方法objectsAtIndexes:）的方法。 如果找到这些中的第一个和其他两个中的至少一个，则创建一个响应所有NSArray方法的集合代理对象并返回该对象。否则，继续执行步骤 3。 代理对象随后将任何NSArray接收到的一些组合的消息countOf<Key>，objectIn<Key>AtIndex:和<key>AtIndexes:消息给键-值编码创建它兼容的对象。如果原始对象还实现了一个可选的方法，其名称类似于get<Key>:range:，则代理对象也会在适当的时候使用它。实际上，与键值编码兼容的对象一起工作的代理对象允许底层属性表现得好像它是NSArray，即使它不是。 -
如果没有找到简单的访问方法或阵列访问方法组，寻找一个三重的方法命名
countOf<Key>，enumeratorOf<Key>和memberOf<Key>:（对应于由所定义的原始的方法NSSet类）。 如果找到所有三个方法，则创建一个响应所有NSSet方法的集合代理对象并返回该对象。否则，继续执行步骤 4。 此代理对象随后将任何NSSet接收到的一些组合信息countOf<Key>，enumeratorOf<Key>和memberOf<Key>:消息以创建它的对象。实际上，与键值编码兼容的对象一起工作的代理对象允许底层属性表现得好像它是NSSet，即使它不是。 -
如果发现收集的访问方法没有简单的存取方法或者组，如果接收器的类方法
accessInstanceVariablesDirectly返回YES，搜索名为实例变量_<key>，_is<Key>，<key>，或者is<Key>，按照这个顺序。如果找到，直接获取实例变量的值并进行步骤5，否则进行步骤6。 -
如果检索到的属性值是一个对象指针，只需返回结果即可。 如果该值是 支持的标量类型
NSNumber，则将其存储在一个NSNumber实例中并返回该实例。 如果结果是NSNumber不支持的标量类型，则转换为NSValue对象并返回。 -
如果所有其他方法都失败，请调用
valueForUndefinedKey:，默认情况下，这会引发异常，但 的子类NSObject可能会提供特定于键的行为。
这里推荐一个翻译工具DeepL，个人觉得还是挺准挺好用的。好了，废话不多说，我们顺着这个步骤来验证一下。
首先按照文档中的顺序**get<Key>** -> <key> -> is<Key> -> _<key> 进行调试验证即可，如图：
如果以上方法都没有，且**accessInstanceVariablesDirectly为YES时，则按照_<key>** -> _is<Key> -> <key> -> **is<Key>**取值，如图：
以上取值顺序依次注释代码进行验证即可，如果都没有的话，就会调用**valueForUndefinedKey:**这个方法，最终抛出异常。
设值 setValue:forKey:
先看下苹果官方文档的**Setter**步骤：
翻译如下：
-
按顺序寻找名为
set<Key>:或_set<Key>的第一个访问器。如果找到了，就用输入值（或根据需要解开的值）来调用它，然后完成。 -
如果没有找到简单的访问器，并且如果类方法
accessInstanceVariablesDirectly返回YES，那么寻找一个名称为_<key>、_is<Key>、<key>或is<Key>的实例变量，依次进行。如果找到了，直接用输入值（或解开的值）设置变量，然后完成。 -
一旦发现没有访问器或实例变量，就调用
setValue:forUndefinedKey:。这默认会引发一个异常，但NSObject的子类可以提供特定于键的行为。
首先来验证：set<Key>: ->_set<Key>:
从上面getter取值顺序我们可以看到有**get<Key>** -> <key> -> is<Key> -> _<key>四个方法，而此处的setter只有set<Key>: → _set<Key>:两个方法。显然，对setter的第一步骤有所怀疑，那就探索一下，实现setIs<Key>和_setIs<Key>，如图：
经过代码验证，这里确实会走**setIs<Key>:，而_setIs<Key>:**没有调用。所以苹果文档这里的描述并不全面。
当**set<Key>:** -> _set<Key>: ->setIs<Key>都没有实现的时候，
并且当accessInstanceVariablesDirectly设置为YES时 获取实例变量的顺序为顺序查找名称为_<key> -> _is<Key> -> <key> -> is<Key>，如下图：
根据上面的流程，梳理一张**setValue:forKey:**的流程图：
KVC自定义实现
清楚了KVC的设值和取值流程，我们就可以自定义一下它的实现过程，代码如下：
- (void)lg_setValue:(nullable id)value forKey:(NSString *)key{
// KVC 自定义
// 1: 判断什么 key
if (key == nil || key.length == 0) {
return;
}
// 2: setter set<Key>: or _set<Key>,
// key 要大写
NSString *Key = key.capitalizedString;
// 拼接方法
NSString *setKey = [NSString stringWithFormat:@"set%@:",Key];
NSString *_setKey = [NSString stringWithFormat:@"_set%@:",Key];
NSString *setIsKey = [NSString stringWithFormat:@"setIs%@:",Key];
if ([self lg_performSelectorWithMethodName:setKey value:value]) {
NSLog(@"*********%@**********",setKey);
return;
}else if ([self lg_performSelectorWithMethodName:_setKey value:value]) {
NSLog(@"*********%@**********",_setKey);
return;
}else if ([self lg_performSelectorWithMethodName:setIsKey value:value]) {
NSLog(@"*********%@**********",setIsKey);
return;
}
// 3: 判断是否响应 accessInstanceVariablesDirectly 返回YES NO 奔溃
// 3:判断是否能够直接赋值实例变量
if (![self.class accessInstanceVariablesDirectly] ) {
@throw [NSException exceptionWithName:@"LGUnknownKeyException" reason:[NSString stringWithFormat:@"****[%@ valueForUndefinedKey:]: this class is not key value coding-compliant for the key name.****",self] userInfo:nil];
}
// 4: 间接变量
// 获取 ivar -> 遍历 containsObjct -
// 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:@"LGUnknownKeyException" reason:[NSString stringWithFormat:@"****[%@ %@]: this class is not key value coding-compliant for the key name.****",self,NSStringFromSelector(_cmd)] userInfo:nil];
}
- (nullable id)lg_valueForKey:(NSString *)key{
// 1:刷选key 判断非空
if (key == nil || key.length == 0) {
return nil;
}
// 2:找到相关方法 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:判断是否能够直接赋值实例变量
if (![self.class accessInstanceVariablesDirectly] ) {
@throw [NSException exceptionWithName:@"LGUnknownKeyException" reason:[NSString stringWithFormat:@"****[%@ valueForUndefinedKey:]: this class is not key value coding-compliant for the key name.****",self] userInfo:nil];
}
// 4.找相关实例变量进行赋值
// 4.1 定义一个收集实例变量的可变数组
NSMutableArray *mArray = [self getIvarListName];
// _<key> _is<Key> <key> is<Key>
// _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 @"";
}
#pragma mark - 相关方法
- (BOOL)lg_performSelectorWithMethodName:(NSString *)methodName value:(id)value{
if ([self respondsToSelector:NSSelectorFromString(methodName)]) {
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Warc-performSelector-leaks"
[self performSelector:NSSelectorFromString(methodName) withObject:value];
#pragma clang diagnostic pop
return YES;
}
return NO;
}
- (id)performSelectorWithMethodName:(NSString *)methodName{
if ([self respondsToSelector:NSSelectorFromString(methodName)]) {
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Warc-performSelector-leaks"
return [self performSelector:NSSelectorFromString(methodName) ];
#pragma clang diagnostic pop
}
return nil;
}
- (NSMutableArray *)getIvarListName{
NSMutableArray *mArray = [NSMutableArray arrayWithCapacity:1];
unsigned int count = 0;
Ivar *ivars = class_copyIvarList([self class], &count);
for (int i = 0; i<count; i++) {
Ivar ivar = ivars[i];
const char *ivarNameChar = ivar_getName(ivar);
NSString *ivarName = [NSString stringWithUTF8String:ivarNameChar];
NSLog(@"ivarName == %@",ivarName);
[mArray addObject:ivarName];
}
free(ivars);
return mArray;
}
