[iOS-Objective-C] 格式化字符串变参函数的实现

2023年11月4日 305次阅读 来源: 水止云起

有些时候，可能需要通过 Objective-C 实现一个接收格式化字符串可变参数的函数，如 Foundation 中的某些方法一样：

FOUNDATION_EXPORT void NSLog(NSString *format, ...) NS_FORMAT_FUNCTION(1,2) NS_NO_TAIL_CALL;

- (instancetype)initWithFormat:(NSString *)format, ... NS_FORMAT_FUNCTION(1,2);

实现变参函数需要用到C语言中关于变参的一组宏：va_star、va_arg、va_end。va 是可变参数 variable argument 的意思。使用方式为：

- (void)vaTestMethod:(NSInteger)unavaliable, ... {
    va_list ap;
    va_start(ap, unavaliable);
    while (YES) {
        NSString *string = va_arg(ap, NSString*);
        if (!string) {
            break;
        }
        NSLog(@"%@",string);
    }
    va_end(ap);
}

- (void)test {
    [self vaTestMethod:0, @"1", @"2", @"3", nil];
}
  1. 声明一个va_list类型的变量，如 ap，这个变量是指向参数的指针。
  2. 用va_start宏初始化变量 ap，这个宏的第二个参数是可变参数的前一个固定参数。这就使得我们实现的函数在可变参数前，必须至少包含一个固定参数。
  3. 用va_arg返回可变的参数，这个宏的第二个参数是你要返回的参数的类型。
  4. 用va_end宏结束可变参数的获取。

从上例可以看出，这种方式的使用场景十分有限。首先这组宏没有提供对参数个数的检测，只能通过在参数末尾传入 nil，或者像NSLog函数一样，根据第一个固定参数 format 来判断参数个数。另外，需要在函数体内知道可变参数中的每个参数的类型，同样需要通过固定参数 format 来获取相关信息。

所以可以通过这种方式实现一个接收格式化字符串可变参数的函数。比如可以在自定义 log 函数的实现中应用。NSString提供了方法- initWithFormat:arguments:直接接收 format 和 ap 参数转换成 string 对象，从而无需开发者自己根据 format 判断要获取的参数类型和数量。

- (void)log:(NSString *)format, ... {    
    va_list ap;
    va_start(ap, format);
    NSString *information = [[NSString alloc] initWithFormat:format arguments:ap];
    va_end(ap);
    fprintf(stderr,"%s\n", [information UTF8String]);
}

va 宏原理

C语言的函数参数是以栈这种数据结构来存取的，在函数参数列表中，从右至左依次入栈存入参数的内存地址，我们运行va_start(ap, v)后，ap就指向第一个可变参数在栈的地址，然后我们用va_arg(ap, t)取得类型t的可变参数值。之后 ap 就会指向这个参数后的地址。最后通过va_end使 ap 不再指向栈。

    原文作者：水止云起
    原文地址: https://www.jianshu.com/p/aae1eecf4828
    本文转自网络文章，转载此文章仅为分享知识，如有侵权，请联系博主进行删除。
点赞