iOS 底层探索之KVO

KVO是Objective-C中的键值监听策略，本篇能学习到以下知识点
1、KVO的使用方法大全
2、KVO的底层如何实现
3、自定义KVO

KVO的使用方法大全

Part1、KVO三部曲

• 1、监听值的变化

[self.person addObserver:self forKeyPath:@"isImageLoadFinshed" options:(NSKeyValueObservingOptionNew) context:NULL];
[self.person addObserver:self forKeyPath:@"dataArray" options:(NSKeyValueObservingOptionNew) context:NULL];

值得注意的是，在监听数组时比较特殊，在增加或减少数组元素时，以正常的方式addObject或removeObject无法成功监听，因为KVO监听的是指针的变化，对于数组来说，增加或删除元素，数组的指针并没有变化，需要KVC配合，如下所示

[[self.person mutableArrayValueForKey:@"dataArray"] addObject:@"Hello"];

• 2、触发值变化的响应

//object是被监听的对象
- (void)observeValueForKeyPath:(NSString *)keyPath ofObject:(id)object change:(NSDictionary *)change context:(void *)context{
    if ([keyPath isEqualToString:@"isImageLoadFinshed"]) {
        NSLog(@"change = %@", change);
    }
}

• 3、dealloc中移除监听

- (void)dealloc{
    [self.person removeObserver:self forKeyPath:@"isImageLoadFinshed"];    
}

注意：context如果不传值的话就传NULL，不要传nil，因为context值是(void *)类型的，context相当于标签，在同一个类中要监听多个Observer时，需要通过context作区分。

Part2、手动观察和自动观察

• 1、自动观察：需要实现automaticallyNotifiesObserversForKey方法

/**
 自动管理KVO的监听

 @param key 被观察的key
 @return 返回YES时,表示可以监听,返回NO时,则不监听
 */
+ (BOOL)automaticallyNotifiesObserversForKey:(NSString *)key {
    if ([key isEqualToString:@"name"]) {//只观察name属性
        return YES;
    }
    return NO;
}

• 2、手动观察：需要在值发生改变之前和之后分别调用willChangeValueForKey和didChangeValueForKey方法

/**
 手动管理KVO监听
 在对象的setter方法中,实现self的willChange和didChange就可以实现手动监听了
 */
- (void)setName:(NSString *)name {
    [self willChangeValueForKey:@"name"];
    _name = name;
    [self didChangeValueForKey:@"name"];
}

Part3、联动观察

只要监听一个属性值,就可以联动观察其他属性值的变化
需要实现keyPathsForValuesAffectingValueForKey方法，这个方法的含义是，与key对应的联动观察的keyPaths集合，我们只需要将联动的元素添加到keyPaths集合中即可。

/**
 联动观察
 在有些时候,只要观察一个属性值,就可以监听对象中其他属性发生的变化
 比如下载进度downloadProgress = writtenData / totalData,当writtenData和totalData任意一个发生变化,downloadProgress就会一同变化,这种我们只需要监听downloadProgress,没必要再去监听writtenData和totalData了.
 @param key 监听的key
 @return keyPath的集合
 */
+ (NSSet *)keyPathsForValuesAffectingValueForKey:(NSString *)key {
    NSMutableSet *keyPaths = [[NSMutableSet alloc] initWithSet:[super keyPathsForValuesAffectingValueForKey:key]];
    if ([key isEqualToString:@"downloadProgress"]) {
        NSArray *affectKeys = @[@"writtenData", @"totalData"];
        [keyPaths addObjectsFromArray:affectKeys];
    }
    
    return keyPaths;
}

以上就是系统KVO的使用方法，很简单，也容易出错，要谨记在离开页面的同时移除监听(如果不移除监听,在其他类中如果也监听了的话,很可能就会造成多次调用监听)。

KVO的底层是如何实现

我们创建一个Person类，定义一个实例变量name和一个属性nickName，实例变量默认不实现setter方法，属性nickName默认实现了setter和getter方法。如下所示

@interface Person : NSObject{
    @public
    NSString *name;
}
@property (nonatomic, copy) NSString *nickName;

- (void)hello;
- (void)world;

@end

@implementation Person 
- (void)hello {
    NSLog(@"你好");
}
- (void)world {
    NSLog(@"世界");
}

@end

然后在ViewDidLoad里面监听name实例变量和nickName属性变量。

- (void)viewDidLoad {
    [super viewDidLoad];
    self.person = [[Person alloc] init];
    [self.person addObserver:self forKeyPath:@"name" options:NSKeyValueObservingOptionNew context:NULL];
    [self.person addObserver:self forKeyPath:@"nickName" options:NSKeyValueObservingOptionNew context:NULL];
    
    self.person.nickName = @"property";
    self.person->name = @"instance";
}

