有些時候,可能需要通過 Objective-C 實現(xiàn)一個接收格式化字符串可變參數(shù)的函數(shù),如 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);
實現(xiàn)變參函數(shù)需要用到C語言中關(guān)于變參的一組宏:va_star、va_arg、va_end。va 是可變參數(shù) 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];
}
- 聲明一個
va_list
類型的變量,如 ap,這個變量是指向參數(shù)的指針。 - 用
va_start
宏初始化變量 ap,這個宏的第二個參數(shù)是可變參數(shù)的前一個固定參數(shù)。這就使得我們實現(xiàn)的函數(shù)在可變參數(shù)前,必須至少包含一個固定參數(shù)。 - 用
va_arg
返回可變的參數(shù),這個宏的第二個參數(shù)是你要返回的參數(shù)的類型。 - 用
va_end
宏結(jié)束可變參數(shù)的獲取。
從上例可以看出,這種方式的使用場景十分有限。首先這組宏沒有提供對參數(shù)個數(shù)的檢測,只能通過在參數(shù)末尾傳入 nil,或者像NSLog
函數(shù)一樣,根據(jù)第一個固定參數(shù) format 來判斷參數(shù)個數(shù)。另外,需要在函數(shù)體內(nèi)知道可變參數(shù)中的每個參數(shù)的類型,同樣需要通過固定參數(shù) format 來獲取相關(guān)信息。
所以可以通過這種方式實現(xiàn)一個接收格式化字符串可變參數(shù)的函數(shù)。比如可以在自定義 log 函數(shù)的實現(xiàn)中應(yīng)用。NSString
提供了方法- initWithFormat:arguments:
直接接收 format 和 ap 參數(shù)轉(zhuǎn)換成 string 對象,從而無需開發(fā)者自己根據(jù) format 判斷要獲取的參數(shù)類型和數(shù)量。
- (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語言的函數(shù)參數(shù)是以棧這種數(shù)據(jù)結(jié)構(gòu)來存取的,在函數(shù)參數(shù)列表中,從右至左依次入棧存入?yún)?shù)的內(nèi)存地址,我們運行va_start(ap, v)
后,ap就指向第一個可變參數(shù)在棧的地址,然后我們用va_arg(ap, t)
取得類型t的可變參數(shù)值。之后 ap 就會指向這個參數(shù)后的地址。最后通過va_end
使 ap 不再指向棧。