objc系列译文(7.3):KVC 和 KVO

Key-value coding (KVC) 和 key-value observing (KVO) 是两种能让我们驾驭 Objective-C 动态特性并简化代码的机制。在这篇文章里,我们将接触一些如何利用这些特性的例子。

观察 model 对象的变化

在 Cocoa 的模型-视图-控制器 (Model-view-controller)架构里,控制器负责让视图和模型同步。这一共有两步:当 model 对象改变的时候,视图应该随之改变以反映模型的变化;当用户和控制器交互的时候,模型也应该做出相应的改变。

KVO 能帮助我们让视图和模型保持同步。控制器可以观察视图依赖的属性变化。

让我们看一个例子:我们的模型类 LabColor 代表一种 Lab色彩空间里的颜色。和 RGB 不同,这种色彩空间有三个元素 Lab。我们要做一个用来改变这些值的滑块和一个显示颜色的方块区域。

我们的模型类有以下三个用来代表颜色的属性:

依赖的属性

我们需要从这个类创建一个 UIColor 对象来显示出颜色。我们添加三个额外的属性,分别对应 R, G, B:

有了这些以后,我们就可以创建这个类的接口了:

维基百科提供了转换 RGB 到 Lab 色彩空间的算法。写成方法之后如下所示:

这些代码没什么令人激动的地方。有趣的是 greenComponent 属性依赖于 lComponent 和 aComponent。不论何时设置 lComponent的值,我们需要让 RGB 三个 component 中与其相关的成员以及 color 属性都要得到通知以保持一致。这一点这在 KVO 中很重要。

Foundation 框架提供的表示属性依赖的机制如下:

更详细的如下:

在我们的例子中如下:

现在我们完整的表达了属性之间的依赖关系。请注意,我们可以把这些属性链接起来。打个比方,如果我们写一个子类去 overrideredComponent 方法,这些依赖关系仍然能正常工作。

观察变化

现在让我们目光转向控制器。 NSViewController 的子类拥有 LabColor model 对象作为其属性。

我们把视图控制器注册为观察者来接收 KVO 的通知,这可以用以下 NSObject 的方法来实现:

这会让以下方法:

在当 keyPath 的值改变的时候在观察者 anObserver 上面被调用。这个 API 看起来有一点吓人。更糟糕的是,我们还得记得调用以下的方法

来移除观察者,否则我们我们的 app 会因为某些奇怪的原因崩溃。

对于大多数的应用来说,KVO 可以通过辅助类用一种更简单优雅的方式实现。我们在视图控制器添加以下的观察记号(Observation token)属性:

当 labColor 在视图控制器中被设置时,我们只要 override labColor 的 setter 方法就行了:

KeyValueObserver 辅助类 封装了 -addObserver:forKeyPath:options:context:-observeValueForKeyPath:ofObject:change:context:-removeObserverForKeyPath: 的调用,让视图控制器远离杂乱的代码。

整合到一起

视图控制器需要对 Lab 的滑块控制做出反应:

所有的代码都在我们的 GitHub 示例代码 中找到。

手动通知 vs 自动通知

我们刚才所做的事情有点神奇,但是实际上发生的事情是,当 LabColor 实例的 -setLComponent: 等方法被调用的时候以下方法:

和:

会在运行 -setLComponent: 中的代码之前以及之后被自动调用。如果我们写了 -setLComponent: 或者我们选择使用自动 synthesize 的 lComponent 的 accessor 到时候就会发生这样的事情。

有些情况下当我们需要 override -setLComponent: 并且我们要控制是否发送键值改变的通知的时候,我们要做以下的事情:

我们关闭了 -willChangeValueForKey: 和 -didChangeValueForKey: 的自动调用,然后我们手动调用他们。我们只应该在关闭了自动调用的时候我们才需要在 setter 方法里手动调用 -willChangeValueForKey: 和 -didChangeValueForKey:。大多数情况下,这样优化不会给我们带来太多好处。

如果我们在 accessor 方法之外改变实例对象(如 _lComponent ),我们要特别小心地和刚才一样封装 -willChangeValueForKey: 和 -didChangeValueForKey:。不过在多数情况下,我们只用 accessor 方法的话就可以了,这样代码会简洁很多。

KVO 和 context

有时我们会有理由不想用 KeyValueObserver 辅助类。创建另一个对象会有额外的性能开销。如果我们观察很多个键的话,这个开销可能会变得明显。

