iOS KVO原理

1. KVO是什么

kvo全称Key-Value Observing,键值监听。
是对观察者模式的一种实现。对一个对象添加Observer后,如果这个对象发生了改变,我们就会收到对象改变的通知。

2. 使用方法

先创建一个Objc类,作为要监听的对象。

#import 

NS_ASSUME_NONNULL_BEGIN

@interface Objc : NSObject

@property (nonatomic, strong) NSString *test;

@end

NS_ASSUME_NONNULL_END

监听的实现

#import "ViewController.h"
#import "Objc.h"

@interface ViewController ()

@property (nonatomic, strong) Objc *objc;

@end

@implementation ViewController

- (void)viewDidLoad {
    [super viewDidLoad];
    NSKeyValueObservingOptions options = NSKeyValueObservingOptionNew | NSKeyValueObservingOptionOld | NSKeyValueObservingOptionInitial | NSKeyValueObservingOptionPrior;
    [self.objc addObserver:self forKeyPath:@"test" options:options context:@"context"];
    self.objc.test = @"123";
}

- (Objc *)objc {
    if (!_objc) {
        _objc = [Objc new];
    }
    return _objc;
}

- (void)observeValueForKeyPath:(NSString *)keyPath ofObject:(id)object change:(NSDictionary *)change context:(void *)context {
    NSLog(@"keyPath:%@",keyPath);
    NSLog(@"object:%@",object);
    NSLog(@"change:%@",change);
    NSLog(@"context:%@",context);
}

- (void)dealloc {
    [self.objc removeObserver:self forKeyPath:@"test"];
}
@end

打印结果

2020-08-11 23:04:27.199075+0800 KVODemo[2091:33456] keyPath:test
2020-08-11 23:04:27.199151+0800 KVODemo[2091:33456] object:
2020-08-11 23:04:27.199267+0800 KVODemo[2091:33456] change:{
    kind = 1;
    new = "";
}
2020-08-11 23:04:27.199332+0800 KVODemo[2091:33456] context:context
2020-08-11 23:04:27.199542+0800 KVODemo[2091:33456] keyPath:test
2020-08-11 23:04:27.199640+0800 KVODemo[2091:33456] object:
2020-08-11 23:04:27.199754+0800 KVODemo[2091:33456] change:{
    kind = 1;
    notificationIsPrior = 1;
    old = "";
}
2020-08-11 23:04:27.199824+0800 KVODemo[2091:33456] context:context
2020-08-11 23:04:27.199883+0800 KVODemo[2091:33456] keyPath:test
2020-08-11 23:04:27.199951+0800 KVODemo[2091:33456] object:
2020-08-11 23:04:27.200016+0800 KVODemo[2091:33456] change:{
    kind = 1;
    new = 123;
    old = "";
}
2020-08-11 23:04:27.200076+0800 KVODemo[2091:33456] context:context

3. KVO原理

1. NSKVONotifying_

我们在objc对象添加监听之前分别打印objc的对象类型

- (void)viewDidLoad {
    [super viewDidLoad];
    NSLog(@"监听前objc类型object_getClass:%@",object_getClass(self.objc));
    NSLog(@"监听前objc类型class:%@",self.objc.class);
    NSKeyValueObservingOptions options = NSKeyValueObservingOptionNew | NSKeyValueObservingOptionOld | NSKeyValueObservingOptionInitial | NSKeyValueObservingOptionPrior;
    [self.objc addObserver:self forKeyPath:@"test" options:options context:@"context"];
    NSLog(@"监听后objc类型object_getClass:%@",object_getClass(self.objc));
    NSLog(@"监听后objc类型class:%@",self.objc.class);
}

打印结果

2020-08-12 22:45:15.591256+0800 KVODemo[2492:43228] 监听前objc类型object_getClass:Objc
2020-08-12 22:45:15.591338+0800 KVODemo[2492:43228] 监听前objc类型class:Objc
2020-08-12 22:45:15.591515+0800 KVODemo[2492:43228] 监听后objc类型object_getClass:NSKVONotifying_Objc
2020-08-12 22:45:15.591588+0800 KVODemo[2492:43228] 监听后objc类型class:Objc

