
本文為投稿文章,作者:唯敬
這篇記錄的是替 JSPatch 新增的一个小功能。想先了解 JSPatch 整體運作與原理,建議先讀官方 wiki 的〈JSPatch 實現原理詳解〉。特別感謝原作者 bang 哥的指導,以及 DevSnow 在過程中提供的協助。
工作中遇到這樣的狀況:某段程式被重構,一個函數的 .m 實作被整段註解掉,但 .h 宣告還留著。由於這部分在客戶端多處被呼叫而來不及全部替換,結果造成了線上 crash:unrecognized selector。
第一個念頭是用 JSPatch 發 hotfix 擋掉——既然找不到實作,那用 JS 動態補上這個方法不就得了?
結果做不下去。原因是那個 selector 帶有一個非 id 型別的參數。
官方 wiki 在 defineClass 的說明裡寫得很明白:可以為一個類別隨意添加 OC 未定義的方法,但所有參數型別都是 id。
追進原始碼就看懂了:
if (!overrided) {
NSMutableString *typeDescStr = [@"@@:" mutableCopy];
for (int i = 0; i < numberOfArg; i ++) {
[typeDescStr appendString:@"@"];
}
overrideMethod(currCls, selectorName, jsMethod, !isInstance,
[typeDescStr cStringUsingEncoding:NSUTF8StringEncoding]);
}
當用 defineClass 宣告新方法時,它能自動判斷參數的位置與個數,卻無法得知參數的型別。而建立新方法時必須提供 type encoding,既然拿不到型別資訊,只好預設全部當成 id,用 @@: 加上「參數個數個 @」拼出來。
所以在我的 case 裡,即使補上了方法,运行时仍然找不到它想要的那個簽名,一樣 crash。
原因清楚了,方向也就清楚:
看似應該改 defineClass 的 input,為新增方法開一個新介面。但這裡有三個顧慮:
其實 defineClass 早就支援 Protocol,寫法跟 OC 一樣:
defineClass("JPViewController: UIViewController<UIScrollViewDelegate, UITextViewDelegate>", {})
它的作用是:當添加 Protocol 裡定義的方法、而類別本身沒有實作時,參數型別不再全是 id,而是自動轉為 Protocol 中定義的型別。
看原始碼就一清二楚:
if (class_respondsToSelector(currCls, NSSelectorFromString(selectorName))) {
overrideMethod(currCls, selectorName, jsMethod, !isInstance, NULL);
} else {
BOOL overrided = NO;
for (NSString *protocolName in protocols) {
char *types = methodTypesInProtocol(protocolName, selectorName, isInstance, YES);
if (!types) types = methodTypesInProtocol(protocolName, selectorName, isInstance, NO);
if (types) {
overrideMethod(currCls, selectorName, jsMethod, !isInstance, types);
free(types);
overrided = YES;
break;
}
}
if (!overrided) {
NSMutableString *typeDescStr = [@"@@:" mutableCopy];
for (int i = 0; i < numberOfArg; i ++) {
[typeDescStr appendString:@"@"];
}
overrideMethod(currCls, selectorName, jsMethod, !isInstance,
[typeDescStr cStringUsingEncoding:NSUTF8StringEncoding]);
}
}
流程是:先判斷方法是否已存在(存在就覆蓋);不存在則看有沒有指定 Protocol,有的話從 Protocol 撈出符合的 method types 來處理;只有在指定 Protocol 裡也找不到時,才退回強制 id 參數的新增。
於是方向就定了:設計一個全新的 defineProtocol 介面,在執行時動態建立 Protocol。Protocol 建立好之後,就能直接沿用 defineClass 既有的能力引入正確的新方法——既不破壞原有邏輯,也不需要使用者改變習慣。
一開始想過直接讓使用者輸入 type encoding,最省事。但和原作者討論後認為,應該盡量降低使用者的學習成本——畢竟 # @ v b i 這類符號不是每個人都能在短時間內搞懂怎麼寫。所以改成輸入直覺的型別名稱:
defineProtocol('lalalala', {
testProtocol: {
paramsType: "int, id",
returnType: "BOOL"
},
...
}, {
...
});
由程式自動把 int、float、id、void 這些字串轉成對應的 encoding。不過自動轉換無法涵蓋所有型別(特別是使用者自訂的 struct),因此額外提供一個可選參數 typeEncode:一旦自動轉換支援不到,就可以手寫 encoding 塞進來。
JS 介面的掛上是標準做法,寫法與 defineClass 完全一致:
context[@"_OC_defineProtocol"] = ^(NSString *protocolDeclaration,
JSValue *instProtocol,
JSValue *clsProtocol) {
return defineProtocol(protocolDeclaration, instProtocol, clsProtocol);
};
對照一下原本的:
context[@"_OC_defineClass"] = ^(NSString *classDeclaration,
JSValue *instanceMethods,
JSValue *classMethods) {
return defineClass(classDeclaration, instanceMethods, classMethods);
};
底層用 runtime 的三個 API 完成:以 objc_allocateProtocol 建立新 Protocol、用 protocol_addMethodDescription 逐步加入方法、最後以 objc_registerProtocol 註冊。
這裡有一個硬性限制:Protocol 一旦註冊生效就無法再修改,所以 defineProtocol 不支援修改已存在的 Protocol。
selector 名稱在 JS 端是以 dict 的 key 形式傳入的,直接取出即可。命名規則與 defineClass 一致:參數以 _ 代替,原本的下劃線則用 `_ 表示,所以解析字串的邏輯可以完全共用。
要注意的是:程式需要靠 paramsType 的個數來判斷函式結尾有沒有參數,因此即使使用手寫 typeEncode,paramsType 仍要傳入數量相符的佔位字串。
參數會傳成 "int, id" 這樣的字串,用逗號切成分解陣列後,再逐一查表轉成編碼。查表用的型別對應表用一個很不錯的巨集技巧建構:
NSMutableDictionary* typeEncodeDic = [[NSMutableDictionary alloc] init];
#define JP_DEFINE_TYPE_ENCODE_CASE(_type) \
if ([@#_type length] > 0) { \
char* encode = @encode(_type); \
NSString * encodestr = [NSString stringWithUTF8String:encode]; \
[typeEncodeDic setObject:encodestr forKey:@#_type]; \
}
JP_DEFINE_TYPE_ENCODE_CASE(id);
這個巨集自動把傳入的型別透過 @encode() 語法糖寫進字典,不必手等人肉列。這裡還藏了一個頗妙的地方:用巨集參數直接生成靜態字串。
原本設計是 JP_DEFINE_TYPE_ENCODE_CASE(@"id", id),但一直找不到在巨集裡把 id 轉成 @"id" 的寫法。後來原作者 bang 哥提供了 @#_type 這個解法——他當初也遇過同樣的困擾。最終的巨集就長這樣:
JP_DEFINE_TYPE_ENCODE_CASE(id); JP_DEFINE_TYPE_ENCODE_CASE(BOOL); JP_DEFINE_TYPE_ENCODE_CASE(int); JP_DEFINE_TYPE_ENCODE_CASE(void); JP_DEFINE_TYPE_ENCODE_CASE(char); JP_DEFINE_TYPE_ENCODE_CASE(short); JP_DEFINE_TYPE_ENCODE_CASE(unsigned short); JP_DEFINE_TYPE_ENCODE_CASE(unsigned int); JP_DEFINE_TYPE_ENCODE_CASE(long); JP_DEFINE_TYPE_ENCODE_CASE(unsigned long); JP_DEFINE_TYPE_ENCODE_CASE(long long); JP_DEFINE_TYPE_ENCODE_CASE(float); JP_DEFINE_TYPE_ENCODE_CASE(double); JP_DEFINE_TYPE_ENCODE_CASE(CGFloat); JP_DEFINE_TYPE_ENCODE_CASE(CGSize); JP_DEFINE_TYPE_ENCODE_CASE(CGRect); JP_DEFINE_TYPE_ENCODE_CASE(CGPoint); JP_DEFINE_TYPE_ENCODE_CASE(CGVector); JP_DEFINE_TYPE_ENCODE_CASE(UIEdgeInsets); JP_DEFINE_TYPE_ENCODE_CASE(NSInteger); JP_DEFINE_TYPE_ENCODE_CASE(Class); JP_DEFINE_TYPE_ENCODE_CASE(SEL);
想支援更多型別?在這裡加一行就好;不想動原始碼的話,就走前面提到的可選參數 typeEncode。
若函式裡有 id 型別(無論是 NSArray 還是自訂的 CustomObject),要求使用者每次都記得寫 id 其實不太友善。所以額外做了一層處理:查不到對應 key 時,用 NSClassFromString 判斷是否為 OC 物件,是則自動轉為 @。
NSString* argencode = [typeEncodeDic objectForKey:argstr];
if (argencode.length <= 0) {
Class cls = NSClassFromString(argstr);
if ([(id)cls isKindOfClass:[NSObject class]]) {
argencode = @"@";
}
}
這樣寫法就完全等效:
paramsType: "id" paramsType: "CustomObject"
一個函式 - (void) setSomething:(id) anObject,它的 type encoding 是:
v12@0:4@8
看起來像亂碼,其實有規律:
掌握這個規則就能手寫 SEL 的編碼,其他型別則可查詢蘋果的定義。
程式邏輯上,可選參數 typeEncode 的優先級最高:使用者一旦手寫,就不會執行自動生成,直接使用手寫值建立 Protocol。
既然能手寫,其實也能靠 OC 程式反查。先實作 - (void) setSomething:(id) anObject,再用下面的方式就能從系統取出編碼:
NSMethod *m = class_getInstanceMethod([SomeClass class], @selector(setSomething:)); const char *types = method_getTypeEncoding(m); NSLog(@"%s", types);
結果系統給出的是 v12@0:4@8——這堆數字是什麼?
反覆測試後發現:寫 v12@0:4@8 或 v@:@,Protocol 都能正常生成,行為完全無差別。至於數字本身,Stack Overflow 上的解釋與 DevSnow 的判斷都指向同一個方向:那是參數在 stack 上的位元組偏移量,屬於位元組對齊資訊,不影響 runtime 的方法匹配與呼叫。
所以實作上兩種寫法都可以,寫 v@:@ 甚至更簡潔。只是在 debug 時看到系統吐出一堆數字,別被嚇到而已。
這個改動的核心價值在於:沒有推翻 defineClass 的既有設計,而是透過「動態建立 Protocol」這個中介層,把原本缺少的型別資訊補進流程裡。既解決了非 id 參數方法無法新增的問題,也讓使用者的既有習慣完全不受影響。
過程中最大的收穫其實不是功能本身,而是把 runtime 的 method encoding 這塊一直模糊的知識真正弄清楚了——從 @encode() 到 type encoding 的字串規則,再到 Protocol 的方法描述查詢,串起來之後,很多以前只能照抄的東西變得可以推理。