iOS进阶 -- KVC应用及原理

时间  2021-08-13
标签 html git github 数组 安全 markdown 网络 多线程 app ide 栏目 iOS 繁體版
原文   原文链接

前言

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

- (void)setValue:(nullable id)value forKey:(NSString *)key;
- (nullable id)valueForKey:(NSString *)key;
复制代码

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

1、KVC的使用技巧

1.一、KVC机制

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

KVC源码定义.png

NSKeyValueCoding是什么呢？经过 KVC文档 和 NSKeyValueCoding 能够发现其解释以下：数组

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

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

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

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

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];
}
复制代码

代码运行结果以下app

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

能够发现经过KVC成功访问了属性和成员变量，而且成功赋值和取值。ide

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也是仍是要保留了字典可变与不可变的特性。

2、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__);
}

复制代码

一、此时的调用结果以下：

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

能够发现确实先调用了 setHobby: 方法，而且四个成员变量均为nil，由于setHobby:方法没有进行赋值操做。

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

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

能够发现这次直接调用 _setHobby: 方法，四个成员变量依然均为 nil，代表并未赋值。

三、继续注释 _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，这样写最终致使了异常抛出，也从侧面验证了第三条，找不到时会抛出异常。

四、变量的查找会考虑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

这段描述也能够分为几个流程：

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

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

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

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

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

一、直接调用 valueForKey:，结果以下：

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

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

二、下面依次注释 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>，而且不会调用其余的方法

三、接下来验证变量的值的查找，依次注释_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 供你们参考。

相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程