iOSKVC 底层原理探索

一,概念

KVC(Key-value coding)键值编码,单看这个名字可能不太好理解。其实翻译一下就很简单了,就是指iOS的开发中,可以允许开发者通过Key名直接访问对象的属性,或者给对象的属性赋值。而不需要调用明确的存取方法。这样就可以在运行时动态地访问和修改对象的属性。而不是在编译时确定,这也是iOS开发中的黑魔法之一。很多高级的iOS开发技巧都是基于KVC实现的。

二,KVC在iOS中的定义

无论是Swift还是Objective-C,KVC的定义都是对NSObject的扩展来实现的(Objective-C中有个显式的NSKeyValueCoding类别名,而Swift没有,也不需要)。所以对于所有继承了NSObject的类型,也就是几乎所有的Objective-C对象都能使用KVC(一些纯Swift类和结构体是不支持KVC的),下面是KVC最为重要的四个方法

- (nullable id)valueForKey:(NSString *)key;                          //直接通过Key来取值
- (void)setValue:(nullable id)value forKey:(NSString *)key;          //通过Key来设值
- (nullable id)valueForKeyPath:(NSString *)keyPath;                  //通过KeyPath来取值
- (void)setValue:(nullable id)value forKeyPath:(NSString *)keyPath;  //通过KeyPath来设值

当然因为KVC 的定义来自于基础框架的Foundation中,所以没有开源,也就看不到具体代码的实现和原来,所以需要我们借助官方文章来进一步学习和了解。

当然NSKeyValueCoding类别中还有其他的一些方法,下面列举一些

+ (BOOL)accessInstanceVariablesDirectly;
//默认返回YES,表示如果没有找到Set方法的话,会按照_key,_iskey,key,iskey的顺序搜索成员,设置成NO就不这样搜索

- (BOOL)validateValue:(inout id __nullable * __nonnull)ioValue forKey:(NSString *)inKey error:(out NSError **)outError;
//KVC提供属性值正确性验证的API,它可以用来检查set的值是否正确、为不正确的值做一个替换值或者拒绝设置新值并返回错误原因。

- (NSMutableArray *)mutableArrayValueForKey:(NSString *)key;
//这是集合操作的API,里面还有一系列这样的API,如果属性是一个NSMutableArray,那么可以用这个方法来返回。

- (nullable id)valueForUndefinedKey:(NSString *)key;
//如果Key不存在,且没有KVC无法搜索到任何和Key有关的字段或者属性,则会调用这个方法,默认是抛出异常。

- (void)setValue:(nullable id)value forUndefinedKey:(NSString *)key;
//和上一个方法一样,但这个方法是设值。

- (void)setNilValueForKey:(NSString *)key;
//如果你在SetValue方法时面给Value传nil,则会调用这个方法

- (NSDictionary *)dictionaryWithValuesForKeys:(NSArray *)keys;
//输入一组key,返回该组key对应的Value,再转成字典返回,用于将Model转到字典。

上面的这些方法在碰到特殊情况或者有特殊需求还是会用到的,所以也是可以了解一下。后面的代码示例会有讲到其中的一些方法。
同时苹果对一些容器类比如NSArray或者NSSet等,KVC有着特殊的实现。建议有基础的或者英文好的开发者直接去看苹果的官方文档,相信你会对KVC的理解更上一个台阶。

三,KVC是怎么寻找Key

KVC是怎么使用的,我相信绝大多数的开发者都很清楚,我在这里就不再写简单的使用KVC来设值和取值的代码了,首先我们来探讨KVC在内部是按什么样的顺序来寻找key的。


setValue for Key.png

