NSInvocation setReturnValue 为NSObject时Bad Access问题

示例代码可参照：hotacool/aspect 的AspectsDemoTests

问题概述

需求：ARC模式下，使用aspect，hook一个返回数组的实例方法，像原返回数组中插入一条数据。如下代码，需要getArray返回@[@"222", @"111"]

// test class:
@implementation TestClass
- (NSArray*)getArray {
    return @[@"111"];
}
@end
// aspect hook
id aspect = [TestClass aspect_hookSelector:@selector(getArray)
                                   withOptions:AspectPositionInstead
                                    usingBlock:^(id info){
                                        NSArray *originRetValue;
                                        [[info originalInvocation] invoke];
                                        [[info originalInvocation] getReturnValue:&originRetValue];
                                        NSMutableArray *retValue = [NSMutableArray arrayWithArray:originRetValue];
                                        [retValue insertObject:@"222" atIndex:0];
                                        [[info originalInvocation] setReturnValue:&retValue];
                                    }
                                         error:nil];

问题: 上面aspect hook方式肯定是错误的，会crash报错EXC_BAD_ACCESS。

原因分析

NSInvocation setReturnValue 是指针操作
首先我们知道，NSInvocation的setReturnValue是指针操作：

- (void)setReturnValue:(void *)retLoc;
- (void)setArgument:(void *)argumentLocation atIndex:(NSInteger)idx;

对于基础数据类型的变量，我们可以直接&var取指针地址：

id aspect = [testClass aspect_hookSelector:@selector(callReturnsDouble) withOptions:AspectPositionInstead usingBlock:^(id info){
        double toReturn = 3.5;
        void *ptr = &toReturn;
        [info.originalInvocation setReturnValue:ptr];
    }error:NULL];

由于基础数据类型的内存管理上的特殊性，不用担心被提前释放，造成野指针的情况。同理，NSString虽然继承于NSObject，但由于编译器的内部优化，使用语法糖形式（@"xxx"）而不通过alloc方式创建时，并没有分配内存到堆区，和基础类型一样可以通过如下方式操作：

// testInsteadHook: test succeed
id aspect = [testObject aspect_hookSelector:@selector(name) withOptions:AspectPositionInstead usingBlock:^(id info) {
        NSString *customText = @"Custom Text";
        [[info originalInvocation] setReturnValue:&customText];
    } error:NULL];
// alloc 方式会crash
id aspect = [testObject aspect_hookSelector:@selector(name) withOptions:AspectPositionInstead usingBlock:^(id info) {
        NSString *customText = [[NSString alloc] initWithUTF8String:"(nonnull const char *)"];
        [[info originalInvocation] setReturnValue:&customText];
    } error:NULL];

ARC模式下，对象创建后，出了autorelease pool会被自动释放
回到我们的问题，ARC模式下会为block范围创建autorelease pool，当在aspect的block中创建新的数组对象，会将对象自动retain到堆区，当block结束，对象自动释放，当invocation内部再调用到这个对象时，会出现EXC_BAD_ACCESS crash。
作为验证，我们可以在外部保存对象的内存不释放，不会导致crash：

NSString *__block customText;//内存不释放，不会crash
    id aspect = [testObject aspect_hookSelector:@selector(name) withOptions:AspectPositionInstead usingBlock:^(id info) {
        customText = [[NSString alloc] initWithUTF8String:"(nonnull const char *)"];
        [[info originalInvocation] setReturnValue:&customText];
    } error:NULL];

    NSLog(@"%@", testObject.name);

解决方案

保持对象的内存不释放，当然不是个好方案。我们需要使新增的对象跟origin method内部的对象一样的内存生命周期。这里分两种不同需求情况：

不需要更改或者新增返回对象的内存地址
如果不需要改变origin method内部的返回对象内存地址，即对象内存指针，我们可以直接获取origin return value的指针并返回，这里我们使用TestClass做例子而不能用NSString：

