Objective - C KVC

（一）KVC （Key-Value Coding）

KVC，即键值编码，通过key来访问属性。
KVC依赖于Runtime,在Objective-C的动态性方法发挥了重要的作用。

它到底强在哪里呢？我们常听人说，“Objective-C没有真正的私有变量”，为什么会这么说呢？

  • 通过Runtime可以直接获取所有的成员变量
  • 通过KVC对成员变量直接访问读写

乍一看仿佛感觉平常用的并不多，其实在最开始还没有特别好的三方Model解析库出现时，我们都是通过-(void)setValue:(id)value forUndefinedKey:(NSString *)key及-(void)setValuesForKeysWithDictionary:dic来进行Json转对象的。
看下面的代码示例：

//.h
@interface ZQObject : NSObject

@property(nonatomic, copy)NSString *name;

@end

//.m
@implementation ZQObject

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

@end


//main.m
int main(int argc, const char * argv[]) {
    @autoreleasepool {
    
        NSDictionary *objDic = @{@"name":@"张三"};
        ZQObject *obj = [[ZQObject alloc] initZQObject];
        [obj setValuesForKeysWithDictionary:objDic];//line
        
        NSLog(@"%@", obj);
    }
    return 0;
}

在上面的代码中，我们可以直接得知，obj对象的name属性已经复制成功。而.m文件中的方法意义则在于保证在没有定义的属性时不会crash,该方法后续再讲。

（1）常见的API
  • - (void)setValue:(id)value forKeyPath:(NSString *)keyPath;
  • - (void)setValue:(id)value forKey:(NSString *)key;
  • - (id)valueForKeyPath:(NSString *)keyPath;
  • - (id)valueForKey:(NSString *)key;
（2）访问属性常规用法
  1. 设置
  • setValue: forKey:设置对象的属性值(单层)
  • setValue: forKeyPath:可以设置属性的属性(可以多层)
  self.person = [[ZQPerson alloc]init];
  //setValue: forKey:方法
  [self.person setValue:@10 forKey:@"age"];
  self.person.dog = [[ZQDog alloc] init];
 //setValue: forKeyPath:方法
  [self.person setValue:@20 forKeyPath:@"dog.height"];
  1. 访问(同理)
  • valueForKeyPath:
  • valueForKey:
  //输出10 10
  NSLog(@"%@ %@",[self.person valueForKey:@"age"],[self.person valueForKeyPath:@"dog.height"])
疑问：通过KVC设置成员变量的值，会触发KVO吗？
- (void)viewDidLoad {
    [super viewDidLoad];

    self.person = [[ZQPerson alloc]init];

    [self.person addObserver:self forKeyPath:@"age" options:NSKeyValueObservingOptionNew | NSKeyValueObservingOptionOld context:nil];
    [self.person setValue:@20 forKey:@"age"];

}

-(void)observeValueForKeyPath:(NSString *)keyPath ofObject:(id)object change:(NSDictionary<NSKeyValueChangeKey,id> *)change context:(void *)context
{
    NSLog(@"%@  %@  %@",keyPath,object,change);
}

-(void)dealloc{
    [self.person removeObserver:self forKeyPath:@"age"];
}

输出结果：会触发！

age  <ZQPerson: 0x60000026a5e0>  {
    kind = 1;
    new = 20;
    old = 0;
}

到底是什么原因呢？

(3)设值原理

①设置ZQPerson的_age成员变量为私有，添加两个方法(如下)，重新运行

//ZQPerson.h
@interface ZQPerson : NSObject{
    int _age;
}

-(void)setAge:(int)age;

-(void)_setAge:(int)age;

@end

//ZQPerson.m
@implementation ZQPerson

-(void)setAge:(int)age{
    _age = age;
    NSLog(@"setAge:%d",age);
}

-(void)_setAge:(int)age{
    _age = age;
    NSLog(@"其次找这里");
}

@end

输出结果：

setAge:20

