探究KVO底层原理

 本文将会分成三部分,一是简述KVO的底层原理,二是详解系统的KVO,三是自己手动实现KVO,我们通过断点调试、NSLog输出等辅助手段提供的信息来证实结论的正确。

KVO的底层原理

 先用几句话说一下KVO的底层原理,以下的原理是根据网上各位大神的博客和自己手动实现KVO时的总结。

  • 若有A是XXX类的实例对象,A对象添加过监听者之后(addObserver),A对象的isa指针指向将被修改,由之前的指向XXX类对象变为指向NSKVONotifying_XXX类对象。

  • NSKVONotifying_XXXXXX的子类,其superclass指针是指向XXX类对象的,NSKVONotifying_XXX是runtime在运行时生成的。

  • 经过KVO监听之后,NSKVONotifying_XXX类内部修改了XXX类中的两个方法:赋值方法和class方法。

    1. 赋值方法:
      A的赋值方法实现(IMP)的地址发生了变化,A的赋值方法的实现(IMP)转换为Foundation框架的NSSetObjectValueAndNotify等系列函数。
    2. class方法:
      修改class方法,使class的返回值由NSKVONotifying_XXX变为XXX,以此来混淆当前对象isa已被修改指向的事实。
    - (Class) class {
         // 得到类对象,再找到类对象父类
         return class_getSuperclass(object_getClass(self));
    }
    
  • 经过KVO监听之后,修改属性赋值方法的执行顺序:

    1. 首先调用willChangeValueForKey
    2. 调用父类的赋值方法为属性赋值
    3. 最后调用didChangeValueForKey
    4. didChangeValueForKey中会调用监听器的监听方法,即observeValueForKeyPath:ofObject:change:context:

以上就是KVO大致的底层原理,只看文字难免会难以理解,接下来开始上代码,用代码来佐证以上原理的正确


详解系统KVO

 和我上一篇博客一样,这次举例仍然用清新简洁的TestObject。我们先定义一个TestObject类。以下是TestObject的 .h 和 .m 文件代码。

//
//  TestObject.h
//  KVO
//
//  Created by 崇 on 2018/9/10.
//  Copyright © 2018年 崇. All rights reserved.
//

#import <Foundation/Foundation.h>

@interface TestObject : NSObject

@property (nonatomic, copy) NSString *name;

@end

//
//  TestObject.m
//  KVO
//
//  Created by 崇 on 2018/9/10.
//  Copyright © 2018年 崇. All rights reserved.
//

#import "TestObject.h"

@implementation TestObject

- (void)setName:(NSString *)name {
    _name = name;
    NSLog(@"执行原赋值方法");
}

- (void)willChangeValueForKey:(NSString *)key {
    NSLog(@"willChangeValueForKey==Begin");
    [super willChangeValueForKey:key];
    NSLog(@"willChangeValueForKey==End");
}

- (void)didChangeValueForKey:(NSString *)key {
    NSLog(@"didChangeValueForKey==Begin");
    [super didChangeValueForKey:key];
    NSLog(@"didChangeValueForKey==End");
}



定义完TestObject后,我们在ViewController.m中给TestObjectname属性添加监听。

- (void)viewDidLoad {
    [super viewDidLoad];

    [self testSystemKVO];
}

- (void)testSystemKVO {
    TestObject *obj = [TestObject new];
    [self checkIMP:obj];
    
    [obj addObserver:self forKeyPath:@"name" options:NSKeyValueObservingOptionOld | NSKeyValueObservingOptionNew context:nil];
    
    obj.name = @"Tom";
    [self checkIMP:obj];
}