如果我们在实现一个类的时候把它自己注册为观察者的话:

一个非常重要的点是我们要传入一个这个类唯一的 context。我们推荐把以下代码

写在这个类 .m 文件的顶端,然后我们像这样调用 API 并传入 PrivateKVOContext 的指针:

然后我们这样写 -observeValueForKeyPath:... 的方法:

这将确保我们写的子类都是正确的。如此一来,子类和父类都能安全的观察同样的键值而不会冲突。否则我们将会碰到难以 debug 的奇怪行为。

进阶 KVO

我们常常需要当一个值改变的时候更新 UI,但是我们也要在第一次运行代码的时候更新一次 UI。我们可以用 KVO 并添加NSKeyValueObservingOptionInitial 的选项 来一箭双雕地做好这样的事情。这将会让 KVO 通知在调用 -addObserver:forKeyPath:... 到时候也被触发。

之前和之后

当我们注册 KVO 通知的时候,我们可以添加 NSKeyValueObservingOptionPrior 选项,这能使我们在键值改变之前被通知。这和-willChangeValueForKey:被触发的时间相对应。

如果我们注册通知的时候附加了 NSKeyValueObservingOptionPrior 选项,我们将会收到两个通知:一个在值变更前,另一个在变更之后。变更前的通知将会在 change 字典中有不同的键。我们可以像以下这样区分通知是在改变之前还是之后被触发的:

如果我们需要改变前后的值,我们可以在 KVO 选项中加入 NSKeyValueObservingOptionNew 和/或NSKeyValueObservingOptionOld

更简单的办法是用 NSKeyValueObservingOptionPrior 选项,随后我们就可以用以下方式提取出改变前后的值:

通常来说 KVO 会在 -willChangeValueForKey: 和 -didChangeValueForKey: 被调用的时候存储相应键的值。

索引

KVO 对一些集合类也有很强的支持,以下方法会返回集合对象:

我们将会详细解释这是怎么工作的。如果你使用这些方法,change 字典里会包含键值变化的类型(添加、删除和替换)。对于有序的集合,change 字典会包含受影响的 index。

集合代理对象和变化的通知在用于更新UI的时候非常有效,尤其是处理大集合的时候。但是它们需要花费你一些心思。

KVO 和线程

一个需要注意的地方是,KVO 行为是同步的,并且发生与所观察的值发生变化的同样的线程上。没有队列或者 Run-loop 的处理。手动或者自动调用 -didChange... 会触发 KVO 通知。

所以,当我们试图从其他线程改变属性值的时候我们应当十分小心,除非能确定所有的观察者都用线程安全的方法处理 KVO 通知。通常来说,我们不推荐把 KVO 和多线程混起来。如果我们要用多个队列和线程,我们不应该在它们互相之间用 KVO。

KVO 是同步运行的这个特性非常强大,只要我们在单一线程上面运行(比如主队列 main queue),KVO 会保证下列两种情况的发生:

首先,如果我们调用一个支持 KVO 的 setter 方法,如下所示:

KVO 能保证所有 exchangeRate 的观察者在 setter 方法返回前被通知到。

其次,如果某个键被观察的时候附上了 NSKeyValueObservingOptionPrior 选项,直到 -observe... 被调用之前,exchangeRate 的 accessor 方法都会返回同样的值。

KVC

最简单的 KVC 能让我们通过以下的形式访问属性:

取值:

设定:

值得注意的是这个不仅可以访问作为对象属性,而且也能访问一些标量(例如 int 和 CGFloat)和 struct(例如 CGRect)。Foundation 框架会为我们自动封装它们。举例来说,如果有以下属性:

我们可以这样设置它:

KVC 允许我们用属性的字符串名称来访问属性,字符串在这儿叫做。有些情况下,这会使我们非常灵活地简化代码。我们下一节介绍例子简化列表 UI

KVC 还有更多可以谈的。集合(NSArrayNSSet 等)结合 KVC 可以拥有一些强大的集合操作。还有,对象可以支持用 KVC 通过代理对象访问非常规的属性。

简化列表 UI

假设我们有这样一个对象:

还有一个 detail 视图控制器,含有四个对应的 UITextField 属性:

我们可以简化更新 UI 的逻辑。首先我们需要两个方法:一个返回 model 里我们用到的所有键的方法,一个把键映射到对应的文本框的方法:

有了这个,我们可以从 model 里更新文本框,如下所示:

