关于KVO, 之前已经写过两篇文章了
但是, 关于KVO内部实现, 我却没有深入研究. 那我们先看看KVO内部发生了什么事情:
我先新建一个Person类, 在类的内部有一个属性name:
#import <Foundation/Foundation.h>
@interface Person : NSObject
@property (nonatomic,copy)NSString *name;
@end
然后, 我让控制器作为观察者, 观察name属性的变化:
- (void)viewDidLoad {
[super viewDidLoad];
[self.person addObserver:self forKeyPath:@"name" options:0 context:nil];
}
- (void)touchesBegan:(NSSet<UITouch *> *)touches withEvent:(UIEvent *)event {
static int number = 0;
self.person.name = [NSString stringWithFormat:@"%@", @(number ++)];
}
- (void)observeValueForKeyPath:(NSString *)keyPath ofObject:(id)object change:(NSDictionary<NSKeyValueChangeKey,id> *)change context:(void *)context {
}
我在第24行打一个断点, 观察一下person的isa指针, 发现此时, isa指针指向的是Person的.
isa指针指向`Person`
但将断点跳过24行, 发现isa指针指向了NSKVONotifying_Person.
isa指针指向`NSKVONotifying_Person`
2024年3月6日补充
最近的XCode貌似不会打印NSKVONotifying_Person了, 而是直接给出一个指针地址
但是利用object_getClass还是能拿到类对象NSKVONotifying_Person
image.png
可以看出, 添加了addObserver之后, 系统利用runtime的API动态地生成了一个NSKVONotifying_Person类.
NSKVONotifying_Person是Person的一个子类, 从哪里可以看出来呢:
image.png
从上图可以看出, 我通过object_getClass方法拿到self.p的isa指针指向的class对象, 然后通过打印class对象的superclass指针地址, 发现, 此时, self.p的父类已经变成了Person(之前是NSObject)
系统是在
- (void)addObserver:(NSObject *)observer forKeyPath:(NSString *)keyPath options:(NSKeyValueObservingOptions)options context:(nullable void *)context;
方法中动态地生成了一个子类, 将isa指针指向这个子类, 这样, 在调用set方法的时候, 就会走子类的set方法, 子类的set方法, 先调super走父类的方法, 这样就不会影响本身Person类中set方法的重写.
我们怎么知道是重写了set方法呢?
unsigned int count;
Method *methodList = class_copyMethodList(object_getClass(self.p), &count);
NSMutableString *methodString = [NSMutableString string];
for (int i = 0; i < count; i++) {
Method method = methodList[I];
SEL selector = method_getName(method);
NSString *methodName = NSStringFromSelector(selector);
[methodString appendString:methodName];
[methodString appendString:@","];
}
NSLog(@"%@", methodString);
我们通过runtime的API, 就可以得到这个类的方法列表
image.png
通过上图, 就可以很清晰地知道, 子类重写了这样几个方法
setName:-
class(必须还是返回原本的类, 而不是动态生成的那个类) -
delloc(因为动态生成了一个类, 可能需要做一些销毁的操作)] -
_isKVOA(可能是新增的方法)
那么, 重写的setName:方法中做了什么操作呢?
image.png
打印了添加观察者之前的方法实现IMP指针和添加观察者之后的方法实现IMP指针, 发现指向的地址是不同的, 这也说明了方法实现其实是不同的, 也从侧面证明了, 新生成的子类重写了父类方法.
methodForSelector:这个方法可以获取到IMP指针, 拿到指针后, 在控制台p (IMP)0x1001a560可以拿到具体的方法名
从上图可以看到, 重写的setName:方法其实调用的是Foundation框架的_NSSetObjectValueAndNotify, 那么_NSSetObjectValueAndNotify做了些什么呢? 主要有以下几件事
- 调用
willChangeValueForKey: - 调用父类的
setName:方法 - 调用
didChangeValueForKey:
在不添加观察者的时候, 是不会调用willChangeValueForKey:和didChangeValueForKey:的
image.png
但添加了观察者之后:
image.png
会调用
willChangeValueForKey:和didChangeValueForKey:在
didChangeValueForKey:, 会调用
- (void)observeValueForKeyPath:(nullable NSString *)keyPath ofObject:(nullable id)object change:(nullable NSDictionary<NSKeyValueChangeKey, id> *)change context:(nullable void *)context;
这样就达到了监听的效果, 那如何证明是在didChangeValueForKey:中调用了
- (void)observeValueForKeyPath:(nullable NSString *)keyPath ofObject:(nullable id)object change:(nullable NSDictionary<NSKeyValueChangeKey, id> *)change context:(nullable void *)context;方法呢?
如下图所示:
image.png
当代码走到
[super didChangeValueForKey:key]时, 先打印了change, 最后才打印didChangeValueForKey-end
那么一个面试题来了, 如何手动调用KVO?
我直接调用didChangeValueForKey:这个方法, 能触发KVO吗? 答案是不行的, 可能didChangeValueForKey:中做了判断, 如果没有调用willChangeValueForKey:, 是不会触发KVO的.
image.png
如上图所示, 先调用
willChangeValueForKey:, 再调用didChangeValueForKey:, 成功地触发了KVO
根据上面这个思路, 我们来自定义一个KVO方法:
- 首先, 创建一个
NSObject的分类,
`NSObject`的分类
- 分类中写一个和系统一样的方法, 加一个前缀防止重名:
- (void)yf_addObserver:(NSObject *_Nullable)observer forKeyPath:(NSString *_Nullable)keyPath options:(NSKeyValueObservingOptions)options context:(nullable void *)context;
-
然后实现这个方法:
- 首先, 将观察者
keyPath设置为属性, 供后面的函数使用:
- 首先, 将观察者
objc_setAssociatedObject(self, @"keyPath", keyPath, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
- 动态地生成一个子类:
/* 1. 获取当前类的类名 */
Class klass = [self class];
NSString *className = NSStringFromClass(klass);
/* 2.动态地生成一个子类 */
/* 2.1 生成子类类名 */
NSString *subclassName = [@"YFKVO" stringByAppendingString:className];
/* 2.2 动态地生成一个子类 */
Class subclass = objc_allocateClassPair(klass, [subclassName UTF8String], 0);
objc_registerClassPair(subclass);
object_setClass(self, subclass);
- 为这个子类添加set方法:
/* 3. 为子类增添set方法 */
/* 3.1 获取方法名 */
NSString *methodName = [NSString stringWithFormat:@"set%@:", keyPath.localizedCapitalizedString];
SEL sel = NSSelectorFromString(methodName);
/* 3.2 动态地添加方法 */
class_addMethod(subclass, sel, (IMP)setValue, "v@:@");
- 给对象发送
set方法:
/* 4. 给对象发送set方法 */
// 2024.3.7 不注释会崩溃
// objc_msgSend(self, sel);
/* 5. 保存观察者, 以便下面的函数调用 */
objc_setAssociatedObject(self, @"observer", observer, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
-
setValue函数的实现:
void setValue(id self, SEL _cmd, id value) {
/* 1. 先将指针改为super */
/* 1.1 保存现在的class */
Class subclass = [self class];
object_setClass(self, [self superclass]);
/* 2. 调用父类的set方法 */
NSString *keyPath = objc_getAssociatedObject(self, @"keyPath");
NSString *methodName = [NSString stringWithFormat:@"set%@:", keyPath.localizedCapitalizedString];
SEL sel = NSSelectorFromString(methodName);
((void (*)(Class _Nullable, SEL _Nonnull,id))(void *)objc_msgSend)(self,sel,value);
/* 3.将isa指针变到子类 */
object_setClass(self, subclass);
/* 4. 给观察者发送消息 */
/* 4.1 先获取观察者 */
id observer = objc_getAssociatedObject(self, @"observer");
((void (*)(id, SEL _Nonnull,id, id, id, id))(void *)objc_msgSend)(observer, @selector(observeValueForKeyPath:ofObject:change:context:), keyPath, self, nil, nil);
}
-
这里需要注意的有两点:
- 先要调用父类的
set方法, 这样我在使用KVO的时候, 并不会影响本类的set方法的重写. - 在调用父类的
set方法时, 我们采取的策略是先将isa指针指向了父类, 但在函数末尾, 我们需要将isa指针再重新指向子类, 这样, 我才能保证我自定义的set方法是一定会调用的.
- 先要调用父类的
采用自定义`KVO`的运行结果
- 就算重写了
Person类的set方法也丝毫不影响:
#import "Person.h"
@implementation Person
- (void)setName:(NSString *)name {
_name = [name stringByAppendingString:@"重写set方法, 不影响KVO的实现"];
}
@end
重写了`Person`类`set`方法不影响`KVO`的实现
2024年3月7日补充:
上面的写法基本上没有问题, 但现在objc_msgSend()函数已经无法正常使用了, 必须要强制类型转换.
解决方法连接
((void (*)(Class _Nullable, SEL _Nonnull,id))(void *)objc_msgSend)(self,sel, value);
((void (*)(id, SEL _Nonnull,id, id, id, id))(void *)objc_msgSend)(observer, @selector(observeValueForKeyPath:ofObject:change:context:), keyPath, self, nil, nil);
最新的setValue:方法应该这么写:
//
// NSObject+KVO.m
// KVODemo
//
// Created by tsaievan on 2024/3/6.
//
#import "NSObject+KVO.h"
#import <objc/runtime.h>
#import <objc/message.h>
#import <objc/objc.h>
@implementation NSObject (KVO)
- (void)yf_addObserver:(NSObject *)observer forKeyPath:(NSString *)keyPath options:(NSKeyValueObservingOptions)options context:(nullable void *)context {
objc_setAssociatedObject(self, @"keyPath", keyPath, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
/* 1. 获取当前类的类名 */
Class klass = [self class];
NSString *className = NSStringFromClass(klass);
/* 2.动态地生成一个子类 */
/* 2.1 生成子类类名 */
NSString *subclassName = [@"YFKVO" stringByAppendingString:className];
/* 2.2 动态地生成一个子类 */
Class subclass = objc_allocateClassPair(klass, [subclassName UTF8String], 0);
objc_registerClassPair(subclass);
object_setClass(self, subclass);
/* 3. 为子类增添set方法 */
/* 3.1 获取方法名 */
NSString *methodName = [NSString stringWithFormat:@"set%@:", keyPath.localizedCapitalizedString];
SEL sel = NSSelectorFromString(methodName);
/* 3.2 动态地添加方法 */
class_addMethod(subclass, sel, (IMP)setValue, "v@:@");
/* 4. 保存观察者, 以便下面的函数调用 */
objc_setAssociatedObject(self, @"observer", observer, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
}
void setValue(id self, SEL _cmd, id value) {
/* 1. 先将指针改为super */
/* 1.1 保存现在的class */
/* 2. 调用父类的set方法 */
NSString *keyPath = objc_getAssociatedObject(self, @"keyPath");
[self willChangeValueForKey:keyPath];
id oldValue = [self valueForKey:keyPath];
Class subclass = [self class];
object_setClass(self, [self superclass]);
NSString *methodName = [NSString stringWithFormat:@"set%@:", keyPath.localizedCapitalizedString];
SEL sel = NSSelectorFromString(methodName);
((void (*)(Class _Nullable, SEL _Nonnull,id))(void *)objc_msgSend)(self,sel, value);
/* 3.将isa指针变到子类 */
object_setClass(self, subclass);
/* 4. 给观察者发送消息 */
/* 4.1 先获取观察者 */
id observer = objc_getAssociatedObject(self, @"observer");
NSDictionary *change = @{
NSKeyValueChangeOldKey : oldValue ? oldValue : [NSNull null],
NSKeyValueChangeNewKey : value
};
((void (*)(id, SEL _Nonnull,id, id, id, id))(void *)objc_msgSend)(observer, @selector(observeValueForKeyPath:ofObject:change:context:), keyPath, self, change, nil);
[self didChangeValueForKey:keyPath];
}
@end
