实现自己的 KVC

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

KVC 实现的猜想

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

动手实现

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

笔者的实现比系统的慢 7~20 倍左右；
如同前言所述，笔者的实现功能弱小；
笔者的实现比系统的慢 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 中的函数的问题，如果知道怎么整希望能指点我一下，或者指出我的错误。

实现自己的 KVC

KVC 实现的猜想

动手实现

最后

你可能感兴趣的:(实现自己的 KVC)