KVC

作者: SPIREJ | 来源:发表于2019-11-12 00:31 被阅读0次

KVC定义

KVC（Key-value coding）键值编码，就是指iOS的开发中，可以允许开发者通过Key名直接访问对象的属性，或者给对象的属性赋值。而不需要调用明确的存取方法。这样就可以在运行时动态地访问和修改对象的属性。而不是在编译时确定，这也是iOS开发中的黑魔法之一。很多高级的iOS开发技巧都是基于KVC实现的。

在实现了访问器方法的类中，使用点语法和KVC访问对象其实差别不大，二者可以任意混用。但是没有访问器方法的类中，点语法无法使用，这时KVC就有优势了。

KVC的定义都是对NSObject的扩展来实现的，Objective-C中有个显式的NSKeyValueCoding类别名，所以对于所有继承了NSObject的类型，都能使用KVC(一些纯Swift类和结构体是不支持KVC的，因为没有继承NSObject)，下面是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来设值

NSKeyValueCoding类别中其他的一些方法：

+ (BOOL)accessInstanceVariablesDirectly;
//默认返回YES，表示如果没有找到Set<Key>方法的话，会按照_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<NSString *, id> *)dictionaryWithValuesForKeys:(NSArray<NSString *> *)keys;
//输入一组key,返回该组key对应的Value，再转成字典返回，用于将Model转到字典。

同时苹果对一些容器类比如NSArray或者NSSet等，KVC有着特殊的实现。

有序集合对应的方法如下：

-countOf<Key>//必须实现，对应于NSArray的基本方法count: 

-objectIn<Key>AtIndex:

-<key>AtIndexes://这两个必须实现一个，对应于 NSArray 的方法 objectAtIndex: 和 objectsAtIndexes:

-get<Key>:range://不是必须实现的，但实现后可以提高性能，其对应于 NSArray 方法 getObjects:range:

-insertObject:in<Key>AtIndex:

-insert<Key>:atIndexes://两个必须实现一个，类似于 NSMutableArray 的方法 insertObject:atIndex: 和 insertObjects:atIndexes:

-removeObjectFrom<Key>AtIndex:

-remove<Key>AtIndexes://两个必须实现一个，类似于 NSMutableArray 的方法 removeObjectAtIndex: 和 removeObjectsAtIndexes:

-replaceObjectIn<Key>AtIndex:withObject:

-replace<Key>AtIndexes:with<Key>://可选的，如果在此类操作上有性能问题，就需要考虑实现之

通过以下几个方面来了解KVC相关的技术概念以及使用：

KVC设值
KVC取值
KVC使用keyPath
KVC处理异常
KVC键值验证（Key-Value Validation）
KVC处理数值和结构体类型属性
KVC处理集合
KVC处理字典

KVC相关技术概念

KVC设值

最好的学习文档就是官方文档，根据苹果官方文档KVC 的注解，可粗略得出下面这张KVC设置的流程：

KVC赋值过程.png

程序优先调用相关方法 set<Key>: 方法，代码通过setter方法完成设置，若key是成员变量，还会依次寻找set<Key>:，_set<Key>:， setIs<Key>:方法
如果没有找到set<Key>:方法，KVC机制会检查+ (BOOL)accessInstanceVariablesDirectly方法有没有返回YES，默认该方法会返回YES，如果你重写了该方法让其返回NO的话，那么KVC会执行setValue：forUndefinedKey:方法，系统抛出异常，未定义key。
若是YES，所以KVC机制会搜索该类里面有没有名为_<key> _is<Key> <key> is<Key>的成员变量，存在以<key>命名的变量，KVC都可以对该成员变量赋值。
方法和成员变量都不存在，setValue：forUndefinedKey:方法，系统抛出异常，未定义key

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

KVC取值

KVC取值过程.png

当调用valueForKey：时，KVC对key的搜索方式不同于setValue：属性值 forKey：其搜索方式如下：

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

这里有示例代码分析KVC赋值和取值查找过程 https://github.com/SPIREJ/KVC

