iOS -- KVO基本使用以及原理分析

1、 简介

KVO的全称是Key-Value Observing, 翻译过来就是键值监听，可以用于监听某个对象属性值的改变。

2、注册键值观察

您必须执行以下步骤才能使对象接收符合KVO的属性的键值观察通知：

• 添加观察者addObserver:forKeyPath:options:context:
• observeValueForKeyPath:ofObject:change:context:在观察者内部实现接受更改通知消息。
• removeObserver:forKeyPath:当不再接收消息时，使用该方法取消注册观察者。至少在观察者从内存中释放之前调用此方法。（isa指回本类）

2.1 添加观察者

观察对象首先通过发送addObserver:forKeyPath:options:context: 消息将自身作为观察者和要观察的属性的关键路径来向观察对象注册自己。 观察者还指定了一个选项参数和一个上下文指针来管理通知的各个方面。
2.1.1 Options
NSKeyValueObservingOptionOld 更改之前接收观察到的属性的值。
NSKeyValueObservingOptionNew 请求属性的新值。
NSKeyValueObservingOptionInitial 注册观察者之后会立即接收到旧值，您可以使用此附加的一次性通知来确定观察者中属性的初始值。
NSKeyValueObservingOptionPrior 一次修改会触发两次回调，
2.1.2 Context
addObserver:forKeyPath:options:context:消息中的上下文指针包含将在相应的更改通知中传递回观察者的任意数据。您可以指定NULL并完全依赖于键路径字符串来确定更改通知的来源，但是这种方法可能会导致其父类也因不同原因观察到相同键路径的对象出现问题。
一种更安全，更可扩展的方法是使用上下文来确保您收到的通知发往您的观察者而不是父类。
类中唯一命名的静态变量的地址构成了良好的上下文。在父级或子类中以类似方式选择的上下文不太可能重叠。您可以为整个类选择单个上下文，并依赖通知消息中的键路径字符串来确定更改的内容。或者，您可以为每个观察到的键路径创建不同的上下文，从而完全绕过字符串比较的需要，从而实现更有效的通知解析。
2.1.3 创建上下文指针

static void * PersonAccountBalanceContext =＆PersonAccountBalanceContext;
static void * PersonAccountInterestRateContext =＆PersonAccountInterestRateContext;

2.1.4 为balance和interestRate属性添加观察者

- (void)registerAsObserverForAccount:(Account*)account {
    [account addObserver:self
              forKeyPath:@"balance"
                 options:(NSKeyValueObservingOptionNew |
                          NSKeyValueObservingOptionOld)
                 context:PersonAccountBalanceContext];
 
    [account addObserver:self
              forKeyPath:@"interestRate"
                 options:(NSKeyValueObservingOptionNew |
                          NSKeyValueObservingOptionOld)
                  context:PersonAccountInterestRateContext];
}

2.2 实现监听方法

- (void)observeValueForKeyPath:(NSString *)keyPath
                      ofObject:(id)object
                        change:(NSDictionary *)change
                       context:(void *)context {
 
    if (context == PersonAccountBalanceContext) {
        // Do something with the balance…
 
    } else if (context == PersonAccountInterestRateContext) {
        // Do something with the interest rate…
 
    } else {
        // Any unrecognized context must belong to super
        [super observeValueForKeyPath:keyPath
                             ofObject:object
                               change:change
                               context:context];
    }
}

2.3 移除观察者

- (void)unregisterAsObserverForAccount:(Account*)account {
    [account removeObserver:self
                 forKeyPath:@"balance"
                    context:PersonAccountBalanceContext];
 
    [account removeObserver:self
                 forKeyPath:@"interestRate"
                    context:PersonAccountInterestRateContext];
}

3、KVO合规性

3.1 手动更改通知

3.1.1 automaticNotifiesObserversForKey的示例实现：

+ (BOOL)automaticallyNotifiesObserversForKey:(NSString *)theKey {
 
    BOOL automatic = NO;
    if ([theKey isEqualToString:@"balance"]) {
        automatic = NO;
    }
    else {
        automatic = [super automaticallyNotifiesObserversForKey:theKey];
    }
    return automatic;
}

要实现手动观察器通知，请willChangeValueForKey:在更改值之前以及didChangeValueForKey:更改值之后调用。

3.1.2 实现手动通知

- （void）setBalance：（double）theBalance {
    [self willChangeValueForKey：@“balance”];
    _balance = theBalance;
    [self didChangeValueForKey：@“balance”];
}

您可以通过检查值是否已更改至最小值而发送不必要的通知。

3.1.3 在提供通知之前测试更改的值

- （void）setBalance：（double）theBalance {
    if（theBalance！= _balance）{
        [self willChangeValueForKey：@“balance”];
        _balance = theBalance;
        [self didChangeValueForKey：@“balance”];
    }
}

如果单个操作导致多个键发生更改，则必须嵌套更改通知。

3.1.4 嵌套多个键的更改通知

- （void）setBalance：（double）theBalance {
    [self willChangeValueForKey：@“balance”];
    [self willChangeValueForKey：@“itemChanged”];
    _balance = theBalance;
    _itemChanged = _itemChanged + 1;
    [self didChangeValueForKey：@“itemChanged”];
    [self didChangeValueForKey：@“balance”];
}

4、注册依赖键

在许多情况下，一个属性的值取决于另一个对象中的一个或多个其他属性的值。如果一个属性的值发生更改，则还应标记派生属性的值以进行更改。
例如，人的全名取决于名字和姓氏
TZPerson.h

