KVC简介
KVC全称Key-Value Coding
,按照官方定义来说是由NSKeyValueCoding
非正式协议启用的一种机制,对象采用这种机制来提供对其属性的间接访问。
常用的KVC方法有:
- (nullable id)valueForKey:(NSString *)key;
- (void)setValue:(nullable id)value forKey:(NSString *)key;
- (nullable id)valueForKeyPath:(NSString *)keyPath;
- (void)setValue:(nullable id)value forKeyPath:(NSString *)keyPath;
还有一些其他的方法在Foundation
框架中的NSKeyValueCoding.h
中都有,只要关于NSObject
的都可以使用KVC。
KVC的原理
下面我们来探索一下KVC的取值和赋值过程:
通过Key-Value Coding Programming Guide网址可以看到Search Pattern for the Basic Setter
的关于setter
赋值操作的说明,如下图所示:
通过文档说明,可以了解到一些东西,例如:accessInstanceVariablesDirectly
方法,_
,那么这些又是有什么作用的呢?下面通过代码来探索一下这些属性和方法的作用:
创建一个Person
类,添加一个name
属性,然后实现几个setter
方法和accessInstanceVariablesDirectly
方法:
+ (BOOL)accessInstanceVariablesDirectly{
return YES;
}
- (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);
}
在accessInstanceVariablesDirectly
方法返回YES
的过程中,4个setter
方法依次执行和注释,结果前3个方法对name
属性的赋值都有作用,而最后一个方法没有作用,而当accessInstanceVariablesDirectly
,则会导致程序崩溃;
那么就能明白,对于属性的赋值,前三个方法都有作用;
下面来看看赋值问题:
person.h
@interface Person : NSObject{
@public
NSString *_name;
NSString *_isName;
NSString *name;
NSString *isName;
}
- (void)viewDidLoad {
[super viewDidLoad];
Person *person = [[Person alloc] init];
[person setValue:@"OC" forKey:@"name"];
NSLog(@"%@-%@-%@-%@",person->_name,person->_isName,person->name,person->isName);
NSLog(@"%@-%@-%@",person->_isName,person->name,person->isName);
NSLog(@"%@-%@",person->name,person->isName);
NSLog(@"%@",person->isName);
}
在上面的程序中,在.h
中有4个类似的name
属性,而viewcontroller
中只对name
赋值,对四种属性值进行打印;
最后得出的结论是通过对name
赋值,它对属性的赋值顺序是按照_name
->_isName
->name
->isName
;通过对属性name
的调换,结果还是一摸一样的;
赋值方法探索完,来探索一下取值方法过程:
在文档中有详细的解释说明:
下面只截取一部分内容:
同样的首先探索一下getter
方法的调用问题:
- (NSString *)getName{
return NSStringFromSelector(_cmd);
}
- (NSString *)name{
return NSStringFromSelector(_cmd);
}
- (NSString *)isName{
return NSStringFromSelector(_cmd);
}
- (NSString *)_name{
return NSStringFromSelector(_cmd);
}
- (void)viewDidLoad {
[super viewDidLoad];
Person *person = [[Person alloc] init];
[person setValue:@"OC" forKey:@"name"];
// person->_name = @"_name";
// person->_isName = @"_isName";
// person->name = @"name";
// person->isName = @"isName";
NSLog(@"取值:%@",[person valueForKey:@"name"]);
}
通过一个方法一个方法的注释和打开,它的取值调用顺序为:getName
->name
->isName
->_name
;和苹果官方文档的第一点说的一摸一样。
如果是实例变量,那么它就会按照第四点的顺序:
同样的是使用上面的代码,将setValue
代码去掉,依次打开和执行person->name
的设值,在经过执行代码之后,就会发现只有第一个_name
的赋值打印是有值的,其他三个都为NULL
;不知道读者有没有get到重点,在person.h
中有申明4个成员变量,当将_name
的申明注释,那么对_isName
的赋值打印是有值的,而其他的依然没有值。
这就是KVC的取值和赋值过程。
KVC的自定义
既然是自定义KVC,那么一些规则还是必须按照系统的规则来,例如取值和获取值的顺序等,通过对NSObject
创建分类来实现自定义的KVC,下面来按照步骤实现自定义KVC:
1、判断key的值是否存在
2、setter的顺序问题
3、是否能响应accessInstanceVariablesDirectly
和判断能否直接赋值实例变量
4、间接变量的设值
5、找不到实例变量
- (void)oc_setValue:(nullable id)value forKey:(NSString *)key{
// KVC 自定义
// 1: 判断什么 key
if (key == nil || key.length == 0) {
return;
}
// 2: setter set: or _set,
// 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 oc_performSelectorWithMethodName:setKey value:value]) {
NSLog(@"*********%@**********",setKey);
return;
}else if ([self oc_performSelectorWithMethodName:_setKey value:value]) {
NSLog(@"*********%@**********",_setKey);
return;
}else if ([self oc_performSelectorWithMethodName:setIsKey value:value]) {
NSLog(@"*********%@**********",setIsKey);
return;
}
// 3: 判断是否响应 accessInstanceVariablesDirectly 返回YES NO 奔溃
// 3:判断是否能够直接赋值实例变量
if (![self.class accessInstanceVariablesDirectly] ) {
@throw [NSException exceptionWithName:@"OCUnknownKeyException" reason:[NSString stringWithFormat:@"****[%@ valueForUndefinedKey:]: this class is not key value coding-compliant for the key name.****",self] userInfo:nil];
}
// 4: 间接变量
// 获取 ivar -> 遍历 containsObjct -
// 4.1 定义一个收集实例变量的可变数组
NSMutableArray *mArray = [self getIvarListName];
// _ _is is
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:@"OCUnknownKeyException" reason:[NSString stringWithFormat:@"****[%@ %@]: this class is not key value coding-compliant for the key name.****",self,NSStringFromSelector(_cmd)] userInfo:nil];
}
- (BOOL)oc_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;
}
- (NSMutableArray *)getIvarListName{
NSMutableArray *mArray = [NSMutableArray arrayWithCapacity:1];
unsigned int count = 0;
Ivar *ivars = class_copyIvarList([self class], &count);
for (int i = 0; i