iOS-手動實現(xiàn)KVO

我的Github地址 : Jerry4me, 本文章的demo鏈接 : JRCustomKVODemo


前言

KVO(Key-Value Observing, 鍵值觀察), KVO的實現(xiàn)也依賴于runtime. 當(dāng)你對一個對象進(jìn)行觀察時, 系統(tǒng)會動態(tài)創(chuàng)建一個類繼承自原類, 然后重寫被觀察屬性的setter方法. 然后重寫的setter方法會負(fù)責(zé)在調(diào)用原setter方法前后通知觀察者. KVO還會修改原對象的isa指針指向這個新類.

我們知道, 對象是通過isa指針去查找自己是屬于哪個類, 并去所在類的方法列表中查找方法的, 所以這個時候這個對象就自然地變成了新類的實例對象.

不僅如此, Apple還重寫了原類的- class方法, 視圖欺騙我們, 這個類沒有變, 還是原來的那個類(偷龍轉(zhuǎn)鳳). 只要我們懂得Runtime的原理, 這一切都只是掩耳盜鈴罷了.

以下實現(xiàn)是參考Glow 技術(shù)團(tuán)隊博客的文章進(jìn)行修改而成, 主要目的是加深對runtime的理解, 大家看完后不妨自己動手實現(xiàn)以下, 學(xué)而時習(xí)之, 不亦樂乎


KVO的缺陷

Apple給我們提供的KVO不能通過block來回調(diào)處理, 只能通過下面這個方法來處理, 如果監(jiān)聽的屬性多了, 或者監(jiān)聽了多個對象的屬性, 那么這里就痛苦了, 要一直判斷判斷if else if else....多麻煩啊, 說實話我也不懂為什么Apple不提供多一個傳block參數(shù)的方法
- (void)observeValueForKeyPath:(NSString *)keyPath ofObject:(id)object change:(NSDictionary *)change context:(void *)context

那么, 既然Apple沒有幫我們實現(xiàn), 那我們就手動實現(xiàn)一個唄, 先看下我們最終目標(biāo)是什么樣的 :

[object jr_addObserver:observer key:@"name" callback:^(id observer, NSString *key, id oldValue, id newValue) {
    // do something here
}];
[object jr_addObserver:observer key:@"address" callback:^(id observer, NSString *key, id oldValue, id newValue) {
    // do something here
}];

簡簡單單就能讓observer監(jiān)聽object的兩個屬性, 并且監(jiān)聽屬性改變后的回調(diào)就在對應(yīng)的callback下, 清晰明了, 何不快哉! Talk is cheap, show you the code!


首先, 我們?yōu)?code>NSObject新增一個分類

NSObject+jr_KVO.h

#import <Foundation/Foundation.h>
#import "JRObserverInfo.h"

@interface NSObject (jr_KVO)
- (void)jr_addObserver:(id)observer key:(NSString *)key callback:(JRKVOCallback)callback;
- (void)jr_removeObserver:(id)observer key:(NSString *)key;
@end

添加觀察者

jr_addObserver方法里我們需要做什么呢?

  1. 檢查對象是否存在該屬性的setter方法, 沒有的話我們就做什么都白搭了, 既然別人都不允許你修改值了, 那也就不存在監(jiān)聽值改變的事了
  2. 檢查自己(self)是不是一個kvo_class(如果該對象不是第一次被監(jiān)聽屬性, 那么它就是kvo_class, 反之則是原class), 如果是, 則跳過這一步; 如果不是, 則要修改self的類(origin_class -> kvo_class)
  3. 經(jīng)過第二部, 到了這里已經(jīng)100%確定self是kvo_class的對象了, 那么我們現(xiàn)在就要重寫kvo_class對象的對應(yīng)屬性的setter方法
  4. 最后, 將觀察者對象(observer), 監(jiān)聽的屬性(key), 值改變時的回調(diào)block(callback), 用一個模型(JRObserverInfo)存進(jìn)來, 然后利用關(guān)聯(lián)對象維護(hù)self的一個數(shù)組(NSMutableArray<JRObserverInfo *> *)
