一句代码,更加优雅的调用KVO和通知

写在前面

每次使用KVO和通知我就觉得是一件麻烦的事情,即便谈不上麻烦,也可说是不方便吧,对于KVO,你需要注册,然后实现监听方法,最后还要移除,通知当然也需要移除操作,这使得相关逻辑的代码过于分散,控制器搞得乱乱的,而且总有时候会忘记移除什么的,总之感觉不太好,所以我想如果能有方法添加一个KVO或者通知后能够省略后面移除或者实现监听方法步骤的话会多好,所以我就尝试写了一个分类,这个分类的目的在于尽可能简化KVO和通知的步骤,对于KVO,你只需要一句代码就可完成监听,无需自己手动移除,通知也差不多,接口如下:

/**

*  通过Block方式注册一个KVO,通过该方式注册的KVO无需手动移除,其会在被监听对象销毁的时候自动移除

*

*  @param keyPath 监听路径

*  @param block  KVO回调block,obj为监听对象,oldVal为旧值,newVal为新值

*/- (void)xw_addObserverBlockForKeyPath:(NSString*)keyPath block:(void(^)(idobj,idoldVal,idnewVal))block;/**

*  通过block方式注册通知,通过该方式注册的通知无需手动移除,同样会自动移除

*

*  @param name  通知名

*  @param block 通知的回调Block,notification为回调的通知对象

*/- (void)xw_addNotificationForName:(NSString*)name block:(void(^)(NSNotification*notification))block;

使用也很简单咯,github地址如下:XWEasyKVONotification,你只需要导入NSObject+XWAdd这个分类,然后调用上面两个接口即可完成KVO和通知,事例代码如下

//监听_objA的name属性[_objA xw_addObserverBlockForKeyPath:@"name"block:^(idobj,idoldVal,idnewVal) {NSLog(@"kvo,修改name为%@", newVal);    }];    [selfxw_addNotificationForName:@"XWTestNotificaton"block:^(NSNotification*notification) {NSLog(@"收到通知:%@", notification.userInfo);    }];

是不是非常简单,再也不用关心忘记移除导致的崩溃了,而且代码也集中,看着也更舒服了

原理

1、由于KVO和通知都差不多,原理部分通过KVO的接口的的实现原理进行说明,考虑到代码的统一我首先考虑到使用block,同时为了block能回调,我们需要一个内部的对象target的来实现KVO的代码,在监听到值改变的时候通过这个对象来回调block,同时一个target应该对应一个keyPath,并且可应该对应多个Block,因为我们可能对一个keyPath进行多处监听,这个类的具体代码大致如下:

