KVO与KVC的原理及其应用

一、关于KVO

1. KVO实现原理

实现kvo监听某一属性值变化的相关代码：

- (void)viewDidLoad {
    [super viewDidLoad];
    People *p = [[People alloc] init];
    [p addObserver:self forKeyPath:@"name" options:NSKeyValueObservingOptionNew context:nil];
    p.name = @"123";
}
-(void)observeValueForKeyPath:(NSString *)keyPath ofObject:(id)object change:(NSDictionary<NSKeyValueChangeKey,id> *)change context:(void *)context{
    NSLog(@"%@",change);
}

当一个对象的属性被观察时，系统会动态创建了一个子类；
并且改变了原有对象的isa指针指向，指向动态创建的子类；
子类中重写了被观察属性的set方法，在使用点方法和set方法给属性赋值时，最终调用的是子类中的set方法。

在addObserver处设置断点观察对象isa指针变化，被观察前isa指针指向的是原始类如图：

而执行代码被观察后，指针指向的是NSKVONotifying_People类，可自行实验。

2. 自定义KVO

创建一个分类新增一个方法HBaddObserver，在方法中创建子类注册并指向子类，再为子类添加set方法既可。自定义kvo过程中，主要使用到的系统方法：

//// 1.创建一个子类
/** 
 superclass:设置新类的父类
 name:新类名称
 extraBytes:额外字节数设置为0
*/
 objc_allocateClassPair(Class _Nullable superclass, const char * _Nonnull name, size_t extraBytes)

//// 2.注册该类
/** 
 cls:当前要注册的类，注册后才可以使用
*/
 objc_registerClassPair(Class _Nonnull cls)

//// 3.设置当前对象指向其他类
/** 
 obj:要设置的对象
 cls:指向的类
*/
 object_setClass(id _Nullable obj, Class _Nonnull cls)

//// 4.动态添加一个方法
/** 
 cls:设置添加方法对应的类
 name:选择子（选择器）名称，描述了方法的格式，并不会指向方法
 imp:函数名称（函数指针），和选择子一一对应，指向方法实现的地址
*/
 class_addMethod(Class _Nullable cls, SEL _Nonnull name, IMP _Nonnull imp, const char * _Nullable types)

代码示例：

主控制器代码：

#import "ViewController.h"
#import <objc/message.h>
#import "Person.h"
#import "NSObject+HBKVO.h"

@interface ViewController (){
    Person *p;
}
@end

@implementation ViewController

- (void)viewDidLoad {
    [super viewDidLoad];
    p = [[Person alloc] init];
    [p HBaddObserver:self forKeyPath:@"Name" options:NSKeyValueObservingOptionNew context:nil];
    
}
-(void)observeValueForKeyPath:(NSString *)keyPath ofObject:(id)object change:(NSDictionary<NSKeyValueChangeKey,id> *)change context:(void *)context{
    NSLog(@"change：%@",change);
}
-(void)touchesBegan:(NSSet<UITouch *> *)touches withEvent:(UIEvent *)event{
    static int num = 0;
    p.Name = [NSString stringWithFormat:@"%d",num++];
}
@end

person类头文件代码（.m中无相关代码）：

#import <Foundation/Foundation.h>

NS_ASSUME_NONNULL_BEGIN

@interface Person : NSObject
@property (nonatomic,strong)NSString *Name;
@end

NS_ASSUME_NONNULL_END

自定义KVO相关代码（NSObject分类）：

NSObject+HBKVO.h

#import <Foundation/Foundation.h>

NS_ASSUME_NONNULL_BEGIN

@interface NSObject (HBKVO)
- (void)HBaddObserver:(NSObject *)observer forKeyPath:(NSString *)keyPath options:(NSKeyValueObservingOptions)options context:(nullable void *)context;
@end

NS_ASSUME_NONNULL_END

NSObject+HBKVO.m

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

