我的Github地址 : Jerry4me, 本文章的demo鏈接 : JRCustomKVODemo
前言
KVO(Key-Value Observing, 鍵值觀察), KVO的實(shí)現(xiàn)也依賴于runtime. 當(dāng)你對(duì)一個(gè)對(duì)象進(jìn)行觀察時(shí), 系統(tǒng)會(huì)動(dòng)態(tài)創(chuàng)建一個(gè)類繼承自原類, 然后重寫被觀察屬性的setter方法. 然后重寫的setter方法會(huì)負(fù)責(zé)在調(diào)用原setter方法前后通知觀察者. KVO還會(huì)修改原對(duì)象的isa指針指向這個(gè)新類.
我們知道, 對(duì)象是通過isa指針去查找自己是屬于哪個(gè)類, 并去所在類的方法列表中查找方法的, 所以這個(gè)時(shí)候這個(gè)對(duì)象就自然地變成了新類的實(shí)例對(duì)象.
不僅如此, Apple還重寫了原類的- class方法, 視圖欺騙我們, 這個(gè)類沒有變, 還是原來的那個(gè)類(偷龍轉(zhuǎn)鳳). 只要我們懂得Runtime的原理, 這一切都只是掩耳盜鈴罷了.
以下實(shí)現(xiàn)是參考Glow 技術(shù)團(tuán)隊(duì)博客的文章進(jìn)行修改而成, 主要目的是加深對(duì)runtime的理解, 大家看完后不妨自己動(dòng)手實(shí)現(xiàn)以下, 學(xué)而時(shí)習(xí)之, 不亦樂乎
KVO的缺陷
Apple給我們提供的KVO不能通過block來回調(diào)處理, 只能通過下面這個(gè)方法來處理, 如果監(jiān)聽的屬性多了, 或者監(jiān)聽了多個(gè)對(duì)象的屬性, 那么這里就痛苦了, 要一直判斷判斷if else if else....多麻煩啊, 說實(shí)話我也不懂為什么Apple不提供多一個(gè)傳block參數(shù)的方法
- (void)observeValueForKeyPath:(NSString *)keyPath ofObject:(id)object change:(NSDictionary *)change context:(void *)context
那么, 既然Apple沒有幫我們實(shí)現(xiàn), 那我們就手動(dòng)實(shí)現(xiàn)一個(gè)唄, 先看下我們最終目標(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
}];
簡(jiǎn)簡(jiǎn)單單就能讓observer監(jiān)聽object的兩個(gè)屬性, 并且監(jiān)聽屬性改變后的回調(diào)就在對(duì)應(yīng)的callback下, 清晰明了, 何不快哉! Talk is cheap, show you the code!
首先, 我們?yōu)?code>NSObject新增一個(gè)分類
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方法里我們需要做什么呢?
- 檢查對(duì)象是否存在該屬性的setter方法, 沒有的話我們就做什么都白搭了, 既然別人都不允許你修改值了, 那也就不存在監(jiān)聽值改變的事了
- 檢查自己(self)是不是一個(gè)kvo_class(如果該對(duì)象不是第一次被監(jiān)聽屬性, 那么它就是kvo_class, 反之則是原class), 如果是, 則跳過這一步; 如果不是, 則要修改self的類(origin_class -> kvo_class)
- 經(jīng)過第二部, 到了這里已經(jīng)100%確定self是kvo_class的對(duì)象了, 那么我們現(xiàn)在就要重寫kvo_class對(duì)象的對(duì)應(yīng)屬性的setter方法
- 最后, 將觀察者對(duì)象(observer), 監(jiān)聽的屬性(key), 值改變時(shí)的回調(diào)block(callback), 用一個(gè)模型(
JRObserverInfo)存進(jìn)來, 然后利用關(guān)聯(lián)對(duì)象維護(hù)self的一個(gè)數(shù)組(NSMutableArray<JRObserverInfo *> *)
- (void)jr_addObserver:(id)observer key:(NSString *)key callback:(JRKVOCallback)callback
{
// 1. 檢查對(duì)象的類有沒有相應(yīng)的 setter 方法片吊。如果沒有拋出異常
SEL setterSelector = NSSelectorFromString([self setterForGetter:key]);
Method setterMethod = class_getInstanceMethod([self class], setterSelector);
if (!setterMethod) {
NSLog(@"找不到該方法");
// throw exception here
}
// 2. 檢查對(duì)象 isa 指向的類是不是一個(gè) KVO 類缚窿。如果不是，新建一個(gè)繼承原來類的子類蘸秘，并把 isa 指向這個(gè)新建的子類
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是一個(gè)宏, = @"JRKVO_"
// 3. 為kvo class添加setter方法的實(shí)現(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)對(duì)象(裝著所有監(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];
}
這段代碼還有幾個(gè)方法, 我們下面一一解釋...
首先, setterForGetter 和 getterForSetter, 這兩個(gè)方法好辦. 第一個(gè)就是根據(jù)getter方法名獲得對(duì)應(yīng)的setter方法名, 第二個(gè)就是根據(jù)setter方法名獲得對(duì)應(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)換成大寫這一項(xiàng), 不能直接調(diào)用NSString的capitalizedString方法, 因?yàn)樵摲椒ǚ祷氐氖浅耸鬃帜复髮懼馄渌帜溉啃懙淖址?
然后, 接下來就是jr_KVOClassWithOriginalClassName:方法了
- (Class)jr_KVOClassWithOriginalClassName:(NSString *)className
{
// 生成kvo_class的類名
NSString *kvoClassName = [JRKVOClassPrefix stringByAppendingString:className];
Class kvoClass = NSClassFromString(kvoClassName);
// 如果kvo class已經(jīng)被注冊(cè)過了, 則直接返回
if (kvoClass) {
return kvoClass;
}
// 如果kvo class不存在, 則創(chuàng)建這個(gè)類
Class originClass = object_getClass(self);
kvoClass = objc_allocateClassPair(originClass, kvoClassName.UTF8String, 0);
// 修改kvo class方法的實(shí)現(xiàn), 學(xué)習(xí)Apple的做法, 隱瞞這個(gè)kvo_class
Method clazzMethod = class_getInstanceMethod(kvoClass, @selector(class));
const char *types = method_getTypeEncoding(clazzMethod);
class_addMethod(kvoClass, @selector(class), (IMP)jr_class, types);
// 注冊(cè)kvo_class
objc_registerClassPair(kvoClass);
return kvoClass;
}
這個(gè)方法還是很直觀明了的, 可能不太明白的是為什么要為kvo_class這個(gè)類重寫class方法呢? 原因是我們要把這個(gè)kvo_class隱藏掉, 讓別人覺得自己的類沒有發(fā)生過任何改變, 以前是Person, 添加觀察者之后還是Person, 而不是KVO_Person.
這個(gè)jr_class實(shí)現(xiàn)也很簡(jiǎ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)用原方法后, 通知每個(gè)觀察者(調(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))
};
// 這里需要做個(gè)類型強(qiáng)轉(zhuǎn), 否則會(huì)報(bào)too many argument的錯(cuò)誤
((void (*)(void *, SEL, id))objc_msgSendSuper)(&superClazz, _cmd, newValue);
// 為什么不能用下面方法代替上面方法?
// ((void (*)(id, SEL, id))objc_msgSendSuper)(self, _cmd, newValue);
// 找出觀察者的數(shù)組, 調(diào)用對(duì)應(yīng)對(duì)象的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_msgSend與objc_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í)候, 第一個(gè)參數(shù)已經(jīng)不一樣了, 他接受的是一個(gè)指向結(jié)構(gòu)體的指針, 于是才有了我們上面廢力氣創(chuàng)建的一個(gè)看似無用結(jié)構(gòu)體
另外, 調(diào)用objc_msgSend總是需要做方法的類型強(qiáng)轉(zhuǎn),
objc_msgSendSuper(&superClazz, _cmd, newValue);
// 當(dāng)你這樣做時(shí), 編譯器會(huì)報(bào)以下錯(cuò)誤
/* Too many arguments to function call, expected 0, have 3 */
// 所以我們需要做個(gè)方法類型的強(qiáng)轉(zhuǎn), 就不會(huì)報(bào)錯(cuò)了
移除監(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;
}
}
}
相信不用注釋大家也能看懂, 大家記得在對(duì)象- dealloc方法中調(diào)用該方法移除監(jiān)聽者就OK了, 否則有可能報(bào)野指針錯(cuò)誤, 訪問壞內(nèi)存.
監(jiān)聽者信息
JRObserverInfo是個(gè)什么模型呢? 這里告訴大家...
// 回調(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)行展示
這里我就簡(jiǎn)單做個(gè)展示, 下面的textLabel監(jiān)聽上面colorView背景色的改變, 點(diǎn)擊button, 改變上面colorView的顏色, 然后textLabel輸出colorView的當(dāng)前色
demo可在JRCustomKVODemo這里下載, 同時(shí)歡迎大家關(guān)注我的Github, 覺得有幫助的話還請(qǐng)給個(gè)star~~