// crash with EXC_BAD_ACCESS
TestClass *testObject = [TestClass new];
    id aspect = [TestClass aspect_hookSelector:@selector(getArray) withOptions:AspectPositionInstead usingBlock:^(id info) {
        NSArray *originRetValue;
        [[info originalInvocation] invoke];
        [[info originalInvocation] getReturnValue:&originRetValue];
        [[info originalInvocation] setReturnValue:&originRetValue];
    } error:NULL];
    NSLog(@"%@", [testObject getArray]);

直接使用NSArray *originRetValue的指针肯定是crash的，因为它在block内部被retain，出了block被释放，会出现野指针。为了不提前释放，我们可以使用__unsafe_unretained来表明该变量不会retain对象：

// test succeed
TestClass *testObject = [TestClass new];
    id aspect = [TestClass aspect_hookSelector:@selector(getArray) withOptions:AspectPositionInstead usingBlock:^(id info) {
        __unsafe_unretained NSArray * originRetValue;
        [[info originalInvocation] invoke];
        [[info originalInvocation] getReturnValue:&originRetValue];
        [[info originalInvocation] setReturnValue:&originRetValue];
    } error:NULL];
    NSLog(@"%@", [testObject getArray]);

这里要理解__unsafe_unretained修饰词，__unsafe_unretained 跟主要跟 C 代码交互，跟weak功能相似，不会retain对象，但是它没有weak自动设置nil的功能。所以你必须准确知道修饰对象的内存生命周期，确保不会因为提前释放，而导致调用野指针。
在我们这里，它表示originRetValue不会retain origin method内部返回值，返回值还是它原来的内存管理，所以出了block，仍然可以完成invocation的使用。

需要改变返回对象的内存地址
回到本例，我们显然需要改变内存地址，NSArray不可变，无法满足修改的要求。这里笔者没有在网上找到合理的的解决方案，目前的方案是，直接绑定新增对象到origin return value，与原返回值同生命周期：

- (void)testObjectInsteadHook {
    TestClass *testObject = [TestClass new];
    XCTAssertEqualObjects([testObject getArray], @[@"111"], @"Must match");
    id aspect = [TestClass aspect_hookSelector:@selector(getArray)
                                   withOptions:AspectPositionInstead
                                    usingBlock:^(id info){
                                        __unsafe_unretained NSArray *originRetValue;
                                        [[info originalInvocation] invoke];
                                        [[info originalInvocation] getReturnValue:&originRetValue];
                                        NSMutableArray *retValue = [NSMutableArray arrayWithArray:originRetValue];
                                        __block BOOL isContain = NO;
                                        [retValue enumerateObjectsUsingBlock:^(NSString * _Nonnull obj, NSUInteger idx, BOOL * _Nonnull stop) {
                                            if ([obj isEqualToString:@"222"]) {
                                                isContain = YES;
                                                *stop = YES;
                                            }
                                        }];
                                        if (!isContain) {
                                            [retValue insertObject:@"222" atIndex:0];
                                        }
                                        objc_setAssociatedObject(originRetValue, "kRetValueKey", retValue, OBJC_ASSOCIATION_RETAIN_NONATOMIC);//与originRetValue同生命周期
                                        [[info originalInvocation] setReturnValue:&retValue];
                                    }
                                         error:nil];
    XCTAssertEqualObjects([testObject getArray], (@[@"222", @"111"]), @"Must match");
    XCTAssertTrue([aspect remove], @"Must return YES");
    XCTAssertEqualObjects([testObject getArray], @[@"111"], @"Must match");
    XCTAssertFalse([aspect remove], @"Must return NO");
}

这样来保持对象的释放与原返回对象同步，不会提前释放，同时objc_setAssociatedObject的对象会在target释放时自动释放，避免leak。

参考：
stackoverflow
__unsafe_unretained

NSInvocation setReturnValue 为NSObject时Bad Access问题

问题概述

原因分析

解决方案

你可能感兴趣的:(NSInvocation setReturnValue 为NSObject时Bad Access问题)