@interface TZPerson : NSObject

// 依赖关系的成员
@property (nonatomic, strong) NSString* fullName;
@property (nonatomic, strong) NSString* firstName;
@property (nonatomic, strong) NSString* lastName;

@end

TZPerson.m

@implementation TZPerson

- (NSString*)fullName {
    return [NSString stringWithFormat:@"%@ %@", _firstName, _lastName];
}


+ (NSSet*) keyPathsForValuesAffectingFullName
{
    return [NSSet setWithObjects:@"lastName", @"firstName", nil];
}

@end

ViewController.m

- (void)viewDidLoad {
    [super viewDidLoad];
    // Do any additional setup after loading the view.
    _p = [TZPerson new];
    
    /// 添加观察者
    [_p addObserver:self forKeyPath:@"fullName" options:NSKeyValueObservingOptionPrior | NSKeyValueObservingOptionNew context:nil];
}

// 实现监听方法
- (void) observeValueForKeyPath:(NSString *)keyPath ofObject:(id)object change:(NSDictionary *)change context:(void *)context {
    NSLog(@"%@", change);
}

- (void)touchesBegan:(NSSet *)touches withEvent:(UIEvent *)event {
    
    _p.firstName = @"三";
}

- (void) dealloc {
    [_p removeObserver:self forKeyPath:@"fullName"];
}

输出结果

2019-02-17 22:10:18.858304+0800 KVO001[13782:1308579] {
    kind = 1;
    new = "\U4e09 (null)";
}

5、KVO实现细节

使用称为isa-swizzling的技术实现自动键值观察。
该isa指针，顾名思义，指向对象的类，它保持一个调度表。该调度表基本上包含指向该类实现的方法的指针，以及其他数据。
当观察者注册对象的属性时，观察对象的isa指针被修改，指向中间类而不是真正的类。因此，isa指针的值不一定反映实例的实际类。

6、KVO原理分析

以步数为例

- (void)viewDidLoad {
    [super viewDidLoad];
    // Do any additional setup after loading the view.
    _p = [TZPerson new];
    
    /// 添加观察者
    [_p addObserver:self forKeyPath:@"steps" options:NSKeyValueObservingOptionPrior | NSKeyValueObservingOptionNew context:nil];
}

// 实现监听方法
- (void) observeValueForKeyPath:(NSString *)keyPath ofObject:(id)object change:(NSDictionary *)change context:(void *)context {
    NSLog(@"%@", change);
}

- (void)touchesBegan:(NSSet *)touches withEvent:(UIEvent *)event {
    
    _p.steps++;
}

- (void) dealloc {
    [_p removeObserver:self forKeyPath:@"steps"];
}

打断点发现isa指向

isa指向

6.1 利用runtime验证一下

Class class = NSClassFromString(@"NSKVONotifying_TZPerson");
    if (class) {
        NSLog(@"class exist");
    } else {
        NSLog(@"class not exist");
    }
    
//    /// 添加观察者
    [_p addObserver:self forKeyPath:@"steps" options:NSKeyValueObservingOptionPrior | NSKeyValueObservingOptionNew context:nil];
    
    Class class1 = NSClassFromString(@"NSKVONotifying_TZPerson");
    if (class1) {
        NSLog(@"class1 exist");
    } else {
        NSLog(@"class1 not exist");
    }

打印结果

2019-02-17 22:42:06.977372+0800 KVO001[14138:1350932] class not exist
2019-02-17 22:42:06.977829+0800 KVO001[14138:1350932] class1 exist

这就说明NSKVONotifying_TZPerson类在未添加观察者之前是不存在的，添加观察者之后NSKVONotifying_TZPerson类就存在了，也就说明这个类是动态生成的，这也是runtime强大之处，运行时动态生成一个类。

6.2 查看NSKVONotifying_TZPerson类所有的方法以及和TZPerson的关系

/// 打印对应的类及子类
- (void) printClasses:(Class) cls {
    
    /// 注册类的总数
    int count = objc_getClassList(NULL, 0);
    
    /// 创建一个数组， 其中包含给定对象
    NSMutableArray* array = [NSMutableArray arrayWithObject:cls];
    
    /// 获取所有已注册的类
    Class* classes = (Class*)malloc(sizeof(Class)*count);
    objc_getClassList(classes, count);
    
    /// 遍历s
    for (int i = 0; i < count; i++) {
        if (cls == class_getSuperclass(classes[i])) {
            [array addObject:classes[i]];
        }
    }
    
    free(classes);
    
    NSLog(@"classes = %@", array);
}

- (void) printMethods:(Class)cls {
    unsigned int count = 0;
    Method* methods = class_copyMethodList(cls, &count);
    
    NSMutableArray* array = [NSMutableArray array];
    for (int i = 0; i < count; i++) {
        Method method = methods[i];
        SEL sel = method_getName(method);
        IMP imp = method_getImplementation(method);
        NSString* methodName = NSStringFromSelector(sel);
        [array addObject:methodName];
    }
    NSLog(@"%@", array);
    free(methods);
}

结果如下:

2019-02-17 22:47:40.591036+0800 KVO001[14201:1359779] (
    "setSteps:",
    class,
    dealloc,
    "_isKVOA"
)
2019-02-17 22:47:40.638697+0800 KVO001[14201:1359779] classes = (
    TZPerson,
    "NSKVONotifying_TZPerson"
)

可以看出NSKVONotifying_TZPerson是TZPerson的子类。
总结

未被观察的对象

被观察的对象