KVO 从基本使用到原理剖析

秒速五厘米 2022-11-18 05:49 220阅读 0赞

### 文章目录 ###

*  1. 简介
 *  2. 基本使用
 *   *  2.1 设置观察者
     *  2.2 接收属性改变消息
     *  2.3 移除观察者
     *  2.4 KVO 使用实例
 *  3. 原理剖析
 *   *  3.1 KVO 的实现
     *  3.2 NSKVONotifying\_XXX类探究
     *  3.3 NSKVONotifying\_XXX 中 setter 方法的实现
 *  4. 面试题解析
 *   *  4.1 KVO的是如何实现的？
     *  4.2 如何手动触发KVO？
     *  4.3 直接改变成员变量会触发KVO吗？
 *  参考资料

# 1. 简介 #

KVO 是 Key Value Observe 的缩写，主要通过为需要监听的对象属性设置观察者，让观察者接收到属性值改变的消息通知，是 iOS 对观察者模式的一种实现。

# 2. 基本使用 #

## 2.1 设置观察者 ##

当我们需要这个为某个对象设置观察者时，可以使用一下方法：

- (void)addObserver:(NSObject *)observer 
             forKeyPath:(NSString *)keyPath
                options:(NSKeyValueObservingOptions)options 
                context:(nullable void *)context;

方法中各参数的含义：

*  observer：观察者对象
 *  keyPath：需要观察的属性在对象中的路径，相关解释如下：
    
        // 汽车类
        @interface Car : NSObject
        @property (nonatomic, copy) NSString *brandName; // 汽车品牌名称
        @end
        
        // Person 类
        @interface Person : NSObject
        @property (nonatomic, assign) NSInteger age; // 年龄
        @property (nonatomic, strong) Car *car;      // 持有的汽车对象
        @end
        
        Person *p = [Person new];
        // 如果要监听这个人的年龄，keyPath 为 @"age"
        // 如果要监听这个人的汽车的品牌名称，keyPath 为 @"car.brandName"
 *  options：监听选项，用于设置属性改变后需要接收的值。该枚举类型的定义如下：
    
        typedef NS_OPTIONS(NSUInteger, NSKeyValueObservingOptions) { 
        	// 提供属性改变后的新值
            NSKeyValueObservingOptionNew = 0x01,
            // 提供属性改变前的旧值 
            NSKeyValueObservingOptionOld = 0x02,
            // 如果指定，则在添加观察者的时候（注册方法返回前）立即发送一个通知给观察者，
            NSKeyValueObservingOptionInitial API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0)) = 0x04,
            // 如果指定，则在每次修改属性时，会在修改通知被发送之前预先发送一条通知给观察者，与-willChangeValueForKey:被触发的时间是相对应的。
            NSKeyValueObservingOptionPrior API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0)) = 0x08
        };
 *  context：上下文信息，会随着监听到的信息一起传给观察者，可以设置为`nil`。

## 2.2 接收属性改变消息 ##

如果某个类成为了观察者，就需要重写以下方法。当监听的属性值被改变时，方法就会被调用。

/// @param keyPath 发生改变的属性路径
    /// @param object 对应的观察者对象
    /// @param change 可以根据监听选项获取到相应值的字典
    /// @param context 在注册观察者时传入的上下文信息
    - (void)observeValueForKeyPath:(NSString *)keyPath 
    	                  ofObject:(id)object 
    	                    change:(NSDictionary<NSKeyValueChangeKey,id> *)change 
    	                   context:(void *)context;

## 2.3 移除观察者 ##

我们可以通过两种以下方法移除观察者。根据 Foundation 框架中的注释表述，通常我们只要使用方法 2 就可以了。

但是**当我们对同一个对象的同一属性多次添加同一个观察者，但传入不同的上下文信息(context)时**，我们就必须要使用方法 1 进行移除，同时传入的上下文信息(context)要与添加时相对应。

// 1
    - (void)removeObserver:(NSObject *)observer 
                forKeyPath:(NSString *)keyPath 
                   context:(nullable void *)context API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
    
    // 2 
    - (void)removeObserver:(NSObject *)observer
    		    forKeyPath:(NSString *)keyPath;

注意：`addObserver:` 和 `removeObserver:` 必须成对出现，否则会在观察者被释放后，因为收到 KVO 监听的消息导致 Crash。官方建议在 `init` 方法中添加观察者，`dealloc`方法中移除观察者，以保证它们可以成对出现。

