阅读 206

iOS底层学习 - KVC探索之路

KVC是我们在日常开发中常用的功能,俗称'键值编码',本章节就来探索一下我们常用的KVC到底是如何实现的

什么是KVC

基本定义

KVC全称是Key-Value Coding,键值编码,可以通过Key来访问和修改属性。

我们可以通过查看Apple的官方文档来查看其定义和具体的用法。

Key-value coding is a mechanism enabled by the NSKeyValueCoding informal protocol that objects adopt to provide indirect access to their properties. When an object is key-value coding compliant, its properties are addressable via string parameters through a concise, uniform messaging interface. This indirect access mechanism supplements the direct access afforded by instance variables and their associated accessor methods.

[译]键值编码是由NSKeyValueCoding非正式协议启用的一种机制,对象采用这种机制来提供对其属性的间接访问。当对象符合键值编码时,可以通过简洁,统一的消息传递接口通过字符串参数来访问其属性。这种间接访问机制补充了实例变量及其关联的访问器方法提供的直接访问。

通过文档,我们知道了如下几点:

  • KVC是一种对对象属性的间接访问
  • 一般通过getset方法的监听来进行取值和设值
  • 是一种基本的编程思想

基本用法

基本的用法分为两种:赋值和取值。主要API如下

赋值

//赋值
- (void)setValue:(id)value forKeyPath:(NSString *)keyPath;
- (void)setValue:(id)value forKey:(NSString *)key;
复制代码

取值

//取值
- (id)valueForKeyPath:(NSString *)keyPath;
- (id)valueForKey:(NSString *)key; 
复制代码

KVC的几种使用方法

首先先建立一个LGPerson类,通过对该类各不同类型的属性的赋值来讲解,代码如下

typedef struct {
    float x, y, z;
} ThreeFloats;

@interface LGPerson : NSObject{
   @public
   NSString *myName;
}

@property (nonatomic, copy)   NSString          *name;
@property (nonatomic, strong) NSArray           *array;
@property (nonatomic, strong) NSMutableArray    *mArray;
@property (nonatomic, assign) int age;
@property (nonatomic)         ThreeFloats       threeFloats;
@property (nonatomic, strong) LGStudent         *student;

@end
复制代码

基本对象使用

普通使用

基本对象的使用是平时开发中最为常用的,就如类中的name属性,定义为publicmyName成员变量和基本类型intage属性,直接使用上述的基本用法赋值即可,代码如下

[person setValue:@"WY" forKey:@"name"];
[person setValue:@19 forKey:@"age"];
[person setValue:@"WYY" forKey:@"myName"];
NSLog(@"%@ - %@ - %@",[person valueForKey:@"name"],[person valueForKey:@"age"],[person valueForKey:@"myName"]);
-------------------打印结果------------------------
 WY - 19 - WYY
复制代码

层级使用

层级使用也比较容易理解,主要使用了setValue:forKeyPath:的相关方法。比如要对类中student属性中的相关属性进行赋值的时候,就不能直接进行赋值,而需要使用点语法来进行层级赋值,具体代码如下

LGStudent *student = [[LGStudent alloc] init];
student.subject    = @"iOS";
person.student     = student;
[person setValue:@"ios" forKeyPath:@"student.subject"];
NSLog(@"%@",[person valueForKeyPath:@"student.subject"]);
-------------------打印结果------------------------
ios
复制代码

集合类型使用

集合类型的使用即为Person对象中数组类型的属性进行赋值。上述例子中,由于属性是不可变数组,我们是不能直接对该属性进行赋值操作的,一般情况下我们需要引入中间变量来进行等价替换,相关代码如下

person.array = @[@"1",@"2",@"3"];
// 由于不是可变数组 - 无法做到
// person.array[0] = @"100";
NSArray *array = [person valueForKey:@"array"];
// 用 array 的值创建一个新的数组
array = @[@"100",@"2",@"3"];
[person setValue:array forKey:@"array"];
NSLog(@"%@",[person valueForKey:@"array"]);
-------------------打印结果------------------------
(
    100,
    2,
    3
)
复制代码

可以发现,如果使用中间变量来进行操作的话,步骤还是相对繁琐一些的,我们可以使用mutableArrayValueForKey方法来达到简化的目的,相关代码如下

NSMutableArray *ma = [person mutableArrayValueForKey:@"array"];
ma[0] = @"100";
NSLog(@"%@",[person valueForKey:@"array"]);
-------------------打印结果------------------------
(
    100,
    2,
    3
)
复制代码

