iOS 自定义KVO

自己实现kvo之前，需要知道iOS系统对kvo的实现。

系统实现kvo的原理

这依赖了OC强大的runtime特性。
在我们对某个Student的实例对象的name属性addObserver时，系统会动态创建一个继承自Student的类（NSKVONotifying_Student），并重写setName:方法。在这里获取新值、旧值、调用父类方法、并发通知给监听者。把对象的isa指针(指向该对象所属的类对象)指向该子类。

同时，系统还重写了class方法，使该方法返回父类名称，以使开发者不会察觉。

我们通过断点调试，验证下：

- (void)viewDidLoad {
    [super viewDidLoad];    
    _s = [[Student alloc] init];
    [_s addObserver:self forKeyPath:@"score" options:NSKeyValueObservingOptionNew | NSKeyValueObservingOptionOld context:nil];
}

在addObserver处打断点。

监听之前isa指向.jpg

可以看到s的isa指针指向Student类。单步执行下：

监听之后isa指向.jpg

isa指针指向了NSKVONotifying_Student类。

自定义kvo

既然所有对象都能使用kvo的方法，那先建个NSObject的category。并添加addObserver方法：

//  NSObject+Extension.h
#import <Foundation/Foundation.h>

@interface NSObject (Extension)
- (void)ws_addObserver:(NSObject *_Nonnull)observer forKeyPath:(NSString *_Nonnull)keyPath options:(NSKeyValueObservingOptions)options context:(nullable void *)context;
@end

就是系统方法加了前缀。
仿照系统的方式进行实现。

  • 动态创建子类
  • 重写被监听属性的set方法
  • 改变对象的isa指针，使其指向子类

接下来 一步步实现：

1.动态创建子类(WSKVONotifying_原类名)

NSString *oldClassName = NSStringFromClass([self class]);
NSString *newClassName = [NSString stringWithFormat:@"WSKVONotifying_%@", oldClassName];
    
Class class = objc_getClass(newClassName.UTF8String);
if (!class) {
    class = objc_allocateClassPair([self class], newClassName.UTF8String, 0);
    objc_registerClassPair(class);
}

2.重写被监听属性的set方法

  • 首先动态添加set方法，参数keypath就是get方法，通过它拼接处set方法（就是首字母大写，加:）。
//set方法首字母大写
NSString *keyPathChange = [[[keyPath substringToIndex:1] uppercaseString] stringByAppendingString:[keyPath substringFromIndex:1]];
NSString *setNameStr = [NSString stringWithFormat:@"set%@", keyPathChange];
SEL setSEL = NSSelectorFromString([setNameStr stringByAppendingString:@":"]);

//添加set方法
Method getMethod = class_getInstanceMethod([self class], @selector(keyPath));
const char *types = method_getTypeEncoding(getMethod);
class_addMethod(class, setSEL, (IMP)setMethod, types);
  • set方法的实现：包括调用父类的set方法，获取旧值、新值，获取observer并通知observer。
void setMethod(id self, SEL _cmd, id newValue) {
//获取get、set方法名
NSString *setNameStr = objc_getAssociatedObject(self, WSKVO_setter);
NSString *getNameStr = objc_getAssociatedObject(self, WSKVO_getter);
    
//保存子类类型
Class class = [self class];
    
//isa指向原类
object_setClass(self, class_getSuperclass(class));
    
//调用原类get方法，获取oldValue
id oldValue = objc_msgSend(self, NSSelectorFromString(getNameStr));
    
//调用原类set方法
objc_msgSend(self, NSSelectorFromString([setNameStr stringByAppendingString:@":"]), newValue);
    
//调用observer的observeValueForKeyPath: ofObject: change: context:方法
id observer = objc_getAssociatedObject(self, WSKVO_observer);
    
NSMutableDictionary *change = @{}.mutableCopy;
if (newValue) {
    change[NSKeyValueChangeNewKey] = newValue;
}
if (oldValue) {
    change[NSKeyValueChangeOldKey] = oldValue;
}
    
objc_msgSend(observer, @selector(observeValueForKeyPath: ofObject: change: context:), getNameStr, self, change, nil);
    
//isa改回子类类型
object_setClass(self, class);
}

3.改变isa指针的指向

object_setClass(self, class);

上面是分段写的，接下来附上完整的.m实现：

#import "NSObject+Extension.h"
#import <objc/message.h>

static const char *WSKVO_observer = "WSKVO_observer";
static const char *WSKVO_getter = "WSKVO_getter";
static const char *WSKVO_setter = "WSKVO_setter";

@implementation NSObject (Extension)

