KVC使用及原理详解

11

KVC:Key-Value Coding(键值编码),基于NSKeyValueCoding非正式协议实现的机制,它可以直接通过key值对对象的属性进行存取操作,而不需通过调用明确的存取方法。这样就可以在运行时动态在访问和修改对象的属性,而不是在编译时确定。

相关方法:

// 取值
- (nullable id)valueForKey:(NSString *)key;
- (nullable id)valueForKeyPath:(NSString *)keyPath;

// 赋值
- (void)setValue:(nullable id)value forKey:(NSString *)key;
- (void)setValue:(nullable id)value forKeyPath:(NSString *)keyPath;

// 批量取/赋值
- (NSDictionary<NSString *, id> *)dictionaryWithValuesForKeys:(NSArray<NSString *> *)keys;
- (void)setValuesForKeysWithDictionary:(NSDictionary<NSString *, id> *)keyedValues;

主要的使用场景

  • 访问私有API;例如,修改状态栏的背景颜色,虽然系统并未提供更改背景颜色的方法,但我们只要知道对应的key,就能通过KVC访问;
[[[UIApplication sharedApplication] valueForKey:@"statusBarWindow"] valueForKey:@"statusBar"];

不过通过KVC方式访问系统私有API,iOS13中已禁止

  • 动态访问,如字典与模型相互转换:
    Person *xm = [[Person alloc] init];
    xm.age = 10;
    xm.name = @"xiaoming";
    NSDictionary *dic = [xm dictionaryWithValuesForKeys:@[@"name",@"age"]];
    Person *xm = [[Person alloc] init];
    [xm setValuesForKeysWithDictionary:@{@"name":@"xiaoming",@"age":@(10)}];

keyPath

不同于通过key单一的访问,keyPath方式可以通过“路径”访问嵌套对象的属性:

    // key
    [self.person setValue:@"xiaoming" forKey:@"name"];
    [self.person valueForKey:@"name"];
    
    // keyPath
    [self setValue:@"xiaoming" forKeyPath:@"person.name"];
    [self valueForKeyPath:@"person.name"];
    // or
//    [self.person setValue:@"xiaoming" forKeyPath:@"name"];
//    [self.person valueForKeyPath:@"name"];

keyPath方式还可以对更“深层”的对象进行访问,对于数组可以访问数组里每个对象属性(前提是对象类型是一样的),实际的效果就和遍历数组然后对每个对象执行KVC一样:

    Person *xm = [[Person alloc] init];
    xm.name = @"xiaoming";
    Person *xh = [[Person alloc] init];
    xh.name = @"xiaohong";
    
    NSArray *persons = @[xm,xh];
    NSArray *names = [persons valueForKeyPath:@"name"]; // [@"xiaoming",@"xiaohong"]
    Person *xm = [[Person alloc] init];
    Person *xh = [[Person alloc] init];
    NSArray *persons = @[xm,xh];
    
    [persons setValue:@"xiaoming" forKeyPath:@"name"];

聚合运算

KVC支持的聚合运算:

  • sum 求和
  • max 最大值
  • min 最小值
  • avg 平均值
  • count 数量
    Person *xm = [[Person alloc] init];
    xm.age = 10;
    Person *xh = [[Person alloc] init];
    xh.age = 12;
    
    NSArray *person = @[xm,xh];
    [person valueForKeyPath:@"@sum.age"]; // @22

KVC原理

KVC是如何做到访问属性、变量的呢?对于属性,通过正常点语法访问时,都会调用getter,setter方法;KVC的方式,其实也是间接的调用了类似getter,setter方法来实现的;只不过中间会有多层判断,以满足不同名称的实例;
valueForKey获取值为例
[self valueForKey:@"key"],

  • 首先会在类中查找getKey方法,
  • 如果没有该方法接着会查找key方法,
  • 没有的话继续查找isKey方法,
  • 没有的话再继续查找_key方法;

只要有其中一个方法则直接调用,否则直接访问变量;变量名称也支持多种;和查找getter方法的逻辑一样,会依次查找_key,_isKey,key,isKey变量;只要找到了其中一个变量,则直接取值;都没有的话才会报错NSUnknownKeyException

@interface ViewController ()
{
    NSString *_key;
    NSString *_isKey;
    NSString *key;
    NSString *isKey;
}

@end

@implementation ViewController

- (void)viewDidLoad {
    [super viewDidLoad];
    _key = @"1";
    _isKey = @"2";
    key = @"3";
    isKey = @"4";
    NSLog(@"%@", [self valueForKey:@"key"]); // 11
}

- (NSString *)getKey {
    return @"11";
}

- (NSString *)key {
    return @"12";
}

- (NSString *)isKey {
    return @"13";
}

- (NSString *)_key {
    return @"14";
}

@end

分别依次注释getKeykeyisKey_key方法,输出的结果分别是12,13,14,1;然后再依次注释__key =_isKey =key =赋值语句,输出结果分别是2,3,4;

对于名为key的属性,由于自动合成了getter(key:),setter方法及_key实例变量;因此以下两种方式都能获取到正确的值:

[self valueForKey:@"key"];
[self valueForKey:@"_key"];

一张图总结以上过程:

1

对于setValue: forKey:赋值过程和取值过程类似:

  • 依次查找setKey,_setKey方法,
  • 如果没有方法查找到方法,依次查找_key,_isKey,key,isKey变量
  • 都没有的话才会报错NSUnknownKeyException