
作者:唯敬(投稿文章)
這是給 JSPatch 補上的一個小能力。想先瞭解 JSPatch 整體工作原理的,可以參考官方 wiki 上的《JSPatch 實現原理詳解》。
特別感謝原作者 bang 的指導,以及 DevSnow 在這個過程中提供的幫助。
事情源於一次重構。某個函數被徹底廢棄,.m 裡的實現被整段註釋掉了,但 .h 中的聲明還留著。由於這部分在客戶端多處被調用,而替換沒有及時跟上,最終造成了線上 crash:unrecognized selector。
第一反應是用 JSPatch 發熱修。既然找不到的是方法實現,那我用 JS 動態把實現補上不就行了?結果發現行不通——那個 selector 有一個非 id 類型的參數。
JSPatch 只能新增參數全為 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 能從 JS 函數的簽名中自動識別參數的位置與個數,卻無法得知參數的型別。而建立新方法時必須提供 type encoding,資訊不足,於是只能預設全部按 id 處理,用 @@: 加上若干個 @ 拼出來。返回值同理,也必須是 id。
於是當我想補的方法帶著非 id 參數時,運行期依然找不到它,crash 照舊。
原因清楚了,方向也就清楚了:
理論上可以改造 defineClass 的入參,為新增方法開一個專門的接口。但擺著三個顧慮:
defineClass 裡的 Protocol
Wiki 提到 defineClass 可以讓類實現某些 Protocol,寫法與 OC 一致:
defineClass("JPViewController: UIViewController ", {}) 它的作用是:當添加的方法屬於某個 Protocol、但類本身尚未實現時,參數型別不再一律是 id,而是自動採用 Protocol 中聲明的型別。
換句話說,defineClass 本來就具備「從已存在的 Protocol 中取出 selector 的 type encoding」的能力。源碼說得很明白:
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]);
}
}邏輯是:先判斷方法是否已存在,存在則直接覆蓋;不存在則依次檢查 defineClass 中聲明的 Protocol,命中就按 Protocol 的型別覆蓋或新增;只有在 Protocol 裡也找不到時,才退回全 id 的強制新增。
這就給了一個理想的切入點:不去動 defineClass,而是新增一個 defineProtocol 接口,讓調用方在這裡提供足夠資訊,運行期據此動態建立 Protocol。Protocol 一旦存在,defineClass 既有的機制就能自然地借它生成帶正確型別的新方法。
JS 接口設計
最初我想乾脆讓使用者直接填 type encoding,省事。但和原作者交流後改了主意:type encoding 那一堆 : # @ v b i 符號對多數人並不友好,學習成本太高。於是接口設計成這樣:
defineProtocol('lalalala', {
testProtocol: {
paramsType: "int, id",
returnType: "BOOL"
},
...
}, {
...
});使用者寫 int、float、id、void 這類直觀型別名,由代碼自動轉成 type encoding。由於自動轉換需要逐一支援,難免有覆蓋不到的情況(主要是使用者自訂的 struct),因此另外提供一個可選的 typeEncode 參數作為出口——自動轉換搞不定時,由使用者自己手寫。
代碼實現
JS 接口部分與 JSPatch 其他接口完全一致:
context[@"_OC_defineProtocol"] = ^(NSString *protocolDeclaration, JSValue *instProtocol, JSValue *clsProtocol) {
return defineProtocol(protocolDeclaration, instProtocol, clsProtocol);
};對比 defineClass,結構幾乎一模一樣:
context[@"_OC_defineClass"] = ^(NSString *classDeclaration, JSValue *instanceMethods, JSValue *classMethods) {
return defineClass(classDeclaration, instanceMethods, classMethods);
};運行期部分就是標準的三步:objc_allocateProtocol 建立、protocol_addMethodDescription 添加方法、objc_registerProtocol 註冊。
唯一需要留意的約束是:Protocol 一旦註冊生效就無法再修改,所以 defineProtocol 不支援修改已存在的 Protocol。
解析 selector
方法名就是傳入字典的 key,可以直接取出。由於我們刻意讓 defineProtocol 的命名規則與 defineClass 保持一致(參數用 _ 連接,原本的下劃線用 __ 表示),解析邏輯可以直接複用。
注意:源碼需要依賴 paramsType 的數量來判斷方法名末尾是否帶參數,所以即使用了手寫 typeEncode 這種情況,paramsType 內容可以隨意填,但數量必須對得上。
解析 type encoding
參數形如 "int, id",返回值形如 "void"。前者按逗號切成陣列,然後逐項查表。於是我建了一張映射表 typeEncodeDic,以型別字串為 key,映射到對應的編碼字元。
手寫這張表太土了,於是借鑑 bang 在 JSPatch 裡的宏用法,照貓畫虎做了一個:
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);宏裡還有個頗妙的細節:怎麼把 id 這個 token 變成 @"id"?我原本設計成 JP_DEFINE_TYPE_ENCODE_CASE(@"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 型別參數的兼容處理
如果函數參數是 id 型別——無論是 NSArray 這樣的系統類還是自己寫的 CustomObject——使用者原本得記著把所有 OC 物件都寫成 id,這不太合理。所以我加了一層兜底:查不到對應 key 時,用 NSClassFromString 判斷是否為 OC 類,若是則自動按 id 的編碼 @ 處理。
NSString *argencode = [typeEncodeDic objectForKey:argstr];
if (argencode.length <= 0) {
Class cls = NSClassFromString(argstr);
if ([(id)cls isKindOfClass:[NSObject class]]) {
argencode = @"@";
}
}於是這兩種寫法完全等價:
paramsType: "id" paramsType: "CustomObject"
SEL 型別編碼的規律
以這個方法為例:
- (void) setSomething:(id) anObject
它的編碼是:
v@:@
v:返回值 void@:self(self 與 _cmd 是任何 OC 方法的隱藏參數),基本固定::SEL,同樣基本固定@:第一個真實參數的型別掌握規律後,手寫就不難了,各型別的編碼符號可以查蘋果的定義。
代碼中可選參數 typeEncode 的優先級最高:一旦使用者手寫,就不再執行自動生成,直接採用。
if (typeEncode) {
addMethodToProtocol(protocol, selectorName, typeEncode, isInstance);
} else {
// 自動生成 type encode 字串
}除了手寫,type encoding 也可以讓系統幫你算。先在代碼裡實現那個方法,然後:
Class cls = self.class; SEL selstr = NSSelectorFromString(@"setSomething:"); Method method = class_getInstanceMethod(cls, selstr); const char *type = method_getTypeEncoding(method);
結果讓人一愣——系統算出來的是 v12@0:4@8,而不是我們推導的 v@:@。這一串數字是什麼?
反覆測試後發現,兩種寫法 Protocol 都能正常建立,使用上完全沒有差別。至於多出来的數字,Stack Overflow 上有一個針對「ObjC 方法 type encoding 中的數字代表什麼」的解釋,而和 DevSnow 討論後的判斷是:那大概是位元組偏移的補齊資訊,不影響使用。