iOS开发之方法调用NSInvocation

作者：codingZero
链接：https://www.jianshu.com/p/e24b3420f1b4
來源：简书
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。

在iOS开发中，我们一般会使用以下两种方式去调用一个方法
(1) [obj methodName];
(2) [obj performSelector......];

两种方式各自的缺点

1.方法参数过多的情况

- (NSString *)append:(NSString *)str1 withStr2:(NSString *)str2 andStr3:(NSString *)str3 {
    NSString *str = [str1 stringByAppendingString:str2];
    str = [str stringByAppendingString:str3];
    return str;
}

两种方式执行方法的代码如下

方式一，二

看看打印结果

image

方式一的打印结果是没有问题的
方式二由于最多只能传递两个参数，所以最后一个参数的值是不准确的

由此可以得出，方式二的缺点就是不能执行参数过多的方法

---

2.方法名为字符串的情况

image

用方式一显然是不可以的

image

编译报错，有人可能就要说了，直接[self printName:@"Tom"]不就行了，如果这样认为，那就没必要往下看了，这仅仅只是个例子，在真实开发中，这个字符串可能是程序运行过程中才获取的。

此时方式二的优势就体现出来了，我们来看看方式二是如何执行方法的

image

完美运行

image

由此可以得出，方式一不能通过方法名字符串来执行方法

那有没有一种方式，既可以通过方法名字符串来调用方法，也可以传递很多参数呢？答案肯定是有的，要不然笔者何必在这里废话呢

NSInvocation的简单使用

例：要执行如下方法，但只知道方法名字符串

//方法名字符串
NSString *methodNameStr = @"test:withArg2:andArg3:";
//要执行的方法
- (void)test:(NSString *)arg1 withArg2:(NSString *)arg2 andArg3:(NSString *)arg3 {
    NSLog(@"%@---%@---%@", arg1, arg2, arg3);
}

1.创建一个方法签名

//NSObject的对象方法，任何继承自NSObject的对象都可以调用
- (NSMethodSignature *)methodSignatureForSelector:(SEL)aSelector
//NSObject的类方法，任何继承自NSObject的类都可以调用
+ (NSMethodSignature *)instanceMethodSignatureForSelector:(SEL)aSelector

注意

上面的两个方法中，aSelector参数，不一定是你要调用的那个方法，可以是任意方法，但是该方法的参数个数必须与你要调用的参数个数一致

我们一般使用self来创建方法签名

SEL selector = NSSelectorFromString(methodNameStr);
NSMethodSignature *signature = [self methodSignatureForSelector:selector];
//或使用下面这种方式
NSMethodSignature *signature = [[self class] instanceMethodSignatureForSelector:selector];

NSMethodSignature有两个常用的只读属性
a. numberOfArguments:方法参数的个数
b. methodReturnLength:方法返回值类型的长度，大于0表示有返回值

2.使用方法的签名来创建一个NSInvocation对象

NSInvocation *invocation = [NSInvocation invocationWithMethodSignature:signature];
//只能使用该方法来创建，不能使用alloc init

3.给invocation的两个属性赋值
要执行谁的（target）的哪个方法（selector）

invocation.target = self;
invocation.selector = selector;

4.给要执行的方法设置参数
使用setArgument:atIndex:方法给要执行的方法设置参数，注意下标从2开始，因为0、1已经被target与selector占用

NSString *arg1 = @"a";
NSString *arg2 = @"b";
NSString *arg3 = @"c";
[invocation setArgument:&arg1 atIndex:2];
[invocation setArgument:&arg2 atIndex:3];
[invocation setArgument:&arg3 atIndex:4];

设置参数，必须传递参数的地址，不能直接传值
5.执行方法

[invocation invoke];

运行结果如下

image

如果方法有返回值呢？如何获取方法的返回值？
我们修改一下要调用的方法，增加一个返回值，如下所示

- (NSString *)test:(NSString *)arg1 withArg2:(NSString *)arg2 andArg3:(NSString *)arg3 {
    NSLog(@"%@---%@---%@", arg1, arg2, arg3);
    return @"haha";
}

要想获取返回值，我们只需要在之前的基础上增加两行代码

//可以在invoke方法前添加，也可以在invoke方法后添加
//通过方法签名的methodReturnLength判断是否有返回值
if (signature.methodReturnLength > 0) {
    __unsafe_unretained id *result = nil;
    [invocation getReturnValue:&result];
}

注意获取返回值与设置参数一样，都必须将地址传过去

最后将完整的代码及运行结果贴上

image

运行结果

image

---

NSInvocation实现多参数的封装

系统的NSObject提供的performSelector的方法只提供了最多两个参数的调用,我们可以使用NSInvocation封装一个多个参数的performSelector方法.

#import <Foundation/Foundation.h>

@interface NSObject (MutiPerform)

-(id)performSelector:(SEL)Selector withObjects:(NSArray *)objects;
@end

#import "NSObject+MutiPerform.h"

@implementation NSObject (MutiPerform)

-(id)performSelector:(SEL)selector withObjects:(NSArray *)objects{

    //初始化方法签名
    NSMethodSignature *signature = [[self class] instanceMethodSignatureForSelector:selector];
    
    // 如果方法selector不存在
    
    if(signature == nil){

        // 抛出异常
        NSString *reason = [NSString stringWithFormat:@"%@方法不存在",NSStringFromSelector(selector)];
        @throw [NSException exceptionWithName:@"error" reason:reason userInfo:nil];
    }
    
    NSInvocation *invocation = [NSInvocation invocationWithMethodSignature:signature];

    invocation.target = self;
    invocation.selector = selector;
    
    //参数个数signature.numberOfArguments 默认有一个_cmd 一个target 所以要-2
    NSInteger paramsCount = signature.numberOfArguments - 2;
    
    // 当objects的个数多于函数的参数的时候,取前面的参数
    //当当objects的个数少于函数的参数的时候,不需要设置,默认为nil
    paramsCount = MIN(paramsCount, objects.count);
    
    for (NSInteger index = 0; index < paramsCount; index++) {
        
        id object = objects[index];

        // 对参数是nil的处理
        if([object isKindOfClass:[NSNull class]]) continue;
        
        [invocation setArgument:&object atIndex:index+2];

    }
    //调用方法
    [invocation invoke];

    // 获取返回值
    id returnValue = nil;
    
    //signature.methodReturnLength == 0 说明给方法没有返回值
    if (signature.methodReturnLength) {

        //获取返回值
        [invocation getReturnValue:&returnValue];
    }
    
    return returnValue;
}