KVO实现原理及自己实现KVO

96
CholMay
2016.12.22 13:31* 字数 1630

前言

Key-Value-Observer,它来源于观察者模式, 其基本思想(copy于某度)是一个目标对象管理所有依赖于它的观察者对象,并在它自身的状态改变时主动通知观察者对象。这个主动通知通常是通过调用各观察者对象所提供的接口方法来实现的。观察者模式较完美地将目标对象与观察者对象解耦。

本质

  • KVO 是 Objective-C 对观察者设计模式的一种实现,另外一种是:通知机制(notification)
  • KVO提供一种机制,指定一个被观察对象(例如A类),当对象某个属性(例如A中的字符串name)发生更改时,对象会获得通知,并作出相应处理

在MVC设计架构下的项目,KVO机制很适合实现mode模型和controller之间的通讯。
例如:代码中,在模型类A创建属性数据,在控制器中创建观察者,一旦属性数据发生改变就收到观察者收到通知,通过KVO再在控制器使用回调方法处理实现视图B的更新;(本文中的应用就是这样的例子.)

实现原理

KVO在Apple中的API文档如下:
Automatic key-value observing is implemented using a technique called isa-swizzling… When an observer is registered for an attribute of an object the isa pointer of the observed object is modified, pointing to an intermediate class rather than at the true class …
KVO 的实现依赖于 Objective-C 强大的 Runtime【 ,从以上Apple 的文档可以看出苹果对于KVO机制的实现是一笔带过,而具体的细节没有过多的描述,但是我们可以通过Runtime的所提供的方法去探索关于KVO机制的底层实现原理.

基本的原理:

当观察某对象A时,KVO机制动态创建一个对象A当前类的子类,并为这个新的子类重写了被观察属性keyPath的setter 方法。setter 方法随后负责通知观察对象属性的改变状况。

深入剖析:

Apple 使用了 isa 混写(isa-swizzling)来实现 KVO 。当观察对象A时,KVO机制动态创建一个新的名为: NSKVONotifying_A的新类,该类继承自对象A的本类,且KVO为NSKVONotifying_A重写观察属性的setter 方法,setter 方法会负责在调用原 setter 方法之前和之后,通知所有观察对象属性值的更改情况。

  • NSKVONotifying_A类剖析:在这个过程,被观察对象的 isa 指针从指向原来的A类,被KVO机制修改为指向系统新创建的子类 NSKVONotifying_A类,来实现当前类属性值改变的监听;
    所以当我们从应用层面上看来,完全没有意识到有新的类出现,这是系统“隐瞒”了对KVO的底层实现过程,让我们误以为还是原来的类。但是此时如果我们创建一个新的名为“NSKVONotifying_A”的类(),就会发现系统运行到注册KVO的那段代码时程序就崩溃,因为系统在注册监听的时候动态创建了名为NSKVONotifying_A的中间类,并指向这个中间类了。
    因而在该对象上对 setter 的调用就会调用已重写的 setter,从而激活键值通知机制。

  • 子类setter方法剖析:KVO的键值观察通知依赖于 NSObject 的两个方法:willChangeValueForKey:和 didChangevlueForKey:,在存取数值的前后分别调用2个方法:
    被观察属性发生改变之前,willChangeValueForKey:被调用,通知系统该 keyPath 的属性值即将变更;当改变发生后, didChangeValueForKey: 被调用,通知系统该 keyPath 的属性值已经变更;
    之后observeValueForKey:ofObject:change:context: 也会被调用。且重写观察属性的setter 方法这种继承方式的注入是在运行时而不是编译时实现的。
    KVO为子类的观察者属性重写调用存取方法的工作原理在代码中相当于:

-(void)setName:(NSString *)newName
{
    [self willChangeValueForKey:@"name"];    //KVO在调用存取方法之前总调用
    [super setValue:newName forKey:@"name"]; //调用父类的存取方法
    [self didChangeValueForKey:@"name"];     //KVO在调用存取方法之后总调用
}

示例验证

//Person类
@interface Person : NSObject
@property (nonatomic,copy) NSString *name;
@end

//controller
Person *per = [[Person alloc]init];
//断点1
[per addObserver:self forKeyPath:@"name" options:NSKeyValueObservingOptionNew context:nil];
//断点2
per.name = @"小明";
[per removeObserver:self forKeyPath:@"name"];
//断点3

运行项目,

  • 断点1位置:

    可以看到isa指向Person类,我们也可以使用lldb命令查看:
(lldb) po [per class]
Person
(lldb) po object_getClass(per)
Person
(lldb) 
  • 断点2位置:
(lldb) po [per class]
Person
(lldb) po object_getClass(per)
NSKVONotifying_Person
(lldb) 
  • 断点3位置:
(lldb) po [per class]
Person
(lldb) po object_getClass(per)
Person
(lldb)