当调用setValue:属性值 forKey:@”name“的代码时,底层的执行机制如下:

  • 1 程序优先调用set:属性值方法,代码通过setter方法完成设置。注意,这里的是指成员变量名,首字母大小写要符合KVC的命名规则,下同
  • 2 如果没有找到setName:方法,KVC机制会检查+ (BOOL)accessInstanceVariablesDirectly方法有没有返回YES,默认该方法会返回YES,如果你重写了该方法让其返回NO的话,那么在这一步KVC会执行setValue:forUndefinedKey:方法,不过一般开发者不会这么做。所以KVC机制会搜索该类里面有没有名为_的成员变量,无论该变量是在类接口处定义,还是在类实现处定义,也无论用了什么样的访问修饰符,只在存在以_命名的变量,KVC都可以对该成员变量赋值。
  • 3 如果该类即没有set方法,也没有_成员变量,KVC机制会搜索_is的成员变量。
  • 4 和上面一样,如果该类即没有set方法,也没有_和_is成员变量,KVC机制再会继续搜索is的成员变量。再给它们赋值。
  • 5 如果上面列出的方法或者成员变量都不存在,系统将会执行该对象的setValue:forUndefinedKey:方法,默认是抛出异常。

如果开发者想让这个类禁用KVC里,那么重写+ (BOOL)accessInstanceVariablesDirectly方法让其返回NO即可,这样的话如果KVC没有找到set:属性名时,会直接用setValue:forUndefinedKey:方法。

3.1 代码验证赋值过程

  • 1 我们对一个类声明了四个属性name,_isName,isName_name
@interface LGPerson : NSObject{
    @public
    NSString *_isName;
    NSString *name;
    NSString *isName;
    NSString *_name;

}
  • 2 在控制器中我们先实例化一个person对象,从而对调用KVC 进行赋值过程;
 LGPerson *person = [[LGPerson alloc] init];
   // 1: KVC - 设置值的过程 setValue 分析调用过程
  [person setValue:@"LG_Cooci" forKey:@"name"]
  • 3 在person类中按先后顺序执行setter方法,看看执行的流程

第一步执行setName方法

- (void)setName:(NSString *)name{
    NSLog(@"%s - %@",__func__,name);
}

- (void)_setName:(NSString *)name{
    NSLog(@"%s - %@",__func__,name);
}

- (void)setIsName:(NSString *)name{
    NSLog(@"%s - %@",__func__,name);
}
- (void)_setIsName:(NSString *)name{
    NSLog(@"%s - %@",__func__,name);
}

打印结果

2020-10-28 16:36:11.503798+0800 002-KVC取值&赋值过程[8696:180841] -[LGPerson setName:] - LG_Cooci

第二步,注释掉setName方法再次打印结果

//- (void)setName:(NSString *)name{
//    NSLog(@"%s - %@",__func__,name);
//}
//
- (void)_setName:(NSString *)name{
    NSLog(@"%s - %@",__func__,name);
}

- (void)setIsName:(NSString *)name{
    NSLog(@"%s - %@",__func__,name);
}
- (void)_setIsName:(NSString *)name{
    NSLog(@"%s - %@",__func__,name);
}

打印结果

2020-10-28 16:41:37.143073+0800 002-KVC取值&赋值过程[8825:184607] -[LGPerson _setName:] - LG_Cooci

第三步注释掉_setName再次打印

//- (void)setName:(NSString *)name{
//    NSLog(@"%s - %@",__func__,name);
//}
//
//- (void)_setName:(NSString *)name{
//    NSLog(@"%s - %@",__func__,name);
//}

- (void)setIsName:(NSString *)name{
    NSLog(@"%s - %@",__func__,name);
}

- (void)_setIsName:(NSString *)name{
    NSLog(@"%s - %@",__func__,name);
}

打印结果

2020-10-28 16:43:45.832732+0800 002-KVC取值&赋值过程[8883:186519] -[LGPerson setIsName:] - LG_Cooci

第四步,注释掉setIsName 再次打印结果

//- (void)setName:(NSString *)name{
//    NSLog(@"%s - %@",__func__,name);
//}
//
//- (void)_setName:(NSString *)name{
//    NSLog(@"%s - %@",__func__,name);
//}

//- (void)setIsName:(NSString *)name{
//    NSLog(@"%s - %@",__func__,name);
//}

- (void)_setIsName:(NSString *)name{
    NSLog(@"%s - %@",__func__,name);
}

可以看到控制台没有任何打印结果,所以可以得出结论是- (void)_setIsName:(NSString *)name没有调用。

结论,KVC的set方法调用顺序为 setKey ->_setKey -> setIsKey

3.2 实例变量的赋值过程

