iOS进阶 -- KVC应用及原理

奔跑的不将就
1,806 阅读11分钟

前言

KVC又称键值编码 （Key-Value-Coding），在iOS开发中是一个比较常见的技术点，相信很多开发人员都使用过KVC，其主要的两个方法就是如下两个，分别对应设置值和取值：

- (void)setValue:(nullable id)value forKey:(NSString *)key;
- (nullable id)valueForKey:(NSString *)key;

平时的开发中，我们有很多地方使用到KVC，例如给一个对象的属性赋值、StroyBoard中给控件的layer设置边框等都是KVC的应用，本篇文章就来探索下KVC的原理及使用注意事项。

一、KVC的使用技巧

1.1、KVC机制

在代码中调用KVC，然后进入源码定义处，可以发现苹果给 NSObject、NSArray等都加了一个# NSKeyValueCoding 分类，如下图所示：

KVC源码定义.png

NSKeyValueCoding是什么呢？通过 KVC文档 和 NSKeyValueCoding 可以发现其解释如下：

Xnip2021-07-25_09-15-39.png

Xnip2021-07-25_09-15-51.png

图中的大致意思是，NSKeyValueCoding 是一种非正式协议，它提供了一种可以间接访问对象属性的机制，这套机制使得我们可以通过一个简洁明晰的字符串接口访问对象属性。这种机制补充了对象的实例变量的访问。

怎么理解这段话呢？我们新建一个工程 KVCDemo，然后创建一个 BPPerson 类，在该类中分别添加属性及成员变量如下：

Xnip2021-07-25_09-39-01.png

Xnip2021-07-25_09-30-19.png

在调用bpName、title、hobby时，会出现如下情况：

Xnip2021-07-25_09-35-46.png

图中的错误我们都可以理解，bpName 定义在.m实现文件中，外部无法直接访问，其实如果 hobby 不添加 @public 修饰，其默认为 protect，也是无法访问的。但是通过 KVC 则可以避免这些限制，代码如下：

void personKVC(void) {

    BPPerson *person = [BPPerson alloc];

//    person.title = @"攻城狮";

//    person->hobby = @"running and programming";

//    person->bpName = @"奔跑";

    [person setValue:@"BP" forKey:@"bpName"];

    [person setValue:@"running and programming" forKey:@"hobby"];

    [person setValue:@"攻城狮" forKey:@"title"];

    [person printPerson];
    [person printPersonKVC];
}

代码运行结果如下

Xnip2021-07-25_10-05-02.png

可以发现通过KVC成功访问了属性和成员变量，并且成功赋值和取值。

1.2 KVC API介绍

1.2.1 NSObject的 API

KVC中最为基础的两个 API就是 setValue: forKey: 和 valueForKey:，分别是根据 Key 设置值 和取出值，其用法如上面例子所示。此外，还有一些其他的方法供我们调用，下面以如下几个方法为例进行探究“

第一个方法如下：

/* 
   Given a key that identifies an _ordered_ to-many relationship, return a mutable 
   array that provides read-write access to the related objects. Objects added to the
   mutable array will become related to the receiver, and objects removed from the 
   mutable array will become unrelated.
*/
- (NSMutableArray *)mutableArrayValueForKey:(NSString *)key;

在对象包含一个数组变量时，如果调用该方法，会得到一个可变数组，通过修改该数组中的元素，使得原数组也发生变更，即使原数组是不可变数组。下面我们验证下，在 BPPerson 中添加一个不可变数组属性

@property (nonatomic, copy) NSArray *array;

进行如下调用，并得到的结果如下：

Xnip2021-07-25_13-17-34.png

可以发现原数组本来是 @[@"1", @"2", @"3"]，本来不可以被修改，但是通过调用该方法，得到可变数组，并修改其中的值后，发现原数组也变为了图中结果。

第二个方法主要是为了介绍 keyPath，与之相关的有读写两个，所以一起介绍：

- (nullable id)valueForKeyPath:(NSString *)keyPath;
- (void)setValue:(nullable id)value forKeyPath:(NSString *)keyPath;

