一:KVC是什么?
KVC是Key Value Coding的简称,即键值编码,提供一种机制来间接访问对象的属性。而不是通过调用Setter、Getter方法访问,KVC的方法定义在Foundation/NSKeyValueCoding中,是一个NSObject的扩展,任何继承NSObject的类都包含此方法。简单的来说,KVC让我们能够使用属性的字符串名称来设置、读取属性的值,而不是通过.语法实现。
二:KVC能够干什么?
- 对私有变量进行赋值
- 字典转模型
三:KVC的四个常用方法
// 根据属性名称key设置值
- (void)setValue:(nullable id)value forKey:(NSString *)key;
// 根据属性路径名称keyPath设置值
- (void)setValue:(nullable id)value forKeyPath:(NSString *)keyPath;
// 根据属性名称key获取值
- (nullable id)valueForKey:(NSString *)key;
// 根据属性路径名称keyPath获取值
- (nullable id)valueForKeyPath:(NSString *)keyPath;
1:KVC是如何获取值?之- (nullable id)valueForKey:(NSString *)key;
方法
其实这些方法在Foundation框架NSKeyValueCoding.h中都有对方法的解析
关于- (nullable id)valueForKey:(NSString *)key;
获取属性值的调用过程如下:
1: 首先查找与其名称匹配的几个方法,判断调用顺序为:
get<key>,<key>,is<key>
2:如果以上三个方法均没有,则调用+(BOOL)accessInstanceVariablesDirectly;
(是否直接访问成员变量),返回YES则直接访问成员变量,返回NO,则调用- (id)valueForUndefinedKey:(NSString *)key
指定一个值返回,不重写此方法默认崩溃
3:直接访问成员变量,也会顺序判断调用:_<key>、_is<key>、<key>、is<key>
,如果没有找到这些成员变量,则调用- (id)valueForUndefinedKey:(NSString *)key
指定一个值返回,不重写此方法默认崩溃
代码测试1:匹配方法
在TestKVCModel类中实现如下方法
@implementation TestKVCModel
//1: 获取kvc最高级
- (NSString *)getTestName {
NSLog(@"getTestName");
return @"xxx";
}
//2: 获取第二级
- (NSString *)testName {
NSLog(@"testName");
return @"xxx";
}
//3: 获取第三级
- (NSString *)isTestName {
NSLog(@"isTestName");
return @"xxx";
}
// 是否允许直接方法成员变量
+ (BOOL)accessInstanceVariablesDirectly {
NSLog(@"accessInstanceVariablesDirectly");
return NO;
}
// 没有访问到,默认返回值,不实现此方法,默认崩溃
- (id)valueForUndefinedKey:(NSString *)key {
NSLog(@"valueForUndefinedKey %@", key);
return @"AAAAA";
}
使用- (nullable id)valueForKey:(NSString *)key;
方法访问testName的值
TestKVCModel *model = [[TestKVCModel alloc] init];
NSLog(@"%@", [model valueForKey:@"testName"]);
多次输出结果:
1:
2019-08-21 10:04:58.378737+0800 TestKVC[47554:2700945] getTestName
2019-08-21 10:04:58.378872+0800 TestKVC[47554:2700945] xxx
2:注释- (NSString *)getTestName方法
2019-08-21 10:06:02.375669+0800 TestKVC[47614:2702788] testName
2019-08-21 10:06:02.375849+0800 TestKVC[47614:2702788] xxx
3:注释- (NSString *)getTestName和- (NSString *)testName方法
2019-08-21 10:06:38.428103+0800 TestKVC[47654:2703877] isTestName
2019-08-21 10:06:38.428253+0800 TestKVC[47654:2703877] xxx
4:同时注释三个方法
2019-08-21 10:07:15.966436+0800 TestKVC[47693:2705005] accessInstanceVariablesDirectly
2019-08-21 10:07:15.966592+0800 TestKVC[47693:2705005] accessInstanceVariablesDirectly
2019-08-21 10:07:15.966689+0800 TestKVC[47693:2705005] valueForUndefinedKey testName
2019-08-21 10:07:15.966769+0800 TestKVC[47693:2705005] AAAAA
测试结果:我们分别注释TestKVCModel中的方法,可以观察其调用顺序,其调用顺序依次为- (NSString *)getTestName
-> - (NSString *)testName
-> - (NSString *)isTestName
注释上面三个方法默认返回值AAAAA,同时注释- (id)valueForUndefinedKey:(NSString *)key
方法,程序会崩溃
接下来,我们为TestKVCModel类添加testName实例变量,+ (BOOL)accessInstanceVariablesDirectly
返回YES允许直接访问实列变量
代码测试2:匹配实例变量
在TestKVCModel.h中添加三个属性
// 使用@property方式申明,会默认生成_key的实列变量,并默认实现getter和setter方法
@interface TestKVCModel : NSObject {
NSString *_testName;
NSString *testName;
NSString *isTestName;
}
在TestKVCModel.m中,设置初始值,允许直接方法成员变量
- (instancetype)init
{
self = [super init];
if (self) {
_testName = @"_testName";
testName = @"testName";
isTestName = @"isTestName";
}
return self;
}
// 是否允许直接方法成员变量
+ (BOOL)accessInstanceVariablesDirectly {
NSLog(@"accessInstanceVariablesDirectly");
return YES;
}
// 没有访问到,默认返回值,不实现此方法,默认崩溃
- (id)valueForUndefinedKey:(NSString *)key {
NSLog(@"valueForUndefinedKey %@", key);
return @"AAAAA";
}
使用- (nullable id)valueForKey:(NSString *)key;
方法访问testName的值
TestKVCModel *model = [[TestKVCModel alloc] init];
NSLog(@"%@", [model valueForKey:@"testName"]);
多次输出结果:
1:
2019-08-21 10:17:54.136509+0800 TestKVC[48278:2719585] accessInstanceVariablesDirectly
2019-08-21 10:17:54.136658+0800 TestKVC[48278:2719585] _testName
2:注释_testName
2019-08-21 10:18:26.850766+0800 TestKVC[48323:2720715] accessInstanceVariablesDirectly
2019-08-21 10:18:26.850964+0800 TestKVC[48323:2720715] testName
3:注释_testName和testName
2019-08-21 10:18:56.617613+0800 TestKVC[48362:2721753] accessInstanceVariablesDirectly
2019-08-21 10:18:56.617764+0800 TestKVC[48362:2721753] isTestName
4:全部注释
2019-08-21 10:19:24.119137+0800 TestKVC[48401:2722593] accessInstanceVariablesDirectly
2019-08-21 10:19:24.119269+0800 TestKVC[48401:2722593] accessInstanceVariablesDirectly
2019-08-21 10:19:24.119399+0800 TestKVC[48401:2722593] valueForUndefinedKey testName
2019-08-21 10:19:24.119510+0800 TestKVC[48401:2722593] AAAAA
测试结果:我们分别注释TestKVCModel中的实列变量,可以观察其调用顺序,其调用顺序依次为_testName -> testName -> isTestName
注释上面三个方法默认返回值AAAAA,同时注释-(id)valueForUndefinedKey:(NSString *)key
方法,程序会崩溃
另外,- (nullable id)valueForKey:(NSString *)key
也适用于类方法
代码测试3:匹配类方法
在TestKVCModel类中添加类方法如下
//1: 获取kvc最高级
+ (NSString *)getTestName {
NSLog(@"getTestName");
return @"xxx11";
}
//2: 获取第二级
+ (NSString *)testName {
NSLog(@"testName");
return @"xxx11";
}
//3: 获取第三级
+ (NSString *)isTestName {
NSLog(@"isTestName");
return @"xxx11";
}
//4:没有访问到,默认返回值,不实现此方法,默认崩溃
+ (id)valueForUndefinedKey:(NSString *)key {
NSLog(@"valueForUndefinedKey %@", key);
return @"AAAAA11";
}
使用类方法调用- (nullable id)valueForKey:(NSString *)key;
访问testName的值
NSLog(@"%@", [TestKVCModel valueForKey:@"testName"]);
输出结果:
1:
2019-08-21 09:30:49.017583+0800 TestKVC[45743:2657198] getTestName
2019-08-21 09:30:49.017710+0800 TestKVC[45743:2657198] xxx11
2:注释+ (NSString *)getTestName方法
2019-08-21 10:00:02.245279+0800 TestKVC[47231:2691526] testName
2019-08-21 10:00:02.245431+0800 TestKVC[47231:2691526] xxx11
3:注释+ (NSString *)getTestName和+ (NSString *)testName方法
2019-08-21 10:00:43.002210+0800 TestKVC[47274:2692668] isTestName
2019-08-21 10:00:43.002343+0800 TestKVC[47274:2692668] xxx11
4:同时注释三个方法
2019-08-21 10:03:06.344779+0800 TestKVC[47426:2696736] valueForUndefinedKey testName
2019-08-21 10:03:06.344918+0800 TestKVC[47426:2696736] AAAAA11
测试结果:与代码测试1的实列方法调用一致,使用场景:在组件中获取pch文件或者其他组件定义的常量或者宏,可以在项目中为组件的类创建分类,使用- (nullable id)valueForKey:(NSString *)key;
获取值
2:KVC是如何获取值?之- (nullable id)valueForKeyPath:(NSString *)keyPath;
方法
- (nullable id)valueForKeyPath:(NSString *)keyPath;
方法是根据路径来获取值,可以获取对象中对象的实例变量值:
NSLog(@"%@", [model valueForKeyPath:@"subModel.nickName"]);
其查找的方式与- (nullable id)valueForKey:(NSString *)key;
一致,先匹配方法,再匹配实列变量
代码测试1:获取对象中对象的值
新建一个SubTestKVCModel类,内容代码如下
SubTestKVCModel.m中
//1: 获取kvc最高级
- (NSString *)getNickName {
NSLog(@"getNickName");
return @"111";
}
//2: 获取第二级
- (NSString *)nickName {
NSLog(@"nickName");
return @"111";
}
//3: 获取第三级
- (NSString *)isNickName {
NSLog(@"isNickName");
return @"111";
}
// 是否允许直接方法成员变量
+ (BOOL)accessInstanceVariablesDirectly {
NSLog(@"accessInstanceVariablesDirectly");
return NO;
}
// 没有访问到,默认返回值,不实现此方法,默认崩溃
- (id)valueForUndefinedKey:(NSString *)key {
NSLog(@"valueForUndefinedKey %@", key);
return @"BBBBB";
}
TestKVCModel.h中
@property (nonatomic, strong) SubTestKVCModel *subModel;
使用- (nullable id)valueForKeyPath:(NSString *)keyPath;
获取TestKVCModel中的subModel的nickName的值
TestKVCModel *model = [[TestKVCModel alloc] init];
model.subModel = [[SubTestKVCModel alloc] init];
NSLog(@"%@", [model valueForKeyPath:@"subModel.nickName"]);
输出结果:
2019-08-21 13:14:07.802015+0800 TestKVC[57293:2933510] getNickName
2019-08-21 13:14:07.802168+0800 TestKVC[57293:2933510] 111
也可以多层索引
NSLog(@"%@", [model valueForKeyPath:@"subModel.subSubModel.myName"]);
3:关于- (nullable id)valueForKeyPath:(NSString *)keyPath
的其他使用
1:在数组中:取最小值、最大值、平均值、求和
CGFloat sum = [[array valueForKeyPath:@"@sum.floatValue"] floatValue];
CGFloat avg = [[array valueForKeyPath:@"@avg.floatValue"] floatValue];
CGFloat max =[[array valueForKeyPath:@"@max.floatValue"] floatValue];
CGFloat min =[[array valueForKeyPath:@"@min.floatValue"] floatValue];
2:在数组中:去除重复元素
NSArray *ary = @[@"a", @"b", @"c", @"d", @"a", @"e", @"c"];
NSArray *resultAry = [ary valueForKeyPath:@"@distinctUnionOfObjects.self"];
NSLog(@"%@", resultAry);
输出:
(
c,
d,
e,
a,
b
)
更多实用方法见:https://www.jianshu.com/p/ff17a9619894
4:KVC是如何设置值的?之- (void)setValue:(nullable id)value forKey:(NSString *)key;
方法
关于- (void)setValue:(nullable id)value forKey:(NSString *)key;
设置属性值的调用过程如下:
1:查找与其名匹配的
setKey
方法
2:找到setKey
方法,判断setKey
的参数类型,如果类型非指针类型,且setValue设置的值为nil,则调用- (void)setNilValueForKey:(NSString *)key
方法
3:如果没有找到setKey
方法,则调用+ (BOOL)accessInstanceVariablesDirectly
(是否允许直接方法成员变量),返回YES则直接访问成员变量,返回NO,则调用- (void)setValue:(id)value forUndefinedKey:(NSString *)ke
,不重写此方法默认崩溃
4:直接访问成员变量,查找成员变量顺序:_<key>、_is<Key>、 <key>、 is<Key>
测试代码1
.h文件
@interface TestKVCModel : NSObject {
int _testName;
int _isTestName;
int testName;
int isTestName;
}
.m文件
//// kvc最高优先级
//- (void)setTestName:(NSString *)testName {
// NSLog(@"setTestName %@", testName);
//}
// kvc最高优先级
- (void)setTestName:(int)testName {
NSLog(@"setTestName int %d", testName);
}
// 实现setKey方法,判断setKey的参数如果非指针类型,且设置的值为nil,则调用此方法
- (void)setNilValueForKey:(NSString *)key {
NSLog(@"setNilValueForKey %@", key);
}
// 没有访问到,调用此方法,没有重写此方法会崩溃
- (void)setValue:(id)value forUndefinedKey:(NSString *)key {
NSLog(@"setValue forUndefinedKey %@", key);
}
// 没有实现setKey方法,是否允许直接方法成员变量
+ (BOOL)accessInstanceVariablesDirectly {
NSLog(@"accessInstanceVariablesDirectly");
return YES;
}
调用- (void)setValue:(nullable id)value forKey:(NSString *)key;
方法设置值
TestKVCModel *model = [[TestKVCModel alloc] init];
[model setValue:nil forKey:@"testName"];
依次注释代码,进行测试,测试结论如上
5:KVC是如何设置值的?之- (void)setValue:(nullable id)value forKeyPath:(NSString *)keyPath
方法
- (void)setValue:(nullable id)value forKeyPath:(NSString *)keyPath;
方法根据路径设置值,可以设置对象中对象的实例变量值:
[model setValue:nil forKeyPath:@"subModel.nickName"];
设置值的调用过程与- (void)setValue:(nullable id)value forKey:(NSString *)key;
方法一致
测试代码1
TestKVCModel *model = [[TestKVCModel alloc] init];
model.subModel = [[SubTestKVCModel alloc] init];
[model setValue:nil forKeyPath:@"subModel.nickName"];