通过以上的代码验证,我们知道了实例变量的set方法调用流程;当我们没有相应的set方法时,我们再次看看相应的示例变量赋值过程。

  • 1 我们所有的成员变量进行监控
  [person setValue:@"LG_Cooci" forKey:@"name"];
     NSLog(@"%@-%@-%@-%@",person->_name,person->_isName,person->name,person->isName);

打印结果

2020-10-28 16:51:28.428396+0800 002-KVC取值&赋值过程[9071:191676] LG_Cooci-(null)-(null)-(null)

  • 2 注释掉_name 方法,再次打印
 NSString *_isName;
    NSString *name;
    NSString *isName;
   // NSString *_name;
 // 1: KVC - 设置值的过程 setValue 分析调用过程
     [person setValue:@"LG_Cooci" forKey:@"name"];
    
     NSLog(@"%@-%@-%@",person->_isName,person->name,person->isName);
    

打印结果

2020-10-28 16:57:00.847725+0800 002-KVC取值&赋值过程[9199:195725] LG_Cooci-(null)-(null)

  • 3 再次注释掉_isName 再打印结果
 // NSString *_isName;
    NSString *name;
    NSString *isName;
   // NSString *_name;

[person setValue:@"LG_Cooci" forKey:@"name"];
NSLog(@"%@-%@",person->name,person->isName);

打印结果

2020-10-28 16:58:39.576608+0800 002-KVC取值&赋值过程[9254:197268] LG_Cooci-(null)

  • 4 再次注释掉name 再次打印结果
// NSString *_isName;
   // NSString *name;
    NSString *isName;
   // NSString *_name;
[person setValue:@"LG_Cooci" forKey:@"name"];
NSLog(@"%@",person->isName);

打印结果

2020-10-28 17:00:24.788572+0800 002-KVC取值&赋值过程[9312:198897] LG_Cooci

结论:在没有set方法的时候,KVC 对成员变量的赋值顺序是 _key -> _isKey -> key ->isKey

四,valueForkey 取值的内部原理

当调用valueForKey:@”name“的代码时,KVC对key的搜索方式不同于setValue:属性值 forKey:@”name“,其搜索方式如下:


ValueForkey.png
  • 1 首先按get,,is的顺序方法查找getter方法,找到的话会直接调用。如果是BOOL或者Int等值类型, 会将其包装成一个NSNumber对象。
  • 2 如果上面的getter没有找到,KVC则会查找countOf,objectInAtIndexAtIndexes格式的方法。如果countOf方法和另外两个方法中的一个被找到,那么就会返回一个可以响应NSArray所有方法的代理集合(它是NSKeyValueArray,是NSArray的子类),调用这个代理集合的方法,或者说给这个代理集合发送属于NSArray的方法,就会以countOf,objectInAtIndexAtIndexes这几个方法组合的形式调用。还有一个可选的get:range:方法。所以你想重新定义KVC的一些功能,你可以添加这些方法,需要注意的是你的方法名要符合KVC的标准命名方法,包括方法签名。
  • 3 如果上面的方法没有找到,那么会同时查找countOfenumeratorOf,memberOf格式的方法。如果这三个方法都找到,那么就返回一个可以响应NSSet所的方法的代理集合,和上面一样,给这个代理集合发NSSet的消息,就会以countOfenumeratorOf,memberOf组合的形式调用。
  • 4 如果还没有找到,再检查类方法+ (BOOL)accessInstanceVariablesDirectly,如果返回YES(默认行为),那么和先前的设值一样,会按_,_is,,is的顺序搜索成员变量名,这里不推荐这么做,因为这样直接访问实例变量破坏了封装性,使代码更脆弱。如果重写了类方法+ (BOOL)accessInstanceVariablesDirectly返回NO的话,那么会直接调用valueForUndefinedKey:
  • 5 还没有找到的话,调用valueForUndefinedKey:

4.1代码验证KVC 的get方法顺序

Person类中分别实现getNamename,isName_name方法

- (NSString *)getName{
    return NSStringFromSelector(_cmd);
}

- (NSString *)name{
    return NSStringFromSelector(_cmd);
}

- (NSString *)isName{
    return NSStringFromSelector(_cmd);
}

- (NSString *)_name{
    return NSStringFromSelector(_cmd);
}
  • 1 在控制器中对相关的属性进行取值内容;