- (void)ws_addObserver:(NSObject *_Nonnull)observer forKeyPath:(NSString *_Nonnull)keyPath options:(NSKeyValueObservingOptions)options context:(nullable void *)context {
    //创建、注册子类
    NSString *oldClassName = NSStringFromClass([self class]);
    NSString *newClassName = [NSString stringWithFormat:@"WSKVONotifying_%@", oldClassName];
    
    Class class = objc_getClass(newClassName.UTF8String);
    if (!class) {
        class = objc_allocateClassPair([self class], newClassName.UTF8String, 0);
        objc_registerClassPair(class);
    }
    
    //set方法首字母大写
    NSString *keyPathChange = [[[keyPath substringToIndex:1] uppercaseString] stringByAppendingString:[keyPath substringFromIndex:1]];
    NSString *setNameStr = [NSString stringWithFormat:@"set%@", keyPathChange];
    SEL setSEL = NSSelectorFromString([setNameStr stringByAppendingString:@":"]);
    
    //添加set方法
    Method getMethod = class_getInstanceMethod([self class], @selector(keyPath));
    const char *types = method_getTypeEncoding(getMethod);
    class_addMethod(class, setSEL, (IMP)setMethod, types);
    
    //改变isa指针，指向子类
    object_setClass(self, class);
    
    //保存observer
    objc_setAssociatedObject(self, WSKVO_observer, observer, OBJC_ASSOCIATION_ASSIGN);
    
    //保存set、get方法名
    objc_setAssociatedObject(self, WSKVO_setter, setNameStr, OBJC_ASSOCIATION_COPY_NONATOMIC);
    objc_setAssociatedObject(self, WSKVO_getter, keyPath, OBJC_ASSOCIATION_COPY_NONATOMIC);
}

void setMethod(id self, SEL _cmd, id newValue) {
    //获取get、set方法名
    NSString *setNameStr = objc_getAssociatedObject(self, WSKVO_setter);
    NSString *getNameStr = objc_getAssociatedObject(self, WSKVO_getter);
    
    //保存子类类型
    Class class = [self class];
    
    //isa指向原类
    object_setClass(self, class_getSuperclass(class));
    
    //调用原类get方法，获取oldValue
    id oldValue = objc_msgSend(self, NSSelectorFromString(getNameStr));
    
    //调用原类set方法
    objc_msgSend(self, NSSelectorFromString([setNameStr stringByAppendingString:@":"]), newValue);
    
    //调用observer的observeValueForKeyPath: ofObject: change: context:方法
    id observer = objc_getAssociatedObject(self, WSKVO_observer);
    
    NSMutableDictionary *change = @{}.mutableCopy;
    if (newValue) {
        change[NSKeyValueChangeNewKey] = newValue;
    }
    if (oldValue) {
        change[NSKeyValueChangeOldKey] = oldValue;
    }
    
    objc_msgSend(observer, @selector(observeValueForKeyPath: ofObject: change: context:), getNameStr, self, change, nil);
    
    //isa改回子类类型
    object_setClass(self, class);
}

@end

测试下

测试代码如下：可以正常实现监听

- (void)viewDidLoad {
    [super viewDidLoad];
    self.view.backgroundColor = [UIColor purpleColor];
    
    _s = [[Student alloc] init];
    
    //使用自定义方法实现kvo监听
    [_s ws_addObserver:self forKeyPath:@"score" options:NSKeyValueObservingOptionNew | NSKeyValueObservingOptionOld context:nil];
}

- (void)observeValueForKeyPath:(NSString *)keyPath ofObject:(id)object change:(NSDictionary<NSKeyValueChangeKey,id> *)change context:(void *)context {
    NSLog(@"old=%@ new=%@", change[NSKeyValueChangeOldKey], change[NSKeyValueChangeNewKey]);
}

- (void)touchesBegan:(NSSet<UITouch *> *)touches withEvent:(UIEvent *)event {
    static NSInteger num = 0;
    _s.score = @(num++);
}

Demo地址

update 2017.10.26

为kvo添加block回调

大部分代码没有变，只是添加了block回调。

//  NSObject+WSKVO.h
#import <Foundation/Foundation.h>

typedef void(^WSKVOBlock)(NSDictionary * _Nonnull change);

@interface NSObject (WSKVO)

- (void)ws_observerkeyPath:(NSString *_Nonnull)keyPath options:(NSKeyValueObservingOptions)options block:(WSKVOBlock _Nonnull )block;

@end

在方法实现中，使用关联对象保存block，在动态添加的setter方法中取出并执行block。

NSObject+WSKVO.m
#import "NSObject+WSKVO.h"
#import <objc/message.h>

