iOS开发·KVO用法,原理与底层实现: runtime模拟实现KVO监听机制(Blcok及Delgate方式)

摘要:这篇文章首先介绍KVO的基本用法,接着探究 KVO (Key-Value Observing) 实现机制,并利用 runtime 模拟实现 KVO的监听机制:一种Block方式回调,一种Delegate回调。同时,本文也会总结KVO实现过程中与 runtime 相关的API用法。

作为一个开发者,有一个学习的氛围跟一个交流圈子特别重要这是一个我的iOS交流群:776598941,不管你是小白还是大牛欢迎入驻 ,分享BAT,阿里面试题、面试经验,讨论技术, 大家一起交流学习成长!

1. KVO理论基础

1.1 KVO的基本用法

步骤

❶ 注册观察者,实施监听

[self.person addObserver:selfforKeyPath:@"age"options:NSKeyValueObservingOptionNewcontext:nil];

❷ 回调方法,在这里处理属性发生的变化

- (void)observeValueForKeyPath:(NSString*)keyPath                      ofObject:(id)object                        change:(NSDictionary *)change                      context:(void*)context {//...实现监听处理}

❸ 移除观察者

[self removeObserver:self forKeyPath:@“age"];

综合例子

//添加观察者_person = [[Person alloc] init];[_person addObserver:selfforKeyPath:@"age"options:NSKeyValueObservingOptionNew|NSKeyValueObservingOptionOldcontext:nil];

//KVO回调方法- (void)observeValueForKeyPath:(NSString*)keyPath                      ofObject:(id)object                        change:(NSDictionary *)change                      context:(void*)context {NSLog(@"%@对象的%@属性改变了,change字典为:%@",object,keyPath,change);NSLog(@"属性新值为:%@",change[NSKeyValueChangeNewKey]);NSLog(@"属性旧值为:%@",change[NSKeyValueChangeOldKey]);}

//移除观察者- (void)dealloc{    [self.personremoveObserver:selfforKeyPath:@"age"];}

利用了KVO实现键值监听的 第三方框架

AFNetworking , MJRresh

1.2 KVO的实现原理

KVO 是 Objective-C 对 观察者模式 (Observer Pattern)的实现。当被观察对象的某个属性发生更改时,观察者对象会获得通知。有意思的是,你不需要给被观察的对象添加任何额外代码,就能使用 KVO 。这是怎么做到的?

KVO 的实现也依赖于 Objective-C 强大的 Runtime 。Apple 的文档有简单提到过 KVO 的实现。Apple 的文档唯一有用的信息是: 被观察对象的 isa 指针会指向一个中间类,而不是原来真正的类 。Apple 并不希望过多暴露 KVO 的实现细节。

不过,要是你用 runtime 提供的方法去深入挖掘,所有被掩盖的细节都会原形毕露。Mike Ash 早在 2009 年就做了这么个探究,了解更多点这里。

KVO 的实现:

当你观察一个对象时,一个 新的类 会动态被创建。这个类 继承 自该对象的原本的类,并 重写了被观察属性的 setter 方法。自然,重写的 setter 方法会负责在调用原 setter 方法之前和之后,通知所有观察对象值的更改。最后把这个对象的 isa 指针 ( isa 指针告诉 Runtime 系统这个对象的类是什么 ) 指向这个新创建的 子类 ,对象就神奇的变成了新创建的 子类 的实例。

这个 中间类 ,继承自 原本的那个类 。不仅如此,Apple 还重写了 -class 方法,企图欺骗我们这个类没有变,就是原本那个类。更具体的信息,去跑一下 Mike Ash 的那篇文章里的代码就能明白,这里就不再重复。

1.3 KVO的不足

KVO 很强大,没错。知道它内部实现,或许能帮助更好地使用它,或在它出错时更方便调试。但官方实现的 KVO 提供的 API 实在不怎么样。

比如,你只能通过重写 -observeValueForKeyPath:ofObject:change:context: 方法来获得通知。想要提供自定义的 selector ,不行;想要传一个 block ,门都没有。而且你还要处理父类的情况 - 父类同样监听同一个对象的同一个属性。但有时候,你不知道父类是不是对这个消息有兴趣。虽然 context 这个参数就是干这个的,也可以解决这个问题 - 在 -addObserver:forKeyPath:options:context: 传进去一个父类不知道的 context。但总觉得框在这个 API 的设计下,代码写的很别扭。至少至少,也应该支持 block 吧。

有不少人都觉得官方 KVO 不好使的。Mike Ash 的 Key-Value Observing Done Right ,以及获得不少分享讨论的 KVO Considered Harmful 都把 KVO 拿出来吊打了一番。所以在实际开发中 KVO 使用的情景并不多,更多时候还是用 Delegate 或 NotificationCenter。

2. Block实现KVO

2.1 模拟实现

注意:以下都是同一个文件:NSObject+Block_KVO.m中写的

导入头文件,并定义两个静态变量

#import"NSObject+Block_KVO.h"#import#import//as prefix string of kvo classstaticNSString*constkCMkvoClassPrefix_for_Block =@"CMObserver_";staticNSString*constkCMkvoAssiociateObserver_for_Block =@"CMAssiociateObserver";

暴露给调用者为被观察对象添加KVO方法

- (void)CM_addObserver:(NSObject*)observer forKey:(NSString*)key withBlock:(CM_ObservingHandler)observedHandler{//step 1 get setter method, if not, throw exceptionSEL setterSelector =NSSelectorFromString(setterForGetter(key));    Method setterMethod = class_getInstanceMethod([selfclass], setterSelector);if(!setterMethod) {@throw[NSExceptionexceptionWithName:NSInvalidArgumentExceptionreason: [NSStringstringWithFormat:@"unrecognized selector sent to instance %@",self] userInfo:nil];return;    }//自己的类作为被观察者类Class observedClass = object_getClass(self);NSString* className =NSStringFromClass(observedClass);//如果被监听者没有CMObserver_,那么判断是否需要创建新类if(![className hasPrefix: kCMkvoClassPrefix_for_Block]) {//【代码①】observedClass = [selfcreateKVOClassWithOriginalClassName: className];//【API注解①】object_setClass(self, observedClass);    }//add kvo setter method if its class(or superclass)hasn't implement setterif(![selfhasSelector: setterSelector]) {constchar* types = method_getTypeEncoding(setterMethod);//【代码②】class_addMethod(observedClass, setterSelector, (IMP)KVO_setter, types);    }//add this observation info to saved new observer//【代码③】CM_ObserverInfo_for_Block* newInfo = [[CM_ObserverInfo_for_Blockalloc] initWithObserver: observer forKey: key observeHandler: observedHandler];//【代码④】【API注解③】NSMutableArray* observers = objc_getAssociatedObject(self, (__bridgevoid*)kCMkvoAssiociateObserver_for_Block);if(!observers) {        observers = [NSMutableArrayarray];        objc_setAssociatedObject(self, (__bridgevoid*)kCMkvoAssiociateObserver_for_Block, observers, OBJC_ASSOCIATION_RETAIN_NONATOMIC);    }    [observers addObject: newInfo];}

其中【代码①】的意思是,被观察的类如果是被观察对象本来的类,那么,就要专门依据本来的类新建一个新的 子类 ,区分是否这个子类的标记是带有 kCMkvoClassPrefix_for_Block 的前缀。怎样新建一个 子类 ?代码如下所示:

- (Class)createKVOClassWithOriginalClassName: (NSString*)className{NSString* kvoClassName = [kCMkvoClassPrefix stringByAppendingString: className];    Class observedClass =NSClassFromString(kvoClassName);if(observedClass) {returnobservedClass; }//创建新类,并且添加CMObserver_为类名新前缀Class originalClass = object_getClass(self);//【API注解②】Class kvoClass = objc_allocateClassPair(originalClass, kvoClassName.UTF8String,0);//获取监听对象的class方法实现代码,然后替换新建类的class实现Method classMethod = class_getInstanceMethod(originalClass,@selector(class));constchar* types = method_getTypeEncoding(classMethod);    class_addMethod(kvoClass,@selector(class), (IMP)kvo_Class, types);    objc_registerClassPair(kvoClass);returnkvoClass;}

另外【代码②】的意思是,将原来的setter方法替换一个新的setter方法(这就是runtime的黑魔法,Method Swizzling)。那么新的setter方法又是什么呢?如下所示:

#pragma mark -- Override setter and getter MethodsstaticvoidKVO_setter(idself, SEL _cmd,idnewValue){NSString* setterName =NSStringFromSelector(_cmd);NSString* getterName = getterForSetter(setterName);if(!getterName) {@throw[NSExceptionexceptionWithName:NSInvalidArgumentExceptionreason: [NSStringstringWithFormat:@"unrecognized selector sent to instance %p",self] userInfo:nil];return;    }idoldValue = [selfvalueForKey: getterName];structobjc_super superClass = {        .receiver =self,        .super_class = class_getSuperclass(object_getClass(self))    };        [selfwillChangeValueForKey: getterName];void(*objc_msgSendSuperKVO)(void*, SEL,id) = (void*)objc_msgSendSuper;    objc_msgSendSuperKVO(&superClass, _cmd, newValue);    [selfdidChangeValueForKey: getterName];//获取所有监听回调对象进行回调NSMutableArray* observers = objc_getAssociatedObject(self, (__bridgeconstvoid*)kCMkvoAssiociateObserver_for_Block);for(CM_ObserverInfo_for_Block* infoinobservers) {if([info.key isEqualToString: getterName]) {dispatch_async(dispatch_queue_create(DISPATCH_QUEUE_PRIORITY_DEFAULT,0), ^{                info.handler(self, getterName, oldValue, newValue);            });        }    }}

【代码③】是新建一个观察者类。这个类的实现写在同一个class,相当于导入一个类:CM_ObserverInfo_for_Block。这个类的作用是观察者,并在初始化的时候负责调用者传过来的Block回调。如下, self.handler = handler; 即负责回调。

@interfaceCM_ObserverInfo_for_Block:NSObject@property(nonatomic,weak)NSObject* observer;@property(nonatomic,copy)NSString* key;@property(nonatomic,copy)CM_ObservingHandlerhandler;@end@implementationCM_ObserverInfo_for_Block- (instancetype)initWithObserver: (NSObject*)observer forKey: (NSString*)key observeHandler: (CM_ObservingHandler)handler{if(self= [superinit]) {                _observer = observer;self.key = key;self.handler = handler;    }returnself;}@end

【代码④】的作用是,以及已知的“属性名”,类型为NSString的静态变量 kCMkvoAssiociateObserver_for_Block 来获取这个“属性”观察者数组(这个其实并不是真正意义的属性,属于runtime关联对象的知识范畴,可理解成 观察者数组 这样一个属性)。其中,关于 (__bridge void *) 的知识后面会讲到。

调用者:利用上面的API为被观察者添加KVO

VC调用API

#import"NSObject+Block_KVO.h"//...........- (void)viewDidLoad {    [superviewDidLoad];        ObservedObject * object = [ObservedObject new];    object.observedNum = @8;#pragma mark - Observed By Block[objectCM_addObserver:selfforKey:@"observedNum"withBlock: ^(idobservedObject,NSString*observedKey,idoldValue,idnewValue) {NSLog(@"Value had changed yet with observing Block");NSLog(@"oldValue---%@",oldValue);NSLog(@"newValue---%@",newValue);    }];        object.observedNum = @10;}

2.2 runtime关键API解析

【API注解①】:object_setClass

我们可以在运行时创建新的class,这个特性用得不多,但其实它还是很强大的。你能通过它创建新的子类,并添加新的方法。

但这样的一个子类有什么用呢?别忘了Objective-C的一个关键点:object内部有一个叫做isa的变量指向它的class。这个变量可以被改变,而不需要重新创建。然后就可以添加新的ivar和方法了。可以通过以下命令来修改一个object的class

object_setClass(myObject, [MySubclassclass]);

这可以用在Key Value Observing。当你开始observing an object时,Cocoa会创建这个object的class的subclass,然后将这个object的isa指向新创建的subclass。

【API注解②】:objc_allocateClassPair

objc_allocateClassPair(Class_Nullable superclass,constchar * _Nonnullname,                        size_t extraBytes)

看起来一切都很简单,运行时创建类只需要三步: 1、为"class pair"分配空间(使用 objc_allocateClassPair ). 2、为创建的类添加方法和成员(上例使用 class_addMethod 添加了一个方法)。 3、注册你创建的这个类,使其可用(使用 objc_registerClassPair )。

为什么这里1和3都说到pair,我们知道pair的中文意思是一对,这里也就是一对类,那这一对类是谁呢?他们就是Class、MetaClass。

需要配置的参数为: 1、第一个参数:作为新类的超类,或用Nil来创建一个新的根类。

2、第二个参数:新类的名称

3、第三个参数:一般传0

【API注解③】:(__bridge void *)

在 ARC 有效时,通过 (__bridge void *) 转换 id 和 void * 就能够相互转换。为什么转换?这是因为 objc_getAssociatedObject 的参数要求的。先看一下它的API:

objc_getAssociatedObject(id _Nonnullobject,constvoid* _Nonnull key)

可以知道,这个“属性名”的key是必须是一个 void * 类型的参数。所以需要转换。关于这个转换,下面给一个转换的例子:

idobj = [[NSObjectalloc] init];void*p = (__bridgevoid*)obj;ido = (__bridgeid)p;

关于这个转换可以了解更多: ARC 类型转换:显示转换 id 和 void *

当然,如果不通过转换使用这个API,就需要这样使用:

方式1:

objc_getAssociatedObject(self, @"AddClickedEvent");

方式2:

staticconstvoid*registerNibArrayKey = ®isterNibArrayKey;

NSMutableArray *array= objc_getAssociatedObject(self, registerNibArrayKey);

方式3:

staticconstcharMJErrorKey ='\0';

objc_getAssociatedObject(self,&MJErrorKey);

方式4:

+ (instancetype)cachedPropertyWithProperty:(objc_property_t)property{    MJProperty *propertyObj = objc_getAssociatedObject(self,property);//省略}

其中 objc_property_t 是runtime的类型

typedefstructobjc_property *objc_property_t;

2.3 runtime其它API解析

剩下的就是runtime的比较常见API了,这里就不按照上面代码的顺序的讲解了。这里只做按runtime的知识范畴将这些API做一个分类:

runtime:关联对象相关API

objc_getAssociatedObject(id _Nonnullobject,constvoid* _Nonnull key)objc_setAssociatedObject(id _Nonnullobject,constvoid* _Nonnull key,                        id _Nullablevalue, objc_AssociationPolicy policy)

runtime:方法替换相关API

BOOLclass_addMethod(Class cls, SEL name, IMP imp,constchar*types);object_getClass(id _Nullable obj)Methodclass_getInstanceMethod(Class cls, SEL name);constchar*method_getTypeEncoding(Method m);FOUNDATION_EXPORT SELNSSelectorFromString(NSString *aSelectorName);

runtime:消息机制相关API

objc_msgSendSuper

KVO

-(void)willChangeValueForKey:(NSString*)key;-(void)didChangeValueForKey:(NSString*)key;

3. 拓展:Delegate实现KVO

注意:以下都是同一个文件:NSObject+Block_Delegate.m中写的

观察类CM_ObserverInfo需要改一个属性,将Block改为一个Delegate。

@interfaceCM_ObserverInfo : NSObject@property(nonatomic, weak) NSObject * observer;@property(nonatomic, copy) NSString * key;//修改这里@property(nonatomic, assign) id observerDelegate;@end

同样,观察类CM_ObserverInfo初始化的时候也需要相应初始这个新属性。

@implementationCM_ObserverInfo- (instancetype)initWithObserver: (NSObject*)observer forKey: (NSString*)key{if(self= [superinit]) {                _observer = observer;self.key = key;//修改这里self.observerDelegate = (id)observer;    }returnself;}@end

暴露给调用者为被观察对象添加KVO方法:不需要传Block了。

#pragma mark -- NSObject Category(KVO Reconstruct)@implementationNSObject(Block_KVO)- (void)CM_addObserver:(NSObject*)observer forKey:(NSString*)key withBlock:(CM_ObservingHandler)observedHandler{//...省略//add this observation info to saved new observer//修改这里CM_ObserverInfo* newInfo = [[CM_ObserverInfoalloc] initWithObserver: observer forKey: key];//...省略}

调用者:利用上面的API为被观察者添加KVO

VC调用API

#import"NSObject+Delegate_KVO.h"//...........- (void)viewDidLoad {    [superviewDidLoad];ObservedObject*object= [ObservedObjectnew];object.observedNum= @8;    #pragma mark -ObservedByDelegate[objectCM_addObserver: self forKey: @"observedNum"];object.observedNum= @10;}

VC实现代理方法

#pragma mark - ObserverDelegate-(void)CM_ObserveValueForKeyPath:(NSString*)keyPath ofObject:(id)object oldValue:(id)oldValue newValue:(id)newValue{NSLog(@"Value had changed yet with observing Delegate");NSLog(@"oldValue---%@",oldValue);NSLog(@"newValue---%@",newValue);}

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

推荐阅读更多精彩内容