实现自己的 KVC

本文只是按照自己思路实现了 setValue:forKey:setValue:forKeyPath: 这两个方法,所以这个标题起得有点夸张了,KVC 跟容器类的交互、对标量的封装以及高阶消息传递等特性,我一个都没实现。😒我是来熟悉 runtime 的 API 来的。

KVC 实现的猜想

关于 Apple 是如何实现 KVC 这个问题,我表示一脸懵逼。因为无法打印出所有调用过的函数的名字,所以我根本不指望能知道 KVC 背后的一切,只能打些可能会被调用的函数的符号断点胡搞瞎搞。透过表象假装看本质,以下都是猜想:对于 setValue:forKey: ,在 setter 存在的情况,KVC 会直接发送 -set<Key>: 消息赋值;在 setter 不在的情况下,会按文档所阐述的规则(_<key>, _<isKey>, <key>, is<Key>)去查找实例变量,检查其是否存在,之后通过与 object_setIvar 给它赋值。对于 setValue:forKeyPath:,递归地检查 keyPath 中的属性是否存在,到达路径最深处事再调用 setValue:forKey: 完成赋值。

动手实现

谨防浪费大家时间,往下看之前,请明白三点:

  1. 笔者的实现比系统的慢 7~20 倍左右;
  2. 如同前言所述,笔者的实现功能弱小;
  3. 笔者的实现比系统的慢 7~20 倍左右。

给 NSObject 整个 Category,实现这两个 API oz_setValue:forKey:oz_setValue:forKeyPath: 代码里面写了注释,所以废话不多说:

- (void)oz_setValue:(id)value forKey:(NSString *)key {
    
    // OZ_SetterNameForkey 的作用是构造形如 `setKey:` 的字符串
    // 这里用 `object_getClass(self)` 而不用 `[self class]` 是为了装逼,下同
    SEL setterSelector = NSSelectorFromString(OZ_SetterNameForkey(key));
    Method setterMethod = class_getInstanceMethod(object_getClass(self), setterSelector);

    // 如果这个 setter 存在咧,那么向当前对象发送 setter 消息
    if (setterMethod) {
        void (*objc_msgSendCasted)(id, SEL, ...) = (void *)objc_msgSend;
        return objc_msgSendCasted(self, setterSelector, value);
    }
    
    // 如果 setter 不存在,且不允许直接访问成员变量的话,就会被判断为给 undefined key 赋值
    if (![[self class] accessInstanceVariablesDirectly]) {
        if ([self respondsToSelector:@selector(setValue:forUndefinedKey:)]) {
            return [self setValue:value forUndefinedKey:key];
        }
        @throw OZ_UnknowKeyException(self, key);
    }

    // 在当前对象中所属的类中找到符合 KVO 命名规则的实例变量
    Ivar target = OZ_Class_GetKVOCompliantIvar(object_getClass(self), key);
    if (!target) {
        @throw OZ_UnknowKeyException(self, key);
    }
    
    // 给当前对象的实例变量赋值
    object_setIvar(self, target, value);
}

-(void)oz_setValue:(id)value forKeyPath:(NSString *)keyPath {
    if (!keyPath) {
        @throw OZ_UnknowKeyException(self, keyPath);
    }
    
    // 返回第一个 '.' 的位置,如果大于或等于 keyPath 的长度,说明不存在,交由 `oz_setValue:forKey:` 处理
    NSUInteger separetedDotIndex = OZ_IndexOfFirstDot(keyPath);
    if (separetedDotIndex >= keyPath.length) {
        return [self oz_setValue:value forKey:keyPath];
    }
    
    // 从第一个 '.' 分割 keyPath
    NSString *firstKey = [keyPath substringToIndex:separetedDotIndex];
    NSString *restKeyPath = [keyPath substringFromIndex:separetedDotIndex + 1];

    Ivar currentIvar = OZ_Class_GetKVOCompliantIvar(object_getClass(self), firstKey);
    
    // 注意,这里要把对象所对于的实例变量的值取出来,它将会是下一次发送消息的接收者
    id ivarValue = object_getIvar(self, currentIvar);
    
    // 如果剩余的 keyPath 没有 '.',那么这个 keyPath 就是最后要设置的变量,
    // ivarValue 拥有这个对象,所以它是消息的接收者,交由 `oz_setValue:forKey:` 处理
    if (![restKeyPath containsString:@"."]) {
        void (*objc_msgSendCasted)(id, SEL, ...) = (void *)objc_msgSend;
        return objc_msgSendCasted(ivarValue, @selector(oz_setValue:forKey:), value, restKeyPath);
    }
    
    // 递归调用
    [ivarValue oz_setValue:value forKeyPath:restKeyPath];
}

贴完了两段有臭又长的代码,接下来是 OZ_Class_GetKVOCompliantIvar 的实现:

static Ivar OZ_Class_GetKVOCompliantIvar(Class cls, NSString *key) {
    NSString *firstLetter = [[key substringToIndex:1] lowercaseString];
    NSString *Key = [key stringByReplacingCharactersInRange:NSMakeRange(0, 1)
                                                 withString:firstLetter];
    //(_key, _isKey, key, isKey)
    NSArray *kvoCompliantKeys = @[[NSString stringWithFormat:@"_%@", key],
                                  [NSString stringWithFormat:@"_is%@", Key],
                                  [NSString stringWithFormat:@"%@", key],
                                  [NSString stringWithFormat:@"is%@", Key],];
    Ivar target = NULL;
    for (NSString *kvoKey in kvoCompliantKeys) {
        target = class_getInstanceVariable(cls, [kvoKey UTF8String]);
        if (target) {
            break;
        }
    }
    return target;
}

除了构建四个遵从 KVC 规则的实例变量名外,值得一提的是 class_getInstanceVariable 这个函数,它在系统调用 setValue:forKeyPath: 时不会被调用到,所以 setValue:forKeyPath: 并不是通过这个这个函数来检验每一级属性的存在。这个东西待优化的空间还有很多,挖个坑迟些再折腾,要继续准备校招的事情了。

最后

起初对于 runtime 的 API 的不熟悉,我并不知道 class_getInstanceVariable 的存在,然后想利用胡搞瞎搞发现的函数 _class_getVariable 来获得变量,但是在运行时得到错误,我在 stackoverflow 上提了个关于调用 dylib 中的函数的问题,如果知道怎么整希望能指点我一下,或者指出我的错误。

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

推荐阅读更多精彩内容

  • KVC(Key-value coding)键值编码,单看这个名字可能不太好理解。其实翻译一下就很简单了,就是指iO...
    朽木自雕也阅读 1,554评论 6 1
  • 转至元数据结尾创建: 董潇伟,最新修改于: 十二月 23, 2016 转至元数据起始第一章:isa和Class一....
    40c0490e5268阅读 1,692评论 0 9
  • KVC(Key-value coding)键值编码,单看这个名字可能不太好理解。其实翻译一下就很简单了,就是指iO...
    黑暗中的孤影阅读 49,689评论 74 441
  • KVC简单介绍 KVC(Key-value coding)键值编码,就是指iOS的开发中,可以允许开发者通过Key...
    公子无礼阅读 1,387评论 0 6
  • 2017已经接近尾声了,静静的闭上眼睛细细回想这一年,这一年收获不少。常言道每天进步一点点,每一年也要比去年有进步...
    优乐维儿阅读 184评论 2 1