static const char *WSKVO_getter = "WSKVO_getter";
static const char *WSKVO_setter = "WSKVO_setter";
static const char *WSKVO_block = "WSKVO_block";

@implementation NSObject (WSKVO)

- (void)ws_observerkeyPath:(NSString *_Nonnull)keyPath options:(NSKeyValueObservingOptions)options block:(WSKVOBlock _Nonnull )block {
    //创建、注册子类
    NSString *oldClassName = NSStringFromClass([self class]);
    NSString *newClassName = [NSString stringWithFormat:@"WSKVONotifying_%@", oldClassName];
    
    Class class = objc_getClass(newClassName.UTF8String);
    if (!class) {
        class = objc_allocateClassPair([self class], newClassName.UTF8String, 0);
        objc_registerClassPair(class);
    }
    
    //set方法首字母大写
    NSString *keyPathChange = [[[keyPath substringToIndex:1] uppercaseString] stringByAppendingString:[keyPath substringFromIndex:1]];
    NSString *setNameStr = [NSString stringWithFormat:@"set%@", keyPathChange];
    SEL setSEL = NSSelectorFromString([setNameStr stringByAppendingString:@":"]);
    
    //添加set方法
    Method getMethod = class_getInstanceMethod([self class], @selector(keyPath));
    const char *types = method_getTypeEncoding(getMethod);
    class_addMethod(class, setSEL, (IMP)setMethod, types);
    
    //改变isa指针，指向子类
    object_setClass(self, class);
        
    //保存set、get方法名
    objc_setAssociatedObject(self, WSKVO_setter, setNameStr, OBJC_ASSOCIATION_COPY_NONATOMIC);
    objc_setAssociatedObject(self, WSKVO_getter, keyPath, OBJC_ASSOCIATION_COPY_NONATOMIC);
    
    //保存block
    objc_setAssociatedObject(self, WSKVO_block, block, OBJC_ASSOCIATION_COPY);
}

void setMethod(id self, SEL _cmd, id newValue) {
    //获取get、set方法名
    NSString *setNameStr = objc_getAssociatedObject(self, WSKVO_setter);
    NSString *getNameStr = objc_getAssociatedObject(self, WSKVO_getter);
    
    //保存子类类型
    Class class = [self class];
    
    //isa指向原类
    object_setClass(self, class_getSuperclass(class));
    
    //调用原类get方法，获取oldValue
    id oldValue = objc_msgSend(self, NSSelectorFromString(getNameStr));
    
    //调用原类set方法
    objc_msgSend(self, NSSelectorFromString([setNameStr stringByAppendingString:@":"]), newValue);
    
    NSMutableDictionary *change = @{}.mutableCopy;
    if (newValue) {
        change[NSKeyValueChangeNewKey] = newValue;
    }
    if (oldValue) {
        change[NSKeyValueChangeOldKey] = oldValue;
    }
    
    //取出block
    WSKVOBlock block = objc_getAssociatedObject(self, WSKVO_block);
    if (block) {
        block(change);
    }
    
    //isa改回子类类型
    object_setClass(self, class);
}

@end

使用block注意避免循环引用问题。

demo已更新，为方便查看，两种方式写在了两个分类中。Demo地址

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 202,056评论 5赞 474
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 84,842评论 2赞 378
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 148,938评论 0赞 335
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 54,296评论 1赞 272
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 63,292评论 5赞 363
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 48,413评论 1赞 281
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 37,824评论 3赞 393
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 36,493评论 0赞 256
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 40,686评论 1赞 295
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,502评论 2赞 318
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,553评论 1赞 329
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 33,281评论 4赞 318
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 38,820评论 3赞 305
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,873评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,109评论 1赞 258
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 42,699评论 2赞 348
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 42,257评论 2赞 341

推荐阅读更多精彩内容

  • 无标题文章
    转至元数据结尾创建： 董潇伟，最新修改于： 十二月 23, 2016 转至元数据起始第一章:isa和Class一....
    40c0490e5268阅读 1,678评论 0赞 9
  • iOS 自定义KVO
    利用Runtime 实现简单的自定义kvo 代码githubgithub.com/zswj/custom-KVO ...
    我是数据链路层阅读 849评论 1赞 0
  • iOS-自定义KVO
    当某个类的属性对象第一次被观察时，系统就会在运行期动态地创建该类的一个派生类，在这个派生类中重写基类中任何被观察属...
    linbj阅读 957评论 0赞 13
  • KVO自定义实现
    本文是 Objective-C Runtime 系列文章的第三篇。如果你对 Objective-C Runtime...
    克鲁德李阅读 348评论 0赞 2
  • 奔跑（24）：关怀
    我是木风阅读 423评论 10赞 12