我们先新建一个 BPAnimal 类，然后在 BPPerson 中加一个 pet 属性，代码如下：

@interface BPPerson : NSObject {
    @public NSString *hobby;
}

@property (nonatomic, copy) NSString *title;
@property (nonatomic, copy) NSArray *array;
@property (nonatomic, strong) BPAnimal *pet; // 宠物
- (void)printPerson;
- (void)printPersonKVC;

@end

@interface BPAnimal : NSObject
@property (nonatomic, copy) NSString *breed; // 品种
@end

BPPerson 中添加一个宠物 pet 属性， 宠物有自己的品种，因此 BPAnimal 中包含一个 breed 属性。 下面通过keyPath来尝试写入和取值，代码和结果如下

Xnip2021-07-25_13-43-33.png

由图中结果可以看出，通过 pet.breed 这一条 keyPath，成功完成赋值。此外还有其他的API还没探索，有兴趣的小伙伴可以继续探索，这里探索了平时使用较多的API。

1.2.2 NSArray 的 valueForKey

在平时我们使用 NSArray 时，用到最多的就是 objectAtIndex，根据下标进行取值。但是在查看KVC的定义时可以发现，NSArray 和 NSMutableArray 也有 valueForKey 的方法，如下代码所示：

@interface NSArray<ObjectType>(NSKeyValueCoding)

/* Return an array containing the results of invoking -valueForKey: 
on each of the receiver's elements. The returned array will contain 
NSNull elements for each instance of -valueForKey: returning nil.*/

- (id)valueForKey:(NSString *)key;

/* Invoke -setValue:forKey: on each of the receiver's elements.*/

- (void)setValue:(nullable id)value forKey:(NSString *)key;
@end

通过注释可以得知，数组的 valueForKey 做的事情是，对数组中的元素调用 valueForKey 方法，并返回一个数组。通过以下demo可以验证这一点：

Xnip2021-07-25_14-36-46.png

由结果发现，对于array调用 setValue:forKey：将原有的狮子改为了老虎，而取值也是统一取出了老虎，因为此时数组中的元素都发生了改变。

需要注意的是，如果数组中的元素不是同一个类的，那么调用该方法就存在崩溃的风险，因为可能有部分元素不存在传入的key，示例如下图：

Xnip2021-07-25_14-43-42.png

当最后一个元素换为 person时，person没有breed变量，因此发生崩溃，并报错 setValue:forUndefinedKey:

1.2.3 NSDictionary的 setObjcet:forKey: 与 setValue:forKey: 的区别

在使用可变字典设置值时，我们经常调用的是 setObjcet:forKey:，但是如果调用 setValue:forKey: 也不会报错，并且也能成功赋值，那么这两个方法到底有什么区别呢？我们先看一下字典的KVC定义，代码如下：

Xnip2021-07-25_14-50-35.png

通过注释可以发现，在调用 setValue:forKey: 时，相当于调用了 setObjcet:forKey:，但是如果传入的value为nil，则会调用 -removeObjectForKey:，而取值调用 valueForKey: 则相当于调用 -objectForKey:。下面通过一个demo验证下：

Xnip2021-07-25_14-59-50.png

可以发现，原本 BP 值为 NP，第一次传入 666，修改成功，但是当第二次传入 nil 时，直接移除了 BP 这个 Key。这里还可以发现一个细节，只有可变字典才有 setValue:forKey:，而不可变字典中则没有进行声明，说明KVC也是还是要保留了字典可变与不可变的特性。

二、KVC的调用流程

对于KVC的调用流程，在 KVC Fundamentals 中可以看到对应的描述，下面我们分为 setValue 和 valueForKey 两部分来分析下其调用流程。

2.1 setValue:forKey:

在官方文档中可以发现如下一段描述：

Xnip2021-07-25_15-58-27.png

