Objective-C 消息转发

作者: 要上班的斌哥 | 来源:发表于2017-04-15 15:28 被阅读93次

    快速转发

    什么是快速转发呢?我们假设有这么一个对象 CacheProxy,若是有未知的选择器发送到 CacheProxy,objc_msgSend 都会调用 CacheProxy 的 forwardingTargetForSelector: 方法,如果这个方法返回一个对象,那么 objc_msgSend 会试着将这个未知的选择器发送给返回的那个对象,这就是快速转发(fast forwarding)。那么我们可以利用这个快速转发的特性来代理对象。

    我们使用 CacheProxy 这个对象来说明如何利用快速转发的特性来缓存其他对象的 setter 和 getter 方法。

    // CacheProxy.h
    #import <Foundation/Foundation.h>
    // 快速转发 :若是有未知的选择器发送到 CacheProxy,objc_msgSend 都会调用 CacheProxy 的 forwardingTargetForSelector: 方法,如果这个方法返回一个对象,那么 objc_msgSend 会试着将这个未知的选择器发送给返回的那个对象。
    @interface CacheProxy : NSProxy
    // 初始化方法 ,返回类型为 id 类型,可以避免编译器报错
    - (id)initWithObject:(id)anObject properties:(NSArray *)properties;
    @end
    

    值的注意的是 CacheProxy 并不是 NSObject 的子类,而是 NSProxy 的子类,NSProxy 是一个轻量级的根类,是为那些转发大部分方法调用的类而设计的。CacheProxy 本身就是一个代理对象,适合成为 NSProxy 的子类。

    // CacheProxy.m
    #import "CacheProxy.h"
    #import <objc/runtime.h>
    
    @interface CacheProxy ()
    
    @property (nonatomic,strong) id object;//被代理的对象
    @property (nonatomic,strong) NSMutableDictionary *valueForProperty;// 用于保存被代理对象的属性值
    
    @end
    
    @implementation CacheProxy
    
    // setFoo: -> foo
    // 通过 selector 得到属性名
    static NSString *propertyNameForSelector(SEL selector){
    // 省略代码
    }
    
    // foo -> setFoo:
    // 通过属性名得到 selector
    static SEL setterForPropertyName(NSString *property){
    // 省略代码
    }
    
    // getter 方法实现
    static id propertyIMP(id self, SEL _cmd){
        NSString *propertyName = NSStringFromSelector(_cmd);
        id value = [[self valueForProperty] valueForKey:propertyName];
        // NSMutableDictionary 不能存储 nil,所以使用 NSNull 来处理 nil
        if (value == [NSNull null]) {
            return nil;
        }
    
        if (value) {
            return value;
        }
    
        // 从缓存对象取不到属性值的话,那么从原对象取属性值
        value = [[self object] valueForKey:propertyName];
        // 从原对象取属性值之后,将属性值缓存到缓存对象
        [[self valueForProperty] setValue:value forKey:propertyName];
    
        return value;
    }
    
    // setter 方法实现
    static void setPropertyIMP(id self, SEL _cmd, id aValue){
        id value = [aValue copy];
        NSString *propertyName = propertyNameForSelector(_cmd);
        // 先将属性值设置到缓存对象,再将属性值设置到原对象
        [[self valueForProperty] setValue:(value != nil ? value : [NSNull null]) forKey:propertyName];
        [[self object] setValue:value forKey:propertyName];
    }
    
    
    - (id)initWithObject:(id)anObject properties:(NSArray *)properties{
        _object = anObject;
        _valueForProperty = [NSMutableDictionary new];
        // 缓存对象为 anObject 的所有属性生成 setter 和 getter 方法
        for(NSString *property in properties){
            // 添加 getter 方法
            class_addMethod([self class], NSSelectorFromString(property), (IMP)propertyIMP, "@@:");
            // 添加 setter 方法
            class_addMethod([self class], setterForPropertyName(property), (IMP)setPropertyIMP, "v@:@");
        }
        return self;
    }
    
    // 覆写以下方法,CacheProxy 缓存对象对外可以被识别为 object 对象
    - (NSString *)description{
        return [NSString stringWithFormat:@"%@ (%@)",[super description],self.object];
    }
    
    - (BOOL)isEqual:(id)object{
        return [self.object isEqual:object];
    }
    
    - (NSUInteger)hash{
        return [self.object hash];
    }
    
    - (BOOL)respondsToSelector:(SEL)aSelector{
        return [self.object respondsToSelector:aSelector];
    }
    
    - (BOOL)isKindOfClass:(Class)aClass{
        return [self.object isKindOfClass:aClass];
    }
    
    
    // 如果有未知的选择器发送到 CacheProxy 缓存对象,在这里把所有的未知选择器都发送给代理对象。
    // 快速转发
    - (id)forwardingTargetForSelector:(SEL)aSelector{
        return self.object;
    }
    
    - (NSMethodSignature *)methodSignatureForSelector:(SEL)sel{
        return [self.object methodSignatureForSelector:sel];
    }
    
    - (void)forwardInvocation:(NSInvocation *)invocation{
        [invocation setTarget:self.object];
        [invocation invoke];
    }
    
    @end
    
    1. 方法 static NSString *propertyNameForSelector(SEL selector) 用于通过 selector 得到属性名。

    2. 方法 static SEL setterForPropertyName(NSString *property)用于通过属性名得到 selector。

    3. 方法 static id propertyIMP(id self, SEL _cmd) 是一个 getter 方法实现。由于 NSMutableDictionary 不能存储 nil,所以使用 NSNull 来处理 nil。从 CacheProxy 这个缓存对象对象取不到属性值的话,那么从被代理对象取属性值。 从被代理对象取属性值之后,将属性值缓存到缓存对象。

    4. 方法 static void setPropertyIMP(id self, SEL _cmd, id aValue) 是一个 setter 方法实现。 先将属性值设置到缓存对象,再将属性值设置到被代理对象。

    5. forwardingTargetForSelector: 方法,如果有未知的选择器发送到 CacheProxy 缓存对象,在这里把所有的未知选择器都发送给被代理对象。

    6. 如果被代理的对象不响应 CacheProxy 发送过来的未知选择器,那么 objc_msgSend会调用 methodSignatureForSelector: 和 forwardInvocation: 进行普通转发。

    7. 初始化方法 initWithObject: properties: 做的工作是代理对象生成被代理对象的属性 setter 和 getter 方法。

    8. 由于 NSProxy 有一些方法的默认实现,有默认实现的方法则不会被转发到代理对象,所以需要覆写以下方法。

    - (NSString *)description{
        return [NSString stringWithFormat:@"%@ (%@)",[super description],self.object];
    }
    
    - (BOOL)isEqual:(id)object{
        return [self.object isEqual:object];
    }
    
    - (NSUInteger)hash{
        return [self.object hash];
    }
    
    - (BOOL)respondsToSelector:(SEL)aSelector{
        return [self.object respondsToSelector:aSelector];
    }
    
    - (BOOL)isKindOfClass:(Class)aClass{
        return [self.object isKindOfClass:aClass];
    }
    

    创建完了 CacheProxy 这个代理对象,我们再创建一个 被代理对象 CachePerson

    #import <Foundation/Foundation.h>
    @interface CachePerson : NSObject
    // 2个属性
    @property (nonatomic,copy) NSString *firstName;
    @property (nonatomic,copy) NSString *lastName;
    @end
    

    接下来看看如何使用 CacheProxy 这个代理对象

        // 说明 CacheProxy 如何缓存其他对象的 setter 和 getter 方法
        NSLog(@"------------------------------------------");
        id cachePerson = [[CachePerson alloc] init];
        id cacheProxy = [[CacheProxy alloc] initWithObject:cachePerson properties:@[@"firstName",@"lastName"]];
        // 设置 CacheProxy 对象的属性, cachePerson 这个被代理对象的属性也有值
        [cacheProxy setFirstName:@"CCCC"];
        [cacheProxy setLastName:@"DDDD"];
        NSLog(@"CacheProxy : firstName-->%@,  lastName--->%@",[cacheProxy firstName],[cacheProxy lastName]);
        NSLog(@"CachePerson : firstName-->%@,  lastName--->%@",[cachePerson firstName],[cachePerson lastName]);
    
        // 说明快速转发
        NSLog(@"------------------------------------------");
        // 只设置被代理对象 CachePerson 的属性,利用快速转发的特性 CacheProxy 也能拿到 CachePerson 的属性
        id cachePerson2 = [[CachePerson alloc] init];
        [cachePerson2 setFirstName:@"EEEE"];
        [cachePerson2 setLastName:@"FFFF"];
    
        id cacheProxy2 = [[CacheProxy alloc] initWithObject:cachePerson2 properties:@[@"firstName"]];
        NSLog(@"CacheProxy2 : firstName-->%@,  lastName--->%@",[cacheProxy2 firstName],[cacheProxy2 lastName]);
        NSLog(@"CachePerson2 : firstName-->%@,  lastName--->%@",[cachePerson2 firstName],[cachePerson2 lastName]);
    

    运行结果:

     ------------------------------------------
    CacheProxy : firstName-->CCCC,  lastName--->DDDD
    CachePerson : firstName-->CCCC,  lastName--->DDDD
     ------------------------------------------
    CacheProxy2 : firstName-->EEEE,  lastName--->FFFF
    CachePerson2 : firstName-->EEEE,  lastName--->FFFF
    

    从运行结果来看,第一个案例,我们设置了 CacheProxy 对象的属性 firstName 和 lastName, cachePerson 这个被代理对象的属性 firstName 和 lastName 也拿到了对应的值。第二个案例,我们只设置被代理对象 CachePerson 的属性 firstName 和 lastName 的值,但是利用快速转发的特性 CacheProxy 也能拿到 CachePerson 的属性 firstName 和 lastName 的值。

    普通转发

    在前面的快速转发失效之后,也就是经过 resolveInstanceMethod: 和 forwardingTargetForSelector: 方法之后还是无法找到未知选择器的响应对象,那么 Runtime 就会尝试最慢的转发方式 forwardInvocation: 方法。

    - (void)forwardInvocation:(NSInvocation *)invocation{
        [invocation setTarget:self.object];
        [invocation invoke];
    }
    

    如上面代码所示,在 forwardInvocation: 方法会收到一个 NSInvocation 参数,这个 NSInvocation 类把目标,选择器,方法签名和方法参数封装在一起。我们可以在方法内部改变 NSInvocation 的目标然后再调用。

    若是类有实现 forwardInvocation: 方法,那么也需要实现 methodSignatureForSelector: 方法, NSInvocation 类的方法签名就是来自于这个方法。

    在 forwardInvocation:方法中,我们可以看到该方法没有任何返回值,但是 Runtime 会把 NSInvocation 的结果返回给最初的调用者。

    转发失败

    在整个消息转发过程都没有为未知选择器找到响应对象,那么接下来要怎么办?
    由于 forwardInvocation:是消息转发过程的最后一环,若是它不处理这个未知选择器的话,那么就什么也不会发生,也可以利用这个特点来丢弃某些方法。但是 forwardInvocation: 的默认实现会有一些动作,它会调用 doesNotReconizeSelector:方法,该方法会抛出 NSInvalidArgumentException。

    我们平常也可以使用 doesNotReconizeSelector:方法做一些自己的事情,比如某个类的 init 方法不允许调用,那么有如下实现方案。

    - (id)init{
        [self doesNotReconizeSelector:_cmd];
    }
    

    要是有人调用 init 方法, Runtime 会报错。
    其实要实现这个效果还可以这么做,

    - (id)init{
        NSAssert(NO,"不要直接调用 init 方法");
        return nil;
    }
    

    最后值得注意的是,当有一个类无法响应未知的选择器的时候应该在 forwardInvocation:中调用 doesNotReconizeSelector: 。除非你非常清楚你想要做什么,不然不要直接返回,直接返回可能会导致一些非常蛋疼的 bug 。

    参考

    本文是《iOS 编程实战》的读书笔记,对阅读的内容进行总结。当我们看懂了之后,不一定懂;我们跟着书上代码敲了一遍之后,还是不一定懂;只有我们能够把自己理解的内容写下来或者通过其它方式表达出来的时候,这个才是真的懂了;

    1. demo https://github.com/junbinchencn/DynamicWork
    2. iOS编程实战 https://book.douban.com/subject/25976913/
    3. https://developer.apple.com/library/content/documentation/Cocoa/Conceptual/ObjCRuntimeGuide/Articles/ocrtForwarding.html#//apple_ref/doc/uid/TP40008048-CH105-SW2

    相关文章

      网友评论

        本文标题:Objective-C 消息转发

        本文链接:https://www.haomeiwen.com/subject/knynattx.html