- (void)touchesBegan:(NSSet *)touches withEvent:(UIEvent *)event{
    NSLog(@"实际情况:%@-%@",self.person.nickName,self.person->name);
    self.person.nickName = @"你好笨鸟";
    self.person->name = @"你好打老虎";
}

#pragma mark - KVO回调
- (void)observeValueForKeyPath:(NSString *)keyPath ofObject:(id)object change:(NSDictionary *)change context:(void *)context{
    NSLog(@"keyPath = %@===change = %@", keyPath, change);
}

我们按照上面代码所写，在点击屏幕之后同时改变nickName和name的值，发现在observeValueForKeyPath中只监听到了nickName的变化，打印如下

image.png

因此得出结论一：KVO观察的是setter方法
通过上面的实例name和属性nickName就可观测出来，实例没有setter方法，属性有setter方法，在同时监听实例和属性时,当他们的值发生改变时,只有属性监听到值的变化。

我们在addObserver处打断点，如下图所示

image.png

在控制台打印如下

(lldb) po self.person

(lldb) po object_getClass(self.person)
NSKVONotifying_Person

addObserver之前person对象的isa指针指向Person类，在addObserver之后，person对象的isa指针指向NSKVONotifying_Person类。

我们再打印一下Person类及其所有子类

[self printClasses:[Person class]];

/**
 获取当前类和它的的所有子类
 objc_getClassList
 该函数的作用是获取已经注册的类，它需要传入两个参数，第一个参数 buffer ：已分配好内存空间的数组，第二个参数 bufferCount ：数组中可存放元素的个数，返回值是注册的类的总数。
 当参数 bufferCount 值小于注册的类的总数时，获取到的是注册类的集合的任意子集
 第一个参数传 NULL 时将会获取到当前注册的所有的类，此时可存放元素的个数为0，因此第二个参数可传0，返回值为当前注册的所有类的总数。
 */
- (void)printClasses:(Class)cls{

    int cnt = 0;
    cnt = objc_getClassList(NULL, 0);
    NSMutableArray *mArray = [NSMutableArray arrayWithObject:cls];
    
    Class *classes = (Class *)malloc(sizeof(Class)*cnt);
    objc_getClassList(classes, cnt);
    
    for (int i = 0; i < cnt; i++) {
        if (cls == class_getSuperclass(classes[i])) {
            [mArray addObject:classes[i]];
        }
    }
    
    free(classes);
    
    NSLog(@"classes = %@", mArray);
}

打印结果如下

classes = (
    Person,
    "NSKVONotifying_Person"
)

于是我们得到了结论二：设置KVO监听时，会动态生成一个NSKVONotifying_XXX类，这个类是XXX的子类

我们继续打印Person类和NSKVONotifying_Person的所有方法

/*从打印可看出,
   1.setNickName的imp地址发生了变化(类被重写)
   2.增加了三个方法分别是,class,dealloc,_isKVOA
*/
[self printClassAllMethod:[Person class]];
NSLog(@"*******************************");
[self printClassAllMethod:NSClassFromString(@"NSKVONotifying_Person")];

- (void)printClassAllMethod:(Class)cls{
    unsigned int count = 0;
    Method *methodList = class_copyMethodList(cls, &count);
    for (int i = 0; i

打印结果如下

image.png

我们发现，Person类的setNickName方法的imp地址和NSKVONotifying_Person类的setNickName方法的imp地址发生了改变；而且我们还看到了NSKVONotifying_Person类多了三个方法class、dealloc、_isKVOA。
于是我们得出结论三：NSKVONotifying_Person类重写了响应属性的setter方法，且增加了三个方法class,dealloc和_isKVOA(这个方法表示这是KVO的类)

针对上述的三个结论，提出几个问题

• 1、系统为什么要动态NSNotifying_XXX类来实现KVO？
  答：因为要减少对原有类的影响。
• 2、重写setter方法都做了哪些操作？
  答：一个是监听新值和旧值的变化，一个是将消息发送给父类Person的setter方法更新属性的值。
• 3、添加class方法的目的是什么？
  答：苹果本意是要隐藏NSNotifying_XXX类，所以要添加class方法返回的是父类Person。
• 4、添加dealloc方法的目的是什么？
  答：为了使NSNotifying_XXX类创建的内容能够及时释放。

总结

综合我们得到的三个结论，不难发现KVO实现监听值变化的本质是

• 1、动态创建了NSKVONotifying_XXX类，这个类是被监听类XXX的子类
• 2、在NSKVONotifying_XXX类中重写了属性的setter方法，手动监听了值的变化
• 3、动态增加了三个方法class、dealloc、_isKVOA。