age  <ZQPerson: 0x600003304ac0>  {
    kind = 1;
    new = 20;
    old = 0;
}

②接着注释掉setAge，再次执行：

_setAge:20

age  <ZQPerson: 0x600002b442d0>  {
    kind = 1;
    new = 20;
    old = 0;
}

我们可以得出结论一：
setValue: forKey:方法首先会查找setKey,_setKey的优先顺序先查找方法

④我们删除所有的set相关方法，重新运行：

age  <ZQPerson: 0x6000015d5cc0>  {
    kind = 1;
    new = 20;
    old = 0;
}

KVO依然会触发！！！

⑤继续，我们重写+(BOOL)accessInstanceVariablesDirectly方法，返回NO，发现报错了valueForUndefinedKey

reason: '[<ZQPerson 0x6000029ac7f0> valueForUndefinedKey:]: this class is not key value coding-compliant for the key age.'

我们可以得出结论二：
如果没有找到方法，会判断该方法是否允许查找成员变量，不允许的情况下直接报错

⑥接下来，我们将+(BOOL)accessInstanceVariablesDirectly返回YES，添加_age,_isAge,age,isAge四个成员变量：

@interface ZQPerson : NSObject{
    int _age;
    int _isAge;
    int age;
    int isAge;
}

@end

运行结果：

接下来不管是怎么注释，或者更换顺序，赋值也是按照这个优先顺序给成员变量赋值

我们可以得出结论三：
若方法是否允许查找成员变量，则会按照_age,_isAge,age,isAge的优先顺序给成员变量赋值，如果找不到，还是会报错valueForUndefinedKey

下面对上面的验证流程做一个总结：


accessInstanceVariablesDirectly方法的默认返回值是YES

只要通过setValue: forKey:的方法，只要赋值成功了，就会触发KVO（自己可以去代码验证）
可能在赋值过程内部，调用了willChangeValueForKey:及didChangeValueForKey:，可以通过重写这两个方法，发现确实会调用这两个方法（验证流程省略）

(4)取值原理
验证流程省略
(5)KVC的进阶用法

上面我们讲述了KVC是什么，但是仅仅上面的介绍，还不足以证明KVC的强大之处
KVC除了上面可以直接给成员变量赋值之外，具体可以用来干什么呢？

1. keyPath访问
需要进行多步操作的时候我们可以通过keyPath一步到位 前面已举例，不再过多的阐述
2. 集合类型访问
我们在Person类中添加一个属性friends

@interface ZQObject : NSObject

@property(nonatomic, copy)NSString *name;

@property(nonatomic, strong)NSMutableArray *friends;

@end

我们可以发现在.m文件中有提示下面三个方法

-(NSUInteger)countOfFriends{
    
}

-(id)objectInFriendsAtIndex:(NSUInteger)index{
    
}

-(NSArray *)friendsAtIndexes:(NSIndexSet *)indexes{
   
}

这是KVC帮我们针对friends属性添加的一系列的方法中的几个，表示对friends属性支持KVC类型，方便我们使用KVC对其进行便携式访问。

如果体验到这个给我们带来的好处呢？
如果我们要给friends属性添加一个值

//常规写法
NSMutableArray *arr = [obj valueForKey:@"friends"];
[arr addObject:[[ZQObject alloc] initZQObject]];

//KVC对集合属性的便携式访问
[[obj mutableSetValueForKey:@"friends"] addObject:[[ZQObject alloc] initZQObject]];

如此这样做并不是仅仅为了减少一行代码，还可以对于不可变的集合类型提供安全的访问。以前的写法，如果friends为不可变数组，会直接crash.而后者会安全的访问，即使是不可变数组，也可以添加元素（重建一个新的不可变数组，并指向)

但是这样就违背了最初就想建立一个不可变数组的初衷，带来逻辑上的矛盾。所以这样不建议这样做，了解即可