@interface_XWBlockTarget:NSObject/**添加一个KVOblock*/- (void)xw_addBlock:(void(^)(__weakidobj,idoldValue,idnewValue))block;@end@implementation_XWBlockTarget{//保存所有的KVOblockNSMutableSet*_blockSet;}- (instancetype)init{self= [superinit];if(self) {        _blockSet = [NSMutableSetnew];    }returnself;}- (void)xw_addBlock:(void(^)(__weakidobj,idoldValue,idnewValue))block{    [_blockSet addObject:[blockcopy]];}//KVO的真正实现- (void)observeValueForKeyPath:(NSString*)keyPath ofObject:(id)object change:(NSDictionary *)change context:(void*)context{if(!_blockSet.count)return;BOOLprior = [[change objectForKey:NSKeyValueChangeNotificationIsPriorKey] boolValue];//只接受值改变时的消息if(prior)return;NSKeyValueChangechangeKind = [[change objectForKey:NSKeyValueChangeKindKey] integerValue];if(changeKind !=NSKeyValueChangeSetting)return;idoldVal = [change objectForKey:NSKeyValueChangeOldKey];if(oldVal == [NSNullnull]) oldVal =nil;idnewVal = [change objectForKey:NSKeyValueChangeNewKey];if(newVal == [NSNullnull]) newVal =nil;//当KVO触发,值改变的时候执行该target下的所有block[_blockSet enumerateObjectsUsingBlock:^(void(^block)(__weakidobj,idoldVal,idnewVal),BOOL* _Nonnull stop) {        block(object, oldVal, newVal);    }];}@end

2、实际进行KVO的监听的对象有了,我们就可以开始书写逻辑了,我们给每一个对象绑定一个targets的字典,每次调用该API注册KVO的就去判断有没有对应的keyPath下的target(target和keyPath一一对应),没有就创建,同时注册这个keyPath的KVO,有就把block加入这个target以便回调,具体代码如下:

- (void)xw_addObserverBlockForKeyPath:(NSString*)keyPath block:(void(^)(idobj,idoldVal,idnewVal))block {if(!keyPath || !block)return;//取出存有所有KVOTarget的字典NSMutableDictionary*allTargets = objc_getAssociatedObject(self, XWKVOBlockKey);if(!allTargets) {//没有则创建allTargets = [NSMutableDictionarynew];//绑定在该对象中objc_setAssociatedObject(self, XWKVOBlockKey, allTargets, OBJC_ASSOCIATION_RETAIN_NONATOMIC);    }//获取对应keyPath中的所有target_XWBlockTarget *targetForKeyPath = allTargets[keyPath];if(!targetForKeyPath) {//没有则创建targetForKeyPath = [_XWBlockTarget new];//保存allTargets[keyPath] = targetForKeyPath;//如果第一次,则注册对keyPath的KVO监听[selfaddObserver:targetForKeyPath forKeyPath:keyPath options:NSKeyValueObservingOptionNew|NSKeyValueObservingOptionOldcontext:NULL];    }    [targetForKeyPath xw_addBlock:block];//对第一次注册KVO的类进行dealloc方法调剂[self_xw_swizzleDealloc];}

3、上一段代码的最后一个方法是对dealloc方法进行调剂,因为我们想要能够在合适的时候自动注销KVO,何为合适的地方呢,当然是被监听对象销毁的时候才是最合适的地方,所以dealloc方法里面是最合适的地方,我们期望能交换被监听对象的dealloc方法然后自己在该方法中实现注销KVO的逻辑,最先能想到的方式是通常我们使用的runtime中的swizzle黑魔法直接进行方法交换,但遗憾的是swizzle黑魔法只能在本类中交换本类的方法,而无法在一个类中对另一个类的方法进行调剂,所以需要另想调剂方法,我们采取直接对变监听对象所在的类修改或者添加dealloc方法来达到调剂目的,我结合代码进行说明:

/**

*  调剂dealloc方法,由于无法直接使用运行时的swizzle方法对dealloc方法进行调剂,所以稍微麻烦一些

*/- (void)_xw_swizzleDealloc{//我们给每个类绑定上一个值来判断dealloc方法是否被调剂过,因为一个类只需要调剂一次,如果调剂过了就无需再次调剂了BOOLswizzled = [objc_getAssociatedObject(self.class, deallocHasSwizzledKey) boolValue];//如果调剂过则直接返回if(swizzled)return;//开始调剂Class swizzleClass =self.class;//获取原有的dealloc方法SEL deallocSelector = sel_registerName("dealloc");//初始化一个函数指针用于保存原有的dealloc方法__blockvoid(*originalDealloc)(__unsafe_unretainedid, SEL) =NULL;//实现我们自己的dealloc方法,通过block的方式idnewDealloc = ^(__unsafe_unretainedidobjSelf){//在这里我们移除所有的KVO[objSelf xw_removeAllObserverBlocks];//根据原有的dealloc方法是否存在进行判断if(originalDealloc ==NULL) {//如果不存在,说明本类没有实现dealloc方法,则需要向父类发送dealloc消息(objc_msgSendSuper)//构造objc_msgSendSuper所需要的参数,.receiver为方法的实际调用者,即为类本身,.super_class指向其父类structobjc_super superInfo = {.receiver= objSelf,.super_class= class_getSuperclass(swizzleClass)            };//构建objc_msgSendSuper函数void(*msgSend)(structobjc_super *, SEL) = (__typeof__(msgSend))objc_msgSendSuper;//向super发送dealloc消息msgSend(&superInfo, deallocSelector);        }else{//如果存在,表明该类实现了dealloc方法,则直接调用即可//调用原有的dealloc方法originalDealloc(objSelf, deallocSelector);        }    };//根据block构建新的dealloc实现IMPIMP newDeallocIMP = imp_implementationWithBlock(newDealloc);//尝试添加新的dealloc方法,如果该类已经复写的dealloc方法则不能添加成功,反之则能够添加成功if(!class_addMethod(swizzleClass, deallocSelector, newDeallocIMP,"v@:")) {//如果没有添加成功则保存原有的dealloc方法,用于新的dealloc方法中,执行原有的系统的dealloc逻辑Method deallocMethod = class_getInstanceMethod(swizzleClass, deallocSelector);        originalDealloc = (void(*)(__unsafe_unretainedid, SEL))method_getImplementation(deallocMethod);        originalDealloc = (void(*)(__unsafe_unretainedid, 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:^(idkey, _XWBlockTarget *target,BOOL*stop) {        [selfremoveObserver:target forKeyPath:key];    }];    [allTargets removeAllObjects];}

通过如上方式,我们就完成了对dealloc方法的调剂,新的dealloc方法执行的时候回注销注册的KVO,这样就免去了手动注销的麻烦事情咯!

写在最后

通知的大致实现方式和KVO一样,详情请自行查看代码咯,我就不多做说明了,现在终于能优雅愉快的使用KVO和通知了,复习一下github地址:XWEasyKVONotification如果觉得对您有帮助,欢迎star!

文/wazrx(简书作者)

原文链接:http://www.jianshu.com/p/70b2503d5fd1

著作权归作者所有,转载请联系作者获得授权,并标注“简书作者”。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,921评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,635评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,393评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,836评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,833评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,685评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,043评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,694评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,671评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,670评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,779评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,424评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,027评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,984评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,214评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,108评论 2 351
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,517评论 2 343

推荐阅读更多精彩内容