总结一下可以分为3步：

  • 首先按照 set<<Key>Key> 、 _set<Key> 的顺序查找方法，如果找到了就调用并赋值，完成KVC流程
  • 如果没找到，并且 accessInstanceVariablesDirectly 方法返回 YES，则按照 _<Key>、_is<Key>、<Key>、is<Key>的顺序查找，如果找到其中一个就将传入的值赋值，并完成KVC流程
  • 如果以上两步都没有找到，就调用 setValue:forUndefinedKey:方法，并抛出异常。

下面通过一个Demo来验证一下，首先按照规则定义对应的成员变量和方法，并先将accessInstanceVariablesDirectly返回 NO。代码如下：

@interface BPPerson : NSObject {
    NSString *hobby;
    NSString *_hobby;
    NSString *ishobby;
    NSString *_ishobby;
}

+ (BOOL)accessInstanceVariablesDirectly {
    return NO;
}

- (void)setHobby:(NSString *)hobby {
    NSLog(@"setHobby == %s", __func__);
}

- (void)_setHobby:(NSString *)hobby {
    NSLog(@"setHobby == %s", __func__);
}

1、此时的调用结果如下：

Xnip2021-07-25_23-49-02.png

可以发现确实先调用了 setHobby: 方法，并且四个成员变量均为nil，因为setHobby:方法没有进行赋值操作。

2、接下来注释该方法，只保留 _setHobby:调用结果如下：

Xnip2021-07-25_23-53-53.png

可以发现此次直接调用 _setHobby: 方法，四个成员变量依然均为 nil，表明并未赋值。

3、继续注释 _setHobby: 方法，并且看下 accessInstanceVariablesDirectly 分别为 NO 和 YES 的情况：

  • accessInstanceVariablesDirectly 为NO时结果如下：

Xnip2021-07-25_23-57-54.png

此时直接抛出异常 setValue:forUndefinedKey:，四个成员变量当然不可能赋值。

  • accessInstanceVariablesDirectly 为YES时结果如下：

Xnip2021-07-26_00-01-05.png

此时发现成员变量 _hobby 成功赋值，其它依然为nil，也正符合第二条规则的顺序的第一个寻找的变量。

  • 按照顺序注释成员变量，依次打印的结果如下： Xnip2021-07-26_00-29-35.png

Xnip2021-07-26_00-30-20.png

Xnip2021-07-26_00-31-07.png

通过打印结果可以发现，对于成员变量的查找顺序确实如文档所说的 _<Key>、_is<Key>、<Key>、is<Key>。在测试过程中，曾将成员变量写作 ishobby、_ishobby，这样写最终导致了异常抛出，也从侧面验证了第三条，找不到时会抛出异常。

4、变量的查找会考虑is<Key> 和 _is<Key>的变量，那么对于set方法会不会也有类似的调用呢？在这里我们可以补充下 setIs<Key> 和 _setIs<Key>的调用情况验证。

先增加两个方法如下：

- (void)setIsHobby:(NSString *)hobby {
    NSLog(@"setIsHobby == %s", __func__);
}
- (void)_setIsHobby:(NSString *)hobby {
    NSLog(@"_setIsHobby == %s", __func__);
}

调用 setValue:forKey:后，的执行结果如下：

Xnip2021-07-26_09-37-23.png

然后注释 setIsHobby:方法，再次执行setValue:forKey:，结果如下：

Xnip2021-07-26_09-37-54.png

通过结果可以发现，实际上在_setHobby:注释后，并没有马上查找成员变量，而是继续查找并调用了setIsHobby:，但是当setIsHobby:注释后，并不会再查找 _setIsHobby:，而是直接给成员变量赋值。也就是说文档中所说的第一步中会多查找一个方法setIs<Key>，但是不会对_setIs<Key>进行调用。

KVC调用流程整理如下图：

KVC写入.jpg

2.2 valueForKey:

对于取值过程 valueForKey 的描述如下：

Xnip2021-07-26_00-42-55.png