通过上述的两种方法,我们可以看到使用KVC方式来对集合进行可变方法操作的读写更加的便捷高效,主要的方法如下

  • mutableArrayValueForKey:mutableArrayValueForKeyPath:

    返回的代理对象表现为一个 NSMutableArray 对象

  • mutableSetValueForKey:mutableSetValueForKeyPath:

    返回的代理对象表现为一个 NSMutableSet 对象

  • mutableOrderedSetValueForKey: and mutableOrderedSetValueForKeyPath:

    返回的代理对象表现为一个 NSMutableOrderedSet 对象

集合操作符的使用

这一部分在平时的开发中可能使用较少,主要是在valueForKeyPath时,进行一些譬如求和,平均值等操作高效运算来使用的。

主要分为以下三大类

  • 聚合操作符

    • @avg: 返回操作对象指定属性的平均值
    • @count: 返回操作对象指定属性的个数
    • @max: 返回操作对象指定属性的最大值
    • @min: 返回操作对象指定属性的最小值
    • @sum: 返回操作对象指定属性值之和
  • 数组操作符

    • @distinctUnionOfObjects: 返回操作对象指定属性的集合--去重
    • @unionOfObjects: 返回操作对象指定属性的集合
  • 嵌套操作符

    • @distinctUnionOfArrays: 返回操作对象(嵌套集合)指定属性的集合--去重,返回的是 NSArray
    • @unionOfArrays: 返回操作对象(集合)指定属性的集合
    • @distinctUnionOfSets: 返回操作对象(嵌套集合)指定属性的集合--去重,返回的是 NSSet

非对象属性使用

标量属性使用

如下图所示,当属性为基本标量属性时,可以通过NSNumber的相关方法,转换为对象类型的NSNumber来进行对应的读写操作

结构体使用

如图所示,我们常见的结构体的类型如下,可以通过先转换为NSValue类型的对象属性,然后来进行对应的读写操作

但是如果我们有一个自定义的结构体,需要进行操作时,应该怎么办呢。我们可以看到Person类中有一个自定义结构体的属性,我们对它来进行赋值看看,相关的代码如下

ThreeFloats floats = {1., 2., 3.};
NSValue *value  = [NSValue valueWithBytes:&floats objCType:@encode(ThreeFloats)];
[person setValue:value forKey:@"threeFloats"];
NSValue *reslut = [person valueForKey:@"threeFloats"];
NSLog(@"%@",reslut);
    
ThreeFloats th;
[reslut getValue:&th] ;
NSLog(@"%f - %f - %f",th.x,th.y,th.z);
-------------------打印结果------------------------
 {length = 12, bytes = 0x0000803f0000004000004040}
 
 1.000000 - 2.000000 - 3.000000

复制代码

我们可以看到,在存储时,我们队结构体进行了编码,并生成了NSValue的变量,进行存储。然后又从NSValue提取到了相对应结构体的值,完成了读写的流程。

验证属性使用

KVC 支持属性验证,而这一特性是通过validateValue:forKey:error: (或validateValue:forKeyPath:error:) 方法来实现的。这个验证方法的默认实现是去收到这个验证消息的对象(或keyPath中最后的对象)中根据 key 查找是否有对应的 validate<Key>:error: 方法实现,如果没有,验证默认成功,返回 YES。

而由于 validate<Key>:error:方法通过引用接收值和错误参数,所以会有以下三种结果:

  1. 验证方法认为值对象有效,并在YES不更改值或错误的情况下返回。

  2. 验证方法认为值对象无效,但选择不对其进行更改。在这种情况下,该方法返回NO错误参考并将错误参考(如果由调用者提供)设置到一个NSError指示失败原因的对象。

  3. 验证方法认为值对象无效,但创建了一个新的有效对象作为替换。在这种情况下,该方法返回,YES而错误对象保持不变。在返回之前,该方法将值引用修改为指向新值对象。进行修改时,即使值对象是可变的,该方法也总是创建一个新对象,而不是修改旧对象。

相关的代码如下

Person* person = [[Person alloc] init];
NSError* error;
NSString* name = @"John";
if (![person validateValue:&name forKey:@"name" error:&error]) {
    NSLog(@"%@",error);
}
复制代码

KVC 的底层实现原理(搜索模式)

通过官方文档,我们可以很清晰的知道KVC在底层是如何进行setget

setValue:forKey:方法

  1. 按照顺序查找,是否存在set<Key>_set<Key>setIs<Key>的方法。如果存在,则直接进行调用
  2. 如果没有条件1中的方法。则优先判断accessInstanceVariablesDirectly方法是否为YES(改方法系统默认为YES,用来判断是都允许对成员变量的赋值)。如果为YES。则按照顺序,查找成员变量_Key_isKeyKeyisKey,如果存在对应的成员变量,则直接进行赋值,如果不存在,则进行下一步3.
  3. 如果1和2中的条件均不满足,则会setValue:forUndefinedKey:报错

