您现在的位置: IOS教程網 >> IOS系統 >  >> iOS 程式開發 >> iOS 開發基礎

一行程式碼搞定 KVO 與通知:XWEasyKVONotification 的原始碼拆解

編輯:iOS 開發基礎

授權轉載,作者:wazrx

寫在前面

每次用 KVO 和通知,我都覺得有點麻煩。KVO 要註冊、要實作監聽方法、最後還得記得移除;通知也得移除。相關邏輯被拆得七零八落,控制器寫得亂七八糟,而且總有那麼一次會忘記移除——然後就是崩潰。

於是我有個想法:能不能加上一個 KVO 或通知之後,把「移除」和「實作監聽方法」這兩步全省掉?抱著這個念頭,我寫了一個分類,目標是把步驟壓到極簡。對外的介面只有兩個:

/**
 *  以 Block 方式註冊 KVO。以此方式註冊的 KVO 無需手動移除,
 *  會在被監聽物件銷毀時自動移除。
 *
 *  @param keyPath 監聽路徑
 *  @param block   KVO 回呼 block,obj 為監聽物件,oldVal 為舊值,newVal 為新值
 */
- (void)xw_addObserverBlockForKeyPath:(NSString *)keyPath block:(void (^)(id obj, id oldVal, id newVal))block;

/**
 *  以 Block 方式註冊通知,同樣會自動移除。
 *
 *  @param name  通知名稱
 *  @param block 通知回呼 block,notification 為回呼的通知物件
 */
- (void)xw_addNotificationForName:(NSString *)name block:(void (^)(NSNotification *notification))block;

使用方式同樣直白。專案在 GitHub 上:XWEasyKVONotification,只要引入 NSObject+XWAdd 這個分類即可:

// 監聽 _objA 的 name 屬性
[_objA xw_addObserverBlockForKeyPath:@"name" block:^(id obj, id oldVal, id newVal) {
    NSLog(@"kvo,修改 name 為 %@", newVal);
}];

[self xw_addNotificationForName:@"XWTestNotificaton" block:^(NSNotification *notification) {
    NSLog(@"收到通知:%@", notification.userInfo);
}];

從此不必再為「忘記移除」提心吊膽,程式碼也集中了,看起來舒服得多。

原理

由於 KVO 與通知的思路高度相似,下面以 KVO 的實作為主說明。

既然要用 block 回呼,就需要一個內部物件 target 來承接真正的 KVO 職責:值變了,由它來觸發 block。設計上,一個 target 對應一個 keyPath,且能裝多個 block——因為同一個 keyPath 可能被多處監聽。這個類別大致如下:

@interface _XWBlockTarget : NSObject

/** 加入一個 KVO block */
- (void)xw_addBlock:(void(^)(__weak id obj, id oldValue, id newValue))block;

@end

@implementation _XWBlockTarget {
    // 保存所有 KVO block
    NSMutableSet *_blockSet;
}

- (instancetype)init {
    self = [super init];
    if (self) {
        _blockSet = [NSMutableSet new];
    }
    return self;
}

- (void)xw_addBlock:(void(^)(__weak id obj, id oldValue, id newValue))block {
    [_blockSet addObject:[block copy]];
}

// KVO 的真正實現在這裡
- (void)observeValueForKeyPath:(NSString *)keyPath ofObject:(id)object
                        change:(NSDictionary *)change context:(void *)context {
    if (!_blockSet.count) return;

    BOOL prior = [[change objectForKey:NSKeyValueChangeNotificationIsPriorKey] boolValue];
    // 只接受值真正改變後的通知
    if (prior) return;

    NSKeyValueChange changeKind = [[change objectForKey:NSKeyValueChangeKindKey] integerValue];
    if (changeKind != NSKeyValueChangeSetting) return;

    id oldVal = [change objectForKey:NSKeyValueChangeOldKey];
    if (oldVal == [NSNull null]) oldVal = nil;

    id newVal = [change objectForKey:NSKeyValueChangeNewKey];
    if (newVal == [NSNull null]) newVal = nil;

    // 觸發時,執行該 target 下的所有 block
    [_blockSet enumerateObjectsUsingBlock:^(void (^block)(__weak id obj, id oldVal, id newVal), BOOL * _Nonnull stop) {
        block(object, oldVal, newVal);
    }];
}

@end

有了真正承擔監聽的物件,接下來組裝邏輯。我們給每個物件綁定一個 targets 字典:每次呼叫 API 註冊時,先判斷該 keyPath 下有沒有對應的 target(target 與 keyPath 一一對應),沒有就建立並註冊原生 KVO,有就把 block 塞進去等待回呼。

