KVC分析

1.jpeg

官方解释什么是KVC

37.png

翻译过来就是：

键值编码(Key-value coding)是由 NSKeyValueCoding 非正式协议启用的一种机制，对象采用该机制来提供对其属性的间接访问。当对象符合键值编码时，其属性可通过字符串参数通过简洁、统一的消息传递接口进行寻址。这种间接访问机制补充了实例变量及其相关访问器方法提供的直接访问。

您通常使用访问器方法来访问对象的属性。 get访问器（或 getter）返回属性的值。 set访问器（或setter）设置属性的值。在 Objective-C 中，您还可以直接访问属性的底层实例变量。以任何这些方式访问对象属性都很简单，但需要调用特定于属性的方法或变量名称。随着属性列表的增长或变化，访问这些属性的代码也必须如此。相比之下，符合键值编码的对象提供了一个简单的消息传递接口，该接口在其所有属性中保持一致。

键值编码(Key-value coding)是一个基本概念，它是许多其他 Cocoa 技术的基础，例如键值观察、Cocoa 绑定、核心数据和 AppleScript 能力。在某些情况下，键值编码还有助于简化您的代码。

对于KVC的使用相信大家都是非常熟悉的了，所以那些怎么使用设值取值啥的就不讲了。这里就简单的探索下他的原理。

准备工作：

我们先创建一个工程，然后创建一个ZYPerson类文件继承于NSObject。并且创建一个属性name。然后在viewController.m里引入这个类，并且初始化一个person对象对其调用KVC的Setter方法设置属性name 的值并且调用KVC的Getter方法取值。

1.png 2.png 3.png

Setter\Getter方法:

一：setter方法原理。

我们直接去苹果的开发者网站查看下关于KVC的文档

4.png

从上面的官方文档我们可以得知，setValue:forKey:的setter方法原来也是有查找顺序的。
1，是按照set<Key>：然后是_set<Key>。也就是说如果有set<Key>存在就不会走后面的_set<Key>而是直接完成。
2，如果未找到简单访问器，并且类方法 accessInstanceVariablesDirectly返回 YES，就会去查找_<key>、_is<Key>、<key>或is<Key> 的实例变量。如果找到，直接使用输入值（或解包值）设置变量并完成。
3，在未找到访问器或实例变量时，调用 setValue:forUndefinedKey:。默认情况下，会引发异常，但 NSObject 的子类可能会提供特定于键的一些操作。整体来讲就是setter方法也是有顺序来执行的。

下面我们来验证下：

验证第1点：