我们看到,objc添加监听后,使用object_getClass方法获取objc类型时获取到的是NSKVONotifying_Objc。
这里就产生了几个问题:

  1. 为什么添加监听后使用object_getClass获取到的对象类型是NSKVONotifying_Objc?
    我们获取添加监听后的objc对象的类对象的父类

    - (void)viewDidLoad {
        [super viewDidLoad];
        NSKeyValueObservingOptions options = NSKeyValueObservingOptionNew | NSKeyValueObservingOptionOld | NSKeyValueObservingOptionInitial | NSKeyValueObservingOptionPrior;
        [self.objc addObserver:self forKeyPath:@"test" options:options context:@"context"];
        Class class = object_getClass(self.objc);
        Class superClass = class_getSuperclass(class);
        NSLog(@"添加监听后objc的类对象:%@",class);
        NSLog(@"%@的父类对象%@",class,superClass);
    }
    

    打印结果

    2020-08-12 23:41:51.984192+0800 KVODemo[16522:112127] 添加监听后objc的类对象:NSKVONotifying_Objc
    2020-08-12 23:41:51.984262+0800 KVODemo[16522:112127] NSKVONotifying_Objc的父类对象Objc
    

    从打印结果可以看出,NSKVONotifying_Objc是Objc的子类,说明我们添加了监听之后动态创建了一个Objc的子类NSKVONotifying_Objc,并将对象objc的类型更改为了NSKVONotifying_Objc。

  2. 为什么添加监听收使用class方法和object_getClass方法获取到的类型不一样?
    我们查看class和object_getClass的源码

    此源码在runtim源码的Object.mm中
    -(id)class {
      return (id)isa; 
    }
    
    + (id)class {
      return self;
    }
    
    此源码在runtim源码的objc-class.mm中
    Class object_getClass(id obj) {
      if (obj) return obj->getIsa();
      else return Nil;
    }
    

    我们从源码看出,实例对象调用class方法会返回isa指针,类对象调用class方法会返回自己,通过object_getClass方法获取对象的类型也会返回isa指针。从源码上看objc对象添加监听之后使用class和使用object_getClass方法获取到的类型应该是一样的,但是这里却不同,我们猜测在添加了监听之后在NSKVONotifying_Objc中重写了class方法。
    我们打印一下添加监听前后class方法的IMP地址来确认是否重写了class方法

    - (void)viewDidLoad {
        [super viewDidLoad];
        Class class1 = object_getClass(self.objc);
        NSLog(@"监听前objc类型object_getClass:%@",object_getClass(class1));
        NSLog(@"监听前objc的class实现地址:%p",method_getImplementation(class_getInstanceMethod(class1, @selector(class))));
        NSKeyValueObservingOptions options = NSKeyValueObservingOptionNew | NSKeyValueObservingOptionOld | NSKeyValueObservingOptionInitial | NSKeyValueObservingOptionPrior;
        [self.objc addObserver:self forKeyPath:@"test" options:options context:@"context"];
        Class class2 = object_getClass(self.objc);
        NSLog(@"监听前objc类型object_getClass:%@",object_getClass(class2));
        NSLog(@"监听前objc的class实现地址:%p",method_getImplementation(class_getInstanceMethod(class2, @selector(class))));
    }
    

    打印结果

    2020-08-13 22:47:08.351079+0800 KVODemo[2177:36963] 监听前objc类型object_getClass:Objc
    2020-08-13 22:47:08.351165+0800 KVODemo[2177:36963] 监听前objc的class实现地址:0x7fff51410632
    2020-08-13 22:47:08.351366+0800 KVODemo[2177:36963] 监听前objc类型object_getClass:NSKVONotifying_Objc
    2020-08-13 22:47:08.351438+0800 KVODemo[2177:36963] 监听前objc的class实现地址:0x7fff2572073d
    

    从打印结果可以看出,添加监听之后class方法的地址改变了,这验证了我们之前的猜想,NSKVONotifying_Objc类中重写了class方法。

我们监听对象时调用了set方法,我们对监听前后的set方法单独分析。
我们再添加监听前后分别打印setTest方法的IMP地址

- (void)viewDidLoad {
    [super viewDidLoad];
    Class class1 = object_getClass(self.objc);
    NSLog(@"监听前objc类型object_getClass:%@",object_getClass(class1));
    IMP imp1 = method_getImplementation(class_getInstanceMethod(class1, @selector(setTest:)));
    NSLog(@"监听前objc的class实现地址:%p",imp1);
    NSKeyValueObservingOptions options = NSKeyValueObservingOptionNew | NSKeyValueObservingOptionOld | NSKeyValueObservingOptionInitial | NSKeyValueObservingOptionPrior;
    [self.objc addObserver:self forKeyPath:@"test" options:options context:@"context"];
    Class class2 = object_getClass(self.objc);
    NSLog(@"监听后objc类型object_getClass:%@",object_getClass(class2));
    IMP imp2 = method_getImplementation(class_getInstanceMethod(class2, @selector(setTest:)));
    NSLog(@"监听后objc的class实现地址:%p",imp2);
    NSLog(@"");
}

打印结果

2020-08-13 23:47:21.212568+0800 KVODemo[4074:75514] 监听前objc类型object_getClass:Objc
2020-08-13 23:47:21.212654+0800 KVODemo[4074:75514] 监听前objc的class实现地址:0x10cd2f920
2020-08-13 23:47:21.212833+0800 KVODemo[4074:75514] 监听前objc类型object_getClass:NSKVONotifying_Objc
2020-08-13 23:47:21.212917+0800 KVODemo[4074:75514] 监听前objc的class实现地址:0x7fff25721c7a

