iOS Objective-C KVC 的常见用法

iOS Objective-C KVC 的常见用法

前言

在我们的开发中经常会用到kvc给属性赋值或者取值操作，但是kvc的用处远远不止这些，下面我们就常见的一些用法做一下总结。

1. Accessing Object Properties(访问对象属性)

定义一个BankAccount类，代码如下：

@interface BankAccount : NSObject
 
@property (nonatomic) NSNumber* currentBalance;              // An attribute
@property (nonatomic) Person* owner;                         // A to-one relation
@property (nonatomic) NSArray< Transaction* >* transactions; // A to-many relation
 
@end

1.1 set value

对于属性我们可以直接调用它的set方法给其设置值。

• set

BankAccount *myAccount = [BankAccount alloc];
[myAccount setCurrentBalance:@(100.0)];

• setValue forKey

[myAccount setValue:@(100.0) forKey:@"currentBalance"];

• setValue forKeyPath

如果我们的Person中还有address属性，address中还有street，则可以使用该方法。

[myAccount setValue:@"oneaddress.twostreet" forKeyPath:@"owner.address.street"]

• set Value sForKeys WithDictionary

通过字典设置值

NSDictionary* dict = @{ @"currentBalance":@(100),
                        @"owner":personObject,
                        @"transactions":@[t1, t2],
                       };
BankAccount *myAccount = [[LGStudent alloc] init];
// 字典转模型
[myAccount setValuesForKeysWithDictionary:dict];

*setValue forUndefinedKey

当设置属性值但是没找到时会调用该方法，默认实现会触发NSUndefinedKeyException，我们可以在子类重写此方法以自定义方式处理请求。

- (void)setValue:(id)value forUndefinedKey:(NSString *)key{
    NSLog(@"没有这个key:%@",key);
}

• set NilValue ForKey

当我们将非对象属性设置为nil值时，符合键值编码的对象会向自身发送一条setNilValueForKey:消息。默认实现会触发NSInvalidArgumentException，但是对象可以覆盖此行为以代替默认值或标记值。

- (void)setNilValueForKey:(NSString *)key{
    NSLog(@"非对象属性 %@ 设置的值是空值",key);
}

1.2 get value

• valueForKey:

NSNumber *number = [myAccount valueForKey: @"currentBalance"];

• valueForKeyPath:

NSString *street = [myAccount valueForKeyPath:@"owner.address.street"]

• dictionaryWithValuesForKeys:

NSArray *array = @[@"currentBalance",@"owner",@"transactions"];
NSDictionary *dic = [myAccount dictionaryWithValuesForKeys:array];

• valueForUndefinedKey:

如果找不到由key值对应的属性，则该对象向自身发送一条valueForUndefinedKey:消息。的默认实现会触发一个NSUndefinedKeyException，但是子类可以覆盖此行为，并更优雅地处理该情况。

- (id)valueForUndefinedKey:(NSString *)key{
    NSLog(@"没有%@ 这个key - 给你一个其他的吧,别奔溃了!",key);
    return [NSObject alloc];
}

2. Accessing Collection Properties（访问集合属性）

• 通过key获取一个可变数组

- (NSMutableArray *)mutableArrayValueForKey:(NSString *)key;

• 通过keyPath获取一个可变数组

- (NSMutableArray *)mutableArrayValueForKeyPath:(NSString *)keyPath;

• 通过key获取一个NSMutableSet

- (NSMutableSet *)mutableSetValueForKey:(NSString *)key;

• 通过keyPath获取一个NSMutableSet

- (NSMutableSet *)mutableSetValueForKeyPath:(NSString *)keyPath;

• 通过key获取一个可变的有序集

- (NSMutableOrderedSet *)mutableOrderedSetValueForKey:(NSString *)key;

• 通过keyPath获取一个可变的有序集

- (NSMutableOrderedSet *)mutableOrderedSetValueForKeyPath:(NSString *)keyPath;

以上API的用处：

1. 跟当我们需要获取一个集合属性并希望修改它的时候，这比通过valueForKey获取后再写回去要更为有效。
2. 可用于KVO对可变类型的集合添加Observer，例如NSMutableArray、NSMutableSet、NSMutableOrderedSet、NSMutableDictionary等，你给它们添加KVO时，你会发现当你添加或者移除元素时并不能接收到变化。因为KVO的本质是系统监测到某个属性的内存地址或常量改变时，会添加上- (void)willChangeValueForKey:(NSString *)key和- (void)didChangeValueForKey:(NSString *)key方法来发送通知，所以一种解决方法是手动调用者两个方法，但是并不推荐，你永远无法像系统一样真正知道这个元素什么时候被改变。另一种便是利用使用mutableXXXValueForKey:了。

