提到KVC/KVO大家一定不会陌生,用起来也很简单,下面一起来探究一下它们的实现原理。
一、KVC
1、查找过程
创建一个Person类,并进行测试
//Person.h
@interface Person : NSObject
@property (nonatomic, copy) NSString *name;
@property (nonatomic, assign) int age;
@end
//测试
- (void)viewDidLoad {
[super viewDidLoad];
Person *p = [Person new];
[p setValue:@"name" forKey:@"name"];
NSLog(@"p.name:%@",p.name);
}
很显然,这里会把p对象的name属性进行设置
2017-10-30 21:30:09.808609+0800 KVCDemo[4365:2098502] p.name:name
但是它是如何进行设置的呢?
注释掉name属性,并添加一个_name变量
//Person.h
@interface Person : NSObject
//@property (nonatomic, copy) NSString *name;
@property (nonatomic, assign) int age;
@end
Person.m
@implementation Person
{
NSString *_name;
}
测试
Person *p = [Person new];
[p setValue:@"name" forKey:@"name"];
NSLog(@"p.name:%@",[p valueForKey:@"name"]);;
//输出
2017-10-30 21:38:10.298386+0800 KVCDemo[4436:2128286] p.name:name
很显然,KOC可以直接对属性变量赋值。
那如果我们写一个set方法会怎样呢?
//Person.m
- (void)setName:(NSString *)name{
NSLog(@"setName");
}
再次运行,打印如下:
2017-10-30 21:41:55.337456+0800 KVCDemo[4468:2142554] setName
2017-10-30 21:41:55.337686+0800 KVCDemo[4468:2142554] p.name:(null)
程序调用了setName方法,但并没有给_name属性赋值(因为在set方法中我们只是简单的打印)
这可以得出一个结论:KVC
当使用KVC的时候,它的顺序是:查找set/get方法,如果有,则调用set/get方法,没有则直接查找相应的实例变量。
但其实这中间还有一步,就是判断accessInstanceVariablesDirectly方法返回是否为YES(默认为YES),如果为YES才会继续去查找实例变量。
所以如果我们想要禁止别人通过KVC方法我们的私有变量的时候,我们就可以重写这个方法,并返回NO。
修改代码如下:
@implementation Person
{
NSString *_name;
}
+ (BOOL)accessInstanceVariablesDirectly{
return NO;
}
测试代码不变,程序崩溃
[<Person 0x604000036660> setValue:forUndefinedKey:]: this class is not key value coding-compliant for the key name.
2、隐藏方法
对于集合类KVC有一些隐藏方法,如:
Person *p1 = [Person new];
p1.age = 10;
Person *p2 = [Person new];
p2.age = 20;
Person *p3 = [Person new];
p3.age = 30;
NSMutableArray *arr = [NSMutableArray arrayWithObjects:p1,p2,p3, nil];
NSLog(@"max:%@",[arr valueForKeyPath:@"@max.age"]);
NSLog(@"min:%@",[arr valueForKeyPath:@"@min.age"]);
NSLog(@"sum:%@",[arr valueForKeyPath:@"@sum.age"]);
NSLog(@"avg:%@",[arr valueForKeyPath:@"@avg.age"]);
输出如下:
2017-10-30 22:05:42.022347+0800 KVCDemo[4651:2227632] max:30
2017-10-30 22:05:42.022524+0800 KVCDemo[4651:2227632] min:10
2017-10-30 22:05:42.025358+0800 KVCDemo[4651:2227632] sum:60
2017-10-30 22:05:42.025716+0800 KVCDemo[4651:2227632] avg:20
注意
当对子类继承自父类的属性使用KVC时,查找顺序如下:
子类的get方法->父类的get方法->accessInstanceVariablesDirectly是否返回YES-->子类的成员变量>父类的成员变量
二、KVO
1、实现过程
下面我们来添加一个KVO探究一下它究竟是如何实现的
- (void)viewDidLoad {
[super viewDidLoad];
Person *p = [Person new];
[p addObserver:self forKeyPath:@"name" options:NSKeyValueObservingOptionNew context:nil];
p.name = @"change";
}
- (void)observeValueForKeyPath:(NSString *)keyPath ofObject:(id)object change:(NSDictionary<NSKeyValueChangeKey,id> *)change context:(void *)context{
NSLog(@"%@",change);
}
输出如下:
2017-10-30 22:22:15.212570+0800 KVCDemo[4777:2291649] {
kind = 1;
new = change;
}
这里解释一下这个kind的值,kind其实就是一个枚举值
typedef NS_ENUM(NSUInteger, NSKeyValueSetMutationKind) {
NSKeyValueUnionSetMutation = 1,
NSKeyValueMinusSetMutation = 2,
NSKeyValueIntersectSetMutation = 3,
NSKeyValueSetSetMutation = 4
};
一般的对象都是1,只有容器类才会出现后面三个,后面会有介绍。
好了,继续我们的探索。这里KVO成功监听的name属性的改变,但是它是怎么监听的呢?
查看文档,我发现了这样一个方法
+ (BOOL)automaticallyNotifiesObserversForKey:(NSString *)key;
这个方法的返回值决定是否自动触发通知,修改代码
+ (BOOL)automaticallyNotifiesObserversForKey:(NSString *)key{
if ([key isEqualToString:@"_name"]) {
return NO;
}
return NO;
}
再次运行,就没有受到通知了,说明我们现在需要自动触发通知。
嗯,一看文档就知道,在改变name的值的时候,我们只需要调用一下这两个方法就OK了。
[p willChangeValueForKey:@"name"];
p.name = @"change";
[p didChangeValueForKey:@"name"];
再次运行,通知成功触发
2017-10-30 22:33:48.386367+0800 KVCDemo[4843:2332128] {
kind = 1;
new = change;
}
这说明了什么呢?在automaticallyNotifiesObserversForKey返回YES的时候(默认返回YES),系统自动帮我们调用了以上那两个方法。那系统是如何调用的呢?
依然开启自动触发通知,然后我们打印一下p的类型,这时候神奇的事情发生了
- (void)viewDidLoad {
[super viewDidLoad];
Person *p = [Person new];
NSLog(@"%s",object_getClassName(p));
[p addObserver:self forKeyPath:@"name" options:NSKeyValueObservingOptionNew context:nil];
NSLog(@"%s",object_getClassName(p));
[p willChangeValueForKey:@"name"];
p.name = @"change";
[p didChangeValueForKey:@"name"];
}
输出如下:
2017-10-30 22:41:03.107362+0800 KVCDemo[4887:2354911] Person
2017-10-30 22:41:03.107818+0800 KVCDemo[4887:2354911] NSKVONotifying_Person
2017-10-30 22:41:03.108140+0800 KVCDemo[4887:2354911] {
kind = 1;
new = change;
}
2017-10-30 22:41:03.108298+0800 KVCDemo[4887:2354911] {
kind = 1;
new = change;
}
咦,p竟然变成了NSKVONotifying_Person这样一个类?
看到这里,我猜测,KVO利用runtime做了这样一件事,它创建了一个新的名为NSKVONotifying_Person这样的类,并把p的isa指针指向了NSKVONotifying_Person,而在NSKVONotifying_Person这个类中,重写了name的set方法
- (void)setName:(NSString *)name{
[self willChangeValueForKey:@"name"];
_name = name;
[self didChangeValueForKey:@"name"];
}
2、自定义KVO
到底怎样利用runtime实现的呢?
下面我们来自己实现一下KVO。
新建一个NSObject的分类
//NSObject+KVO.m
#import "NSObject+KVO.h"
@implementation NSObject (KVO)
- (void)HK_addObserver:(NSObject *)observer forKeyPath:(NSString *)keyPath options:(NSKeyValueObservingOptions)options context:(void *)context{
//动态创建子类
NSString *oldClassName = NSStringFromClass([self class]);
NSString *newClassName = [@"HKKVO_" stringByAppendingString:oldClassName];
Class newClass = objc_allocateClassPair([self class], newClassName.UTF8String, 0); //三个参数分别为superClass,className,第三个参数默认填0
//重写set方法
IMP imp = method_getImplementation(class_getClassMethod([self class], @selector(setName:)));
class_addMethod(newClass, @selector(setName:), imp, "v@:@");
//注册该类
objc_registerClassPair(newClass);
//改变被观察者的isa指针
object_setClass(self, newClass);
}
- (void)setName:(NSString *)name{
NSLog(@"setName");
}
来验证一下:
- (void)viewDidLoad {
[super viewDidLoad];
Person *p = [Person new];
[p HK_addObserver:self forKeyPath:@"name" options:NSKeyValueObservingOptionNew context:nil];
p.name = @"change";
}
输出:
2017-10-31 10:46:16.945467+0800 KVCDemo[5575:2686904] setName
嗯,确实调用了新添加的set方法。但是我们好像还没有接收到通知,如何把这个通知发过去呢?这里只需要把oberver获取一下就可以了,我们通过关联对象实现:
- (void)HK_addObserver:(NSObject *)observer forKeyPath:(NSString *)keyPath options:(NSKeyValueObservingOptions)options context:(void *)context{
//动态创建子类
NSString *oldClassName = NSStringFromClass([self class]);
NSString *newClassName = [@"HKKVO_" stringByAppendingString:oldClassName];
Class newClass = objc_allocateClassPair([self class], newClassName.UTF8String, 0); //三个参数分别为superClass,className,第三个参数默认填0
//重写set方法
IMP imp = method_getImplementation(class_getClassMethod([self class], @selector(setName:)));
class_addMethod(newClass, @selector(setName:), imp, "v@:@");
//注册该类
objc_registerClassPair(newClass);
//改变被观察者的isa指针
object_setClass(self, newClass);
objc_setAssociatedObject(self, @"observer", observer, OBJC_ASSOCIATION_RETAIN);
}
- (void)setName:(NSString *)name{
NSObject *obj = objc_getAssociatedObject(self, @"observer");
[obj observeValueForKeyPath:@"name" ofObject:self change:@{@"kind":@(NSKeyValueUnionSetMutation),@"new":name} context:nil];
NSLog(@"setName");
}
再次运行:
2017-10-31 11:02:42.058328+0800 KVCDemo[5673:2740309] {
kind = 1;
new = change;
}
2017-10-31 11:02:42.058550+0800 KVCDemo[5673:2740309] setName
OK,通知成功发送,但是还有一个问题,我打印了一下name的值,发现为空
NSLog(@"%@",p.name);
2017-10-31 11:09:42.445267+0800 KVCDemo[5700:2752840] (null)
嗯,为空就对了,因为set方法走了我们定义的set方法嘛,_name属性自然没有完成设置,所以这里我们还需要完善一下。
有人可能会想到用KVC,直接[self setValue:name forKey:@"name"];
,注意这里肯定是不可以直接用KVC的,因为子类这里重写了set方法,使用KVC它肯定会走子类的set方法,然后重复调用。
所以这里。。。。。。我还是使用了KVC,哈哈哈哈哈,不过得先把它的isa指针指向父类
- (void)setName:(NSString *)name{
NSObject *obj = objc_getAssociatedObject(self, @"observer");
[obj observeValueForKeyPath:@"name" ofObject:self change:@{@"kind":@(NSKeyValueUnionSetMutation),@"new":name} context:nil];
NSLog(@"setName");
Class superClass = [self superclass];
object_setClass(self, superClass);
[self setValue:name forKey:@"name"];
}
再次运行
2017-10-31 11:22:57.409392+0800 KVCDemo[5804:2797242] {
kind = 1;
new = change;
}
2017-10-31 11:22:57.409527+0800 KVCDemo[5804:2797242] setName
2017-10-31 11:22:57.409649+0800 KVCDemo[5804:2797242] p.name:change
OK,大功告成。
当然,这里我其实是投机取巧啊,系统绝对不是这样做的,系统添加的子类应该要复杂得多,因为直到获取通知,被观察者的isa指针依然指向子类,而我们这里已经将被观察者得指针指回了父类。这里其实依然可以用关联对象,只不过还得重写一下get方法,具体我就不再多讲了,runtime能做的事太多,只要用心思考,方法还是很多的。
补充:
KVO是监听的指针,所以一般情况下KVO是不能直接监听数组的,因为修改数组是不会改变它的指针的,要想监听数组,得使用mutableArrayValueForKey来改变数组,因为这个不仅把元素加进去了,而且还重新生成一个可变数组来重新赋值。
这篇文章涉及到了很多runtime的知识,后面我应该会写一篇关于runtime的讲解,文章有不足的地方望大家指出。