通过打印结果可以看出setTest方法也在NSKVONotifying_Objc中被重写了,我们再使用lldb来看下setTest具体是什么

(lldb) print (IMP)0x10cd2f920
(IMP) $0 = 0x000000010cd2f920 (KVODemo`-[Objc setTest:] at Objc.h:15)
(lldb) print (IMP)0x7fff25721c7a
(IMP) $1 = 0x00007fff25721c7a (Foundation`_NSSetObjectValueAndNotify)

第一个地址打印的是添加监听前setTest方法的IMP地址,第二个打印的是添加监听后setTest方法的IMP地址。
这里看出添加监听前setTest对应的具体方法就是setTest,但是添加监听后,setTest对应的鸡头方法却变成了_NSSetObjectValueAndNotify函数。
下面我们就来研究一下_NSSetObjectValueAndNotify函数

2. _NSSetObjectValueAndNotify

我们来研究一下_NSSetObjectValueAndNotify是什么
我们使用下面的命令来获取Foundation的私有函数有哪些。
使用这个函数要注意,有的终端有最大显示行数的限制,这个命令的打印结果有三万多行,所以要关闭最大行数限制,否则我们需要找的函数会显示不出来。

nm -a /System/Library/Frameworks/Foundation.framework/Versions/Current/Foundation

打印结果,这里只选择了与KVO相关的函数

__NSSetBoolValueAndNotify
__NSSetCharValueAndNotify
__NSSetDoubleValueAndNotify
__NSSetFloatValueAndNotify
__NSSetIntValueAndNotify
__NSSetLongLongValueAndNotify
__NSSetLongValueAndNotify
__NSSetObjectValueAndNotify
__NSSetPointValueAndNotify
__NSSetRangeValueAndNotify
__NSSetRectValueAndNotify
__NSSetShortValueAndNotify
__NSSetSizeValueAndNotify
__NSSetUnsignedCharValueAndNotify
__NSSetUnsignedIntValueAndNotify
__NSSetUnsignedLongLongValueAndNotify
__NSSetUnsignedLongValueAndNotify
__NSSetUnsignedShortValueAndNotify

从上面与KVO相关的方法中我们可以看出,每一种数据类型都对应了一个setXXXValueAndNotify函数。
不过这些函数的具体实现没有公布,所以内部构造这里还是不清楚。
但是我们知道,在调用setXXXValueAndNotify函数的过程中会调用另外两个方法。

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

测试后得出了以下几个结论:

  1. 如果在创建监听的时候只使用了NSKeyValueObservingOptionNew和NSKeyValueObservingOptionOld这两个枚举值,那么observeValueForKeyPath方法会在didChangeValueForKey方法调用后被调用。
  2. 如果在创建监听的时候使用了NSKeyValueObservingOptionPrior枚举值,那么observeValueForKeyPath方法会在willChangeValueForKey方法调用后被调用第一次,在didChangeValueForKey方法调用后被调用第二次。
  3. 如果在创建监听的时候使用了NSKeyValueObservingOptionInitial枚举值,那么在observeValueForKeyPath方法会在willChangeValueForKey方法调用之前被调用一次。

我们还可以利用这两个方法手动触发observeValueForKeyPath方法

  1. 当使用了NSKeyValueObservingOptionInitial枚举值时,创建监听时就会调用一次observeValueForKeyPath方法,不需要其他条件触发。
  2. 当使用NSKeyValueObservingOptionPrior枚举值时,手动调用willChangeValueForKey时可以触发一次observeValueForKeyPath方法的调用。
  3. 如果想在didChangeValueForKey方法调用后再调用一次observeValueForKeyPath方法,需要同时实现willChangeValueForKey和didChangeValueForKey两个方法才行。

所以我们判断在_NSSetObjectValueAndNotify函数内部,在调用原来的set方法之前插入了willChangeValueForKey方法,在调用原来的set方法之后插入了didChangeValueForKey方法,并根据初始化时的枚举值决定调用observeValueForKeyPath的时机。

4. 总结

  1. 添加监听时,会动态创建一个监听对象类型的子类,并将监听对象的isa指针指向新的子类。
  2. 子类中重写了class和监听属性的set方法。
  3. 重写class方法是为了不将动态创建的类型暴露出来。
  4. 重写set方法是将set方法的具体实现替换成了与属性类型相关的__NSSetXXXValueAndNotify函数。
  5. 在__NSSetXXXValueAndNotify函数内部在set方法前后分别插入了willChangeValueForKey和didChangeValueForKey这两个方法。
  6. 根据添加监听时的枚举值决定调用observeValueForKeyPath的具体时机。
公众号

欢迎关注公众号,留言讨论

参考文献:
KVO源码浅析
iOS底层原理探索—KVO的本质

你可能感兴趣的:(iOS KVO原理)