IOS - KVC原理分析

本文首发于 个人博客

KVC就是键值对Key-Value Coding,它是苹果提供给我们处理对象的一种机制。通常我们对属性的操作会通过他的setget方法,但是这需要我们指定相应的setKeygetKey等方法,随着属性列表的增长我们访问这些属性也必须如此。相反,key-value coding提供了一个简单的消息传递接口,允许我们通过这个统一的接口去改变所有的属性(这其实就是我们通常用的json转model的原理)

image

KVC原理分析


KVC设值过程

kvc的设值会调用setValue:forKey:其设值过程流程图如下:

  1. 按顺序查找set<Key>_set<Key>这些方法,如果找到立即调用相应方法并传递name参数设值,结束。
  1. 如果没有找到以上的所有方法,判断accessInstanceVariablesDirectly方法返回值如果返回YES,依次判断_key,_is<Key>,key,isKey等成员变量是否存在,根据顺序存在即赋值并结束。

  2. 如果accessInstanceVariablesDirectly方法也返回NO,或者上述所有成员变量均不存在,调用setValue:forUndefinedKey:并抛出异常并崩溃。

  3. 注意,KVC的设值都是对成员变量的值进行操作,上述_key,_is<Key>,key,isKey等都是成员变量,而不是属性,属性设值的本质其实就是调用set方法,其内部就是对成员变量进行赋值,通常我们只定义了@property的属性,只不过是系统自动帮我们生成了相应的成员变量。

KVC取值过程

kvc的取值会调用ValueForKey:但是其对值的搜索过程不同于setValue:forKey:

  1. 依次查找实例方法:get<Key>,<key> ,is<Key>,_<key>,如果找到跳转到第5步。
  1. 判断是否属于NSArrray,基于是否找到NSArray相关的实例方法如:countOf,objectInAtIndex:AtIndexes

  2. 判断是否属于NSSet,基于是否有NSSet相关的方法:countOf<Key>, enumeratorOf<Key>and memberOf<Key>:

  3. 如果上述方法都不存在,判断对象的类方法accessInstanceVariablesDirectly 返回值,如果返回YES,按顺序查找成员变量_<key> , _is<Key> ,<key>is<Key> 如果找到直接直接获取实例变量的值并跳到5继续执行,否则执行6

  4. 检索属性值,如果是指针对象,直接返回结果;如果该值是可转化为NSNumber类型的值,那么将该值转化为NSNumber并返回;除此以外将该值转化为NSValue类型的值作为结果返回。

  5. 如果上述过程都失败,调用valueForUndefinedKey:并抛出一个异常。

自定义KVC


既然针对的是对象,那么我们就应该是针对NSObject的一个扩展Category。结合上面我们了解了KVC有取值和设值的过程,所以我们要自定义setValue:forKey:以及ValueForKey:的方法:

customSetValue:forKey:方法:

  • 查找 set_set方法.
  • 根据 accessInstanceVariablesDirectly 方法的返回值一次判断_key,_isKey,key, isKey等实例变量,找到实例变量并复制,结束.
  • 如果没找到抛异常.

customValueForKey:方法:

  • 找到相关方法 get countOf objectInAtIndex找到返回相应方法的返回值作为结果.
  • 根据 accessInstanceVariablesDirectly 方法的返回值一次判断_key,_isKey,key, isKey等实例变量,找到实例变量直接返回,结束.
  • 如果没找到抛异常.

具体代码

自定义setValue:forKey:方法:

- (void)customSetValue:(nullable id)value forKey:(NSString *)key{
    // 容错判断
    if (key == nil  || key.length == 0) return;
    // 找到相关方法 set<Key> _set<Key> setIs<Key>
    NSString *Key = key.capitalizedString;
    
    // 拼接方法
    NSString *setKey = [NSString stringWithFormat:@"set%@:",Key];
    NSString *_setKey = [NSString stringWithFormat:@"_set%@:",Key];
    NSString *setIsKey = [NSString stringWithFormat:@"setIs%@:",Key];
    NSArray *methodList = @[setKey,_setKey,setIsKey];
    for (NSInteger i = 0; i < methodList.count; i ++) {
        NSString *methodName = methodList[i];
        if ([self respondsToSelector:NSSelectorFromString(key)]) {
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Warc-performSelector-leaks"
            [self performSelector:NSSelectorFromString(methodName) withObject:value];
#pragma clang diagnostic pop
            return;
        }
    }
    
    // 判断是否能够直接赋值实例变量
    if (![self.class accessInstanceVariablesDirectly] ) {
        @throw [NSException exceptionWithName:@"UnknownKeyException" reason:[NSString stringWithFormat:@"****[%@ valueForUndefinedKey:]: this class is not key value coding-compliant for the key name.****",self] userInfo:nil];
    }
    
    // 找相关实例变量进行赋值
    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];
        [mArray addObject:ivarName];
    }
    free(ivars);
    
    NSArray *appendPrefix = @[@"_",@"_is",@"",@"is"];
    for (NSInteger i = 0; i < appendPrefix.count; i ++) {
        NSString *instanceName = [NSString stringWithFormat:@"%@%@",appendPrefix[i],key];
        if ([mArray containsObject:instanceName]) {
            // 获取相应的 ivar
            Ivar ivar = class_getInstanceVariable([self class], instanceName.UTF8String);
            // 对相应的 ivar 设置值
            object_setIvar(self , ivar, value);
            return;
        }
    }
    
    // 如果找不到相关实例
    @throw [NSException exceptionWithName:@"UnknownKeyException" reason:[NSString stringWithFormat:@"****[%@ %@]: this class is not key value coding-compliant for the key name.****",self,NSStringFromSelector(_cmd)] userInfo:nil];
}