按照第一点说的顺序，我们来验证下set<Key>：和_set<Key>`

6.png

再次修改：

7.png

第一点验证是符合文档描述的，确实当我们对属性name实现setName方法就会先走这个方法并且发现keyValue设置值已经失效了。如果没有setName却有_setName方法就会走后者并且KeyValue设值也失效。与文档第一点相符。

验证第2点：

8.png 9.png

修改一下验证第二优先级：

8.png 9.png

修改一下验证第三优先级：

10.png 11.png

再次修改测试最后一个能否赋值

12.png 13.png

**所以文档中第二的设值优先级确实是_<key>高于_is<Key>高于<key>高于is<Key> **

验证第3点：

14.png 15.png 16.png

当keyValue设置的属性根本不存在任何一种上面的情况时候就会走方法setValue:forUndefinedKey:

拓展：

我们效法第1点的对isName和_isName进行添加setter方法实现。看看影响：

1，isName 方法实现Setter方法：

17.png 18.png 19.png

2，_isName 方法实现Setter方法：

20.png

从以上拓展内容得知当isName实现自己的setter方法就不会赋值成功，而_isName则不会。

二：getter方法原理。

5.png

这段关于KeyValue取值的文档主要是以下意思：

1，在实例中按get<Key>、<key>、is<Key> 或_<key>该顺序搜索找到的第一个访问器方法。如果找到，则调用它并使用结果继续执行步骤 5。否则继续下一步。

2，如果没有找到访问器方法，则在实例中搜索名称与模式 countOf<Key> 和 objectIn<Key>AtIndex:（对应于 NSArray类定义的原始方法）和 <key>AtIndexes:（对应于模式）的方法NSArray 方法 objectsAtIndexes:)。
如果找到其中的第一个和至少其他两个中的一个，则创建一个集合代理对象，该对象响应所有 NSArray 方法并返回该对象。否则，继续执行步骤 3。
代理对象随后将它接收到的任何 NSArray 消息转换为 countOf<Key>、objectIn<Key>AtIndex: 和 <key>AtIndexes:消息的某种组合，并将其转换为创建它的键值编码兼容对象。如果原始对象还实现了一个可选方法，其名称类似于 get<Key>:range:，则代理对象也会在适当的时候使用它。实际上，与键值编码兼容的对象一起工作的代理对象允许底层属性表现得好像它是一个 NSArray，即使它不是。

3，如果没有找到简单的访问器方法或数组访问方法组，则查找名为 countOf<Key>、enumeratorOf<Key>和 memberOf<Key>的三元组方法：（对应于 NSSet 类定义的原始方法）。
如果找到所有三个方法，则创建一个集合代理对象，该对象响应所有 NSSet 方法并返回该对象。否则，继续执行步骤4。 这个代理对象随后将它接收到的任何NSSet消息转换为countOf<Key>、enumeratorOf<Key>和memberOf<Key>的某种组合：消息到创建它的对象。实际上，与键值编码兼容的对象一起工作的代理对象允许底层属性表现得好像它是一个NSSet`，即使它不是。

4，如果没有找到简单的访问器方法或集合访问方法组，并且如果接收者的类方法accessInstanceVariables直接返回YES，则搜索名为_<key>、_is<Key>、<key>或is<Key>的实例变量，以该顺序。如果找到，直接获取实例变量的值并进行步骤5，否则进行步骤6。

5，如果检索到的属性值是一个对象指针，只需返回结果即可。
如果该值是 NSNumber 支持的标量类型，则将其存储在 NSNumber实例中并返回。
如果结果是NSNumber 不支持的标量类型，则转换为NSValue对象并返回。

6，如果所有其他方法都失败，请调用 valueForUndefinedKey:。默认情况下，这会引发异常，但 NSObject 的子类可能会提供特定于键的行为。

ps：翻译来自于谷歌翻译

验证取值第1点：

21.png 22.png 23.png 24.png 25.png

KeyValue的取值方法顺序优先级是：get<Key>高于<key>高于is<Key> 高于_<key>。

验证取值第4点：

屏蔽ZYPerson.m里的所有get方法。

26.png 27.png 28.png 29.png 30.png 31.png 32.png 33.png

当KeyValue设值到了实例变量的时候，其取值的优先级是：_<key>高于_is<Key>高于<key>高于is<Key>。

验证取值第2,3点：

34.png 35.png 36.png

所以对于数组NSArray和NSSet类型符合2，3点的文档描述

对于第5、6点就不去验证了，因为都是同样的方式，只不过是换了一种类型，而第六点就跟我们前面验证set方法里异常情况的是一样的。

自定义一个KVC

**ZYPerson (ZYKVC).h:

#import "ZYPerson.h"

NS_ASSUME_NONNULL_BEGIN

@interface ZYPerson (ZYKVC)
// ZY KVC 自定义入口
- (void)zy_setValue:(nullable id)value forKey:(NSString *)key;

@end

NS_ASSUME_NONNULL_END

**ZYPerson (ZYKVC).m：

#import "ZYPerson+ZYKVC.h"
#import <objc/runtime.h>

@implementation ZYPerson (ZYKVC)

- (void)zy_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 zy_performSelectorWithMethodName:setKey value:value]) {
        NSLog(@"*********%@**********",setKey);
        return;
    }else if ([self zy_performSelectorWithMethodName:_setKey value:value]) {
        NSLog(@"*********%@**********",_setKey);
        return;
    }else if ([self zy_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)zy_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)zy_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;
}

@end