
本文為投稿文章,作者:唯敬。GitHub 源碼:vk_msgSend。
說白了,這是一個 NSInvocation 的練習作業。
工作中難免遇到這樣的場景:不想為了一個方法引入整個頭文件,但又想調用它;或者想玩點動態創建、動態調用。這類用法確實不常見,直接 import 頭文件最省事,但我覺得以此為起點能搗鼓出不少有意思的東西。
一次群聊裡提到的場景是:tableView 的 cell 有 N 種樣式,cellForRow 時通過 NSClassFromString 從字符串創建對象,再逐一給 cell 的 UI 賦值。問題來了——實在不想 import 那麼多 cell.h 該怎麼辦?
可行的思路有幾條:
performSelector。說實話,我覺得很不好用。objc_msgSend。靠譜,聽起來也容易用。這裡只說同步的那三個接口:
- (id)performSelector:(SEL)aSelector; - (id)performSelector:(SEL)aSelector withObject:(id)object; - (id)performSelector:(SEL)aSelector withObject:(id)object1 withObject:(id)object2;
我以前幾乎只用它在無參數場景下工作,一旦帶參數就換別的方式了,原因有三:
withObject: 要的是 id。傳 BOOL、NSInteger 怎麼辦?包成 NSNumber 對方還認識嗎?withObject,寫出來一點都不酷。OC 的消息機制大家都熟,方法調用本質是發消息,這裡不重複。假設有這麼一個方法:
- (int) doSomething:(int) x { ... }在 32 位時代,可以直接:
objc_msgSend(self, @selector(doSomething:), 0);
但放到 64 位設備上就會崩潰。原因參見蘋果《Converting Your App to a 64-Bit Binary》中「Take Care with Functions and Function Pointers」一節:64 位下 runtime 在讀取參數列表、進行傳參這部分與 32 位差異很大,所以蘋果明確要求:
Always Define Function Prototypes
Function Pointers Must Use the Correct Prototype
也就是說,直接調用 C 函數指針時必須先做嚴格的類型匹配強轉,不能拿 Imp 這個通用指針直接上。而 objc_msgSend 內部也是同樣的過程:先從 runtime 的 method cache 找 selector,找不到再查 method list,找到後取得對應的 Imp 並調用。所以在 64 位下,必須自己補一次強轉:
((void(*)(id, SEL, int))objc_msgSend)(self, @selector(doSomething:), 0);
以前 32 位時它最方便,現在反而多了一道手續。那能不能順著程序員的偷懶天性,把這步也省掉?
我希望的用法是這樣:
Class cls = NSClassFromString(@"testClassA"); id abc = [[cls alloc] init]; NSError *err; NSString *return1 = [abc vk_callSelector:@selector(testfunction:withB:) error:&err, 4, 3.5f];
目標很明確:
<vk_msgSend> 就能直接調用。於是定義是:
+ (id)vk_callSelector:(SEL)selector error:(NSError *__autoreleasing *)error, ...; + (id)vk_callSelectorName:(NSString *)selName error:(NSError *__autoreleasing *)error, ...; - (id)vk_callSelector:(SEL)selector error:(NSError *__autoreleasing *)error, ...; - (id)vk_callSelectorName:(NSString *)selName error:(NSError *__autoreleasing *)error, ...;
四個接口核心邏輯一致,理應抽一個公共方法。但可變參數函數沒法直接把 ... 轉發給下一層:
- (id)vk_callSelectorName:(NSString*)selName error:(NSError*__autoreleasing*)error, ... {
SEL selector = NSSelectorFromString(selName);
[self vk_callSelector:selector error:error, ...]; // 編譯器不認
}後來組裡一位大神給出了建議:把 va_list 直接作為公共方法的參數。公共方法簽名改成:
static NSArray *vk_targetBoxingArguments(va_list argList, Class cls, SEL selector, NSError *__autoreleasing *error)
調用處則用 va_start 取出 va_list 逐層傳遞:
va_list argList; va_start(argList, error); SEL selector = NSSelectorFromString(selName); NSArray *boxingAruments = vk_targetBoxingArguments(argList, [self class], selector, error); va_end(argList);
接口層允許任意類型,但內部統一轉成 id 以便傳遞,這一步就是 vk_targetBoxingArguments,而它要用到 va_arg——我在這裡踩了個不小的坑。
從 va_list 取值必須明確知道每個參數的類型,而我們要做的是通用方法,不能寫死。類型從哪來?NSMethodSignature。它相當於 SEL 的 typeEncode 封裝,記錄了返回值類型與各參數類型:
methodSignature = [cls instanceMethodSignatureForSelector:selector];
有了它就能遍歷取類型再取值。註意前兩個下標分別是返回值和 receiver,所以從 2 開始:
for (int i = 2; i < [methodSignature numberOfArguments]; i++) {
const char *argumentType = [methodSignature getArgumentTypeAtIndex:i];
switch (argumentType[0] == 'r' ? argumentType[1] : argumentType[0]) {
// 依類型從 va_list 取值並包裝
}
}幾種典型處理:
// 1) 基礎類型,如 int int value = va_arg(argList, int); [argumentsBoxingArray addObject:@(value)]; break;
// 2) 結構體,如 CGSize CGSize val = va_arg(argList, CGSize); NSValue *value = [NSValue valueWithCGSize:val]; [argumentsBoxingArray addObject:value]; break;
// 3) id:nil 無法放入數組,用 vk_nilObject 佔位
id value = va_arg(argList, id);
if (value) {
[argumentsBoxingArray addObject:value];
} else {
[argumentsBoxingArray addObject:[vk_nilObject new]];
}// 4) SEL:當字符串處理 SEL value = va_arg(argList, SEL); NSString *selValueName = NSStringFromSelector(value); [argumentsBoxingArray addObject:selValueName];
5)block 本質就是 id,處理方式完全一致。
// 6) id*:pointer 不能直接入數組,用 vk_pointer 持有 void *value = va_arg(argList, void**); vk_pointer *pointerObj = [[vk_pointer alloc] init]; pointerObj.pointer = value; [argumentsBoxingArray addObject:pointerObj];
調試時我對 typeEncode 中的 f 這麼取參數:
va_arg(argList, float)
編譯器給出警告:
Second argument to 'va_arg' is of promotable type 'float'; this va_arg has undefined behavior because arguments will be promoted to 'double'
一開始我沒理它,結果運行時參數裡含 float 就出大問題了:正如警告所說,此處實際是按 double 壓棧的,我卻按 float 去取,取出來的值是 0(一個較小的 double 取前幾位自然是 0);而緊隨其後的那個 id 參數用 va_arg(argList, id) 取時直接崩潰——指針已經偏移錯位。老老實實把 f 改成按 double 處理,一切正常。
拿到包裝好的參數數組後就可以調用了。
// 1. 生成 NSInvocation Class cls = [target class]; NSMethodSignature *methodSignature = vk_getMethodSignature(cls, selector); NSInvocation *invocation = [NSInvocation invocationWithMethodSignature:methodSignature]; // 2. 設置 target 與 SEL [invocation setTarget:target]; [invocation setSelector:selector];
3. 循環壓入參數。同樣遍歷 methodSignature,依 typeEncode 把數組裡的對象還原成對應類型:
for (int i = 2; i < [methodSignature numberOfArguments]; i++) {
const char *argumentType = [methodSignature getArgumentTypeAtIndex:i];
id valObj = argsArr[i-2];
switch (argumentType[0] == 'r' ? argumentType[1] : argumentType[0]) {
// 依類型分支處理
}
}// int 等基礎類型 int value = [valObj intValue]; [invocation setArgument:&value atIndex:i]; break;
// CGSize 等結構體 CGSize value = [val CGSizeValue]; [invocation setArgument:&value atIndex:i];
// id:包裝時的 nil 被換成了 vk_nilObject,這裡還原為空指針
static vk_nilObject *vknilPointer = nil;
if ([valObj isKindOfClass:[vk_nilObject class]]) {
[invocation setArgument:&vknilPointer atIndex:i];
} else {
[invocation setArgument:&valObj atIndex:i];
}// SEL:從字符串還原 NSString *selName = valObj; SEL selValue = NSSelectorFromString(selName); [invocation setArgument:&selValue atIndex:i];
block 同 id;id* 則從 vk_pointer 取回 void* 再壓入:
vk_pointer *value = valObj; void *pointer = value.pointer; [invocation setArgument:&pointer atIndex:i];
如果全程斷點單步,整個流程不會有事;一旦放開斷點跑完就崩潰。
原因在於:invoke 過程中若在內部 alloc 初始化了對象,invoke 結束後到了下一個 autorelease 時機就會出現 zombie 崩潰(向已 dealloc 的對象發 release)。簡單說,invoke 與直接函數調用不同,內部 alloc 的對象會多一次 autorelease,因此不會立刻崩,但等到 autoreleasepool 釋放時就變成了過度 release。
我的處理方式是:判斷 void* 指向的對象是否存在。
vk_pointer *value = valObj;
void *pointer = value.pointer;
id obj = *((__unsafe_unretained id *)pointer);
if (!obj) {
if (argumentType[1] == '@') {
if (!_vkNilPointerTempMemoryPool) {
_vkNilPointerTempMemoryPool = [[NSMutableDictionary alloc] init];
}
if (!_markArray) {
_markArray = [[NSMutableArray alloc] init];
}
[_markArray addObject:valObj];
}
}
[invocation setArgument:&pointer atIndex:i];如果傳入的是一個已 alloc init 好的 mutableArray 之類對象,invoke 內部只是往裡寫數據、不會在指針處重新 new,那麼直接壓入是安全的。而如果 void* 指向的對象不存在——比如傳入一個 NSError* 等著內部創建——就會觸發崩潰。思路是先幫它多持有一次:既然多了一次 release,那就在 invoke 之後把它加進一個全局字典,讓 ARC 幫忙 retain。
if ([_markArray count] > 0) {
for (vk_pointer *pointerObj in _markArray) {
void *pointer = pointerObj.pointer;
id obj = *((__unsafe_unretained id *)pointer);
if (obj) {
@synchronized(_vkNilPointerTempMemoryPool) {
[_vkNilPointerTempMemoryPool setObject:obj
forKey:[NSNumber numberWithInteger:[(NSObject*)obj hash]]];
}
}
}
}這段代碼放在 [invocation invoke] 之後,因為只有執行完才知道 void* 指向的位置是否真的創建了新對象。
關於這個方案,有兩點必須說清楚:
void** 變成了 void***,導致被調函數雖然創建了 NSError,執行完卻沒有賦值回外部指針,外面看到的 error 仍是空。大家在函數外取個 &error 的地址,再對比函數內收到的 error 地址,就能看出不對。與壓參同理,依 typeEncode 判斷返回類型:
const char *returnType = [methodSignature methodReturnType];
// int 等基礎類型,統一包裝成 NSNumber 返回 int returnValue; [invocation getReturnValue:&returnValue]; return @(returnValue); break;
// CGSize 等結構體,統一包裝成 NSValue 返回 CGSize result; [invocation getReturnValue:&result]; NSValue *returnValue = [NSValue valueWithBytes:&(result) objCType:@encode(CGSize)]; return returnValue;
// id 類型:getReturnValue 只是把值拷貝到指定地址,
// 返回的 id 是指針,實際對象會在 runloop 結束後被釋放
void *result;
[invocation getReturnValue:&result];
if (result == NULL) {
return nil;
}
id returnValue = (__bridge id)result;
return returnValue;返回值被強制成了 id,也就是說原函數若返回 NSInteger,我會給出 NSNumber。原因是參數可以靠可變參數「繞過去」,返回值卻繞不掉——我暫時沒找到一個符號能同時兼容基礎類型與 id。有人建議用 void *,但那樣調用方拿到的仍要自己轉一次,與我的初衷(直接拿到最終結果)不符。
感謝 bang 哥,很多 invocation 的用法都是拆 JSPatch 學來的;感謝彩虹,各種疑難雜症陪我一起動腦解決。