前言
KVO是iOS開發當中必不可少的一個工具，可以說是使用最廣泛的工具之一。無論你是要在檢測某一個屬性變化，還是構建viewmodel雙向繫結UI以及資料，KVO都是一個十分使用的工具。
然而！！
KVO用起來太TMD麻煩了，要註冊成為某個物件屬性的觀察者，要在適當的時候移除觀察者狀態，還要寫毀掉函式，更蛋疼的是物件屬性還要用字串作為表示。其中任何一個地方都要注意很多點，而且因為Delegate回撥函式的原因，導致程式碼分離，可讀性極差，維護起來異常費勁。
所以說，對於我來說，能不用的時候，儘量繞過去用其他的方法，直到我發現了Facebook的開源框架KVOController。
基本介紹
1、主要結構
事實上KVOController的實現只有2各類，第一個是NSObject的Category是我們使用的類，第二個則是具體的實現方法。
2、NSObject + FBKVOController 分析
在Category的.h檔案中有兩個屬性，根據備註可知區別在意一個是持有的，另一個不是。
/**
@abstract Lazy-loaded FBKVOController for use with any object
@return FBKVOController associated with this object, creating one if necessary
@discussion This makes it convenient to simply create and forget a FBKVOController, and when this object gets dealloc'd, so will the associated controller and the observation info.
*/
@property (nonatomic, strong) FBKVOController *KVOController;
/**
@abstract Lazy-loaded FBKVOController for use with any object
@return FBKVOController associated with this object, creating one if necessary
@discussion This makes it convenient to simply create and forget a FBKVOController.
Use this version when a strong reference between controller and observed object would create a retain cycle.
When not retaining observed objects, special care must be taken to remove observation info prior to deallocation of the observed object.
*/
@property (nonatomic, strong) FBKVOController *KVOControllerNonRetaining;複製程式碼Category的.m檔案和其他檔案類似，寫的都是setter以及getter方法，並且在getter方法中對別對兩個屬性做了對於 FBKVOController 的初始化。
- (FBKVOController *)KVOController
{
id controller = objc_getAssociatedObject(self, NSObjectKVOControllerKey);
// lazily create the KVOController
if (nil == controller) {
controller = [FBKVOController controllerWithObserver:self];
self.KVOController = controller;
}
return controller;
}
- (void)setKVOController:(FBKVOController *)KVOController
{
objc_setAssociatedObject(self, NSObjectKVOControllerKey, KVOController, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
}
- (FBKVOController *)KVOControllerNonRetaining
{
id controller = objc_getAssociatedObject(self, NSObjectKVOControllerNonRetainingKey);
if (nil == controller) {
controller = [[FBKVOController alloc] initWithObserver:self retainObserved:NO];
self.KVOControllerNonRetaining = controller;
}
return controller;
}
- (void)setKVOControllerNonRetaining:(FBKVOController *)KVOControllerNonRetaining
{
objc_setAssociatedObject(self, NSObjectKVOControllerNonRetainingKey, KVOControllerNonRetaining, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
}複製程式碼3、FBKVOController分析
1）幾個基本API
/**
@abstract Creates and returns an initialized KVO controller instance.
@param observer The object notified on key-value change.
@return The initialized KVO controller instance.
*/
+ (instancetype)controllerWithObserver:(nullable id)observer;
/**
@abstract Registers observer for key-value change notification.
@param object The object to observe.
@param keyPath The key path to observe.
@param options The NSKeyValueObservingOptions to use for observation.
@param block The block to execute on notification.
@discussion On key-value change, the specified block is called. In order to avoid retain loops, the block must avoid referencing the KVO controller or an owner thereof. Observing an already observed object key path or nil results in no operation.
*/
- (void)observe:(nullable id)object keyPath:(NSString *)keyPath options:(NSKeyValueObservingOptions)options block:(FBKVONotificationBlock)block;
/**
@abstract Registers observer for key-value change notification.
@param object The object to observe.
@param keyPath The key path to observe.
@param options The NSKeyValueObservingOptions to use for observation.
@param action The observer selector called on key-value change.
@discussion On key-value change, the observer's action selector is called. The selector provided should take the form of -propertyDidChange, - propertyDidChange: or -propertyDidChange:object:, where optional parameters delivered will be KVO change dictionary and object observed. Observing nil or observing an already observed object's key path results in no operation.
*/
- (void)observe:(nullable id)object keyPath:(NSString *)keyPath options:(NSKeyValueObservingOptions)options action:(SEL)action;
/**
@abstract Block called on key-value change notification.
@param observer The observer of the change.
@param object The object changed.
@param change The change dictionary which also includes @c FBKVONotificationKeyPathKey
*/
typedef void (^FBKVONotificationBlock)(id _Nullable observer, id object, NSDictionary<NSKeyValueChangeKey, id> *change);複製程式碼- 第一個很簡單了，是建立KVOController的例項
- 第二個是註冊鍵值變化的觀察者，返回一個有固定引數的Block。需要注意的是，為了避免迴圈引用，儘量避免使用KVOController及其持有者。
- 第三個和第二個一樣，也是註冊鍵值變化的觀察者，但是返回的是一個選擇子SEL，API介紹中還對選擇子SEL進行了建議。
- 第四個很簡單，是第二個回撥函式的Block。值得注意的是，observer以及object分別是變化的觀察者以及屬性變化的物件，所以我們書寫的時候可以改成我們需要的樣式，以此來免去另加的轉換過程。
主要的實現邏輯
KVOController的實現需要有兩個私有的成員變數：
- NSMapTable
> _objectInfosMap; - pthread_mutex_t _lock;
以及另一個暴露在外只讀的屬性：
- @property (nullable, nonatomic, weak, readonly) id observer;
在實現過程中，作為 KVO 的管理者，其必須持有當前物件所有與 KVO 有關的資訊，而在 KVOController 中，用於儲存這個資訊的資料結構就是 NSMapTable。為了保證執行緒安全，需要持有pthread_mutex_t鎖，用於在操作NSMapTable時候使用。
1、下面讓我們看初始化方法：
- (instancetype)initWithObserver:(nullable id)observer retainObserved:(BOOL)retainObserved
{
self = [super init];
if (nil != self) {
_observer = observer;
NSPointerFunctionsOptions keyOptions = retainObserved ? NSPointerFunctionsStrongMemory|NSPointerFunctionsObjectPointerPersonality : NSPointerFunctionsWeakMemory|NSPointerFunctionsObjectPointerPersonality;
_objectInfosMap = [[NSMapTable alloc] initWithKeyOptions:keyOptions valueOptions:NSPointerFunctionsStrongMemory|NSPointerFunctionsObjectPersonality capacity:0];
pthread_mutex_init(&_lock, NULL);
}
return self;
}複製程式碼很簡單，主要工作是持有了傳進來的Observer，初始化了NSMapTable以及初始化了pthread_mutex_t鎖。
值得一提的是初始化 NSMapTable，我們回看第二部分，在屬性的區分就在於是否是持有，根據屬性的名字也能看出，不持有的話，引用計數就不會加一。所以在初始化的時候明顯的區分就是在建立NSPointerFunctionsOptions的時候，是StrongMemory還是WeakMemory。
通過方法+ (instancetype)controllerWithObserver:(nullable id)observer初始化的時候，預設為持有。
2、註冊觀察者
通常情況下我們會使用可以回撥Block的API，但是也有少數情況下會選擇傳遞選擇子SEL的API，我們這裡只拿傳遞Block的方法舉例子。
- (void)observe:(nullable id)object keyPath:(NSString *)keyPath options:(NSKeyValueObservingOptions)options block:(FBKVONotificationBlock)block
{
NSAssert(0 != keyPath.length && NULL != block, @"missing required parameters observe:%@ keyPath:%@ block:%p", object, keyPath, block);
if (nil == object || 0 == keyPath.length || NULL == block) {
return;
}
// create info
_FBKVOInfo *info = [[_FBKVOInfo alloc] initWithController:self keyPath:keyPath options:options block:block];
// observe object with info
[self _observe:object info:info];
}複製程式碼在這裡傳遞進來的一些引數會被封裝成為私有的_FBKVOInfo，那我們來簡單看一下_FBKVOInfo的主要實現：
{
@public
__weak FBKVOController *_controller;
NSString *_keyPath;
NSKeyValueObservingOptions _options;
SEL _action;
void *_context;
FBKVONotificationBlock _block;
_FBKVOInfoState _state;
}
- (instancetype)initWithController:(FBKVOController *)controller
keyPath:(NSString *)keyPath
options:(NSKeyValueObservingOptions)options
block:(nullable FBKVONotificationBlock)block
action:(nullable SEL)action
context:(nullable void *)context
{
self = [super init];
if (nil != self) {
_controller = controller;
_block = [block copy];
_keyPath = [keyPath copy];
_options = options;
_action = action;
_context = context;
}
return self;
}複製程式碼由此可以看出， _FBKVOInfo的主要作用就是起到了一個類似Model一樣儲存主要資料的作用，並儲存了一個_FBKVOInfoState作為表示當前的 KVO 狀態。
需要注意的是，成員變數都是用了@public修飾。
另外，對- (NSString *)debugDescription以及- (NSString *)debugDescription兩個方法做了重寫，方便了使用以及Debug。
之後執行了私有方法- (void)_observe:(id)object info:(_FBKVOInfo *)info
- (void)_observe:(id)object info:(_FBKVOInfo *)info
{
// lock
pthread_mutex_lock(&_lock);
NSMutableSet *infos = [_objectInfosMap objectForKey:object];
// check for info existence
_FBKVOInfo *existingInfo = [infos member:info];
if (nil != existingInfo) {
// observation info already exists; do not observe it again
// unlock and return
pthread_mutex_unlock(&_lock);
return;
}
// lazilly create set of infos
if (nil == infos) {
infos = [NSMutableSet set];
[_objectInfosMap setObject:infos forKey:object];
}
// add info and oberve
[infos addObject:info];
// unlock prior to callout
pthread_mutex_unlock(&_lock);
[[_FBKVOSharedController sharedController] observe:object info:info];
}複製程式碼1）首先先進行的是對於自身持有的 _objectInfosMap這個成員變數的操作，一切都需要在先鎖定，執行結束再解鎖的過程。
- 首先獲取了對於當前觀察者的註冊的關注列表。
- 判斷是否當前需要關注的資訊是否在此列表中，如果有則return出去，不再進行關注。
- 如果當前的關注列表不存在則此時建立一個
- 將關注的資訊儲存在關注列表中。
2）然後是獲取了 _FBKVOSharedController單例並且執行了單例的- (void)observe:(id)object info:(nullable _FBKVOInfo *)info方法。
- (void)observe:(id)object info:(nullable _FBKVOInfo *)info
{
if (nil == info) {
return;
}
// register info
pthread_mutex_lock(&_mutex);
[_infos addObject:info];
pthread_mutex_unlock(&_mutex);
// add observer
[object addObserver:self forKeyPath:info->_keyPath options:info->_options context:(void *)info];
if (info->_state == _FBKVOInfoStateInitial) {
info->_state = _FBKVOInfoStateObserving;
} else if (info->_state == _FBKVOInfoStateNotObserving) {
// this could happen when `NSKeyValueObservingOptionInitial` is one of the NSKeyValueObservingOptions,
// and the observer is unregistered within the callback block.
// at this time the object has been registered as an observer (in Foundation KVO),
// so we can safely unobserve it.
[object removeObserver:self forKeyPath:info->_keyPath context:(void *)info];
}
}複製程式碼加鎖，對於當前單例的NSHashTable進行新增操作的資訊，並執行Foundation的
- (void)addObserver:(NSObject *)observer forKeyPath:(NSString *)keyPath options:(NSKeyValueObservingOptions)options context:(nullable void *)context;複製程式碼然後對資訊中的state進行更改。
3、觀察並回撥
- (void)observeValueForKeyPath:(nullable NSString *)keyPath
ofObject:(nullable id)object
change:(nullable NSDictionary<NSKeyValueChangeKey, id> *)change
context:(nullable void *)context
{
NSAssert(context, @"missing context keyPath:%@ object:%@ change:%@", keyPath, object, change);
_FBKVOInfo *info;
{
// lookup context in registered infos, taking out a strong reference only if it exists
pthread_mutex_lock(&_mutex);
info = [_infos member:(__bridge id)context];
pthread_mutex_unlock(&_mutex);
}
if (nil != info) {
// take strong reference to controller
FBKVOController *controller = info->_controller;
if (nil != controller) {
// take strong reference to observer
id observer = controller.observer;
if (nil != observer) {
// dispatch custom block or action, fall back to default action
if (info->_block) {
NSDictionary<NSKeyValueChangeKey, id> *changeWithKeyPath = change;
// add the keyPath to the change dictionary for clarity when mulitple keyPaths are being observed
if (keyPath) {
NSMutableDictionary<NSString *, id> *mChange = [NSMutableDictionary dictionaryWithObject:keyPath forKey:FBKVONotificationKeyPathKey];
[mChange addEntriesFromDictionary:change];
changeWithKeyPath = [mChange copy];
}
info->_block(observer, object, changeWithKeyPath);
} else if (info->_action) {
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Warc-performSelector-leaks"
[observer performSelector:info->_action withObject:change withObject:object];
#pragma clang diagnostic pop
} else {
[observer observeValueForKeyPath:keyPath ofObject:object change:change context:info->_context];
}
}
}
}
}複製程式碼這個就相對簡單了，主要是根據關注資訊內是Block還是Action來執行，如果兩者都沒有就會呼叫觀察者 KVO 回撥方法。
4、登出觀察
事實上，登出是在執行dealloc的時候執行的，同時也去掉了鎖：
- (void)dealloc
{
[self unobserveAll];
pthread_mutex_destroy(&_lock);
}複製程式碼因為KVO事件都由私有的 _KVOSharedController 來處理，所以當每一個 KVOController 物件被釋放時，都會將它自己持有的所有 KVO 的觀察者交由 _KVOSharedControlle r的方法處理，我們再來看下程式碼：
- (void)unobserve:(id)object infos:(nullable NSSet<_FBKVOInfo *> *)infos
{
if (0 == infos.count) {
return;
}
// unregister info
pthread_mutex_lock(&_mutex);
for (_FBKVOInfo *info in infos) {
[_infos removeObject:info];
}
pthread_mutex_unlock(&_mutex);
// remove observer
for (_FBKVOInfo *info in infos) {
if (info->_state == _FBKVOInfoStateObserving) {
[object removeObserver:self forKeyPath:info->_keyPath context:(void *)info];
}
info->_state = _FBKVOInfoStateNotObserving;
}
}複製程式碼該方法會遍歷所有傳入的 _FBKVOInfo ，從其中取出keyPath 並將 _KVOSharedController 移除觀察者。
當然，假如你需要手動的移除某一個的觀察者， _KVOSharedController 也提供了方法：
- (void)unobserve:(id)object info:(nullable _FBKVOInfo *)info
{
if (nil == info) {
return;
}
// unregister info
pthread_mutex_lock(&_mutex);
[_infos removeObject:info];
pthread_mutex_unlock(&_mutex);
// remove observer
if (info->_state == _FBKVOInfoStateObserving) {
[object removeObserver:self forKeyPath:info->_keyPath context:(void *)info];
}
info->_state = _FBKVOInfoStateNotObserving;
}複製程式碼總結
這套框架提供了豐富的結構，基本能夠滿足我們對於KVO的使用需求。
只需要一次程式碼，就可以完成對一個物件的鍵值觀測，同時不需要處理移除觀察者，也可以在同一處程式碼進行鍵值變化之後的處理，從噁心的回撥方法中解脫出來，不僅提供了使用方便，也不需要我們手動主要觀察者，避免了各種問題，絕對算的上一個完善好用的框架。