- (void)jr_addObserver:(id)observer key:(NSString *)key callback:(JRKVOCallback)callback
{
    // 1. 檢查對象的類有沒有相應(yīng)的 setter 方法。如果沒有拋出異常
    SEL setterSelector = NSSelectorFromString([self setterForGetter:key]);
    
    Method setterMethod = class_getInstanceMethod([self class], setterSelector);
    if (!setterMethod) {
        NSLog(@"找不到該方法");
        // throw exception here
    }
    
    // 2. 檢查對象 isa 指向的類是不是一個 KVO 類。如果不是,新建一個繼承原來類的子類,并把 isa 指向這個新建的子類
    Class clazz = object_getClass(self);
    NSString *className = NSStringFromClass(clazz);
    
    if (![className hasPrefix:JRKVOClassPrefix]) {
        clazz = [self jr_KVOClassWithOriginalClassName:className];
        object_setClass(self, clazz);
    }    

    // 到這里為止, object的類已不是原類了, 而是KVO新建的類
    // 例如, Person -> JRKVOClassPrefixPerson
    // JRKVOClassPrefix是一個宏, = @"JRKVO_"
    
    // 3. 為kvo class添加setter方法的實現(xiàn)
    const char *types = method_getTypeEncoding(setterMethod);
    class_addMethod(clazz, setterSelector, (IMP)jr_setter, types);
    
    // 4. 添加該觀察者到觀察者列表中
    // 4.1 創(chuàng)建觀察者的信息
    JRObserverInfo *info = [[JRObserverInfo alloc] initWithObserver:observer key:key callback:callback];
    // 4.2 獲取關(guān)聯(lián)對象(裝著所有監(jiān)聽者的數(shù)組)
    NSMutableArray *observers = objc_getAssociatedObject(self, JRAssociateArrayKey);
    if (!observers) {
        observers = [NSMutableArray array];
        objc_setAssociatedObject(self, JRAssociateArrayKey, observers, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
    }
    
    [observers addObject:info];
    
}

這段代碼還有幾個方法, 我們下面一一解釋...

首先, setterForGettergetterForSetter, 這兩個方法好辦. 第一個就是根據(jù)getter方法名獲得對應(yīng)的setter方法名, 第二個就是根據(jù)setter方法名獲得對應(yīng)的getter方法名

- (NSString *)setterForGetter:(NSString *)key
{
    // name -> Name -> setName:
    
    // 1. 首字母轉(zhuǎn)換成大寫
    unichar c = [key characterAtIndex:0];
    NSString *str = [key stringByReplacingCharactersInRange:NSMakeRange(0, 1) withString:[NSString stringWithFormat:@"%c", c-32]];
    
    // 2. 最前增加set, 最后增加:
    NSString *setter = [NSString stringWithFormat:@"set%@:", str];

    return setter;
    
}

- (NSString *)getterForSetter:(NSString *)key
{
    // setName: -> Name -> name
    
    // 1. 去掉set
    NSRange range = [key rangeOfString:@"set"];
    
    NSString *subStr1 = [key substringFromIndex:range.location + range.length];
    
    // 2. 首字母轉(zhuǎn)換成大寫
    unichar c = [subStr1 characterAtIndex:0];
    NSString *subStr2 = [subStr1 stringByReplacingCharactersInRange:NSMakeRange(0, 1) withString:[NSString stringWithFormat:@"%c", c+32]];
    
    // 3. 去掉最后的:
    NSRange range2 = [subStr2 rangeOfString:@":"];
    NSString *getter = [subStr2 substringToIndex:range2.location];
    
    return getter;
}

這里需要注意的是, 首字母轉(zhuǎn)換成大寫這一項, 不能直接調(diào)用NSString的capitalizedString方法, 因為該方法返回的是除了首字母大寫之外其他字母全部小寫的字符串.

然后, 接下來就是jr_KVOClassWithOriginalClassName:方法了

- (Class)jr_KVOClassWithOriginalClassName:(NSString *)className
{
    // 生成kvo_class的類名
    NSString *kvoClassName = [JRKVOClassPrefix stringByAppendingString:className];
    Class kvoClass = NSClassFromString(kvoClassName);
    
    // 如果kvo class已經(jīng)被注冊過了, 則直接返回
    if (kvoClass) {
        return kvoClass;
    }
    
    // 如果kvo class不存在, 則創(chuàng)建這個類
    Class originClass = object_getClass(self);
    kvoClass = objc_allocateClassPair(originClass, kvoClassName.UTF8String, 0);
    
    // 修改kvo class方法的實現(xiàn), 學(xué)習(xí)Apple的做法, 隱瞞這個kvo_class
    Method clazzMethod = class_getInstanceMethod(kvoClass, @selector(class));
    const char *types = method_getTypeEncoding(clazzMethod);
    class_addMethod(kvoClass, @selector(class), (IMP)jr_class, types);
    
    // 注冊kvo_class
    objc_registerClassPair(kvoClass);
    
    return kvoClass;
    
}

這個方法還是很直觀明了的, 可能不太明白的是為什么要為kvo_class這個類重寫class方法呢? 原因是我們要把這個kvo_class隱藏掉, 讓別人覺得自己的類沒有發(fā)生過任何改變, 以前是Person, 添加觀察者之后還是Person, 而不是KVO_Person.
這個jr_class實現(xiàn)也很簡單.

Class jr_class(id self, SEL cmd)
{
    Class clazz = object_getClass(self); // kvo_class
    Class superClazz = class_getSuperclass(clazz); // origin_class
    return superClazz; // origin_class
}

最后, 重頭戲來了, 那就是重寫kvo_class的setter方法! Observing也正正是在這里體現(xiàn)出來的.

    /**
     *  重寫setter方法, 新方法在調(diào)用原方法后, 通知每個觀察者(調(diào)用傳入的block)
     */
static void jr_setter(id self, SEL _cmd, id newValue)
{
    NSString *setterName = NSStringFromSelector(_cmd);
    NSString *getterName = [self getterForSetter:setterName];
    
    if (!getterName) {
        NSLog(@"找不到getter方法");
        // throw exception here
    }
    
    // 獲取舊值
    id oldValue = [self valueForKey:getterName];
    
    // 調(diào)用原類的setter方法
    struct objc_super superClazz = {
        .receiver = self,
        .super_class = class_getSuperclass(object_getClass(self))
    };
    // 這里需要做個類型強(qiáng)轉(zhuǎn), 否則會報too many argument的錯誤
    ((void (*)(void *, SEL, id))objc_msgSendSuper)(&superClazz, _cmd, newValue);
    // 為什么不能用下面方法代替上面方法?
    //    ((void (*)(id, SEL, id))objc_msgSendSuper)(self, _cmd, newValue);
    
    // 找出觀察者的數(shù)組, 調(diào)用對應(yīng)對象的callback
    NSMutableArray *observers = objc_getAssociatedObject(self, JRAssociateArrayKey);
    // 遍歷數(shù)組
    for (JRObserverInfo *info in observers) {
        if ([info.key isEqualToString:getterName]) {
            // gcd異步調(diào)用callback
            dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
                info.callback(info.observer, getterName, oldValue, newValue);
            });
        }
    }
}