图解如下

getValue:forKey:方法

  1. get<Key>, <key>, is<Key> 以及 _<key>的顺序查找对象中是否有对应的方法。

    • 如果找到了,将方法返回值带上跳转到第 5 步
    • 如果没有找到,跳转到第 2 步
  2. 查找是否有 countOf<Key>objectIn<Key>AtIndex: 方法(对应于 NSArray 类定义的原始方法)以及 <key>AtIndexes: 方法(对应于 NSArray 方法 objectsAtIndexes:)

    • 如果找到其中的第一个(countOf<Key>),再找到其他两个中的至少一个,则创建一个响应所有 NSArray 方法的代理集合对象,并返回该对象。(翻译过来就是要么是 countOf<Key> + objectIn<Key>AtIndex:,要么是 countOf<Key> + <key>AtIndexes:,要么是 countOf<Key> + objectIn<Key>AtIndex: + <key>AtIndexes:)
    • 如果没有找到,跳转到第 3 步
  3. 查找名为 countOf<Key>enumeratorOf<Key>memberOf<Key> 这三个方法(对应于NSSet类定义的原始方法)

    • 如果找到这三个方法,则创建一个响应所有 NSSet 方法的代理集合对象,并返回该对象
    • 如果没有找到,跳转到第 4 步
  4. 判断类方法 accessInstanceVariablesDirectly 结果

    • 如果返回 YES,则以_<key>, _is<Key>, <key>, is<Key> 的顺序查找成员变量,如果找到了,将成员变量带上跳转到第 5 步,如果没有找到则跳转到第 6 步
    • 如果返回 NO,跳转到第 6 步
  5. 判断取出的属性值

    • 如果属性值是对象,直接返回
    • 如果属性值不是对象,但是可以转化为 NSNumber 类型,则将属性值转化为 NSNumber 类型返回
    • 如果属性值不是对象,也不能转化为 NSNumber 类型,则将属性值转化为 NSValue 类型返回
  6. 调用 valueForUndefinedKey:。 默认情况下,这会引发一个异常,但是NSObject 的子类可以提供特定于 key 的行为。

图解如下:

自定义KVC

了解了KVC的基本使用和底层原理之后,我们可以根据其底层原理,来实现一个简单的自定义KVC。

首先我们创建一个NSObject的分类并添加前缀自定义方法名,用来解耦和避免和系统方法冲突

自定义赋值

根据上面的小结,主体思路如下:

  1. 非空判断
  2. 找到相关方法set<Key>_set<Key>setIs<Key>
  3. 判断是否能够直接赋值实例变量
  4. 找相关实例变量进行赋值
  5. 如果找不到相关实例,抛出异常

相关代码如下:

- (void)lg_setValue:(nullable id)value forKey:(NSString *)key{
    
    ✅// 1:非空判断一下
    if (key == nil  || key.length == 0) return;
    
    ✅// 2:找到相关方法 set<Key> _set<Key> setIs<Key>
    ✅// key 要大写
    NSString *Key = key.capitalizedString;
   ✅ // 拼接方法
    NSString *setKey = [NSString stringWithFormat:@"set%@:",Key];
    NSString *_setKey = [NSString stringWithFormat:@"_set%@:",Key];
    NSString *setIsKey = [NSString stringWithFormat:@"setIs%@:",Key];
    
    if ([self lg_performSelectorWithMethodName:setKey value:value]) {
        NSLog(@"*********%@**********",setKey);
        return;
    }else if ([self lg_performSelectorWithMethodName:_setKey value:value]) {
        NSLog(@"*********%@**********",_setKey);
        return;
    }else if ([self lg_performSelectorWithMethodName:setIsKey value:value]) {
        NSLog(@"*********%@**********",setIsKey);
        return;
    }
    
    ✅// 3:判断是否能够直接赋值实例变量
    if (![self.class accessInstanceVariablesDirectly] ) {
        @throw [NSException exceptionWithName:@"LGUnknownKeyException" reason:[NSString stringWithFormat:@"****[%@ valueForUndefinedKey:]: this class is not key value coding-compliant for the key name.****",self] userInfo:nil];
    }
    
    ✅// 4.找相关实例变量进行赋值
    ✅// 4.1 定义一个收集实例变量的可变数组
    NSMutableArray *mArray = [self getIvarListName];
    // _<key> _is<Key> <key> is<Key>
    NSString *_key = [NSString stringWithFormat:@"_%@",key];
    NSString *_isKey = [NSString stringWithFormat:@"_is%@",Key];
    NSString *isKey = [NSString stringWithFormat:@"is%@",Key];
    if ([mArray containsObject:_key]) {
        ✅// 4.2 获取相应的 ivar
       Ivar ivar = class_getInstanceVariable([self class], _key.UTF8String);
        ✅// 4.3 对相应的 ivar 设置值
       object_setIvar(self , ivar, value);
       return;
    }else if ([mArray containsObject:_isKey]) {
       Ivar ivar = class_getInstanceVariable([self class], _isKey.UTF8String);
       object_setIvar(self , ivar, value);
       return;
    }else if ([mArray containsObject:key]) {
       Ivar ivar = class_getInstanceVariable([self class], key.UTF8String);
       object_setIvar(self , ivar, value);
       return;
    }else if ([mArray containsObject:isKey]) {
       Ivar ivar = class_getInstanceVariable([self class], isKey.UTF8String);
       object_setIvar(self , ivar, value);
       return;
    }

    ✅// 5:如果找不到相关实例
    @throw [NSException exceptionWithName:@"LGUnknownKeyException" reason:[NSString stringWithFormat:@"****[%@ %@]: this class is not key value coding-compliant for the key name.****",self,NSStringFromSelector(_cmd)] userInfo:nil];
}
复制代码