KVC使用keyPath

在开发过程中，一个类的成员变量有可能是自定义类或其他的复杂数据类型，你可以先用KVC获取该属性，然后再次用KVC来获取这个自定义类的属性，
但这样是比较繁琐的，对此，KVC提供了一个解决方案，那就是键路径keyPath。顾名思义，就是按照路径寻找key。例如：

[self.textFiled setValue:[UIColor orangeColor] forKeyPath:@"_placeholderLabel.textColor"];

KVC异常处理

1. KVC处理nil异常

通常情况下，KVC不允许你要在调用setValue：属性值 forKey：(或者keyPath)时对非对象传递一个nil的值。很简单，因为值类型是不能为nil的。如果你不小心传了，KVC会调用setNilValueForKey:方法。这个方法默认是抛出异常，所以一般而言最好还是重写这个方法。

- (void)setNilValueForKey:(NSString *)key {
    NSLog(@"出现异常，不能将%@的值设置为nil", key);
}

2. KVC处理UndefinedKey

通常情况下，KVC不允许你要在调用setValue：属性值 forKey：(或者keyPath)时对不存在的key进行操作。
不然，会报错forUndefinedKey发生崩溃，重写forUndefinedKey方法避免崩溃。

- (id)valueForUndefinedKey:(NSString *)key {
    NSLog(@"出现异常，不存在key: %@", key);
    return nil;
}

- (void)setValue:(id)value forUndefinedKey:(NSString *)key{
    NSLog(@"出现异常，不存在key: %@", key);
}

KVC键值验证（Key-Value Validation）

KVC提供了验证key对应的value是否可用的方法：

- (BOOL)validateValue:(inout id _Nullable * _Nonnull)ioValue forKey:(NSString *)inKey error:(out NSError **)outError;

示例：

- (BOOL)validateValue:(inout id  _Nullable __autoreleasing *)ioValue forKey:(NSString *)inKey error:(out NSError *__autoreleasing  _Nullable *)outError {
    
    if (*ioValue == nil || inKey == nil || inKey.length == 0) {
          NSLog(@"value可能为nil, 或者key为nil或者空值");
          return NO;
      }
    return YES;
}

// --------调用
NSString *value = nil;
NSError *error;
BOOL validate =  [p validateValue:&value forKey:@"password" error:&error];
if (validate) {
    [p setValue:value forKey:@"password"];
}

// --------打印
//value可能为nil, 或者key为nil或者空值

KVC处理数值和结构体类型属性

不是每一个方法都返回对象，但是valueForKey：总是返回一个id对象，如果原本的变量类型是值类型或者结构体，返回值会封装成NSNumber或者NSValue对象。
这两个类会处理从数字，布尔值到指针和结构体任何类型。然后开以者需要手动转换成原来的类型。
尽管valueForKey：会自动将值类型封装成对象，但是setValue：forKey：却不行。你必须手动将值类型转换成NSNumber或者NSValue类型，才能传递过去。
因为传递进去和取出来的都是id类型，所以需要开发者自己担保类型的正确性，运行时Objective-C在发送消息的会检查类型，如果错误会直接抛出异常。

举个例子，Person类有个NSInteger类型的age属性，如下:

@property (nonatomic,assign) NSInteger age;

设置值：通过KVC设置age属性的值

[person setValue:[NSNumber numberWithInteger:18] forKey:@"age"];

我们赋给age的是一个NSNumber对象，KVC会自动的将NSNumber对象转换成NSInteger对象，然后再调用相应的访问器方法设置age的值。

获取值：这时，会以NSNumber的形式返回age的值

[person valueForKey:@"age"];

那到底哪些类型数据要用NSNumber封装哪些类型数据要用NSValue封装呢？

可以使用NSNumber的数据类型有：（就是一些常见的数值类型）