臥槽, struct objc_super是什么玩意, 臥槽, ((void (*)(void *, SEL, id))objc_msgSendSuper)(&superClazz, _cmd, newValue);這一大串又是什么玩意???

?????

首先, 我們來看看objc_msgSendobjc_msgSendSuper的區(qū)別 :

Apple文檔中是這么說的 : 
void objc_msgSend(void /* id self, SEL op, ... */)
void objc_msgSendSuper(void /* struct objc_super *super, SEL op, ... */)

那么, 很顯然, 我們調(diào)用objc_msgSendSuper的時候, 第一個參數(shù)已經(jīng)不一樣了, 他接受的是一個指向結(jié)構(gòu)體的指針, 于是才有了我們上面廢力氣創(chuàng)建的一個看似無用結(jié)構(gòu)體

另外, 調(diào)用objc_msgSend總是需要做方法的類型強(qiáng)轉(zhuǎn),

objc_msgSendSuper(&superClazz, _cmd, newValue);
// 當(dāng)你這樣做時, 編譯器會報以下錯誤
/* Too many arguments to function call, expected 0, have 3 */
// 所以我們需要做個方法類型的強(qiáng)轉(zhuǎn), 就不會報錯了

移除監(jiān)聽者

移除監(jiān)聽者就easy easy easy太多了, 直接上代碼吧