@implementation NSObject (HBKVO)
-(void)HBaddObserver:(NSObject *)observer forKeyPath:(NSString *)keyPath options:(NSKeyValueObservingOptions)options context:(void *)context{
    NSString *oldName = NSStringFromClass(self.class);
    NSString *newName = [@"HBKVO_" stringByAppendingString:oldName];
    //1、创建一个子类
    Class newClass = objc_allocateClassPair(self.class, newName.UTF8String, 0);
    //2、注册该类
    objc_registerClassPair(newClass);
    //3、指向子类
    object_setClass(self, newClass);
    //4、动态添加一个方法
    NSString *first = [keyPath substringWithRange:NSMakeRange(0, 1)];
    NSString *other = [keyPath substringFromIndex:1];
    NSString *setName = [NSString stringWithFormat:@"set%@%@:",first.uppercaseString,other];//设置一个属性名首字母大写的方法
    Method method = class_getInstanceMethod(self.class, sel_registerName(setName.UTF8String));
    const char *types = method_getTypeEncoding(method);
    class_addMethod(newClass, sel_registerName(setName.UTF8String), (IMP)setValue, types);
    //class_addMethod(newClass, sel_registerName(setMethod.UTF8String), (IMP)setName, "v@:@");
    
    //设置关联数据
    //获取元类旧值使用
    objc_setAssociatedObject(self, "keyPath", keyPath, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
    //设置新值的时候使用
    objc_setAssociatedObject(self, "setName", setName, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
    //通知值变化
    objc_setAssociatedObject(self, "observer", observer, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
    //传进来的内容需要回传
    objc_setAssociatedObject(self, "context", (__bridge id _Nullable)(context), OBJC_ASSOCIATION_RETAIN_NONATOMIC);
}
void setValue(id self,SEL _cmd,NSString *newValue){
    NSLog(@"newValue:%@",newValue);
    NSString *keyPath = objc_getAssociatedObject(self, "keyPath");
    NSString *setName = objc_getAssociatedObject(self, "setName");
    id observer = objc_getAssociatedObject(self, "observer");
    id context = objc_getAssociatedObject(self, "context");
    //存储新类
    Class newClass = [self class];
    //指向父类获取旧值
    object_setClass(self, class_getSuperclass(newClass));
    NSString *oldValue = objc_msgSend(self,sel_registerName(keyPath.UTF8String));
    //对原始类属性或成员变量复制
    objc_msgSend(self, sel_registerName(setName.UTF8String),newValue);
    NSMutableDictionary *change = [NSMutableDictionary dictionary];
    if (oldValue) {
        change[NSKeyValueChangeOldKey] = oldValue;
    }
    if (newValue) {
        change[NSKeyValueChangeNewKey] = newValue;
    }
    //调用observer的回调方法
    objc_msgSend(observer, @selector(observeValueForKeyPath:ofObject:change:context:),keyPath,observer,change,context);
    //操作完成后指回动态创建的新类
    object_setClass(self, newClass);
}
@end

一、关于KVC

KVC的全称为KeyValueCoding，是对NSObjcet的扩展，分类名为： NSKeyValueCoding。我们经常用KVC或者setter方法来触发KVO，实现键值变化监听，实现一些功能。

1. KVC常用的方法说明

// 1、将键字符串key所对应的属性的值设置为value。不能设定属性值时，将会引起接收器调用方法2
- (void)setValue:(nullable id)value forKey:(NSString *)key

// 2、当属性值设置失败，调用此方法
- (void)setValue:(nullable id)value forUndefinedKey:(NSString *)key

// 3、返回标识属性的键字符串所对应的值。如果获取失败，将会引起接收器调用方法4
- (nullable id)valueForKey:(NSString *)key

// 4、取值失败，调用此方法
- (nullable id)valueForUndefinedKey:(NSString *)key

// 5、在键字符串key所对应的"标量"型属性值设为nil，调用此方法，并抛出NSInvalidArgumentException异常(可demo测试)
- (void)setNilValueForKey:(NSString *)key


// 6、默认返回值YES，代表如果没有找到Set方法的话，会按照_key，_iskey，key，iskey的顺序搜索成员，设置成NO就不这样搜索
+ (BOOL)accessInstanceVariablesDirectly

标量：属性中的单纯的数值(整数、实数、布尔值等)
在赋值的时候，如果是结构体，必须包装成NSValue实例；
如果是标量型属性，必须包装成NSNumber实例。

2. KVC赋值的实现原理

查找是否实现setter、_setter 方法，如果有，优先调用setter方法完成赋值(注意：set后面的键的第一字字母必须是大写！！)

当没找到setter方法，调用accessInstanceVariablesDirectly询问。如果返回YES，顺序匹配变量名与 _<key>，_is<Key>,<key>,is<Key>,匹配到则设定其值；如果返回NO,结束查找。并调用 setValue：forUndefinedKey：报异常

如果既没有setter也没有实例变量时，调用 setValue：forUndefinedKey：

结合demo，写下基本实现原理

// .h文件
#import <Foundation/Foundation.h>

@interface Peson : NSObject {
    //_<key>, _is<Key>, <key>, or is<Key>  注意顺序!!!
    //NSString *_name;
    //NSString *_isName;
   // NSString *name;
    NSString *isName;
}
@end

// .m文件
#import "Peson.h"
#import <objc/runtime.h>

@implementation Peson

- (void)setValue:(id)value forKey:(NSString *)key
{
    NSString *setter = [[@"set" stringByAppendingString:[key capitalizedString]] stringByAppendingString:@":"];
    
    // 1、检查是否存在setter方法
    if ([self respondsToSelector:NSSelectorFromString(setter)]) {
        // 1.1 如果是标量型属性赋值，且值为nil，赋值失败
        if (![value isKindOfClass:[NSObject class]] && value == nil)
        {
            [self setNilValueForKey:key];
            // 1.2 如果是对象指针类型，直接进行赋值操作
        }else{
          
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Warc-performSelector-leaks"
            [self performSelector:NSSelectorFromString(setter) withObject:value];
#pragma clang diagnostic pop
        }
    // 2、询问 accessInstanceVariablesDirectly,默认YES,继续往下查找
    }else{
        //获取所有属性列表
        unsigned int count = 0;
        Ivar *ivar = class_copyIvarList([self class], &count);
        //_<key>, _is<Key>, <key>, or is<Key>  注意顺序!!!
        NSArray *searchPropretys = @[@"_name",@"_isName",@"name",@"isName"];
        // 是否找到变量名的标志位，判断是否需要抛出异常
        BOOL flag  =  false;
        
        //遍历属性,依次匹配
        for (int i = 0; i < count; i++) {
            //如果找到了，结束循环
            if (flag) {
                break;
            }else{
                Ivar var = ivar[i];
                NSString *name = [NSString stringWithUTF8String:ivar_getName(var)];
                
                for (int j = 0; j < searchPropretys.count; j++) {
                    //找到了，结束循环
                    if ([name isEqualToString:searchPropretys[j]]) {
                        flag = YES;
                        object_setIvar(self, var, value);
                        break;
                    }
                }              
            }
        }
        
        //记得释放
        free(ivar)；
        
        //如果没找到，调用setValue: forUndefinedKey: 抛出异常
        if (!flag) {
            [self setValue:value forUndefinedKey:key];
        }
    }
}

+(BOOL)accessInstanceVariablesDirectly {
    return YES;
}

注意：上面有一个细节需要说下，对于标量型属性赋值，如果是纯数值，需要使用包装类NSNumber，对于结构体，需要用NSValue实例包装。

通过上面我们也可以发现，为什么KVC和setter方法都可以触发KVO 。

3. KVC取值的实现原理

查找是否实现getter方法，依次匹配-get<Key> 和 -<key> 和 is<Key>，如果找到，直接返回。需要注意的是：如果返回的是对象指针类型，则返回结果；如果返回的是NSNumber转换所支持的标量类型之一，则返回一个NSNumber，否则，将返回一个NSValue

当没有找到getter方法，调用accessInstanceVariablesDirectly询问，如果返回YES， _<key>，_is<Key>,<key>,is<Key>，找到了返回对应的值；如果返回NO，结束查找。并调用 valueForUndefinedKey: 报异常

如果没找到getter方法和属性值，调用 valueForUndefinedKey: 报异常。

紧接着实现上面demo的取值方法：

- (id)valueForKey:(NSString *)key
{
    // 1. 查找getter方法
    // -get<Key>
     NSString *getKey = [@"get" stringByAppendingString:[key capitalizedString]];
     NSString *isKey = [@"is" stringByAppendingString:[key capitalizedString]];
    //  1.1 优先查找 -get<Key>
    if ([self respondsToSelector:NSSelectorFromString(getKey)])
    {
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Warc-performSelector-leaks"
        [self performSelector:NSSelectorFromString(getKey)];
#pragma clang diagnostic pop
        
      // 1.2 查找   -<key>
    }else if ([self respondsToSelector:NSSelectorFromString(key)])
    {
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Warc-performSelector-leaks"
        [self performSelector:NSSelectorFromString(key)];
#pragma clang diagnostic pop
      
     // 1.3 查找 is<Key>
    }else if ([self respondsToSelector:NSSelectorFromString(isKey)])
    {
    
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Warc-performSelector-leaks"
        [self performSelector:NSSelectorFromString(isKey)];
#pragma clang diagnostic pop
        
      
     // 2. 询问 accessInstanceVariablesDirectly，是否继续查找属性，默认返回YES
    }else{
        //_<key>, _is<Key>, <key>, or is<Key>  注意顺序!!!

        //获取所有属性列表
        unsigned int count = 0;
        Ivar *ivar = class_copyIvarList([self class], &count);
        //_<key>, _is<Key>, <key>, or is<Key>  注意顺序!!!
        NSArray *searchPropretys = @[@"_name",@"_isName",@"name",@"isName"];
        
        BOOL flag  =  false;
        
        //遍历属性,依次匹配
        for (int i = 0; i < count; i++) {
            //如果找到了，跳出外重循环
            if (flag) {
                break;
            }else{
                Ivar var = ivar[i];
                NSString *name = [NSString stringWithUTF8String:ivar_getName(var)];
                for (int j = 0; j < searchPropretys.count; j++) {
                    //找到了，结束循环
                    if ([name isEqualToString:searchPropretys[j]]) {
                        flag = YES;
                        return  object_getIvar(self, var);
                        break;
                    }
                }
            }
        }
        free(ivar);
        //如果没找到，调用
        if (!flag) {
            [self valueForUndefinedKey:key];
        }
    }
    return nil;
}

参考链接：
KVO实现原理

KVC和字典
 iOS KVC实现原理
 KVC的底层原理，及自定义KVC

KVC的运用场景
1.动态的取值和设值
2.用KVC来访问和修改私有变量
3.Model和字典转换
4.修改一些控件的内部属性

最常用的是个性化UITextField中的placeHolderText
这里的关键点是如何获取你要修改的样式属性名也就是key or keyPath名

KVC 能够触发 KVO，在 KVC 底层有手动触发 KVO的代码，监听willChangeValueForKey 和 didChangeValueForKey可得到验证。

三、KVO/KVC图示

以Person类为示例，在添加addObserver方法之前，实例对象、类对象的关系：

实例addObserver之前，对象与类得关系

当对一个对象进行kvo监听的时候，会生成一个NSKVONotifying_前缀的类，然后我们实际的操作是对这个类进行的。某对象在addObserver:之后，这个对象的isa指针已经指向了NSKVONotifying_前缀的类，其父类被设置为Person类。

//// 验证1
// 如果在原有工程中，创建NSKVONotifying_Person类，运行代码会报 KVO failed to allocate class pair for name NSKVONotifying_Person, automatic key-value observing will not work for this class 错误，
//因为原有工程中已经存在该类，故无法运行时生成该类。

//// 验证2
// 我们可以在addObserver:前后断点打印对象的isa指针，会发现两个实例对应的打印结果不同。
NSLog(@"KVO之前 - %@", object_getClass(self.person));
NSKeyValueObservingOptions options = NSKeyValueObservingOptionNew | NSKeyValueObservingOptionOld;
[self.person addObserver:self forKeyPath:@"age" options:options context:@"keyOfMy"];
NSLog(@"KVO之后 - %@", object_getClass(self.person));

//log
//2021-06-22 20:02:02.101462+0800 TestProj[81369:8704592] KVO之前 - Person
//2021-06-22 20:02:07.003729+0800 TestProj[81369:8704592] KVO之后 - NSKVONotifying_Person

//// 验证3
//在 person 对象调用 addObserver: forKeyPath: options: context: 方法前后添加如下代码，打印结果不同 。
NSLog(@"KVO之前 - %p", [self.person methodForSelector:@selector(setAge:)]);
NSKeyValueObservingOptions options = NSKeyValueObservingOptionNew | NSKeyValueObservingOptionOld;
[self.person addObserver:self forKeyPath:@"age" options:options context:@"keyOfMy"];
NSLog(@"KVO之后 - %p", [self.person methodForSelector:@selector(setAge:)]);

//log
2021-06-22 20:12:15.245515+0800 TestProj[81577:8714132] KVO之前 - 0x10414be60
2021-06-22 20:12:23.842112+0800 TestProj[81577:8714132] KVO之后 - 0x7fff207bf79f

实例addObserver之后，对象与类得关系

在addObserver:后调用setage方法，会根据对象的isa找到NSKVONotifying_Person，然后在类的方法列表中找到setage。

通过下面方法，查看NSKVONotifying_Person 的内部结构：

- (void)printMethodNamesOfClass:(Class)cls{
    unsigned int count;
    // 获得方法数组
    Method *methodList = class_copyMethodList(cls, &count);
    // 存储方法名
    NSMutableString *methodNames = [NSMutableString string];
    // 遍历所有的方法
    for (int i = 0; i < count; i++) {
        // 获得方法
        Method method = methodList[I];
        // 获得方法名
        NSString *methodName = NSStringFromSelector(method_getName(method));
        // 拼接方法名
        [methodNames appendString:methodName];
        [methodNames appendString:@", "];
    }
    // 释放
    free(methodList);
    // 打印方法名
    NSLog(@"%@ %@", cls, methodNames);
}

// log，在kvo监听下包含了四个方法：
// NSKVONotifying_MJPerson setAge:, class, dealloc, _isKVOA,

可见Apple是不希望暴露NSKVONotifyin_Person，重写了class方法，大概实现如下：

- (Class) class {
     // 得到类对象，在找到类对象父类
     return class_getSuperclass(object_getClass(self));
}

重写setName: 的内部实现，其中调用了"_NSSetObjectValueAndNotify()" ：

- (void)setName:(NSString *)name {
    _NSSetObjectValueAndNotify()
}

- (void)willChangeValueForKey:(NSString *)key {
    [super willChangeValueForKey:key];
}

- (void)didChangeValueForKey:(NSString *)key {
    [super didChangeValueForKey:key];
    [observer observeValueForKeyPath:@"name"];
}

void _NSSetObjectValueAndNotify() {
    [self willChangeValueForKey:@"name"];
    [super setName:name];
    [self didChangeValueForKey:@"name"];
}

手动触发KVO

因为 KVO 的本质是重写了 set 方法， set 方法内部调用了willChangeValueForKey 和 didChangeValueForKey 方法，直接修改成员变量并不会调用 set 方法。由此可知，KVO 的触发条件一般是修改监听对象属性值，但也可在不修改被监听属性值的情况下触发 KVO 监听回调。

[self.person1 willChangeValueForKey:@"age"];
[self.person1 didChangeValueForKey:@"age"];

注：直接修改成员变量不会触发 KVO 监听方法，

KVC触发KVO

kvc常见的API有:

- (void)setValue:(id)value forKeyPath:(NSString *)keyPath;
- (void)setValue:(id)value forKey:(NSString *)key;
- (id)valueForKeyPath:(NSString *)keyPath;
- (id)valueForKey:(NSString *)key;

setValue:forKey:的原理，

setValue:forKey:流程

方法accessInstanceVariablesDirectly:(是否允许访问成员变量)，默认返回YES。该方法有个应用场景就是如果你自己写框架，你的一些私有的变量不想被外部通过KVC的方式去修改，就可以重写这个方法，返回 NO 即可！

valueForKey:的原理，

valueForKey:流程

KVC修改属性值，是会触发KVO的，原因是系统自动实现了set方法，并且底层都会调用 willChangeValueForKey和 didChangeValueForKey。

最后编辑于：2023.03.10 18:32:07

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