IOS - KVC原理分析

作者: Typeco | 来源:发表于2020-04-01 19:54 被阅读0次

    本文首发于 个人博客

    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的一些总结,有问题希望您随时提出。

    相关文章

      网友评论

        本文标题:IOS - KVC原理分析

        本文链接:https://www.haomeiwen.com/subject/hlfzuhtx.html