- (id)customValueForKey:(NSString *)key{
    
    // 容错
    if (key == nil  || key.length == 0) {
        return nil;
    }
    
    // 找到相关方法 get<Key> <key> countOf<Key>  objectIn<Key>AtIndex
    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
    
    // 判断是否能够直接赋值实例变量
    if (![self.class accessInstanceVariablesDirectly] ) {
        @throw [NSException exceptionWithName:@"UnknownKeyException" reason:[NSString stringWithFormat:@"****[%@ valueForUndefinedKey:]: this class is not key value coding-compliant for the key name.****",self] userInfo:nil];
    }
    
    // 找相关实例变量进行赋值
    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];
        [mArray addObject:ivarName];
    }
    free(ivars);
 
    NSArray *appendPrefix = @[@"_",@"_is",@"",@"is"];
    for (NSInteger i = 0; i < appendPrefix.count; i ++) {
        NSString *instanceName = [NSString stringWithFormat:@"%@%@",appendPrefix[i],key];
        if ([mArray containsObject:instanceName]) {
            Ivar ivar = class_getInstanceVariable([self class], instanceName.UTF8String);
            return object_getIvar(self, ivar);;
        }
    }
    return nil;
}

4、KVC使用的细节

1.针对Int类型的key的写法

  [object setValue:@123 forKey:@"count"];
  1. 如果对Int类型的传一个NSString的值如:[object setValue:@"123" forKey:@"count"],系统会自动帮我们转换成__NSCFNumber的类型,说明KVC具有自动转型的功能

  2. 结构体的取值以及设值要转换为NSValue作为中间媒介。

  3. setNilValueForKey:的方法只针对NSNumber(int,bool, etc..)以及NSValue(结构体)相关的数据生效,针对指针对象赋值nil并不会走到这个方法。

  4. 集合操作符的使用:

// @sum用来计算集合中right keyPath指定的属性的总和

NSNumber *sum = [bookrack valueForKeyPath:@"@sum.bookPrice"];
NSLog(@"sum: %f", [sum floatValue]);
----------------------------------------------------------------
// @avg用来计算集合中right keyPath指定的属性的平均值

NSNumber *avgNum = [bookrack valueForKeyPath:@"@avg.bookPrice"];
----------------------------------------------------------------
// @max,@min 用来查找集合中right keyPath指定属性的最大值和最小值

NSNumber *max = [bookrack valueForKeyPath:@"@max.bookPrice"];
NSNumber *min = [bookrack valueForKeyPath:@"@min.bookPrice"];
----------------------------------------------------------------
// @unionOfObjects将集合中的所有对象的同一个属性放在数组中返回。

NSArray *priceArray = [bookrack valueForKeyPath:@"@unionOfObjects.bookPrice"];
----------------------------------------------------------------
// @distinctUnionOfObjects将集合中对象的属性进行去重后并返回。

NSArray *nameArray = [bookrack valueForKeyPath:@"@distinctUnionOfObjects.bookName"];
  1. 如果在集合对象中操作的属性,本来就是NSNumber类型,则可以像下面这样,直接用self代表值自身
NSArray *array = @[@(productA.price), @(productB.price), @(productC.price), @(productD.price)];
NSNumber *avg = [array valueForKeyPath:@"@avg.self"];
  1. KVC在实践中也有很多用处,例如UITabbarUIPageControl这样的控件,系统已经为我们封装好了,但是对于一些样式的改变并没有提供足够的API,这种情况就需要我们用KVC进行操作了。

总结

以上就是个人针对KVC的一些总结,有问题希望您随时提出。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,033评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,725评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,473评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,846评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,848评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,691评论 1 282
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,053评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,700评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,856评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,676评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,787评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,430评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,034评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,990评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,218评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,174评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,526评论 2 343

推荐阅读更多精彩内容

  • KVC是Key Value Coding的简称。它是一种可以通过字符串的名字(key)来访问类属性的机制。而不是通...
    153037c65b0c阅读 11,448评论 15 17
  • KVC是Key Value Coding的简称。它是一种可以通过字符串的名字(key)来访问类属性的机制。而不是通...
    _李恒阅读 736评论 0 0
  • 前言:往往会某项工具WORK,就想究其原理。本文先简单介绍KVC 一、KVC 简介 1.1 KVC 概述 1.KV...
    梦蕊dream阅读 906评论 0 2
  • KVC/KVO 概念 KVC : 即 Key-Value-Coding,用于键值编码。作为 cocoa 的一个标准...
    满脸胡茬的小码农阅读 1,948评论 2 8
  • 1. KVO 一.KVO原理的使用与证明 我们在开发的过程中经常使用KVO和KVC,但是我们并不了解其底层原理和功...
    周灬阅读 835评论 0 9