这段描述也可以分为几个流程：

  • 1、按照 get<Key>、<key>、is<Key>、_<key>的顺序查找方法实现，如果找到就调用，并执行第5步；
  • 2、如果上一步中没有找到，并且是一个数组类型，则调用数组相关的方法；
  • 3、如果上一步没找到，并且是一个集合类型，则调用集合相关方法；
  • 4、如果以上都没找到，则判断accessInstanceVariablesDirectly 是否为 YES，如果为YES，则依次查找成员变量_<key>, _is<Key>, <key>, is<Key>，如果查找到则进行第5步，否则进行第6步
  • 5、查找到值，需要对值进行处理
    • 如果检索到的值是一个对象指针，则直接返回该对象，
    • 如果是一个 NSNumber标量，则将其存储在NSNumber中并返回，
    • 如果不是一个 NSNumber标量，则存储在 NSValue中并返回
  • 6、在1～4未找到的情况下，抛出异常

以上流程中有针对数组和集合的处理，而对于字典的处理并不在这一步骤中，这是因为如前文所述，字典的KVC实际上是调用自己的 setObject:forKey: 和 objectForKey: 方法，并不会查找自身的成员变量和属性。

下面对普通对象的 valueForKey: 进行验证如下：

Xnip2021-07-26_11-01-09.png

按照步骤要求给成员变量赋值不同的值，同时在实现上述第一步的方法时，再增加 getIsHobby方法。下面开始进行验证：

1、直接调用 valueForKey:，结果如下：

Xnip2021-07-26_11-12-37.png

从结果可以看到，这里直接调用 getHobby 方法，并且没有从成员变量取值。

2、下面依次注释 getHobby、hobby、isHobby、_hobby，结果依次如下：

Xnip2021-07-26_11-50-10.png

Xnip2021-07-26_11-51-21.png

Xnip2021-07-26_11-51-52.png

Xnip2021-07-26_11-52-28.png

分析结果如下：

  • 注释 getHobby后，结果显示直接调用了hobby方法，未从变量取值
  • 注释 hobby后，结果显示直接调用了isHobby方法，未从变量取值
  • 注释 isHobby后，结果显示直接调用了_hobby方法，未从变量取值
  • 注释 _hobby后，并未调用getIsHobby和_isHobby方法，而是直接从变量_hobby取值

由这个结果发现，对于方法的查找次序确实是如第一步 get<Key>、<key>、is<Key>、_<key>，并且不会调用其他的方法

3、接下来验证变量的值的查找，依次注释_hobby, _isHobby, hobby, isHobby，发现结果如下：

Xnip2021-07-26_11-58-54.png

Xnip2021-07-26_11-59-38.png

Xnip2021-07-26_12-00-08.png

Xnip2021-07-26_12-00-43.png

根据结果可以发现变量的调用顺序确实如_<key>, _is<Key>, <key>, is<Key>，并且最终未找到时会抛出异常valueForUndefinedKey:。

在测试过程中，还有一个细节，就是当注释_hobby的赋值语句，但_hobby定义并未注释时，打印结果如下：

Xnip2021-07-26_12-02-06.png

可以发现结果此时并没有因为_hobby值为nil，就去查找_isHobby，而是直接取_hobby的值，这一次序不因为变量值而改变，在setValue:forKey:时，也是这样。

valueForKey的流程图如下：

kvc取值.jpg

总结

总结起来，本篇主要介绍了KVC的相关内容，主要有以下几点：

  • KVC提供了一种机制，可以间接访问对象的成员变量和属性（不过对于是否安全，这个技术是否破坏了对象的封装性等等，就仁者见仁，智者见智了，但苹果提供了这样一种机制，并且没有取消掉，所以存在即合理吧）
  • KVC的写入值，会先调用相关的set方法，然后在accessInstanceVariablesDirectly为YES情况下，会赋值相应的成员变量
  • 相应的取值时，也会先调用相关get方法，如果没有，在accessInstanceVariablesDirectly为YES情况下，会取相关变量的值

以上即为KVC的API探索，以及其调用流程，本篇探索就到此为止，其实还有关于自定义KVC的探索，但是自定义KVC较长，并且需要考虑到数组、字典、集合以及多线程等的情况，没有加入本篇章。其实在网络上有很多大神写的很厉害，这里放上其中一个 DIS_KVC_KVO 供大家参考。

avatar
文章
阅读
粉丝