- (void)xw_addObserverBlockForKeyPath:(NSString *)keyPath
                                block:(void (^)(id obj, id oldVal, id newVal))block {
    if (!keyPath || !block) return;

    // 取出存放所有 KVO Target 的字典
    NSMutableDictionary *allTargets = objc_getAssociatedObject(self, XWKVOBlockKey);
    if (!allTargets) {
        allTargets = [NSMutableDictionary new];
        // 關聯到該物件上
        objc_setAssociatedObject(self, XWKVOBlockKey, allTargets, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
    }

    // 取出該 keyPath 對應的 target
    _XWBlockTarget *targetForKeyPath = allTargets[keyPath];
    if (!targetForKeyPath) {
        targetForKeyPath = [_XWBlockTarget new];
        allTargets[keyPath] = targetForKeyPath;
        // 第一次註冊時,才真正掛上原生 KVO
        [self addObserver:targetForKeyPath
               forKeyPath:keyPath
                  options:NSKeyValueObservingOptionNew | NSKeyValueObservingOptionOld
                  context:NULL];
    }

    [targetForKeyPath xw_addBlock:block];

    // 對第一次註冊 KVO 的類別進行 dealloc 調劑
    [self _xw_swizzleDealloc];
}

最後那個方法,是整個方案的關鍵:我們希望在「合適的時機」自動取消註冊,而最合適的位置莫過於被監聽物件銷毀時的 dealloc。

直覺做法是拿出 runtime 的 swizzle 黑魔法交換方法,但這招有個硬限制:swizzle 只能交換本類別的方法,無法在一個類別裡調劑另一個類別的方法。 於是改為直接在被監聽物件所屬的類別上「新增或替換」dealloc 實作:

/**
 *  調劑 dealloc 方法。因無法直接對其他類別使用 swizzle,做法稍微迂回一些
 */
- (void)_xw_swizzleDealloc {
    // 每個類別只需調劑一次,用關聯物件做標記
    BOOL swizzled = [objc_getAssociatedObject(self.class, deallocHasSwizzledKey) boolValue];
    if (swizzled) return;

    Class swizzleClass = self.class;
    SEL deallocSelector = sel_registerName("dealloc");

    // 用來保存原有的 dealloc 實作
    __block void (*originalDealloc)(__unsafe_unretained id, SEL) = NULL;

    // 以 block 形式實作新的 dealloc
    id newDealloc = ^(__unsafe_unretained id objSelf) {
        // 在這裡移除所有 KVO
        [objSelf xw_removeAllObserverBlocks];

        if (originalDealloc == NULL) {
            // 本類別沒有實作 dealloc,需向父類發送 dealloc 訊息
            struct objc_super superInfo = {
                .receiver = objSelf,
                .super_class = class_getSuperclass(swizzleClass)
            };
            void (*msgSend)(struct objc_super *, SEL) = (__typeof__(msgSend))objc_msgSendSuper;
            msgSend(&superInfo, deallocSelector);
        } else {
            // 本類別實作過 dealloc,直接呼叫原實作
            originalDealloc(objSelf, deallocSelector);
        }
    };

    // 由 block 產生新的 IMP
    IMP newDeallocIMP = imp_implementationWithBlock(newDealloc);

    // 嘗試直接添加。若類別已複寫 dealloc 則會失敗
    if (!class_addMethod(swizzleClass, deallocSelector, newDeallocIMP, "v@:")) {
        // 添加失敗,保存原實作並替換,確保原本的系統邏輯仍會執行
        Method deallocMethod = class_getInstanceMethod(swizzleClass, deallocSelector);
        originalDealloc = (void(*)(__unsafe_unretained id, SEL))method_getImplementation(deallocMethod);
        originalDealloc = (void(*)(__unsafe_unretained id, SEL))method_setImplementation(deallocMethod, newDeallocIMP);
    }

    // 標記該類別已調劑完成
    objc_setAssociatedObject(self.class, deallocHasSwizzledKey, @(YES), OBJC_ASSOCIATION_RETAIN_NONATOMIC);
}

/** 移除所有 KVO */
- (void)xw_removeAllObserverBlocks {
    NSMutableDictionary *allTargets = objc_getAssociatedObject(self, XWKVOBlockKey);
    if (!allTargets) return;

    [allTargets enumerateKeysAndObjectsUsingBlock:^(id key, _XWBlockTarget *target, BOOL *stop) {
        [self removeObserver:target forKeyPath:key];
    }];

    [allTargets removeAllObjects];
}

如此一來,新的 dealloc 在執行時會先完成所有 KVO 的注销,再走原本的銷毀流程。手動移除這件事,就此從開發者的待辦清單裡消失了。

寫在最後

通知的實作思路與 KVO 幾乎一致,細節就不在此重複,有興趣的直接看程式碼即可。現在,KVO 和通知總算能用得優雅又安心了。

專案地址再次附上:XWEasyKVONotification。若對你有幫助,歡迎給個 star!

  1. 上一篇文章:
  2. 下一篇文章:
蘋果刷機越獄教程| IOS教程問題解答| IOS技巧綜合| IOS7技巧| IOS8教程
Copyright © IOS教程網 All Rights Reserved