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

iOS 的 KVO 用法與輕量級封裝實作

編輯:iOS 開發綜合

KVO 的基本用法

註冊觀察者:

[object addObserver:observer forKeyPath:@"text" options:NSKeyValueObservingOptionNew context:nil];

實作回呼方法:

-(void)observeValueForKeyPath:(NSString *)keyPath ofObject:(id)object change:(NSDictionary *)change context:(void *)context {
    if ([keyPath isEqualToString:@"text"]) {
        NSLog(@"text:@%@", change[NSKeyValueChangeNewKey]);
    }
}

在釋放時取消註冊:

[object removeObserver:self forKeyPath:@"text"];

原生寫法有幾個明顯的痛點:註冊時參數繁多、釋放時必須記得取消註冊,而且只有一個回呼入口,當觀察的對象一多,回呼方法裡就會塞滿判斷分支,程式碼迅速變得雜亂。

動手封裝 KVO

下面針對上述問題做一層輕量封裝。首先定義一個觀察者類:

@interface XYObserver : NSObject
@end

@interface XYObserver ()
@property (nonatomic, assign) XYObserverType type;                 // 觀察者類型
@property (nonatomic, weak)   id target;                           // 值變更時負責回應的物件
@property (nonatomic, assign) SEL selector;                        // 值變更時呼叫的方法
@property (nonatomic, copy)   XYObserver_block_sourceObject_new_old block; // 值變更時執行的 block
@property (nonatomic, assign) id sourceObject;                     // 被觀察的物件
@property (nonatomic, strong) NSString *keyPath;                   // 被觀察物件的 keyPath

-(instancetype)initWithSourceObject:(id)sourceObject keyPath:(NSString*)keyPath target:(id)target selector:(SEL)selector type:(XYObserverType)type;
-(instancetype)initWithSourceObject:(id)sourceObject keyPath:(NSString*)keyPath block:(XYObserver_block_sourceObject_new_old)block;
@end

接著為 NSObject 加上一個類別,把觀察相關的 API 掛上去:

@interface NSObject (XYObserver)
@property (nonatomic, readonly, strong) NSMutableDictionary *observers;

/**
 * 參數說明
 * sourceObject 被觀察的物件
 * keyPath     被觀察屬性的 keypath
 * target      預設為 self
 * selector    可為 propertyNew: / propertyNew:old: / propertyIn:new: / propertyIn:new:old:
 * type        依 selector 自動帶值
 * block       與 selector 二選一
 */
-(void)observeWithObject:(id)sourceObject property:(NSString*)property;
-(void)observeWithObject:(id)sourceObject property:(NSString*)property block:(XYObserver_block_sourceObject_new_old)block;
-(void)removeObserverWithObject:(id)sourceObject property:(NSString *)property;
-(void)removeObserverWithObject:(id)sourceObject;
-(void)removeAllObserver;
@end

註冊時,我們用「屬性名 + 後綴」拼出對應的 selector,並判斷物件是否實作,再據此分派:

-(void)observeWithObject:(id)object property:(NSString*)property {
    SEL aSel = NSSelectorFromString([NSString stringWithFormat:@"%@New:", property]);
    if ([self respondsToSelector:aSel]) {
        [self observeWithObject:object keyPath:property target:self selector:aSel type:XYObserverType_new];
        return;
    }
    // ... 其餘型別依此類推
}

若改用 block,直接保存即可:

-(void)observeWithObject:(id)object property:(NSString*)property block:(XYObserver_block_sourceObject_new_old)block {
    [self observeWithObject:object keyPath:property block:block];
}

回呼時依型別分派到 selector 或 block:

-(void)observeValueForKeyPath:(NSString*)keyPath ofObject:(id)object change:(NSDictionary*)change context:(void*)context {
    __weak __typeof(self) weakSelf = self;
    if (_block) {
        _block(weakSelf, change[NSKeyValueChangeNewKey], change[NSKeyValueChangeOldKey]);
        return;
    }
    if (_type == XYObserverType_new) {
        action(_target, _selector, change[NSKeyValueChangeNewKey]);
    } else if (_type == XYObserverType_new_old) {
        action(_target, _selector, change[NSKeyValueChangeNewKey], change[NSKeyValueChangeOldKey]);
    } else if (_type == XYObserverType_self_new) {
        action(_target, _selector, self, change[NSKeyValueChangeNewKey]);
    } else if (_type == XYObserverType_self_new_old) {
        action(_target, _selector, self, change[NSKeyValueChangeNewKey], change[NSKeyValueChangeOldKey]);
    }
}

把每個觀察者放進一本字典裡統一管理,並用關聯物件 lazily 建立這本字典:

-(void)observeWithObject:(id)object keyPath:(NSString*)keyPath target:(id)target selector:(SEL)selector type:(XYObserverType)type {
    XYObserver *ob = [[XYObserver alloc] initWithSourceObject:object keyPath:keyPath target:target selector:selector type:type];
    NSString *key = [NSString stringWithFormat:@"%@_%@", object, keyPath];
    [self.observers setObject:ob forKey:key];
}

-(id)observers {
    id object = objc_getAssociatedObject(self, NSObject_observers);
    if (nil == object) {
        NSMutableDictionary *dic = [NSMutableDictionary dictionaryWithCapacity:8];
        objc_setAssociatedObject(self, NSObject_observers, dic, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
        return dic;
    }
    return object;
}

當觀察者物件釋放時,會在自己的 dealloc 中主動取消註冊,避免殘留:

-(void)dealloc {
    if (_sourceObject) {
        [_sourceObject removeObserver:self forKeyPath:_keyPath];
    }
}

為了少寫一點樣板程式,再定義幾個宏:

#define ON_KVO_1_( __property ) -(void) __property##New:(id)newValue
#define ON_KVO_2_( __property ) -(void) __property##New:(id)newValue old:(id)oldValue
#define ON_KVO_3_( __property ) -(void) __property##In:(id)sourceObject new:(id)newValue
#define ON_KVO_4_( __property ) -(void) __property##In:(id)sourceObject new:(id)newValue old:(id)oldValue

使用範例

[self observeWithObject:self property:@"testKVO"];

ON_KVO_4_(testKVO) {
    NSLogD(@"obj:%@ new:%@ old:%@", sourceObject, newValue, oldValue);
}

[self observeWithObject:self property:@"testKVO2" block:^(id sourceObject, id newValue, id oldValue) {
    NSLogD(@"obj:%@ new:%@ old:%@", sourceObject, newValue, oldValue);
}];

這樣封裝的好處很直接:使用 KVO 時不必再記住一堆瑣碎細節,selector 與 block 兩種風格都能自由取用。完整程式碼可至 https://github.com/uxyheaven/XYQuickDevelop 下載。

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