IOS:KVC原理与自定义

一、KVC简介

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

二、KVC原理分析

2.一、KVC设值过程

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

  1. 按顺序查找set<Key>_set<Key>这些方法,若是找到当即调用相应方法并传递name参数设值,结束。数组

  2. 若是没有找到以上的全部方法,判断accessInstanceVariablesDirectly方法返回值若是返回YES,依次判断_key,_is<Key>,key,isKey等成员变量是否存在,根据顺序存在即赋值并结束。bash

  3. 若是accessInstanceVariablesDirectly方法也返回NO,或者上述全部成员变量均不存在,调用setValue:forUndefinedKey:并抛出异常并崩溃。markdown

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

2.二、KVC取值过程

kvc的取值会调用ValueForKey:可是其对值的搜索过程不一样于setValue:forKey:this

  1. 依次查找实例方法:get<key>,<key>,is<Key>,_<key>,若是找到跳转到第5步。spa

  2. 判断是否属于NSArrray,基因而否找到NSArray相关的实例方法如:countOf<Key>,objectIn<Key>AtIndex:<key>AtIndexes指针

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

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

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

  6. 若是上述过程都失败,调用valueForUndefinedKey:并抛出一个异常。

3.自定义KVC

3.一、思路

  1. 既然针对的是对象,那么咱们就应该是针对NSObject的一个扩展Category

  2. 结合上面咱们了解了KVC有取值和设值的过程,因此咱们要自定义setValue:forKey:以及ValueForKey:的方法。

  3. customSetValue:forKey:方法:

    • 查找 set 和 _set 方法;
    • 根据 accessInstanceVariablesDirectly 方法的返回值一次判断_key,_is<Key>,key, isKey等实例变量,找到实例变量并复制,结束。
    • 若是没找到抛异常。
  4. customValueForKey:方法:

    • 找到相关方法 get countOf objectInAtIndex找到返回相应方法的返回值做为结果;
    • 根据 accessInstanceVariablesDirectly 方法的返回值一次判断_key,_is<Key>,key, isKey等实例变量,找到实例变量直接返回,结束。
    • 若是没找到抛异常。

3.二、具体实现

- (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进行操做了

5.总结

以上就是我的针对KVC的一些总结,有问题但愿您随时提出。如今正值新型肺炎疫情期间,你们或许有的已经开始复工了,有的或许还在家进行隔离,但愿你们都注意保护本身,保护家人,保护你们。

相关文章
相关标签/搜索