- (void)jr_removeObserver:(id)observer key:(NSString *)key
{
    NSMutableArray *observers = objc_getAssociatedObject(self, JRAssociateArrayKey);
    if (!observers) return;
    
    for (JRObserverInfo *info in observers) {
        if([info.key isEqualToString:key]) {
            [observers removeObject:info];
            break;
        }
    }
}

相信不用注釋大家也能看懂, 大家記得在對象- dealloc方法中調(diào)用該方法移除監(jiān)聽者就OK了, 否則有可能報野指針錯誤, 訪問壞內(nèi)存.


監(jiān)聽者信息

JRObserverInfo是個什么模型呢? 這里告訴大家...

// 回調(diào)block大家可以自行定義
typedef void (^JRKVOCallback)(id observer, NSString *key, id oldValue, id newValue);

@interface JRObserverInfo : NSObject

/** 監(jiān)聽者 */
@property (nonatomic, weak) id observer;
/** 監(jiān)聽的屬性 */
@property (nonatomic, copy) NSString *key;
/** 回調(diào)的block */
@property (nonatomic, copy) JRKVOCallback callback;

- (instancetype)initWithObserver:(id)observer key:(NSString *)key callback:(JRKVOCallback)callback;
@end

運(yùn)行展示

這里我就簡單做個展示, 下面的textLabel監(jiān)聽上面colorView背景色的改變, 點擊button, 改變上面colorView的顏色, 然后textLabel輸出colorView的當(dāng)前色

運(yùn)行結(jié)果

demo可在JRCustomKVODemo這里下載, 同時歡迎大家關(guān)注我的Github, 覺得有幫助的話還請給個star~~


參考 :
如何自己動手實現(xiàn)KVO

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • 轉(zhuǎn)至元數(shù)據(jù)結(jié)尾創(chuàng)建: 董瀟偉,最新修改于: 十二月 23, 2016 轉(zhuǎn)至元數(shù)據(jù)起始第一章:isa和Class一....
    40c0490e5268閱讀 2,103評論 0 9
  • 前言 KVO:簡單的來說,就是觀察者觀察被觀察對象屬性的變化而發(fā)生相應(yīng)的變化。實現(xiàn)的原理基于KVC與強(qiáng)大的Runt...
    Colleny_Z閱讀 1,325評論 0 2
  • 本篇會對KVO的實現(xiàn)進(jìn)行探究,不涉及太多KVO的使用方法,但是會有一些使用時的思考。 一、使用上的疑問 1.key...
    奮拓達(dá)閱讀 573評論 0 2
  • 尋秦記 1 旅客們步履匆忙走出車站,繞過灰色城墻,消失在車流人海中。他們腳步帶起的微塵還在身后升騰。這是西安的塵土...
    九曲胡同閱讀 1,155評論 9 8
  • 早上醒來,舍友A問我:“你還要一個人啊”?我一頭霧水,是在跟我說話嗎? A小姐一臉嫌棄:“今天是520,大姐?!?...
    會飛的小蝸牛閱讀 596評論 0 5

友情鏈接更多精彩內(nèi)容