NSInvocation的莫名crash

2018-09-29

NSInvocation是iOS框架中对命令模式的一种OC封装，使用起来非常方便。在方法调用，或者消息转发中都可以使用到。以下是学着别人demo使用时，封装的多参数调用函数：

#import <Foundation/Foundation.h>
@interface NSObject (PerformSelector)
- (id)performSelector:(SEL)aSelector
        withArguments:(NSArray *)arguments;
@end
#import "NSObject+PerformSelector.h"
@implementation NSObject (PerformSelector)
- (id)performSelector:(SEL)aSelector
        withArguments:(NSArray *)arguments {
    if (!aSelector) {
        return nil;
    }
    NSMethodSignature *signature = [[self class] instanceMethodSignatureForSelector:aSelector];
    NSInvocation *invocation = [NSInvocation invocationWithMethodSignature:signature];
    invocation.target = self;
    invocation.selector = aSelector;
    
    if ([arguments isKindOfClass:[NSArray class]]) {
        // 减2是因为signature的参数包含固定的self和_cmd
        NSInteger count = MIN(arguments.count, signature.numberOfArguments - 2);
        for (int i = 0; i < count; i++) {
            // 返回指定index的参数类型
            const char *type = [signature getArgumentTypeAtIndex:(i + 2)];
            // 类型是OC对象（本函数的参数为NSArray，所以都是对象）
            if (strcmp(type, "@") == 0) {
                // 取出参数
                id argument = arguments[i];
                // 设置参数（copy到invocation上）
                // 【同样，invocation的参数列表中前两个也是self和_cmd】
                [invocation setArgument:&argument atIndex:(i + 2)];
            }
        }
    }
    
    // 调用函数（此时会动态配置返回值）
    [invocation invoke];
    
    // 取回返回值    
    id returnValue = @1;
    if (strcmp(signature.methodReturnType, "@") == 0) {
        // 返回值是OC对象，取回赋值到指针（这里是给野指针赋值，使其存在内容）
        [invocation getReturnValue:&returnValue];
    }
    return returnValue;
}
@end

示例类如下：

#import <Foundation/Foundation.h>
@interface TestClass : NSObject
- (NSString *)saySomething:(NSString *)a
                         b:(NSString *)b
                         c:(NSString *)c;
@end
#import "TestClass.h"
@implementation TestClass
- (instancetype)init {
    if (self = [super init]) {
        
    }
    return self;
}
- (NSDictionary *)saySomething:(NSString *)a
                             b:(NSString *)b
                             c:(NSString *)c {
    return @{
             @"a": a,
             @"b": b,
             @"c": c
             };
}
@end

调用如下：

1
2
3

TestClass *tc = [[TestClass alloc] init];
        result = [tc performSelector:@selector(saySomething:b:c:) withArguments:@[@"Tom", @"Jim", @"Li Lei"]];
        NSLog(@"result = %@", result);

以上，解决了使用performSelector调用时只能传递单个参数的尴尬问题。但是，问题来了~~

运行时，会发生crash。try-catch也无法捕获异常，觉得颇为诡异。之后，再打开zombie检测后，发现如下输出：

1	2018-09-29 17:15:18.926491+0800 InvocationTest1[37029:49376429] *** -[__NSDictionaryI release]: message sent to deallocated instance 0x60000086aec0

原来是返回值被过渡释放导致。

究其原因，可以在NSInvocation的类文档中查到，主要就一句：

This class does not retain the arguments for the contained invocation by default.

即为，本类默认不对参数进行保留操作。

实质上，不仅如此，通过调用getReturnValue:方法并查阅说明可以知道，此方法只是根据给定的指针，创建buffer并将返回值写入其中。并未对其进行内存管理。

现在回到代码。由于performSelector函数中，只是使用了临时变量指向并返回，导致NSInvocation的返回值对象的引用计数实际上是0，即创建完就要被释放。所以，当performSelector函数执行完成后，实际上返回值已经被释放。由于外侧调用者也没有对其进行保留等其他操作，导致调用者的作用域结束后，返回值会再次收到release操作，即发生crash。

那么，如何解决此问题呢？
两种方式：

在调用NSInvocation对象的getReturnValue:方法时，不要传入OC对象指针，使用C指针（void *），并在最终桥接转换为OC对象。这种是本人比较推荐的方式，由于此实质上是往buffer内写入内容，使用C指针会更加严谨，而且避免了ARC内存释放导致的crash，返回时桥接转换为对象即可（这种情况也兼容所有数据类型）。

将performSelector的代码修正为：

void *returnValue = NULL;
if (strcmp(signature.methodReturnType, "@") == 0) {
    // 返回值是OC对象，取回赋值到指针（这里是给野指针赋值，使其存在内容）
    [invocation getReturnValue:&returnValue];
}
return (__bridge id)returnValue;

使用__unsafe_unretained修饰OC指针，避免ARC对返回值进行内存管理。使用__weak同样可以达到效果，不过感觉上有点懵，需要继续深入查看内存管理相关的内容了。。。

id __unsafe_unretained returnValue = @1;
if (strcmp(signature.methodReturnType, "@") == 0) {
    // 返回值是OC对象，取回赋值到指针（这里是给野指针赋值，使其存在内容）
    [invocation getReturnValue:&returnValue];
}
return returnValue;

问题解决。。。

测试程序代码：测试NSInvocation调用