上面代码中的checkIMP:方法用来跟踪对象obj赋值方法实现(IMP)。首先我们在checkIMP:方法中打断点,并在checkIMP:方法中输出objisa指针指向的类、class方法返回的类 和 添加监听(addObserver:)前后两次的IMP地址。然后在testSystemKVO方法中[obj addObserver:self forKeyPath:@"name"...这一行打断点。

用接下来的代码来验证最开始关于KVO原理的结论。

运行Xcode,程序停在checkIMP:方法中的断点处,输出以下内容:

image.png

此时还没有执行addObserver:,现在的情况是:
  • objisa指向TestObjectclass指向TestObjectimp地址=0x104a06140
  • imp类型:(KVO`-[TestObject setName:]at TestObject.m:23)

跳过断点,程序停在testSystemKVO方法中[obj addObserver:self forKeyPath:@"name"...这一行断点处,单步跳过,程序停在obj.name = @"Tom";这一行。

image.png

在添加过监听者后(addObserver:),根据最开始的结论此时objisa指针已经被修改了指向,objisa指针指向了NSKVONotifying_TestObject。下图提供证明。
image.png

接下来单步跳过,程序停在testSystemKVO方法中的[self checkIMP:obj];这一行我们来看看添加监听者之后控制台的输出情况:
image.png

image.png
根据控制台的输出,可以证明:

  • objisa指针已经被修改,指向了NSKVONotifying_TestObject
  • obj的确是TestObject的子类,其SuperClass指向TestObject
  • objname属性赋值这一操作,先调用了willChangeValueForKey,然后执行了原赋值方法,最后调用了didChangeValueForKey方法,并且监听方法observeValueForKeyPath:ofObject:change:context:是在didChangeValueForKey方法开始调用后、结束调用前被调用。也就是说系统的observeValueForKeyPath:ofObject:change:context:方法是在didChangeValueForKey方法执行过程中被调用的。


    接下来继续,跳过断点,程序停在checkIMP:方法中的断点。看看控制台:
    image.png
此时已经执行addObserver:,现在的情况是:
  • objisa指向NSKVONotifying_TestObjectclass指向TestObjectimp地址=0x104d48a7a
  • 修改后的imp类型:(Foundation`_NSSetObjectValueAndNotify)

前后对比可以发现:

  • 赋值方法在添加监听之前imp地址0x104a06140、类型:(KVO'-[TestObject setName:]at TestObject.m:23),添加监听之后imp地址0x104d48a7a,类型:(Foundation'_NSSetObjectValueAndNotify)因此证明添加监听后obj的赋值方法被修改为NSSetObjectValueAndNotify等系列函数
  • class方法在添加监听之前返回TestObject,添加监听之后也返回TestObject,在控制台输出中我们可以看到objisa指针已经被修改,此时class应该返回NSKVONotifying_TestObject因此证明obj的class方法被修改
至此,已经证明最开始的结论是正确的,这就是系统KVO的底层原理


自己手动实现KVO

下面是我自己实现KVO的大致思路:

  • KVO的addObserverobserveValueForKeyPath:ofObject:change:context:等方法都是NSObject的各种类目NSKeyValueObserving.h中的方法,为了方便,我在TestObject中定义了一个代理协议
@protocol TestKVOProtocol<NSObject>

- (void)testObserveValueForKeyPath:(NSString *)keyPath change:(NSDictionary *)change;

@end
  • TestObject的内部延展中定义了一个属性observer用来接受观察者
@interface TestObject()

@property (nonatomic, strong) id<TestKVOProtocol> observer;

@end
  • 定义了一个testAddObserver:(id)observer forKeyPath:(NSString *)keyPath方法,用来模仿系统的addObserver
- (void)testAddObserver:(id)observer forKeyPath:(NSString *)keyPath {
    self.observer = observer;
    
    if ([NSStringFromClass(object_getClass(self)) containsString:@"GCKVONotifiying"]) {
        NSString *selName = [NSString stringWithFormat:@"set%@:",uppercaseFirstLetter(keyPath)];
        class_addMethod(object_getClass(self), NSSelectorFromString(selName), (IMP)GCSetObjectValueAndNotify, "v@:@");
    }
    else {
        NSString *kvoClsName = [NSString stringWithFormat:@"GCKVONotifiying_%@",NSStringFromClass(object_getClass(self))];
        NSString *selName = [NSString stringWithFormat:@"set%@:",uppercaseFirstLetter(keyPath)];
        
        Class kvoCls = objc_allocateClassPair(object_getClass(self), [kvoClsName UTF8String], 0);
        class_addMethod(kvoCls, NSSelectorFromString(selName), (IMP)GCSetObjectValueAndNotify, "v@:@");
        class_addMethod(kvoCls, NSSelectorFromString(@"class"), (IMP)GCClass, "#@:@");
        
        objc_registerClassPair(kvoCls);
        object_setClass(self, kvoCls);
    }
}
  • 定义了GCSetObjectValueAndNotify函数,用来模仿系统的(Foundation`_NSSetObjectValueAndNotify)
static void GCSetObjectValueAndNotify(id self, SEL _cmd, id value) {

    NSString *setMethodName = NSStringFromSelector(_cmd);
    NSString *getMethodNameTemp = lowercaseFirstLetter([setMethodName stringByReplacingOccurrencesOfString:@"set" withString:@""]);
    NSString *getMethodName = [getMethodNameTemp stringByReplacingOccurrencesOfString:@":" withString:@""];
    
    // 1.判断新值与旧值是否相同
    id oldValue = objc_getAssociatedObject(self,NSSelectorFromString(getMethodName));
    if ([value isEqual:oldValue]) return;

    Class subCls = object_getClass(self);
    Class supCls = class_getSuperclass(subCls);
    struct objc_super superInfo = {
        self,
        supCls
    };

    // 2.触发testWillChangeValueForKey
    ((void (*) (void * , SEL, ...))objc_msgSendSuper)(&superInfo, NSSelectorFromString(@"testWillChangeValueForKey:"), getMethodName);

    // 3.调用父类赋值方法给属性赋新值
    ((void (*) (void * , SEL, ...))objc_msgSendSuper)(&superInfo, _cmd, value);

    // 4.触发testDidChangeValueForKey
    ((void (*) (void * , SEL, ...))objc_msgSendSuper)(&superInfo, NSSelectorFromString(@"testDidChangeValueForKey:"), getMethodName);

    // 5.保存旧值
    objc_setAssociatedObject(self, NSSelectorFromString(getMethodName), value, OBJC_ASSOCIATION_RETAIN);
}
  • 定义了GCClass函数,用来模仿系统替换class方法的操作
static Class GCClass(id self, SEL _cmd) {
    Class selfClass = object_getClass(self);
    return class_getSuperclass(selfClass);
}
  • 定义了changeValueForKey的两个方法
- (void)testWillChangeValueForKey:(NSString *)key {
    NSLog(@"自定义%s",__func__);
}

- (void)testDidChangeValueForKey:(NSString *)key {
    NSLog(@"自定义%s",__func__);
    if (self.observer && [self.observer respondsToSelector:@selector(testObserveValueForKeyPath:change:)]) {
        NSMutableDictionary *dict = [NSMutableDictionary dictionary];
        
        if (!objc_getAssociatedObject(self, NSSelectorFromString(key))) {
            [dict setObject:@"<null>" forKey:@"old"];
        }
        else {
            [dict setObject:objc_getAssociatedObject(self, NSSelectorFromString(key)) forKey:@"old"];
        }
        [dict setObject:[self valueForKey:key] forKey:@"new"];
        [self.observer testObserveValueForKeyPath:key change:dict];
    }
}

使用时需要遵循协议

@interface ViewController ()<TestKVOProtocol>

@end
- (void)viewDidLoad {
    [super viewDidLoad];
    [self testMyKVO];
}

- (void)testMyKVO {
    TestObject *obj = [TestObject new];
    [self checkIMP:obj];
    
    [obj testAddObserver:self forKeyPath:@"name"];

    obj.name = @"Sam";
    [self checkIMP:obj];
}



使用结果和系统的KVO几乎几乎几乎完全一致。😁
手动实现的源码:https://github.com/ChinaChong/GCKVOTest

都是自己的拙见,如有错误,欢迎指正!

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

推荐阅读更多精彩内容