LGPerson *person = [[LGPerson alloc] init];
    
    // 1: KVC - 设置值的过程 setValue 分析调用过程
     [person setValue:@"LG_Cooci" forKey:@"name"];
    
    NSLog(@"取值:%@",[person valueForKey:@"name"]);

打印结果是

2020-10-28 17:10:39.770668+0800 002-KVC取值&赋值过程[9557:205906] 取值:getName

  • 2 注释掉getName方法,再次打印
//- (NSString *)getName{
//    return NSStringFromSelector(_cmd);
//}

- (NSString *)name{
    return NSStringFromSelector(_cmd);
}

- (NSString *)isName{
    return NSStringFromSelector(_cmd);
}

- (NSString *)_name{
    return NSStringFromSelector(_cmd);
}

打印结果

2020-10-28 17:11:43.928335+0800 002-KVC取值&赋值过程[9593:207045] 取值:name

  • 3 再次注释掉name方法,打印
//- (NSString *)getName{
//    return NSStringFromSelector(_cmd);
//}

//- (NSString *)name{
//    return NSStringFromSelector(_cmd);
//}

- (NSString *)isName{
    return NSStringFromSelector(_cmd);
}

- (NSString *)_name{
    return NSStringFromSelector(_cmd);
}

打印结果

2020-10-28 17:12:33.678782+0800 002-KVC取值&赋值过程[9622:208078] 取值:isName

  • 4 再注释isName方法打印
//- (NSString *)getName{
//    return NSStringFromSelector(_cmd);
//}

//- (NSString *)name{
//    return NSStringFromSelector(_cmd);
//}

//- (NSString *)isName{
//    return NSStringFromSelector(_cmd);
//}

- (NSString *)_name{
    return NSStringFromSelector(_cmd);
}

打印结果

2020-10-28 17:13:29.096733+0800 002-KVC取值&赋值过程[9654:209106] 取值:_name

结论,KVC中相关成员变量的取值方法执行顺序是 getKey -> Key -> isKey -> _Key

4.2实例变量的取值过程

在没有实现任何get方法的情况下,

//- (NSString *)getName{
//    return NSStringFromSelector(_cmd);
//}

//- (NSString *)name{
//    return NSStringFromSelector(_cmd);
//}

//- (NSString *)isName{
//    return NSStringFromSelector(_cmd);
//}

//- (NSString *)_name{
//    return NSStringFromSelector(_cmd);
//}
  • 1 我们在控制器中对所有的成员变量进行一个赋值操作
person->_name = @"_name";
NSLog(@"取值:%@",[person valueForKey:@"name"]);

打印结果是

2020-10-28 17:25:02.021100+0800 002-KVC取值&赋值过程[9964:217084] 取值:_name

  • 2 注释掉_name 再次打印结果
 NSString *_isName;
    NSString *name;
    NSString *isName;
    //NSString *_name;
person->_isName = @"_isName";
NSLog(@"取值:%@",[person valueForKey:@"name"]);

打印结果

2020-10-28 17:29:25.962006+0800 002-KVC取值&赋值过程[10103:221196] 取值:_isName

  • 3 再次注释掉_isName 再次打印
//  NSString *_isName;
    NSString *name;
    NSString *isName;
    //NSString *_name;
 person->name = @"name";
  NSLog(@"取值:%@",[person valueForKey:@"name"]);

打印结果

2020-10-28 17:35:22.496774+0800 002-KVC取值&赋值过程[10281:225879] 取值:name

  • 4 再次注释掉name 在打印结果
 //  NSString *_isName;
   // NSString *name;
    NSString *isName;
    //NSString *_name;
person->isName = @"isName";
NSLog(@"取值:%@",[person valueForKey:@"name"]);

打印结果是

2020-10-28 17:37:17.713126+0800 002-KVC取值&赋值过程[10352:227627] 取值:isName

结论;成员变量的取值过程是 _Key -> _isKey -> Key ->isKey

八,总结

以上就是相关的KVC的原理,通过以上的学习和总结,了解了KVC 的赋值过程和取值过程的顺序,执行的流程已经处理异常的步骤,自己对KVC的理解更进一步。有不足的地方希望各位大神多多指正。

你可能感兴趣的:(iOSKVC 底层原理探索)