上面的结果说明,在per对象被观察时,framework使用runtime动态创建了一个Person类的子类NSKVONotifying_Person,而且为了隐藏这个行为,NSKVONotifying_Person重写了- class方法返回之前的类,就好像什么也没发生过一样。但是使用object_getClass()时就暴露了,因为这个方法返回的是这个对象的isa指针,这个指针指向的一定是个这个对象的类对象
然后来偷窥一下这个动态类实现的方法,这里请出一个NSObject的扩展NSObject+DLIntrospection,它封装了打印一个类的方法、属性、协议等常用调试方法,一目了然。

@interface NSObject (DLIntrospection) 
+ (NSArray *)classes; 
+ (NSArray *)properties; 
+ (NSArray *)instanceVariables; 
+ (NSArray *)classMethods; 
+ (NSArray *)instanceMethods; 
 
+ (NSArray *)protocols; 
+ (NSDictionary *)descriptionForProtocol:(Protocol *)proto; 
 
+ (NSString *)parentClassHierarchy; 
@end

然后继续在刚才的断点处调试:

// 断点1 
(lldb) po [object_getClass(per) instanceMethods] 
<__NSArrayI 0x8e9aa00>( 
- (void)setName:(id)arg0 , 
- (void).cxx_destruct, 
- (id)name 
) 
// 断点 2 
(lldb) po [object_getClass(per) instanceMethods] 
<__NSArrayI 0x8d55870>( 
- (void)setName:(id)arg0 , 
- (class)class, 
- (void)dealloc, 
- (BOOL)_isKVOA 
) 
// 断点 3 
(lldb) po [object_getClass(per) instanceMethods] 
<__NSArrayI 0x8e9cff0>( 
- (void)setName:(id)arg0 , 
- (void).cxx_destruct, 
- (id)name 
) 

大概就是说arc下这个方法在所有dealloc调用完成后负责释放所有的变量,当然这个和KVO没啥关系了,回到正题。
从上面断点2的打印可以看出,动态类重写了4个方法:

  • - setName:最主要的重写方法,set值时调用通知函数
  • - class隐藏自己必备啊,返回原来类的class
  • - dealloc做清理犯罪现场工作
  • - _isKVOA这就是内部使用的标示了,判断这个类有没被KVO动态生成子类

接下来验证一下KVO重写set方法后是否调用了- willChangeValueForKey:和- didChangeValueForKey:
最直接的验证方法就是在Person类中重写这两个方法:

@implementation Person 
- (void)willChangeValueForKey:(NSString *)key { 
    NSLog(@"%@", NSStringFromSelector(_cmd)); 
    [super willChangeValueForKey:key]; 
} 
- (void)didChangeValueForKey:(NSString *)key { 
    NSLog(@"%@", NSStringFromSelector(_cmd)); 
    [super didChangeValueForKey:key]; 
} 
@end 

自己代码实现KVO

由于系统是自动实现的派生类NSKVONotifying_Person, 这儿我们自己手动创建一个派生类ALINKVONotifying_Person, 集成自Person. 同时给NSObject创建一个分类, 让每一个对象都拥有我们自定义的KVO特性.

//NSObject+KVO.h
#import <Foundation/Foundation.h>
@interface NSObject (KVO)
- (void)czc_addObserver:(NSObject *)observer forKeyPath:(NSString *)keyPath options:(NSKeyValueObservingOptions)options context:(nullable void *)context;
@end

//NSObject+KVO.m
#import "NSObject+KVO.h"
#import "ALINKVONotifying_Person.h"
#import <objc/message.h>
NSString *const ObserverKey = @"ObserverKey";

@implementation NSObject (KVO)
- (void)czc_addObserver:(NSObject *)observer forKeyPath:(NSString *)keyPath options:(NSKeyValueObservingOptions)options context:(void *)context{
    
    // 把观察者保存到当前对象
    objc_setAssociatedObject(self, (__bridge const void *)(ObserverKey), observer, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
    // 修改对象isa指针
    object_setClass(self, [ALINKVONotifying_Person class]);
}
@end

//ALINKVONotifying_Person.m
#import "ALINKVONotifying_Person.h"
#import <objc/runtime.h>
extern NSString *const ObserverKey;
@implementation ALINKVONotifying_Person
- (void)setName:(NSString *)name{
    NSString *oldName = self.name;
     [super setName:name];
    // 获取观察者
    id obsetver = objc_getAssociatedObject(self, ObserverKey);
    NSDictionary<NSKeyValueChangeKey,id> *changeDict = oldName ? @{NSKeyValueChangeNewKey : name, NSKeyValueChangeOldKey : oldName} : @{NSKeyValueChangeNewKey : name};
    [obsetver observeValueForKeyPath:@"name" ofObject:self change:changeDict context:nil];
}
@end

此时我们调用自己定义的监听方法, 效果和系统的也是一样的

[per czc_addObserver:self forKeyPath:@"name" options:NSKeyValueObservingOptionNew context:nil];
发布笔记
Web note ad 1