KVC是Key Value Coding的简称。它是一种可以通过字符串的名字(key)来访问类属性的机制。而不是通过调用Setter、Getter方法访问。KVC的方法定义在Foundation/NSKeyValueCoding中。
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来设值
//默认返回YES,表示如果没有找到Set方法的话,会按照_key,_iskey,key,iskey的顺序搜索成员,设置成NO就不这样搜索
+ (BOOL)accessInstanceVariablesDirectly;
//KVC提供属性值正确性验证的API,它可以用来检查set的值是否正确、为不正确的值做一个替换值或者拒绝设置新值并返回错误原因。 - (BOOL)validateValue:(inout id __nullable * __nonnull)ioValue forKey:(NSString *)inKey error:(out NSError **)outError;
//如果Key不存在,且没有KVC无法搜索到任何和Key有关的字段或者属性,则会调用这个方法,默认是抛出异常。
- (nullable id)valueForUndefinedKey:(NSString *)key;
- (void)setValue:(nullable id)value forUndefinedKey:(NSString *)key;//和上一个方法一样,但这个方法是设值。
- (void)setNilValueForKey:(NSString *)key;//如果你在SetValue方法时面给Value传nil,则会调用这个方法
- (NSDictionary *)dictionaryWithValuesForKeys:(NSArray *)keys;//输入一组key,返回该组key对应的Value,再转成字典返回,用于将Model转到字典。
设值的实现步骤:
1.首先搜索是否有setKey:的方法(key是成员变量名,首字母大写),没有则会搜索是否有setIsKey:的方法。
2.如果没有找到setKey:的方法,此时看+ (BOOL)accessInstanceVariablesDirectly; (是否直接访问成员变量)方法。
若返回NO,则直接调用- (nullable id)valueForUndefinedKey:;(默认是抛出异常)。
若返回YES,按 _key、_iskey、key、isKey的顺序搜索成员名。
3.在第二步还没搜到的话就会调用- (nullable id)valueForUndefinedKey:方法。
验证一:如果实现setKey:方法则不会调用_setKey:和+ (BOOL)accessInstanceVariablesDirectly; 方法
创建一个类YYKVCModel,不声明属性,在.m文件同时实现以下三个方法:
+ (BOOL)accessInstanceVariablesDirectly{
NSLog(@"accessInstanceVariablesDirectly");
return YES;
}
- (void)_setTestName:(NSString *)testName{
NSLog(@"不被调用,因为实现了setTestName\n");
}
- (void)setTestName:(NSString *)testName{
NSLog(@"setTestName调用\n");
}
用kvc赋值
YYKVCModel *model = [[YYKVCModel alloc] init];
[model setValue:@"1223" forKey:@"testName"];
运行结果:只调用了setTestName方法。说明setTestName方法优先级高于_setTestName方法。
验证二:注释掉setTestName:方法,新增方法setIsTestName:
+ (BOOL)accessInstanceVariablesDirectly{
NSLog(@"accessInstanceVariablesDirectly");
return YES;
}
- (void)_setTestName:(NSString *)testName{
NSLog(@"_setTestName被调用\n");
}
- (void)setIsTestName:(NSString *)testName{
NSLog(@"setIsTestName不被调用\n");
}
运行结果:调用了_setTestName方法,不调用setIsTestName方法。说明_setTestName的优先级高于setIsTestName。
验证三:注释掉_setTestName:方法添加成员变量
@interface YYKVCModel : NSObject {
NSString *_testName;
}
运行结果:调用了setIsTestName:方法,_testName的值为null。说明setIsTestName方法优先级高于直接给_testName赋值。
验证四:注释掉setIsTestName:方法,为YYKVCModel增加以下成员变量
@interface YYKVCModel : NSObject {
NSString *_testName;
NSString *_isTestName;
}
运行结果:+ (BOOL)accessInstanceVariablesDirectly方法被调用,此时返回的是YES。_testName值变为1223,_isTestName值为null。说明直接给_testName赋值优先级高于直接给_isTestName赋值。
验证五:为YYKVCModel增加以下成员变量
@interface YYKVCModel : NSObject {
NSString *_isTestName;
NSString *testName;
}
运行结果:+ (BOOL)accessInstanceVariablesDirectly方法被调用,此时返回的是YES。_isTestName值变为1223,testName值为null。说明直接给_isTestName赋值优先级高于直接给testName赋值。
验证六:为YYKVCModel增加以下成员变量
@interface YYKVCModel : NSObject {
NSString *testName;
NSString *isTestName;
}
运行结果:+ (BOOL)accessInstanceVariablesDirectly方法被调用,此时返回的是YES。testName值变为1223,isTestName值为null。说明直接给testName赋值优先级高于直接给isTestName赋值。
验证七:注释 NSString *testName;
运行结果:+ (BOOL)accessInstanceVariablesDirectly方法被调用,此时返回的是YES。isTestName值变为1223。
验证八:在+ (BOOL)accessInstanceVariablesDirectly方法返回NO
运行结果:调用两次+ (BOOL)accessInstanceVariablesDirectly方法,然后调用- (void)setValue:(id)value forUndefinedKey:(NSString *)key方法,不实现方法将默认抛出异常,isTestName值为null。
若返回YES则只会调用一次。
由以上实验得出结论:
以上的代码中并没有声明testName这个属性,若声明属性会默认生成setter和getter方法,无法进行测试。
KVC的赋值本质上只是调用了属性的setter方法,setter方法会按照setKey、_setKey、setIsKey的优先级进行调用,还没有,则按_key、_isKey、key、isKey查找成员变量。
如果accessInstanceVariablesDirectly返回NO,则不会查找_key、_isKey、key、isKey,会直接调用- (void)setValue:(id)value forUndefinedKey:(NSString *)key。
若查找到isKey还是没找到,也会调用(void)setValue:(id)value forUndefinedKey:(NSString *)key,该方法默认会抛出异常。
KVC取值的实现:
1.按先后顺序搜索getKey、key、isKey、_getKey、_key五个方法,若某一个方法被实现,取到的即是方法返回的值,后面的方法不再运行。如果是BOOL或者Int等值类型, 会将其包装成一个NSNumber对象。
2.若这五个方法都没有找到,则会调用+ (BOOL)accessInstanceVariablesDirectly方法判断是否允许取成员变量的值。
若返回NO,直接调用- (nullable id)valueForUndefinedKey:(NSString *)key方法,默认是奔溃。
若返回YES,会按先后顺序取_key、_isKey、 key、isKey的值。
3.返回YES时,_key、_isKey、 key、isKey的值都没取到,调用- (nullable id)valueForUndefinedKey:(NSString *)key方法。
验证方法与上面设置值类似。
验证后得出结论:
在实验中同样没有用属性声明testName。在取值过程中按顺序看getKey、key、isKey、_getKey、_key五个方法是否实现,若实现了则取到的值为方法返回的值,所以本质上是按先后顺序调用了这五个getter方法,如果没有,则会询问+ (BOOL)accessInstanceVariablesDirectly方法能否直接取成员变量,若返回YES,则会按顺序取_key、_isKey、 key、isKey的值。
如果在+ (BOOL)accessInstanceVariablesDirectly中返回NO,或者取到isKey仍然取不到值,则会调用- (nullable id)valueForUndefinedKey方法,该方法中返回的值即为取到的值。
KVC取值的补充:
在取值的第一步结束第二步开始之前,还会判断获取的值是否是数组或者集合。
1.如果是数组(NSArray *)的话,当实现countOf方法和objectInAtIndex或AtIndexes中任意一个方法时则会返回一个数组.
具体写法:key为testArray
-(NSUInteger)countOfTestArray{
return 3;
}
- (id)testArrayAtIndexes:(NSIndexSet *)indexs{
return @[@(2), @(4), @(6)];
}
-(id)objectInTestArrayAtIndex:(NSUInteger)index{
return @(index);
}
KVC调用
YYKVCModel *model = [[YYKVCModel alloc] init];
id array = [model valueForKey:@"testArray"]; array类型为NSKeyValueArray
2.不可变数组还可以实现get<Key>:range:
如果是可变数组还可以实现:
-insertObject:in<Key>AtIndex:或者-insert<Key>:atIndexes:
-removeObjectFrom<Key>AtIndex:或者-remove<Key>AtIndexes:
-replaceObjectIn<Key>AtIndex:withObject:或者-replace<Key>AtIndexes:with<Key>:
3.集合需要实现以下三个方法:
-countOf<Key>
-enumeratorOf<Key>
-memberOf:<key>
KVC中的异常
1.获取值时找不到key
- (nullable id)valueForUndefinedKey:(NSString *)key;
2.设值时找不到key
- (void)setValue:(nullable id)value forUndefinedKey:(NSString *)key;
3.给不能设置nil的属性设置了nil。
定义一个属性
@property (nonatomic, assign) NSInteger num;
用kvc赋值
YYKVCModel *model = [[YYKVCModel alloc] init];
[model setValue:nil forKey:@"num"];
此时运行的话程序会崩溃,报错如下
重写- (void)setNilValueForKey:(NSString *)key方法后会发现不再奔溃,可知在该方法中默认抛出了异常。我们可以重写该方法做处理。
KVC处理非对象和自定义对象
KVC中返回的是一个id类型的对象,所以调用valueForKey:时如果是基本数据类型或者结构体,KVC会自动转成NSNumber类型或者NSValue类型,但是调用SetValue: forKey:时需要手动把基本数据类型或者结构体转成对象。
自定义对象需要我们自己保证类型的正确性。
KVC的属性验证
- (BOOL)validateValue:(inout id _Nullable __autoreleasing *)ioValue forKey:(NSString *)inKey error:(out NSError * _Nullable __autoreleasing *)outError;对应使用key的方式。
- (BOOL)validateValue:(inout id _Nullable __autoreleasing *)ioValue forKeyPath:(NSString *)inKeyPath error:(out NSError * _Nullable __autoreleasing *)outError;对应使用keyPath的方式。
KVC并不会自动调用该方法,需要我们手动调用
比如在设置值的时候我们可以判断键值的正确性,如果正确则继续操作,失败则不操作。验证失败后可以把错误存放在outError返回,这边的ioValue传入的也是指针,所以可以在需要时在验证方法中更改value,然后在外面设置。
KVC与容器类
在使用KVO观察属性改变时,会发现如果观察可变数组时,对于添加或者移除元素时并不能接收到变化。因为KVO的本质是在setter方法上,添加上- (void)willChangeValueForKey:(NSString *)key和- (void)didChangeValueForKey:(NSString *)key方法来发送通知。此时用mutableArrayValueForKey:方法获取数组,在做增加删除操作就能接收到监听。
写法如:
[[self mutableArrayValueForKey:@"mutableArray"] addObject:@"1"];