UICollectionViewCell 使用 KVO 的正确方
今天遇到一个问题,需要 UICollectionViewCell
对 ViewController 的属性进行 KVO 观察,之前在忙乱中尝试了各种方法来解除监听总算搞定了。今天,改动了代码又出现这个问题,于是研究了一番。
KVO 观察一般都在 - dealloc
方法中解除监听。之前我想到的是在 cell 被 dealloc 时解除监听,这就需要一个变量来引用 VC,为了避免引用循环,在 cell 中设置弱引用delegate,但问题是,在 cell 被 dealloc 前,ViewController 就已经被 dealloc 了(设置几个 NSLog语句在 dealloc 中就能观察到调用顺序),所以在 cell 对象中是没有机会解除监听的。那么只能在 VC 中解除了。(2015/09/15更新)以现在的我来看,这个思路简直无语了,完全没必要做这种多余的事情。当然,说明我进步了。
ViewController 中的 view 会在 - dealloc
前消失,看起来- viewWillDisappear:
和 - viewDidDisappear:
是个合适的时机。但实际上,最好不要在这里进行解除操作,- dealloc
依然是最佳时机。当前 ViewController 以模态方式显示其他视图或是压入 NavigationVC中,这两个方法也会被调用,如果当前视图第二次消失时,会再一次进行解除操作,这时候就会出现问题了。报错一般是:
Cannot remove an observer for the key path "deleteMode" from because it is not registered as an observer.
大意就是「我没有观察你所以你不能让我解除观察啊」。这说明进行观察就类似没有 ARC 的时代管理内存类似,alloc 了几次就要 release 几次,监听了几次就要解除几次,解除多了少了都不行。时机确定,- dealloc
是完美的时机。那么怎么解除?
我之前一直是通过- collectionView:cellForItemAtIndexPath:
遍历 UICollectionView 中的 Cell 来解除,但不能解决问题,由于重用机制,遍历得到的 Cell 并不一定是你想要的 Cell,往往就会出现解除多了的情况。那么同样由于重用机制,之前在- collectionView:cellForItemAtIndexPath:
方法中进行观察并不是一个好的时机。谨记:观察一次解除一次。那么哪里可以满足这个条件?答案是- collectionView:willDisplayCell:forItemAtIndexPath:
和- collectionView:didEndDisplayingCell:forItemAtIndexPath:
,之前学习过 objc.io 的《CollectionView 动画》,但是记忆错误,认为这两个方法只在添加或删除 Cell 的时候才会调用,文档上的注释看上去也是这个意思,前者的是:
The collection view calls this method before adding a cell to its content. Use this method to detect cell additions, as opposed to monitoring the cell itself to see when it appears.
后者的是:
The collection view calls this method before adding a cell to its content. Use this method to detect cell additions, as opposed to monitoring the cell itself to see when it appears.
但事实上这两个方法不仅仅是在添加或删除 Cell 时才调用,滚动视图时,Cell 在屏幕上的出现或消失也会调用这两个方法,可以说,这两个方法完全跟踪了屏幕上所有 Cell 出现和消失的情况。回想前面说的,观察一次就要解除一次,Cell 出现过一次,那么就要解除一次,观察和解除的次数要相等,那么在这两个方法里进行观察和对应的解除无疑是最佳场所。在 ViewController 被 dealloc 前,还有哪些 Cell 需要解除对 ViewController 的观察呢,就是在屏幕上的那些,其他不在屏幕上的 Cell在消失时就有过对应的解除操作了不用担心,那么使用- visibleCells
遍历屏幕上的 Cell 进行一次解除操作就可以了。Bingo!
之前我也有过需要 SupplementaryView 来观察 ViewController 的需求,虽然它跟 Cell 一样在 UICollectionView 的 delegate 有 willDisplay 和 didEndDisplay 的方法,但是却没有类似 - visibleCells
的方法,解除操作的最后一步无法完成。
09/15 更新:iOS 9 已经针对 SupplementaryView 提供了类似 - visibleCells
的方法:(Swift)visibleSupplementaryViewsOfKind(_: String) -> [UICollectionReusableView]
,那么在 iOS 9 中就可以像 Cell 一样方便地解除观察了。
04/29 更新:已找到解决办法,方案灵感来自于 stackoverflow 上这条问题下赞同数最高的答案:UICollectionView: How to get the header view for a section。上一段提到,问题在于解除操作的最后一步无法完成,苹果没有开放获得可见的 SupplementaryView 的 API。怎么获取,其实路线和 Cell 一样,关键在以下三个方法中:
//由于重用机制,消失在屏幕外的SupplementaryView 会供新出现在屏幕上的使用;
//使用字典以 indexPath 为键,以对应的 SupplementaryView 为值来维护屏幕上可见的 SupplementaryView的信息。
//在这里执行观察操作,如果该 indexPath 在字典里不存在则新建,若存在则更新该键的值。
- collectionView:willDisplaySupplementaryView:forElementKind:atIndexPath:
//对消失在屏幕上的 SupplementaryView 执行解除监听操作;
- collectionView:didEndDisplayingSupplementaryView:forElementOfKind:atIndexPath:
这样字典中就只剩下在屏幕上可见的 SupplementaryView,在 ViewController 被 dealloc 时遍历字典解除 KVO 观察。
需要注意的是,必须在 Cell 或 SupplementaryView 中实现观察所需的- observeValueForKeyPath:ofObject:change:context:
,不然会报错说观察者接收到了 KVO 通知却没有回应。要实现这个方法需要通过继承生成子类而不能通过 category 来实现,不然有他子类也同样实现了该方法,在 category 中也实现了的话,调用行为未知。
总结:
1.ViewController 的- dealloc
是解除监听的最佳时机。
2.KVO 观察的注册和解除成对,执行一次- addObserver:forKeyPath:options:context:
就要执行一次- removeObserver:forKeyPath:context:
。
3.对于 Cell,在 - collectionView:willDisplayCell:forItemAtIndexPath:
中执行观察,在- collectionView:didEndDisplayingCell:forItemAtIndexPath:
解除观察,可以保证观察和解除的次数平衡;最后,在 ViewController 的 - dealloc
里使用 - visibleCells
来获取还没解除观察的 Cell。由于重用机制,不要在- collectionView: cellForItemAtIndexPath:
中进行观察,无法保证进行同样次数的解除操作。
4.对于 SupplementaryView,在 - collectionView:willDisplaySupplementaryView:forElementKind:atIndexPath:
中执行观察,在 - collectionView:didEndDisplayingSupplementaryView:forElementOfKind:atIndexPath:
解除观察。在 iOS 9 中,新增了 (Swift)visibleSupplementaryViewsOfKind(_: String) -> [UICollectionReusableView]
,可以像 Cell 一样方便地解除观察;但在 iOS 8 以及更早的版本中,只能通过其他方法了,见上面的描述。