+ (NSNumber*)numberWithChar:(char)value;
+ (NSNumber*)numberWithUnsignedChar:(unsignedchar)value;
+ (NSNumber*)numberWithShort:(short)value;
+ (NSNumber*)numberWithUnsignedShort:(unsignedshort)value;
+ (NSNumber*)numberWithInt:(int)value;
+ (NSNumber*)numberWithUnsignedInt:(unsignedint)value;
+ (NSNumber*)numberWithLong:(long)value;
+ (NSNumber*)numberWithUnsignedLong:(unsignedlong)value;
+ (NSNumber*)numberWithLongLong:(longlong)value;
+ (NSNumber*)numberWithUnsignedLongLong:(unsignedlonglong)value;
+ (NSNumber*)numberWithFloat:(float)value;
+ (NSNumber*)numberWithDouble:(double)value;
+ (NSNumber*)numberWithBool:(BOOL)value;
+ (NSNumber*)numberWithInteger:(NSInteger)valueNS_AVAILABLE(10_5,2_0);
+ (NSNumber*)numberWithUnsignedInteger:(NSUInteger)valueNS_AVAILABLE(10_5,2_0);

可以使用NSValue的数据类型有：

+ (NSValue*)valueWithCGPoint:(CGPoint)point;
+ (NSValue*)valueWithCGSize:(CGSize)size;
+ (NSValue*)valueWithCGRect:(CGRect)rect;
+ (NSValue*)valueWithCGAffineTransform:(CGAffineTransform)transform;
+ (NSValue*)valueWithUIEdgeInsets:(UIEdgeInsets)insets;
+ (NSValue*)valueWithUIOffset:(UIOffset)insetsNS_AVAILABLE_IOS(5_0);

NSValue主要用于处理结构体型的数据，它本身提供了如上集中结构的支持。任何结构体都是可以转化成NSValue对象的，包括其它自定义的结构体。

KVC处理集合

KVC同时还提供了很复杂的函数，主要有下面这些：

1、简单集合运算符

简单集合运算符共有@avg， @count ， @max ， @min ，@sum5种，通过一个例子来演示。

@property (nonatomic, copy) NSString *name;
@property (nonatomic, assign) CGFloat price;

///------我是分割线

- (void)bookTest {
    Book *book1 = [Book new];
    book1.name = @"The Great Gastby";
    book1.price = 10;
    Book *book2 = [Book new];
    book2.name = @"Time History";
    book2.price = 20;
    Book *book3 = [Book new];
    book3.name = @"Wrong Hole";
    book3.price = 30;
   
    Book *book4 = [Book new];
    book4.name = @"Wrong Hole";
    book4.price = 40;
   
    NSArray* arrBooks = @[book1,book2,book3,book4];
    NSNumber* sum = [arrBooks valueForKeyPath:@"@sum.price"];
    NSLog(@"sum:%f",sum.floatValue);
    NSNumber* avg = [arrBooks valueForKeyPath:@"@avg.price"];
    NSLog(@"avg:%f",avg.floatValue);
    NSNumber* count = [arrBooks valueForKeyPath:@"@count"];
    NSLog(@"count:%f",count.floatValue);
    NSNumber* min = [arrBooks valueForKeyPath:@"@min.price"];
    NSLog(@"min:%f",min.floatValue);
    NSNumber* max = [arrBooks valueForKeyPath:@"@max.price"];
    NSLog(@"max:%f",max.floatValue);
}

打印结果：

2019-11-11 16:45:15.451619+0800 KVC[18842:2647883] sum:100.000000
2019-11-11 16:45:15.451953+0800 KVC[18842:2647883] avg:25.000000
2019-11-11 16:45:15.454993+0800 KVC[18842:2647883] count:4.000000
2019-11-11 16:45:15.455196+0800 KVC[18842:2647883] min:10.000000
2019-11-11 16:45:15.455306+0800 KVC[18842:2647883] max:40.000000

2、对象运算符

比集合运算符稍微复杂，能以数组的方式返回指定的内容，一共有两种：

@distinctUnionOfObjects
@unionOfObjects

