KVO实现原理 自定义KVO

2019-06-27  本文已影响0人  铸造中

原理

注册一个中间类KVO_xxx继承自要观察的类,通过isa-swizzling将xxx类的isa指像新的的类KVO_XXX. 并且动态给新类重写setter方法,以达到属性拦截目的,从而触发回调通知观察者属性是否改变。


class的底层结构图.png

isa指针,顾名思义, 指向的对象的类维护调度表。这个调度表基本上包含指向类实现⽅方法,以 及其他数据。 将这个isa指向子类KVO_XXX从而在用户无感知的状态下实现setter方法重写。

实现步骤

--先看步骤,最后有demo。

1.自定义一个category 当调用xlAddObserver的时候开始生成中间类,当有监听的属性改变的时候触发回调
@interface NSObject (XLKVO)

//监听
-(void)xlAddObserver:(id)obj forKeypath:(NSString *)keyPath;

//回调
-(void)xlObserveValueForKeyPath:(NSString *)keyPath ofObject:(id)object;

@end
2.根据要监听的类生成一个KVO_XXX的中间类
-(void)xlAddObserver:(id)obj forKeypath:(NSString *)keyPath {
    //1.注册一个中间类XLKVO_开头的子类 继承自当前类
    Class superClass = object_getClass(self);
    NSString * newClassName = [NSString stringWithFormat:@"XLKVO_%@",NSStringFromClass(superClass)];
    //判断下是否注册过
    Class newClass;
    if (!NSClassFromString(newClassName)) {
        //创建新类
        newClass = [self registerNewClass:superClass newClassName:newClassName];
        //改变 当前类的isa只向newClass 此时所有的函数执行都要经过子类newClass了
        object_setClass(self, newClass);
    }
}

//注册一个新的类
-(Class)registerNewClass:(Class)superClass newClassName:(NSString *)newClassName{
    //生成一个类继承自superClass
    Class newClass = objc_allocateClassPair(superClass, newClassName.UTF8String, 0);
    //注册
    objc_registerClassPair(newClass);
    return newClass;
}
2.关联对象,关联observer和keypath以便重写setter的时候调用触发
//关联对象 obj,以便在后面通知执行回调方法
    objc_setAssociatedObject(self, @"xlobserver", obj, OBJC_ASSOCIATION_RETAIN);
    objc_setAssociatedObject(self, @"keyPath", keyPath, OBJC_ASSOCIATION_RETAIN);
3. 给KVO_XXX类动态追加上写要监听的属性的setter方法 。 这里的self已经经过了object_setClass(self, newClass);函数指向了新的KVO类了
   //动态给newClass添加一个setter方法 实现方法重写完成监听回调
    //注:这里的所有的self都是指的新的类
    NSString * setterName = [self setterNameFromKeyPath:keyPath];
    Method setterMethod = class_getInstanceMethod(superClass, NSSelectorFromString(setterName));
    const char * types = method_getTypeEncoding(setterMethod);
    class_addMethod(newClass, NSSelectorFromString(setterName), (IMP)xlKVOStter, types);

根据属性名字拼接setter方法

//拼接setter方法名
-(NSString *)setterNameFromKeyPath:(NSString *)name {
    NSString * firstName = [[name substringToIndex:1]uppercaseString];
    NSString * otherStr = [name substringFromIndex:1];
    return [NSString stringWithFormat:@"set%@%@:",firstName,otherStr];
}

指定setter函数的imp实现,在调用类的setter函数的时候,其实是在完成一个消息发送,objc_msgSend,最终指向行真正的函数实现,在这个地方我们就完成了属性的拦截,从而达到监听的目的。

//setter方法的IMP实现 前两个参数固定的写法 _cmd在Objective-C的方法中表示当前方法的selector
static void xlKVOStter(id self,SEL _cmd,id value) {
    //1.执行父类的方法
    //消息转发 直接去执行父类的
    //结构体 点的作用是结构体成员指定初始化
    struct objc_super superStruct = {
        .receiver = self,
        .super_class = class_getSuperclass(object_getClass(self))
    };
    //取结构体地址 执行消息发送
    objc_msgSendSuper(&superStruct,_cmd,value);
    
    
    //2.调用observer通知属性即将改变
    id obj = objc_getAssociatedObject(self, @"xlobserver");
    NSString * keyPath = objc_getAssociatedObject(self, @"keyPath");
    [obj xlObserveValueForKeyPath:keyPath ofObject:self];
   
}

细节优化

在此我们就已经完成了KVO的基本功能了,不过还有一些小细节需要优化一下。

1.在给KVO类添加setter的时候先判断一下,以免重复添加.

我们可以通过获取该类的method列表来判断是否已经追加了

//判断是否存在该方法
-(BOOL)hasSelector:(SEL)selector {
    Class myclass = object_getClass(self);
    unsigned int methodCount = 0;
    //获取该类的方法列表,列表是一个结构体指针的数组
    Method * methodList = class_copyMethodList(myclass, &methodCount);
    
    for (int i = 0; i < methodCount; i++) {
        SEL sel = method_getName(methodList[i]);
        if (sel == selector) {
            free(methodList);
            return YES;
        }
    }
    free(methodList);
    return NO;
}
2.给KVO添加一个class方法,返回父类的class,以达到无感知的目的
//重写对象的class方法,将KVO_XXX的class指向监听类的class,达到用户无感知的目的
    Method classMethod = class_getInstanceMethod(superClass, NSSelectorFromString(@"class"));
    const char * classTypes = method_getTypeEncoding(classMethod);
    class_addMethod(newClass, NSSelectorFromString(@"class"), (IMP)KVOClass, classTypes);
static Class KVOClass (id self,SEL _cmd) {
    return class_getSuperclass(object_getClass(self));
}

到此整个功能已经完成了。
需要demo可以加QQ群:839813029

上一篇下一篇

猜你喜欢

热点阅读