iOS-KVO

KVO(Key-Value observing):是苹果提供的一套事件通知机制.允许对象监听另一个对象特定属性的改变,并在属性发生改变时接收到事件.由于KVO的实现机制,所以对属性才会发生作用;一般继承自NSObject的对象都默认支持KVO.KVO是iOS中观察者模式的一种实现.KVO是一对一的,而不是一对多.

使用规则:

1.[obj addObserver:<#(nonnull NSObject *)#> forKeyPath:<#(nonnull NSString *)#> options:<#(NSKeyValueObservingOptions)#> context:<#(nullable void *)#>];
 obj:添加观察者(被观察对象)
 参数1:观察者
 参数2:被观察的属性
 参数3://NSKeyValueObservingOptionNew :得到新值时就会走我们的KVO方法.change字典中的key值就是new;
 //NSKeyValueObservingOptionOld:有旧值出现时就会触发我们的kvo方法,并且我们得到的change中的key为old,old对应的值为我们的旧值,并得不到新值.
 //NSKeyValueObservingOptionInitial:初始化时就会走我们的方法,但是我们并得不到任何新值旧值,他会在初始化的时候走一次kvo方法,等值改变时也会走我们的方法,只是得不到新或者旧值.
 //NSKeyValueObservingOptionPrior:触发时机在值改变前走一次方法,改变后又走一次我们的kvo方法.
 //组合使用:NSKeyValueObservingOptionNew &NSKeyValueObservingOptionOld有新值并且有旧值的出现,才能走我们的kvo方法.

2.谁作为观察者 谁就去实现这个kvo的方法
 -(void)observeValueForKeyPath:(NSString *)keyPath ofObject:(id)object change:(NSDictionary *)change context:(void *)context{}
3.谁添加谁移除,你让谁去看,或者说是观察,你就移除谁. key就是你的观察的属性名
 [self removeObserver:self.wsP forKeyPath:@"xx"];
4.kvo监听到数据变化时走的方法.他和添加监听者是成对出现的.一定不要落下

KVO本质总结:

• KVO是通过isa-swizzling技术实现的.在运行时根据原类创建一个中间类,这个中间类是原类的子类,并动态修改当前对象的isa指向中间类.并且将class方法重写,返回原类的Class.所以苹果建议在开发中不应该依赖isa指针,而是通过class实例方法来获取对象类型.
  KVO会重写keyPath对应属性的setter方法,没有被KVO的属性则不会重写其setter方法.在重写的setter方法中,修改值之前会调用willChangeValueForKey:方法,修改值之后会调用didChangeValueForKey:方法.这两个方法最终都会被调用到observeValueForKeyPath:ofObject:change:context:方法中.

(以WSPerson/age为例):

1.当wsP注册一个观察者添加KVO监听时,系统会修改这个对象的isa指针指向.KVO在运行时会动态生成一个新的子类:NSKVONotifying_WSPerson类(self.wsP.isa =NSKVONotifying_WSPerson),然后让instance对象的isa指针指向这个全新的子类,内部实现Class重写操作.这个全新子类的类对象的superclass指针才指向了WSPerson.
2.NSKVONotifying_WSPerson重写了setAge:方法.当调用setAge:方法的时候,通过查看IMP地址,实际上调用的是Foundation框架里的_NSSetIntValueAndNotify函数.//NSLog(@"%p",[self.wsP methodForSelector:@selector(setAge:)])   //--> 0x1ae1c6120   -->  p (IMP)0x1ae1c6120 -->  (IMP) $0 = 0x00000001ae1c6120 (Foundation`_NSSetIntValueAndNotify) 
3._NSSetIntValueAndNotify函数里面先是调用了[self willChangeValueForKey:@"age"] -> [super setAge:age]->[self didChangeValueForKey:@"age"];,然后在didChangeValueForKey:方法内部又会调用监听器的observeValueForKeyPath:ofObject:change:context:监听方法.
4.重写屏蔽内部实现 隐藏了NSKVONotifying_WSPerson类的存在
 -(Class)class{
     return [WSPerson class];
 }// NSLog(@"wsP进行kvo的类对象===%@  ==%s",[self.wsP class] ,object_getClassName(self.wsP));   --> wsP进行kvo的类对象===WSPerson  ==NSKVONotifying_WSPerson

演示代码

ViewController.h

//
//  ViewController.h
//  wsKVO
//
//  Created by ws on 2021/6/4.
//

#import 

@interface ViewController : UIViewController


@end

ViewController.m

//
//  ViewController.m
//  wsKVO
//
//  Created by ws on 2021/6/4.
//

#import "ViewController.h"
#import "WSPerson.h"
#import //包含对类、成员变量、属性、方法的操作

@interface ViewController ()
@property(nonatomic,strong)WSPerson *wsP;
@property(nonatomic,strong)UIButton *myBtn;
@property(nonatomic,copy)NSString *wsTestStr0;
@property(nonatomic,copy)NSString *wsTestStr1;
@property(nonatomic,copy)NSString *wsTestStr2;

@property(nonatomic,strong)NSMutableArray *wsArray;
@property(nonatomic,strong)NSMutableArray *wsArray1;
@end

@implementation ViewController
-(NSMutableArray *)wsArray{
    if (!_wsArray) {
        _wsArray = [NSMutableArray array];
    }
    return _wsArray;
}

-(NSMutableArray *)wsArray1{
    if (!_wsArray1) {
        _wsArray1 = [NSMutableArray array];
    }
    return _wsArray1;
}

-(WSPerson *)wsP{
    if (!_wsP) {
        _wsP = [[WSPerson alloc] init];
    }
    return _wsP;
}

-(UIButton *)myBtn{
    if (!_myBtn) {
        _myBtn = [UIButton buttonWithType:UIButtonTypeCustom];
        [_myBtn setBackgroundColor:[UIColor cyanColor]];
        _myBtn.bounds = CGRectMake(0.0, 0.0, 100.0, 100.0);
        _myBtn.center = self.view.center;
        [_myBtn addTarget:self action:@selector(myBtnClickAction) forControlEvents:UIControlEventTouchUpInside];
    }
    return _myBtn;
}

- (void)viewDidLoad {
    [super viewDidLoad];
//    [self ws_getMethodsAction];//获取进行kvo对象的方法列表
    [self.view addSubview:self.myBtn];
    NSLog(@"进行kvo之前的类对象==%s",object_getClassName(self.wsP));//进行kvo的类对象==WSPerson
    //自动监听wsTestStr0属性的变化
    [self addObserver:self forKeyPath:@"wsTestStr0" options:NSKeyValueObservingOptionNew context:nil];
    //自动监听wsTestStr1属性的变化
    [self addObserver:self.wsP forKeyPath:@"wsTestStr1" options:NSKeyValueObservingOptionNew context:nil];
    //手动监听wsTestStr1属性的变化
    [self addObserver:self.wsP forKeyPath:@"wsTestStr2" options:NSKeyValueObservingOptionNew context:nil];
    //自动监听wsArray数组属性的变化
    [self addObserver:self forKeyPath:@"wsArray" options:NSKeyValueObservingOptionNew context:nil];
    //自动监听wsArray1数组属性的变化
    [self addObserver:self forKeyPath:@"wsArray1" options:NSKeyValueObservingOptionNew context:nil];
    //自动监听wsP.age属性的变化
    //此处控制器打印 p self.wsP.isa结果 ----> WSPerson
    [self.wsP addObserver:self forKeyPath:@"age" options:NSKeyValueObservingOptionNew context:nil];
    //此处控制器打印 p self.wsP.isa结果 ----> NSKVONotifying_WSPerson
    NSLog(@"wsP进行kvo的类对象===%@  ==%s",[self.wsP class] ,object_getClassName(self.wsP));//wsP进行kvo的类对象===WSPerson  ==NSKVONotifying_WSPerson

    //查看IMP地址
    NSLog(@"%p",[self.wsP methodForSelector:@selector(setAge:)]);
//    [self ws_getMethodsAction];//获取进行kvo对象的方法列表
}

#pragma mark 监听wsTestStr0的变化
//谁作为观察者 谁就去实现这个kvo的方法
-(void)observeValueForKeyPath:(NSString *)keyPath ofObject:(id)object change:(NSDictionary *)change context:(void *)context{
    if ([keyPath isEqualToString:@"wsTestStr0"]) {
        NSLog(@"wsTestStr0/字典 == %@",change);
    }else if ([keyPath isEqualToString:@"wsArray"]) {
        NSLog(@"wsArray/字典 == %@",change);
    }else if ([keyPath isEqualToString:@"wsArray1"]) {
        NSLog(@"wsArray1/字典 == %@",change);
    }else if ([keyPath isEqualToString:@"age"]){
        NSLog(@"age ==%@",change);
    }
}

#pragma mark 测试按钮点击事件
-(void)myBtnClickAction{
    //自动监听wsTestStr0
    self.wsTestStr0 = @"自动监听wsTestStr0";
    
    //自动监听wsTestStr1
    self.wsTestStr1 = @"自动监听wsTestStr1";
    
    /**
    手动监听wsTestStr2:
    步骤1.执行willChangeValueForKey和didChangeValueForKey
    步骤2.重写automaticallyNotifiesObserversForKey 把key等于wsTestStr2的属性返回NO
     */
    [self willChangeValueForKey:@"wsTestStr2"];
    self.wsTestStr2 = @"手动监听wsTestStr2";
    [self didChangeValueForKey:@"wsTestStr2"];
    
    //自动监听(集合)数组变化的两种方式:
    //方式1:需要重写系统自动生成的两个方法--插入和删除,而且两个方法必须同时写.这样数组内容发生改变的时候才会走监听的方法
    [self insertObject:@"1" inWsArrayAtIndex:self.wsArray.count];
    //方式2:通过mutableArrayValueForKeyPath 方法可以不用重写他的 增删改方法. 当数据发生改变的时候 也能触发KVO方法
    [[self mutableArrayValueForKeyPath:@"wsArray1"] addObject:@"11"];
    
    //自动监听wsP.age
    self.wsP.age = 10;
}

//重写插入方法
-(void)insertObject:(id)object inWsArrayAtIndex:(NSUInteger)index{
    [self.wsArray insertObject:object atIndex:index];
}
//重写删除方法
-(void)removeObjectFromWsArrayAtIndex:(NSUInteger)index{
    [self.wsArray removeObjectAtIndex:index];
}

//重写替换方法
-(void)replaceObjectInWsArrayAtIndex:(NSUInteger)index withObject:(id)object{
    [self.wsArray replaceObjectAtIndex:index withObject:object];
}


//默认返回YES,自动监听
+(BOOL)automaticallyNotifiesObserversForKey:(NSString *)key{
    if ([key isEqualToString:@"wsTestStr1"]) {
        //自动监听
        return YES;
    }else if ([key isEqualToString:@"wsTestStr2"]) {
        //手动监听
        return NO;
    }else{
        //wsTestStr0  wsArray
        return YES;
    }
}

#pragma mark 获取进行kvo对象的方法列表
-(void)ws_getMethodsAction{
    //获取函数数组
    Class wsClass = self.wsP.class;
    unsigned int wsCount = 0;
    Method *wsMethodArray = class_copyMethodList(wsClass, &wsCount);
    for (int i = 0; i < wsCount; i++) {
        SEL methodName = method_getName(wsMethodArray[i]);
        NSString *wsMethodNameStr = NSStringFromSelector(methodName);
        NSLog(@"--%@",wsMethodNameStr);//setXX: XX
    }
    //c语言创建 手动移除
    free(wsMethodArray);
}

-(void)dealloc{
    //谁添加谁移除,你让谁去看,或者说是观察,你就移除谁. key就是你的观察的属性名
    [self removeObserver:self forKeyPath:@"wsTestStr0"];
    [self removeObserver:self.wsP forKeyPath:@"wsTestStr1"];
    [self removeObserver:self.wsP forKeyPath:@"wsTestStr2"];
    [self removeObserver:self forKeyPath:@"wsArray"];
    [self removeObserver:self forKeyPath:@"wsArray1"];
    
    [self.wsP removeObserver:self forKeyPath:@"age"];
}

@end

WSPerson.h

//
//  WSPerson.h
//  wsKVO
//
//  Created by ws on 2021/6/4.
//

#import 

NS_ASSUME_NONNULL_BEGIN

@interface WSPerson : NSObject
@property(nonatomic,assign)int age;
@end

NS_ASSUME_NONNULL_END

WSPerson.m

//
//  WSPerson.m
//  wsKVO
//
//  Created by ws on 2021/6/4.
//

#import "WSPerson.h"

@implementation WSPerson
//谁作为观察者 谁就去实现这个kvo的方法
-(void)observeValueForKeyPath:(NSString *)keyPath ofObject:(id)object change:(NSDictionary *)change context:(void *)context{
    if ([keyPath isEqualToString:@"wsTestStr1"]) {
        NSLog(@"自动触发wsTestStr1/字典 == %@",change);
    }else if ([keyPath isEqualToString:@"wsTestStr2"]){
        NSLog(@"手动触发wsTestStr2/字典 == %@",change);
    }
}

@end

kvo前后isa指向对比.png

kvo前后setAge的imp对比.png