自定义取值

根据上面的小结,主体思路如下:

  1. 非空判断
  2. 找到相关方法 get<Key><key>countOf<Key>objectIn<Key>AtIndex
  3. 判断是否能够直接赋值实例变量
  4. 找相关实例变量进行赋值

相关的代码如下:

- (nullable id)lg_valueForKey:(NSString *)key{
    
    ✅// 1: 判断非空
    if (key == nil  || key.length == 0) {
        return nil;
    }

    ✅// 2:找到相关方法 get<Key> <key> countOf<Key>  objectIn<Key>AtIndex
    ✅// key 要大写
    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
    
    ✅// 3:判断是否能够直接赋值实例变量
    if (![self.class accessInstanceVariablesDirectly] ) {
        @throw [NSException exceptionWithName:@"LGUnknownKeyException" reason:[NSString stringWithFormat:@"****[%@ valueForUndefinedKey:]: this class is not key value coding-compliant for the key name.****",self] userInfo:nil];
    }
    
    ✅// 4.找相关实例变量进行赋值
    ✅// 4.1 定义一个收集实例变量的可变数组
    NSMutableArray *mArray = [self getIvarListName];
    // _<key> _is<Key> <key> is<Key>
    // _name -> _isName -> name -> isName
    NSString *_key = [NSString stringWithFormat:@"_%@",key];
    NSString *_isKey = [NSString stringWithFormat:@"_is%@",Key];
    NSString *isKey = [NSString stringWithFormat:@"is%@",Key];
    if ([mArray containsObject:_key]) {
        Ivar ivar = class_getInstanceVariable([self class], _key.UTF8String);
        return object_getIvar(self, ivar);;
    }else if ([mArray containsObject:_isKey]) {
        Ivar ivar = class_getInstanceVariable([self class], _isKey.UTF8String);
        return object_getIvar(self, ivar);;
    }else if ([mArray containsObject:key]) {
        Ivar ivar = class_getInstanceVariable([self class], key.UTF8String);
        return object_getIvar(self, ivar);;
    }else if ([mArray containsObject:isKey]) {
        Ivar ivar = class_getInstanceVariable([self class], isKey.UTF8String);
        return object_getIvar(self, ivar);;
    }

    return @"";
}
复制代码

相关方法

- (BOOL)lg_performSelectorWithMethodName:(NSString *)methodName value:(id)value{
 
    if ([self respondsToSelector:NSSelectorFromString(methodName)]) {
        
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Warc-performSelector-leaks"
        [self performSelector:NSSelectorFromString(methodName) withObject:value];
#pragma clang diagnostic pop
        return YES;
    }
    return NO;
}

- (id)performSelectorWithMethodName:(NSString *)methodName{
    if ([self respondsToSelector:NSSelectorFromString(methodName)]) {
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Warc-performSelector-leaks"
        return [self performSelector:NSSelectorFromString(methodName) ];
#pragma clang diagnostic pop
    }
    return nil;
}

- (NSMutableArray *)getIvarListName{
    
    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];
        NSLog(@"ivarName == %@",ivarName);
        [mArray addObject:ivarName];
    }
    free(ivars);
    return mArray;
}
复制代码

这里只是非常简单的实现,很多多线程等情况没有考虑,可以参考DIS_KVC_KVO的实现方式,来进行进一步加深印象