它们的返回值都是NSArray，区别是前者返回的元素都是唯一的，是去重以后的结果；后者返回的元素是全集。

例如：(代码接上)

NSLog(@"distinctUnionOfObjects");
NSArray* arrDistinct = [arrBooks valueForKeyPath:@"@distinctUnionOfObjects.price"];
for (NSNumber *price in arrDistinct) {
    NSLog(@"%f",price.floatValue);
}

NSLog(@"unionOfObjects");
NSArray* arrUnion = [arrBooks valueForKeyPath:@"@unionOfObjects.price"];
for (NSNumber *price in arrUnion) {
    NSLog(@"%f",price.floatValue);
}

2019-11-11 16:50:39.715850+0800 KVC[18904:2653549] distinctUnionOfObjects
2019-11-11 16:50:39.716505+0800 KVC[18904:2653549] 20.000000
2019-11-11 16:50:39.717081+0800 KVC[18904:2653549] 30.000000
2019-11-11 16:50:39.717421+0800 KVC[18904:2653549] 40.000000
2019-11-11 16:50:39.717860+0800 KVC[18904:2653549] unionOfObjects
2019-11-11 16:50:39.718361+0800 KVC[18904:2653549] 30.000000
2019-11-11 16:50:39.719007+0800 KVC[18904:2653549] 20.000000
2019-11-11 16:50:39.719167+0800 KVC[18904:2653549] 30.000000
2019-11-11 16:50:39.749840+0800 KVC[18904:2653549] 40.000000

KVC处理字典

当对NSDictionary对象使用KVC时，valueForKey:的表现行为和objectForKey:一样。所以使用valueForKeyPath:用来访问多层嵌套的字典是比较方便的。

KVC里面还有两个关于NSDictionary的方法:

- (NSDictionary<NSString *, id> *)dictionaryWithValuesForKeys:(NSArray<NSString *> *)keys;
- (void)setValuesForKeysWithDictionary:(NSDictionary<NSString *, id> *)keyedValues;

dictionaryWithValuesForKeys:是指输入一组key，返回这组key对应的属性，再组成一个字典。
setValuesForKeysWithDictionary是用来修改Model中对应key的属性。下面直接用代码会更直观一点:

@interface Address : NSObject

@property (nonatomic, copy)NSString* country;
@property (nonatomic, copy)NSString* province;
@property (nonatomic, copy)NSString* city;
@property (nonatomic, copy)NSString* district;

@end

///------我是分割线

- (void)AddressTest {
    //模型转字典
    Address* add = [Address new];
    add.country = @"China";
    add.province = @"Guang Dong";
    add.city = @"Shen Zhen";
    add.district = @"Nan Shan";
    NSArray* arr = @[@"country",@"province",@"city",@"district"];
    //把对应key所有的属性全部取出来
    NSDictionary* dict = [add dictionaryWithValuesForKeys:arr];
    NSLog(@"%@",dict);
    
    //字典转模型
    NSDictionary* modifyDict = @{@"country":@"USA",@"province":@"california",@"city":@"Los angle"};
    //用key Value来修改Model的属性
    [add setValuesForKeysWithDictionary:modifyDict];
    NSLog(@"country:%@  province:%@ city:%@",add.country,add.province,add.city);
}

打印结果

2019-11-11 17:05:24.649851+0800 KVC[19010:2669916] {
    city = "Shen Zhen";
    country = China;
    district = "Nan Shan";
    province = "Guang Dong";
}
2019-11-11 17:05:24.650093+0800 KVC[19010:2669916] country:USA  province:california city:Los angle

打印出来的结果完全符合预期。

参考：
iOS KVC和KVO详解

KVC

KVC定义

KVC相关技术概念

KVC设值

KVC取值

KVC使用keyPath

KVC异常处理

1. KVC处理nil异常

2. KVC处理UndefinedKey

KVC键值验证（Key-Value Validation）

KVC处理数值和结构体类型属性

KVC处理集合

KVC处理字典

相关文章

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读