3. Using Collection Operators（使用集合运算符）

当我们使用valueForKeyPath:获取数据时，可以在键路径中嵌入集合运算符。集合运算符是一小部分关键字之一，其后跟一个@符号，该符号指定getter在返回数据之前应执行的操作以某种方式处理数据。

定义一个Person类：

@interface Person : NSObject

@property (nonatomic, copy)   NSString     *name;
@property (nonatomic, assign) int          age;
@property (nonatomic, assign) int          height;

@end

3.1 Aggregation Operators（聚合操作符）

聚合操作符有 @avg、@count、@max、@min、@sum，示例：

// @avg、@count、@max、@min、@sum
- (void)aggregationOperator{
    
    NSMutableArray *personArray = [NSMutableArray array];
    
    for (int i = 0; i < 6; i++) {
        Person *p = [Person new];
        NSDictionary* dict = @{
                               @"name":@"name",
                               @"age":@(18+i),
                               @"height":@(175 + 2*arc4random_uniform(6)),
                               };
        [p setValuesForKeysWithDictionary:dict];
        [personArray addObject:p];
    }
    NSLog(@"%@", [personArray valueForKey:@"height"]);
    
    /// 平均身高
    float avg = [[personArray valueForKeyPath:@"@avg.height"] floatValue];
    NSLog(@"%f", avg);
    
    /// 数量
    int count = [[personArray valueForKeyPath:@"@count.height"] intValue];
    NSLog(@"%d", count);
    
    /// 身高和
    int sum = [[personArray valueForKeyPath:@"@sum.height"] intValue];
    NSLog(@"%d", sum);
    
    /// 身高最大值
    int max = [[personArray valueForKeyPath:@"@max.height"] intValue];
    NSLog(@"%d", max);
    
    /// 身高最小值
    int min = [[personArray valueForKeyPath:@"@min.height"] intValue];
    NSLog(@"%d", min);
}

打印结果：

打印结果.jpg

3.2 Array Operators（数组操作符）

数组操作符有@distinctUnionOfObjects @unionOfObjects，示例：

NSMutableArray *personArray = [NSMutableArray array];
    
for (int i = 0; i < 6; i++) {
    Person *p = [Person new];
    NSDictionary* dict = @{
                           @"name":@"name",
                           @"age":@(18+i),
                           @"height":@(175 + 2*arc4random_uniform(6)),
                           };
    [p setValuesForKeysWithDictionary:dict];
    [personArray addObject:p];
}
NSLog(@"%@", [personArray valueForKey:@"height"]);
// 返回操作对象指定属性的集合 --- 全部对象
NSArray* arr1 = [personArray valueForKeyPath:@"@unionOfObjects.height"];
NSLog(@"arr1 = %@", arr1);
// 返回操作对象指定属性的集合 -- 去重 
NSArray* arr2 = [personArray valueForKeyPath:@"@distinctUnionOfObjects.height"];
NSLog(@"arr2 = %@", arr2);

打印结果：

打印结果.jpg

3.3 Nesting Operators（嵌套运算符）

嵌套嵌套运算符有 @distinctUnionOfArrays @unionOfArrays @distinctUnionOfSets，示例：

@distinctUnionOfArrays @unionOfArrays

- (void)arrayNesting{
    NSMutableArray *personArray1 = [NSMutableArray array];
    for (int i = 0; i < 6; i++) {
        Person *p = [Person new];
        NSDictionary* dict = @{
                               @"name":@"name",
                               @"age":@(18+i),
                               @"height":@(175 + 2*arc4random_uniform(6)),
                               };
        [p setValuesForKeysWithDictionary:dict];
        [personArray1 addObject:p];
    }
    
    NSMutableArray *personArray2 = [NSMutableArray array];
    for (int i = 0; i < 6; i++) {
        Person *p = [Person new];
        NSDictionary* dict = @{
                               @"name":@"name",
                               @"age":@(18+i),
                               @"height":@(175 + 2*arc4random_uniform(6)),
                               };
        [p setValuesForKeysWithDictionary:dict];
        [personArray2 addObject:p];
    }
    
    // 嵌套数组
    NSArray* nestArr = @[personArray1, personArray2];
    
    // 返回全部对象到一个数组
    NSArray* arr1 = [nestArr valueForKeyPath:@"@unionOfArrays.height"];
    NSLog(@"arr1 = %@", arr1);
    
    // 返回去重的对象到一个数组
    NSArray* arr = [nestArr valueForKeyPath:@"@distinctUnionOfArrays.height"];
    NSLog(@"arr = %@", arr);
}