## 2.4 KVO 使用实例 ##

接下来我们以一个简单的实例来演示 KVO 的使用。首先创建一个只包含 age 属性的 Person，用来作为被监听的对象。

/// Person 类
    @interface Person : NSObject
    @property(nonatomic, assign) NSInteger age; // 年龄属性
    @end

在本例中，我们给 person 对象的 age 属性添加一个监听器，当用户点击屏幕时，会更改 person 对象的 age 属性的值，进行触发 KVO。

@interface ViewController ()
    @property (nonatomic, strong) Person *person; // person对象
    @end
    
    @implementation ViewController
    
    - (void)dealloc { 
    	// 移除观察者
        [self.person removeObserver:self forKeyPath:@"age"];
    }
    
    - (void)viewDidLoad { 
        [super viewDidLoad];
        // 初始化，并设置 age 的初始值
        self.person = [[Person alloc] init];
        self.person.age = 18;
        
        // 监听选项，这里选择“原来的值”和“改变后的值”
        NSKeyValueObservingOptions options = NSKeyValueObservingOptionNew | NSKeyValueObservingOptionOld;
        // 为属性 person 添加观察者
        [self.person addObserver:self forKeyPath:@"age" options:options context:nil];
    }
    
    /// 屏幕的触摸事件
    - (void)touchesBegan:(NSSet<UITouch *> *)touches withEvent:(UIEvent *)event { 
        // 改变 age 的值
        self.person.age = 19;
    }
    
    - (void)observeValueForKeyPath:(NSString *)keyPath ofObject:(id)object change:(NSDictionary<NSKeyValueChangeKey,id> *)change context:(void *)context { 
        NSLog(@"keyPath: %@,\n object: %@,\n change: %@,\n context: %@", keyPath, object, change, context);
    }
    
    @end

在点击屏幕之后，我们可以看到控制台打印出了以下信息：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MjI5MjIyOQ_size_16_color_FFFFFF_t_70]  
可以看到，我们可以根据监听选项获取到该属性**改变前和改变后的值**。通常我们会根据 keyPath 和 object 来区分对不同属性的监听，然后改变的值来进行相应操作。

# 3. 原理剖析 #

学习一样知识，不能总停留在使用的表层，应该深入去学习它内部的实现原理，下面我们就一步步学习 KVO 的实现原理。

## 3.1 KVO 的实现 ##

我们利用 runtime 提供的 `object_getClass()` 函数去获取对象在添加 KVO 监听前和添加 KVO 监听后，`isa` 指针所指向的类对象。

NSLog(@"person 添加KVO监听之前 - %@", object_getClass(self.person));
        
    // 监听选项，这里选择“原来的值”和“改变后的值”
    NSKeyValueObservingOptions options = NSKeyValueObservingOptionNew | NSKeyValueObservingOptionOld;
    // 为属性 person 添加观察者
    [self.person addObserver:self forKeyPath:@"age" options:options context:nil];
    
    NSLog(@"person 添加KVO监听之后 - %@", object_getClass(self.person));

程序运行后可以看到控制台打印的结果：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MjI5MjIyOQ_size_16_color_FFFFFF_t_70 1]  
可以发现，在添加 KVO 监听前，person 对象的 `isa` 指针是指向 Person 类对象的；而在添加了 KVO 监听后，person 对象的 `isa` 指针是指向了一个叫 NSKVONotifying\_Person 的类对象。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MjI5MjIyOQ_size_16_color_FFFFFF_t_70 2]

这说明，KVO 的实现是通过 runtime API 生成一个叫 NSKVONotifying\_XXX 的类，然后将被监听对象的 `isa` 指针指向该类对象，以此为基础来实现的。

## 3.2 NSKVONotifying\_XXX类探究 ##

为了能够探究 NSKVONotifying\_XXX 的作用，我们可以利用下面的方法将它内部的方法列表打印出来。

// 打印类中所有的方法
    - (void)printMethodNamesOfClass:(Class)cls { 
        unsigned int outCount;
        // 获取方法数组
        Method *methodList = class_copyMethodList(cls, &outCount);
        // 存储方法名
        NSMutableString *methodNames = [NSMutableString string];
        
        // 遍历所有方法
        for (int i = 0; i < outCount; i++) { 
            // 获取方法
            Method method = methodList[i];
            // 获取方法名
            NSString *methodName = NSStringFromSelector(method_getName(method));
            [methodNames appendString:methodName];
            if (i != outCount - 1) { 
                 [methodNames appendString:@", "];
            }
        }
        free(methodList); // 需要手动释放方案列表内存
        
        NSLog(@"%@", methodNames);
    }