3. KVC验证
前面提到过几次，使用KVC是有风险的，因为通过字符串去访问实例变量，虽然KVC提供复杂的查找逻辑来帮助对应到对应的成员变量，但仍然会发生找不到的情况，就会导致crash.
我们可以使用- (BOOL)validateValue:(inout id _Nullable * _Nonnull)ioValue forKey:(NSString *)inKey error:(out NSError **)outError;KVC验证来验证值是否符合key所对应的类型或者值是否正确

下面我们看看常见的防止crash的方式：

//try-catch捕获异常
@try {
            [obj setValue:@"张三" forKey:@"names"];
        } @catch (NSException *exception) {
            NSLog(@"%@", exception.userInfo);
        } @finally {
            NSLog(@"finish");
        }

//在类.m中写上该方法 处理预期之外的属性匹配
-(void)setValue:(id)value forUndefinedKey:(NSString *)key{
}

//KVC验证

//main.m
int main(int argc, const char * argv[]) {
    @autoreleasepool {
        ZQObject *obj = [[ZQObject alloc] initZQObject];
        ZQPerson *per = [[ZQPerson alloc] init];
        NSError *error = nil;
        BOOL isOK = [obj validateValue:&per forKey:@"names" error:&error];
        if (isOK) {
            [obj setValue:per forKey:@"name"];
        }
      }
    return 0;
}

//ZQObject.m
//对不正确的类型设置默认值
-(BOOL)validateValue:(inout id  _Nullable __autoreleasing *)ioValue forKey:(NSString *)inKey error:(out NSError *__autoreleasing  _Nullable *)outError{
    if ([* ioValue isKindOfClass:[NSString class]]) {
        
    }else{
        *ioValue = @"default name";
    }
    return YES;
}

//对不正确的类型设置判断为NO
-(BOOL)validateValue:(inout id  _Nullable __autoreleasing *)ioValue forKey:(NSString *)inKey error:(out NSError *__autoreleasing  _Nullable *)outError{
    if ([* ioValue isKindOfClass:[NSString class]]) {
        return YES;
    }
    
    return NO;
    
}

4. 数学运算
在NSKeyValueCoding.h中开头部分即定义了很多数学方法：

NSKeyValueOperator

下面举一些常规的例子：

    ZQObject *obj = [[ZQObject alloc] initWithName:@"张三" andAge:18];
    ZQObject *obj2 = [[ZQObject alloc] initWithName:@"李四" andAge:20];
    ZQObject *obj3 = [[ZQObject alloc] initWithName:@"王五" andAge:30];
    NSArray *persons = @[obj, obj2, obj3];
        
    NSNumber *sumAge = [persons valueForKeyPath:@"@sum.age"];
    NSNumber *avgAge = [persons valueForKeyPath:@"@avg.age"];
    NSNumber *maxAge = [persons valueForKeyPath:@"@max.age"];
    NSNumber *minAge = [persons valueForKeyPath:@"@min.age"];

另外还有两种NSDistinctUnionOf...和NSUnionOf...共6个方法，分别对应Array、Dictionary、Set。
小结
  1. 由于KVC直接或间接访问成员变量，所以会存在不安全的情况
  2. KVC的验证相对麻烦些，需要对每一个验证属性写验证方法
  3. KVC的访问查找逻辑相对复杂，如果用它来JSON转Model，效率低下，尽量不用
  4. KVC依然为我们提供了一些便利，开发者应扬长避短，充分发挥KVC的强项
最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 214,172评论 6赞 493
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 91,346评论 3赞 389
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 159,788评论 0赞 349
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 57,299评论 1赞 288
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 66,409评论 6赞 386
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 50,467评论 1赞 292
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 39,476评论 3赞 412
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 38,262评论 0赞 269
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 44,699评论 1赞 307
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,994评论 2赞 328
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,167评论 1赞 343
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 34,827评论 4赞 337
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 40,499评论 3赞 322
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,149评论 0赞 21
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,387评论 1赞 267
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 47,028评论 2赞 365
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 44,055评论 2赞 352