打印结果：

打印结果.jpg

@distinctUnionOfSets：

- (void)setNesting{
    
    NSMutableSet *personSet1 = [NSMutableSet set];
    for (int i = 0; i < 6; i++) {
        Person *p = [Person new];
        NSDictionary* dict = @{
                               @"name":@"name",
                               @"age":@(18+i),
                               @"height":@(175 + 2*arc4random_uniform(6)),
                               };
        [p setValuesForKeysWithDictionary:dict];
        [personSet1 addObject:p];
    }
    
    NSLog(@"personSet1 = %@", [personSet1 valueForKey:@"height"]);
    
    NSMutableSet *personSet2 = [NSMutableSet set];
    for (int i = 0; i < 6; i++) {
        Person *p = [Person new];
        NSDictionary* dict = @{
                               @"name":@"name",
                               @"age":@(18+i),
                               @"height":@(175 + 2*arc4random_uniform(6)),
                               };
        [p setValuesForKeysWithDictionary:dict];
        [personSet2 addObject:p];
    }
    NSLog(@"personSet2 = %@", [personSet2 valueForKey:@"height"]);

    // 嵌套set
    NSSet* nestSet = [NSSet setWithObjects:personSet1, personSet2, nil];
    // 并集
    NSSet* set1 = [nestSet valueForKeyPath:@"@distinctUnionOfSets.height"];
    NSLog(@"set1 = %@", set1);
}

打印结果：

打印结果.jpg

4. Representing Non-Object Values（表示非对象值）

当我们通过任意一个getter获取值的时候，如果返回值不是对象，则getter使用此值初始化一个NSNumber或者NSValue对象，返回该值。类似的在使用Setter的时候，如果我们给定的值不是对象，我们也需要将使用适当的类型传入值对象，然后通过对象存储该数据。

封装在NSNumber对象中的标量类型

NSNumber.jpg

封装在NSValue中的常见结构体类型

NSValue.jpg

使用自定义的结构体类型：

定义结构体：

typedef struct {
    float x, y, z;
} ThreeFloats;
 
@interface MyClass
@property (nonatomic) ThreeFloats threeFloats;
@end

给自定义结构体赋值：

ThreeFloats floats = {1., 2., 3.};
NSValue* value = [NSValue valueWithBytes:&floats objCType:@encode(ThreeFloats)];
[myClass setValue:value forKey:@"threeFloats"];

使用KVC取出自定义结构体的值：

NSValue* result = [myClass valueForKey:@"threeFloats"];
ThreeFloats th;
[reslut getValue:&th] ;
NSLog(@"%f - %f - %f",th.x,th.y,th.z);

5. Validating Properties（验证属性）

KVC支持属性验证的方法，分别是validateValue:forKey:error:和validateValue:forKeyPath:error:，这个验证方法的默认实现是去收到这个验证消息的对象(或keyPath中最后的对象)中根据 key 查找是否有对应的 validate:error: 方法实现，如果没有，验证默认成功，返回 YES。，当存在特定属性的验证方法时，默认实现将返回调用该方法的结果。

由于特定于属性的验证方法通过引用接收值和错误参数，因此验证具有三种可能的结果：

1. 验证方法认为值对象有效，并在YES不更改值或错误的情况下返回。

2. 验证方法认为值对象无效，但选择不对其进行更改。在这种情况下，该方法返回NO错误参考并将错误参考（如果由调用者提供）设置为NSError指示失败原因的对象。

3. 验证方法认为值对象无效，但创建了一个新的有效对象作为替换。在这种情况下，该方法返回，YES而错误对象保持不变。在返回之前，该方法将值引用修改为指向新值对象。进行修改时，即使值对象是可变的，该方法也总是创建一个新对象，而不是修改旧对象。

示例代码：

Person* person = [[Person alloc] init];
NSError* error;
NSString* name = @"John";
if (![person validateValue:&name forKey:@"name" error:&error]) {
    NSLog(@"%@",error);
}

5.参考资料

Apple Documentation - About Key-Value Coding