在添加了 KVO 之后，我们通过下面代码，打印 NSKVONotifying\_XXX 中包含的方法。

[self printMethodNamesOfClass:object_getClass(self.person)];

控制台的打印结果如下，可以看到其中包含 `setAge:`, `class`, `dealloc` 和 `_isKVOA` 四个方法。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MjI5MjIyOQ_size_16_color_FFFFFF_t_70 3]  
从我们的开发经验中，我们不难猜测， **KVO 是通过在生成的 NSKVONotifying\_XXX 类中重写 setter 方法来实现的**。

而对与其他三个方法，这里也给出基于经验猜测的参考解释：

*  `class` 是**为了对外屏蔽生成 NSKVONotifying\_XXX 类，使用者还是认为自己正在使用的是原来的类**。
    
    我们在添加 KVO 之后，利用 `class` 方法获取 person 的类，可以发现返回的还是 Person，这也侧面验证了上述的想法。
    
        NSLog(@"person 添加KVO监听之后 - %@", [self.person class]);
 *  `dealloc` 是用于在对象销毁前进行收尾工作。
 *  `_isKVO` 是为了判断该类是否为了 KVO 而生成的。

## 3.3 NSKVONotifying\_XXX 中 setter 方法的实现 ##

@implementation Person
    
    - (void)willChangeValueForKey:(NSString *)key { 
        NSLog(@"[BEGIN] willChangeValueForKey:");
        [super willChangeValueForKey:key];
        NSLog(@"[END] willChangeValueForKey:");
    }
    
    - (void)didChangeValueForKey:(NSString *)key { 
        NSLog(@"[BEGIN] didChangeValueForKey:");
        [super didChangeValueForKey:key];
        NSLog(@"[END] didChangeValueForKey:");
    }
    
    @end

# 4. 面试题解析 #

## 4.1 KVO的是如何实现的？ ##

通过 runtime API 生成 `NSKVONotifying_XXX` 类，在其中重写所监听属性的 setter 方法，然后将被监听对象的 `isa` 指针该类对象。

于是，当被监听属性的值通过 setter 方法被修改之后，就会触发 KVO。

## 4.2 如何手动触发KVO？ ##

我们可以通过调用 `willChangeValueForKey:` 和 `didChangeValueForKey:` 来触发 KVO。假如我们在 3.1 的例子中要手动触发 KVO，可以使用下面的代码。

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

## 4.3 直接改变成员变量会触发KVO吗？ ##

@interface Person : NSObject { 
        @public
        NSInteger _age; // 成员变量
    }
    @property(nonatomic, assign) NSInteger age; // 属性
    @end

我们直接对成员变量 \_age 进行修改，是不会触发 KVO的。因为 KVO 的触发，需要调用到生成 NSKVONotifying\_Person 类中的 setter 方法，直接修改成员变量是不会经过 setter 方法的，所以不会触发 KVO。

# 参考资料 #

*  [https://www.cnblogs.com/496668219long/p/4470923.html][https_www.cnblogs.com_496668219long_p_4470923.html]
 *  [https://www.jianshu.com/p/badf5cac0130][https_www.jianshu.com_p_badf5cac0130]

--------------------

看完要记得点赞哦，如果有问题可以提出来，大家交流一下~

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MjI5MjIyOQ_size_16_color_FFFFFF_t_70]: /images/20221022/295b86242237493698ae8d22fbffc435.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MjI5MjIyOQ_size_16_color_FFFFFF_t_70 1]: /images/20221022/9cd208d30fc84a1db2bdf638932ba2c7.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MjI5MjIyOQ_size_16_color_FFFFFF_t_70 2]: /images/20221022/e937da44836e457bad6d94158e403590.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MjI5MjIyOQ_size_16_color_FFFFFF_t_70 3]: /images/20221022/420a467289d94dfd84e44ad4031f6eb9.png
[https_www.cnblogs.com_496668219long_p_4470923.html]: https://www.cnblogs.com/496668219long/p/4470923.html
[https_www.jianshu.com_p_badf5cac0130]: https://www.jianshu.com/p/badf5cac0130