我们也可以用一个 action 方法让四个文本框都能实时更新 model:

注意:我们之后会添加验证输入的部分,在键值验证里会提到。

最后,我们需要确认文本框在需要的时候被更新:

有了这个,我们的 detail 视图控制器 就能正常工作了。

整个项目可以在 GitHub 上找到。它也用了我们后面提到的键值验证

键路径(Key Path)

KVC 同样允许我们通过关系来访问对象。假设 person 对象有属性 addressaddress 有属性 city,我们可以这样通过 person 来访问 city

值得注意的是这里我们调用 -valueForKeyPath: 而不是 -valueForKey:

Key-Value Coding Without @property

不需要 @property 的 KVC

我们可以实现一个支持 KVC 而不用 @property 和 @synthesize 或是自动 synthesize 的属性。最直接的方式是添加 -<key> 和 -set<Key>: 方法。例如我们想要 name ,我们这样做:

这完全等于 @property 的实现方式。

但是当标量和 struct 的值被传入 nil 的时候尤其需要注意。假设我们要 height 属性支持 KVC 我们写了以下的方法:

然后我们这样调用:

这会抛出一个 exception。要正确的处理 nil,我们要像这样 override -setNilValueForKey:

我们可以通过 override 这些方法来让一个类支持 KVC:

这也许看起来很怪,但这可以让一个类动态的支持一些键的访问。但是这两个方法会在性能上拖后腿。

附注:Foundation 框架支持直接访问实例变量。请小心的使用这个特性。你可以去查看 +accessInstanceVariablesDirectly 的文档。这个值默认是 YES 的时候,Foundation 会按照 _<key>_is<Key><key> 和 is<Key> 的顺序查找实例变量。

集合的操作

一个常常被忽视的 KVC 特性是它对集合操作的支持。举个例子,我们可以这样来获得一个数组中最大的值:

或者说,我们有一个 Transaction 对象的数组,对象有属性 amount 的话,我们可以这样获得最大的 amount

当我们调用 [a valueForKeyPath:@"@max.amount"] 的时候,它会在数组 a 的每个元素中调用 -valueForKey:@"amount" 然后返回最大的那个。

KVC 的苹果官方文档有一个章节 Collection Operators 详细的讲述了类似的用法。

通过集合代理对象来实现 KVC

虽然我们可以像对待一般的对象一样用 KVC 深入集合内部(NSArray 和 NSSet 等),但是通过集合代理对象, KVC 也让我们实现一个兼容 KVC 的集合。这是一个颇为高端的技巧。

当我们在对象上调用 -valueForKey: 的时候,它可以返回 NSArrayNSSet 或是 NSOrderedSet 的集合代理对象。这个类没有实现通常的 -<Key> 方法,但是它实现了代理对象所需要使用的很多方法。

如果我们希望一个类支持通过代理对象的 contacts 键返回一个 NSArray,我们可以这样写:

这样做的话,当我们调用 [object valueForKey:@"contacts”] 的时候,它会返回一个由这两个方法来代理所有调用方法的NSArray 对象。这个数组支持所有正常的对 NSArray 的调用。换句话说,调用者并不知道返回的是一个真正的 NSArray, 还是一个代理的数组。

对于 NSSet 和 NSOrderedSet,如果要做同样的事情,我们需要实现的方法是:

NSArray NSSet NSOrderedSet
-countOf<Key> -countOf<Key> -countOf<Key>
-enumeratorOf<Key> -indexIn<Key>OfObject:
以下两者二选一 -memberOf<Key>:
-objectIn<Key>AtIndex: 以下两者二选一
-<key>AtIndexes: -objectIn<Key>AtIndex:
-<key>AtIndexes:
可选(增强性能)
-get<Key>:range: 可选(增强性能)
-get<Key>:range:

可选 的一些方法可以增强代理对象的性能。

虽然只有特殊情况下我们用这些代理对象才会有意义,但是在这些情况下代理对象非常的有用。想象一下我们有一个很大的数据结构,调用者不需要(一次性)访问所有的对象。

举一个(也许比较做作的)例子说,我们想写一个包含有很长一串质数的类。如下所示:

我们将会运行以下代码:

这将会调用一次 -countOfPrimes 和一次传入参数 idx 作为最后一个索引的 -objectInPrimesAtIndex:。为了只取出最后一个值,它不需要先把所有的数封装成 NSNumber 然后把它们都导入 NSArray

在一个复杂一点的例子中,通讯录编辑器示例 app 用同样的方法把 C++ std::vector 封装以来。它详细说明了应该怎么利用这个方法。

可变的集合

我们也可以在可变集合(例如 NSMutableArrayNSMutableSet,和 NSMutableOrderedSet)中用集合代理。

访问这些可变的集合有一点点不同。调用者在这儿需要调用以下其中一个方法:

一个窍门:我们可以让一个类用以下方法返回可变集合的代理:

然后在实现键 wrappedContacts 的一些方法。

我们需要实现上面的不变集合的两个方法,还有以下的几个:

NSMutableArray / NSMutableOrderedSet NSMutableSet
至少实现一个插入方法和一个删除方法 至少实现一个插入方法和一个删除方法
-insertObject:in<Key>AtIndex: -add<Key>Object:
-removeObjectFrom<Key>AtIndex: -remove<Key>Object:
-insert<Key>:atIndexes: -add<Key>:
-remove<Key>AtIndexes: -remove<Key>:
可选(增强性能)以下方法二选一 可选(增强性能)
-replaceObjectIn<Key>AtIndex:withObject: -intersect<Key>:
-replace<Key>AtIndexes:with<Key>: -set<Key>:

上面提到,这些可变集合代理对象和 KVO 结合起来也十分强大。KVO 机制能在这些集合改变的时候把详细的变化放进 change 字典中。

有批量更新(需要传入多个对象)的方法,也有只改变一个对象的方法。我们推荐选择相对于给定任务来说最容易实现的那个来写,虽然我们有一点点倾向于选择批量更新的那个。

在实现这些方法的时候,我们要对自动和手动的 KVO 之间的差别十分小心。Foundation 默认自动发出十分详尽的变化通知。如果我们要手动实现发送详细通知的话,我们得实现这些:

或者这些:

我们要保证先把自动通知关闭,否则每次改变 KVO 都会发出两次通知。

常见的 KVO 错误

首先,KVO 兼容是 API 的一部分。如果类的所有者不保证某个属性兼容 KVO,我们就不能保证 KVO 正常工作。苹果文档里有 KVO 兼容属性的文档。例如,NSProgress 类的大多数属性都是兼容 KVO 的。

当做出改变以后,有些人试着放空的 -willChange 和 -didChange 方法来强制 KVO 的触发。KVO 通知虽然会生效,但是这样做破坏了有依赖于 NSKeyValueObservingOld 选项的观察者。详细来说,这影响了 KVO 对观察键路径 (key path) 的原生支持。KVO 在观察键路径 (key path) 时依赖于 NSKeyValueObservingOld 属性。

我们也要指出有些集合是不能被观察的。KVO 旨在观察关系 (relationship) 而不是集合。我们不能观察 NSArray,我们只能观察一个对象的属性——而这个属性有可能是 NSArray。举例说,如果我们有一个 ContactList 对象,我们可以观察它的 contacts 属性。但是我们不能向要观察对象的 -addObserver:forKeyPath:... 传入一个 NSArray

相似地,观察 self 不是永远都生效的。而且这不是一个好的设计。

调试 KVO

你可以在 lldb 里查看一个被观察对象的所有观察信息。

这会打印出有关谁观察谁之类的很多信息。

这个信息的格式不是公开的,我们不能让任何东西依赖它,因为苹果随时都可以改变它。不过这是一个很强大的排错工具。

键值验证 (KVV)

最后提示,KVV 也是 KVC API 的一部分。这是一个用来验证属性值的 API,只是它光靠自己很难提供逻辑和功能。

如果我们写能够验证值的 model 类的话,我们就应该实现 KVV 的 API 来保证一致性。用 KVV 验证 model 类的值是 Cocoa 的惯例。

让我们在一次强调一下:KVC 不会做任何的验证,也不会调用任何 KVV 的方法。那是你的控制器需要做的事情。通过 KVV 实现你自己的验证方法会保证它们的一致性。

以下是一个简单的例子:

它强大之处在于,当 model 类(Contact)验证 name 的时候,会有机会去处理名字。

如果我们想让名字不要有前后的空白字符,我们应该把这些逻辑放在 model 对象里面。Contact 类可以像这样实现 KVV:

通讯录示例 里的 DetailViewController 和 Contact 类详解了这个用法。

1 1 收藏 评论

相关文章

可能感兴趣的话题



直接登录
跳到底部
返回顶部