在上一篇博客中，說(shuō)明了 KVO 的執(zhí)行過(guò)程和基本的實(shí)現(xiàn)原理柏肪。
KVO的執(zhí)行原理
- 對(duì)象本身作為事件的發(fā)布者，在自己被觀察者(通常是那個(gè)包含自己的控制器)觀察的屬性發(fā)生改變的時(shí)候然遏，向觀察者發(fā)布屬性修改了的通知逊谋。（本質(zhì)就是在 setter 方法調(diào)用的時(shí)候執(zhí)行發(fā)布)
[self.person addObserver:self forKeyPath:@"name" options:(NSKeyValueObservingOptionNew) context:nil];
- 控制器，本身之前實(shí)現(xiàn)訂閱好這個(gè) setter 通知绢淀，并在事件響應(yīng)函數(shù)中萤悴，對(duì)這個(gè)的事件發(fā)布做出相應(yīng)。
- (void)observeValueForKeyPath:(NSString *)keyPath ofObject:(id)object change:(NSDictionary<NSKeyValueChangeKey,id> *)change context:(void *)context {
NSLog(@"%@",change);
}
這些道理都懂皆的，但如何自己在了解了 KVO 實(shí)現(xiàn)原理之后覆履，自己實(shí)現(xiàn)一個(gè) KVO 呢？
為什么要自己實(shí)現(xiàn) KVO费薄？
- 熟悉 runtime 的各種使用方法硝全。
- 傳統(tǒng)的 KVO，所有的屬性訂閱都幾種在了一個(gè)方法相應(yīng)體里面楞抡∥爸冢看起來(lái)不太優(yōu)雅(裝逼)
if ([object isKindOfClass:[xxx class]] && [keyPath isEqualToString:@"xxx"]) {
} else if ([object isKindOfClass:[xxx class]] && [keyPath isEqualToString:@"xxx"]) {
} else if ([object isKindOfClass:[xxx class]] && [keyPath isEqualToString:@"xxx"]) {
} ......
實(shí)現(xiàn)目標(biāo)
希望能夠以 block 回調(diào)的方式來(lái)自己實(shí)現(xiàn) KVO。
好處在于召廷，每一個(gè)屬性對(duì)應(yīng)一個(gè)自己的回調(diào) block凳厢。
這樣代碼看起來(lái)比較清晰和緊湊账胧。
也符合函數(shù)是編程的思想。
最終需要實(shí)現(xiàn)的代碼效果
[self.person rl_addObserver:self forKeyPath:@"name" options:(NSKeyValueObservingOptionNew) context:nil withBlock:^(id observer, NSString *keyPath, id oldValue, id newValue) {
NSLog(@"observer : %@ keyPath : %@ oldValue : %@ newValue : %@",observer,keyPath,oldValue,newValue);
}];
[self.person rl_addObserver:self forKeyPath:@"age" options:(NSKeyValueObservingOptionNew) context:nil withBlock:^(id observer, NSString *keyPath, id oldValue, id newValue) {
//... 這是 age 的改變時(shí)的 KVO block 回調(diào)
}];
.....
在開(kāi)始先自己的目標(biāo)方法之前先紫，首先在回顧一下 KVO 的實(shí)現(xiàn)基本步驟
- 創(chuàng)建一個(gè)當(dāng)前類的子類治泥。
- 在子類中重寫(xiě)當(dāng)前屬性的 setter 方法。
- 在子類重寫(xiě)的 setter 方法里面遮精，手動(dòng)的調(diào)用 KVO 實(shí)現(xiàn)的兩句代碼居夹。
image.png
當(dāng)然，和真實(shí)的 KVO 相比仑鸥，這里缺少了 _isKVO , class , dealloc 的實(shí)現(xiàn)吮播。
首要目的，先是以函數(shù)式編程的方法眼俊，來(lái)實(shí)現(xiàn)自己的 KVO意狠。
開(kāi)始動(dòng)手來(lái)實(shí)現(xiàn)自己的 KVO。
第一步：添加一個(gè) NSObject 的分類
typedef void(^KVOBlock)(id observer,NSString *keyPath,id oldValue ,id newValue);
@interface NSObject (RLKVO)
- (void)rl_addObserver:(NSObject *)observer forKeyPath:(NSString *)keyPath options:(NSKeyValueObservingOptions)options context:(nullable void *)context withBlock:(KVOBlock)block;
@end
方法名哪來(lái)的疮胖？
復(fù)制粘貼系統(tǒng)自帶的 KVO 的方法环戈。
后面加入了一個(gè) block用來(lái)當(dāng)屬性發(fā)生改變時(shí)，回調(diào)觀察者澎灸。
第二步：實(shí)現(xiàn)這個(gè)方法
先考慮一下院塞，在這個(gè)方法內(nèi)部，需要做什么事情性昭。
- keyPath 的有效性檢查拦止。
- 根據(jù)當(dāng)前 self，創(chuàng)建一個(gè)子類糜颠。
- 當(dāng)類創(chuàng)建完畢之后汹族，修改當(dāng)前 self 的 isa 指針到這個(gè)子類。
- 在子類中其兴，添加一個(gè) set方法顶瞒，用來(lái)重寫(xiě)父類的 setter 方法。(用 class_addMethod 添加方法 sel 和 真實(shí)的函數(shù)名元旬，不用匹配榴徐，只要建立雙方的聯(lián)系就行了。此例子中匀归，sel = setName: 而真實(shí)的 C 函數(shù)叫 kvoSetter)坑资。sel & IMP 不需要匹配名字
- 在子類的 setter 方法內(nèi)部，調(diào)用 self willChangeValueForKey: & self didChangeValueForkey:穆端。
當(dāng)然盐茎，還有有一些細(xì)枝末節(jié)的東西。在代碼注釋里會(huì)有說(shuō)明徙赢。
- (void)rl_addObserver:(NSObject *)observer forKeyPath:(NSString *)keyPath options:(NSKeyValueObservingOptions)options context:(void *)context withBlock:(KVOBlock)block {
// keyPath 的檢查字柠。
NSString *setterName = setterFormat(keyPath);
SEL sel = NSSelectorFromString(setterName);
// 這里獲取 method 的意義在于，可以方便的獲取當(dāng)前方法的 EncodingType 一遍在添加方法class_addMethod的時(shí)候狡赐，可以設(shè)置 EncodingType.
Method setterMethod = class_getInstanceMethod([self class], sel);
if (!setterMethod) {
@throw [NSException exceptionWithName:NSInvalidArgumentException reason:[NSString stringWithFormat:@"%@ have not %@ method",[self class],setterName] userInfo:nil];
}
// 獲取前類的類名窑业，并作為之后創(chuàng)建子類的父類。
NSString *superClassName = NSStringFromClass([self class]);
const char *type = method_getTypeEncoding(setterMethod); // 通過(guò)方法結(jié)果提枕屉，拿到方法編碼常柄。EncodingType。否則就需要自己手拼寫(xiě) v@:@ 麻煩搀擂。
// 動(dòng)態(tài)創(chuàng)建類
Class newClass = [self createClassFromSuperName:superClassName sel:sel encodingType:type];
// 替換當(dāng)前 self 的 isa 指針
object_setClass(self, newClass);
// 保存信息
RLKVO_Info *info = [[RLKVO_Info alloc] initWithObserver:observer block:block keypath:keyPath];
NSMutableArray *infoArray = objc_getAssociatedObject(self, &infoArrayPro);
if (!infoArray) {
infoArray = [NSMutableArray array];
objc_setAssociatedObject(self, &infoArrayPro, infoArray, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
}
[infoArray addObject:info];
}
此段代碼解釋：
- 首先根據(jù)用戶傳入的 keyPath 字符串西潘，配置成 setKeyPath: 字符串，表示 setter 方法的sel哨颂。
- 獲取這個(gè) setKeyPath: 的 sel
- 根據(jù) sel 獲取當(dāng)期對(duì)應(yīng)的方法 Method
- 如果 Method 不存在喷市，說(shuō)明傳入的 keyPath 是錯(cuò)誤的。對(duì)象沒(méi)有這個(gè)屬性威恼，拋出異常品姓。
- 獲取當(dāng)前對(duì)象的 className，以備創(chuàng)建子類的時(shí)候使用箫措。
- 根據(jù) Method 拿到方法的 EncodingType 簽名腹备。
- 動(dòng)態(tài)的創(chuàng)建子類。
創(chuàng)建當(dāng)前類的子類方法
/**
根據(jù)父類創(chuàng)建子類
@param superName 父類類型字符串
@param sel 父類當(dāng)前方法的 sel
@param encodingType 父類當(dāng)前方法的 EncodingType
@return 返回以當(dāng)前父類創(chuàng)建的新類斤蔓。
*/
- (Class)createClassFromSuperName:(NSString *)superName sel:(SEL)sel encodingType:(const char *)encodingType {
// 創(chuàng)建一個(gè)類.
Class newClass = objc_allocateClassPair(
NSClassFromString(superName), // 當(dāng)前類的基類
[NSString stringWithFormat:@"RLKVO_%@",
NSStringFromClass([self class])].UTF8String,// 類名
0);
// const char *types = method_getTypeEncoding(class_getInstanceMethod(NSClassFromString(superName), @selector(class)));
// 往新類中添加方法
class_addMethod(newClass, sel, (IMP)kvoSetter, encodingType);
// 類創(chuàng)建完畢之后植酥，注冊(cè)到 runtime
objc_registerClassPair(newClass);
// 返回這個(gè)新類。
return newClass;
}
此段代碼說(shuō)明：
- 動(dòng)態(tài)的創(chuàng)建一個(gè)子類弦牡，類名為 RLKVO_父類的名字友驮。
- 往新類中，添加一個(gè) kvoSetter 的方法喇伯，方法簽名使用父類的 setKeyPath: 喊儡。
- 新類創(chuàng)建完畢，還并沒(méi)有完成稻据，需要把新類注冊(cè)到 runtime艾猜。
- 最后返回已經(jīng)注入到 runtime 的這個(gè)子類。
當(dāng)子類創(chuàng)建捻悯，完畢之后匆赃，就需要把當(dāng)前對(duì)象的 isa 指針改成新創(chuàng)建的這個(gè)類了。
也就是第一段代碼的今缚。
// 動(dòng)態(tài)創(chuàng)建類
Class newClass = [self createClassFromSuperName:superClassName sel:sel encodingType:type];
// 替換當(dāng)前 self 的 isa 指針
object_setClass(self, newClass);
到目前為止算柳，做的事情，主要包括創(chuàng)建了一個(gè)基于當(dāng)前類的子類 & 把當(dāng)前類的 isa 指針改成了子類姓言。
往子類中添加的 kvoSetter 方法具體實(shí)現(xiàn)
// 使用 class_addMethod runtime 添加方法瞬项。
void kvoSetter(id self,SEL _cmd,id newValue) {
// 拿到 setter
NSString *setterName = NSStringFromSelector(_cmd);
// 根據(jù) setter 拿到 getter
NSString *getterName = getterFormat(setterName);
id oldValue = [self valueForKey:getterName];
if (!getterName) {
@throw [NSException exceptionWithName:NSInvalidArgumentException reason:@"getter 方法不存在" userInfo: nil];
}
// 手動(dòng)開(kāi)啟 KVO
[self willChangeValueForKey:getterName];
// 調(diào)用父類的方法蔗蹋。
// 定義一個(gè)函數(shù)指針
void(*objc_msgSendRLKVO)(void *,SEL ,id) = (void *)objc_msgSendSuper;
struct objc_super superClassStruct = {
.receiver = self,
.super_class = class_getSuperclass(object_getClass(self))
};
objc_msgSendRLKVO(&superClassStruct,_cmd,newValue);
[self didChangeValueForKey:getterName];
//
NSMutableArray *infoArrM = objc_getAssociatedObject(self, &infoArrayPro);
if (infoArrM) {
[infoArrM enumerateObjectsUsingBlock:^(RLKVO_Info *info, NSUInteger idx, BOOL * _Nonnull stop) {
info.block(info.observer, info.keyPath, oldValue, newValue);
}];
}
}
在方法實(shí)現(xiàn)中，最重要的就是需要調(diào)用 block囱淋，把 KVO 的相關(guān)數(shù)據(jù)回調(diào)出去給觀察者猪杭。
NSMutableArray *infoArrM = objc_getAssociatedObject(self, &infoArrayPro);
if (infoArrM) {
[infoArrM enumerateObjectsUsingBlock:^(RLKVO_Info *info, NSUInteger idx, BOOL * _Nonnull stop) {
info.block(info.observer, info.keyPath, oldValue, newValue);
}];
}
最后運(yùn)行結(jié)果：
- (void)viewDidLoad {
[super viewDidLoad];
_person = [RLPerson new];
_person.name = @"李四";
[_person rl_addObserver:self forKeyPath:@"name" options:(NSKeyValueObservingOptionNew) context:nil withBlock:^(id observer, NSString *keyPath, id oldValue, id newValue) {
NSLog(@"keyPath : %@ oldValue: %@ newValue : %@",keyPath,oldValue,newValue);
}];
}
- (void)touchesBegan:(NSSet<UITouch *> *)touches withEvent:(UIEvent *)event {
_person.name = [NSString stringWithFormat:@"%@-",_person.name];
}
KVO+BLOCK 實(shí)現(xiàn)2.gif
此次實(shí)現(xiàn)過(guò)程中，代碼細(xì)節(jié)有很多妥衣，光使用文字很難說(shuō)的清楚皂吮。
我把源碼放到了 github 上面。有興趣的小伙伴可以下載來(lái)看看税手。
注意：此 demo 應(yīng)該不能使用到實(shí)際的開(kāi)發(fā)環(huán)境中蜂筹。還有很多細(xì)節(jié)沒(méi)有處理。比如 _iskVO class dealloc 等芦倒。僅供學(xué)習(xí)之用艺挪。
