您现在的位置: IOS教程網 >> IOS系統 >  >> iOS 程式開發 >> iOS 開發綜合

iOS 熱更新方案剖析:JSPatch 原理與 Patch 現場恢復實踐

編輯:iOS 開發綜合

為什麼 iOS 需要 Hotfix

Apple 的審核標準嚴格、週期偏長,稍微複雜一點的 App 發一次版往往要等上一個月以上。對於需要快速響應線上問題的團隊來說,代碼熱更新(Hotfix / Patch)幾乎是刚需。

過去幾年業界主流方案是基於 Wax 框架的 WaxPatch。遺憾的是 Wax 已經停止維護四五年,實戰中積累了不少坑:參數轉換容易出錯、若繼承類未被實例化則對其方法的修改不生效、wax_gc 對 Objective-C 對象的持有存在延遲釋放等。加上 Apple 對這類腳本注入方案的態度一直比較模糊,潛在合規風險也不小。

隨著 Facebook 開源 React Native,人們意識到可以借助 JavaScriptCore.framework 在 JavaScript 與 Objective-C 之間架一座橋,JSPatch 正是在這個背景下出現的。最初我以為它只是 React Native 之上的一層封裝,讀完源碼才發現兩者幾乎沒有關係。

深入研究後,JSPatch 給我的第一印象是:體積小、邏輯直白、維護成本低。它直接用 Objective-C 調用 runtime API,iOS 工程師基本零成本上手,不必額外投入精力去學 Lua。作者在 JS 與 OC 的橋接上巧妙利用了兩種語言的消息轉發機制,實現得相當優雅。唯一的遺憾是它依賴 JavaScriptCore.framework,因此只能支持 iOS 7 及以上。

考慮到當時公司部分產品仍需兼容 iOS 6,而新項目已經把最低版本提到 iOS 7,加之 JSPatch 成熟度還在爬坡,最終的選擇是讓 JSPatch 與 WaxPatch 並存互補。

JSPatch 相比 WaxPatch 的優勢

  1. 語言選型更合適:JS 在應用開發領域的普及度遠高於 Lua,前端與客戶端正在融合,作為擴展腳本語言,JS 是更自然的選擇。
  2. 更符合 Apple 規則:iOS Developer Program License Agreement 第 3.3.2 條禁止動態下發可執行代碼,但明確把「通過 Apple 的 JavaScriptCore.framework 或 WebKit 執行的代碼」排除在外,而 JSPatch 恰好走的是這條路。
  3. 體積更小:直接使用系統內置的 JavaScriptCore.framework,無需內嵌腳本引擎。
  4. 支持 block:Wax 多年停止維護,OC 的 block 與 Lua 之間無法互傳,第三方雖有補充實現,但參數限制頗多。

劣勢同樣明顯:不支持 iOS 6,且內存占用目前略高於 Wax,仍在持續改進。

實現原理拆解

作者的原理文章寫得非常細緻,這裡只記錄我自己的理解要點。建議對照源碼閱讀。

  • 原理詳解:https://blog.cnbang.net/tech/2808/JSPatch
  • 源碼與說明:https://github.com/bang590/JSPatch

(1)Objective-C 的動態特性是地基

無論 Wax 還是 JSPatch,本質上都是利用 OC 的動態語言特性去替換方法實現。OC 的運行時由 runtime system 承載(純 C 實現,Apple 開源了一份),基於消息機制構建 Class 與 instance 體系。我們習慣寫的 [object method],更準確的理解是「向 receiver 發送消息」,編譯階段會被翻譯為 runtime 的 C 函數調用。

runtime 開放了一批關鍵 API:


// 反射獲取類與選擇器
Class cls = NSClassFromString(@"UIViewController");
SEL sel = NSSelectorFromString(@"viewDidLoad");

// 新增或替換方法的 IMP
BOOL class_addMethod(Class cls, SEL name, IMP imp, const char *types);
IMP class_replaceMethod(Class cls, SEL name, IMP imp, const char *types);

// 運行時動態註冊類
Class superCls = NSClassFromString(superClassName);
cls = objc_allocateClassPair(superCls, className.UTF8String, 0);
objc_registerClassPair(cls);

(2)JS 如何調用 OC

要打通這條路徑,需要解決兩個問題:怎樣拿到 OC 的類對象,以及怎樣調用它的方法。

對於前者,JSPatch 用 require 在 JS 環境中創建一個同名佔位對象;當向 OC 發送 alloc 消息後,把 OC 側真實對象的地址記在這個 JS 同名對象上。JS 本身並不完成任何初始化。


// 請求 OC 類對象
UIView = require("UIView");

var _require = function(clsName) {
    if (!global[clsName]) {
        global[clsName] = { __isCls: 1, __clsName: clsName }
    }
    return global[clsName]
}

// 類方法與實例方法分別轉發
var ret = instance ? _OC_callI(instance, selectorName, args, isSuper)
                   : _OC_callC(clsName, selectorName, args)

對於後者,JSPatch 在執行腳本前先做了一次字符替換,把所有 obj.method(args) 改寫成 obj.__c("method")(args) 的形式,再由 __c 統一轉發到 OC 的橋接函數。


static NSString *_regexStr = @"\\s*(\\w+)\\s*\\(";
static NSString *_replaceStr = @".__c(\"$1\")(";

Object.prototype.__c = function(methodName) {
    return function(){
        var args = Array.prototype.slice.call(arguments)
        return _methodFunc(self.__obj, self.__clsName, methodName, args, self.__isSuper)
    }
}

context[@"_OC_callI"] = ^id(JSValue *obj, NSString *selectorName, JSValue *arguments, BOOL isSuper) {
    return callSelector(nil, selectorName, arguments, obj, isSuper);
};
context[@"_OC_callC"] = ^id(NSString *className, NSString *selectorName, JSValue *arguments) {
    return callSelector(className, selectorName, arguments, nil, NO);
};

(3)JS 如何替換 OC 方法

修復線上 bug 才是 JSPatch 的主戰場,而它的精妙之處在於借用了 OC 的消息轉發機制。

第一步:把原 selector 的 IMP 替換成空實現,這樣消息到達後就會走轉發流程;同時把原 IMP 保存下來(本文的改造版在此增加了現場恢復支持)。


IMP msgForwardIMP = getEmptyMsgForwardIMP(typeDescription, methodSignature);
class_replaceMethod(cls, selector, msgForwardIMP, typeDescription);

NSString *originalSelectorName = [NSString stringWithFormat:@"ORIG_%@", selectorName];
SEL originalSelector = NSSelectorFromString(originalSelectorName);
if (class_respondsToSelector(cls, selector)) {
    if (!class_respondsToSelector(cls, originalSelector)) {
        class_addMethod(cls, originalSelector, originalImp, typeDescription);
    } else {
        class_replaceMethod(cls, originalSelector, originalImp, typeDescription);
    }
}

第二步:根據返回類型構造一個新的 IMP,關聯到 JS 實現,並以「類名 + 選擇器」為鍵全局緩存。全局緩存平時用處不大,但對後續恢復現場至關重要。


if (!_JSOverideMethods[clsName][JPSelectorName]) {
    _initJPOverideMethods(clsName);
    _JSOverideMethods[clsName][JPSelectorName] = function;
    const char *returnType = [methodSignature methodReturnType];
    IMP JPImplementation = NULL;
    // 依返回類型構造對應的 IMP
    if (!class_respondsToSelector(cls, JPSelector)) {
        class_addMethod(cls, JPSelector, JPImplementation, typeDescription);
    } else {
        class_replaceMethod(cls, JPSelector, JPImplementation, typeDescription);
    }
}

第三步:改寫這些類的 forwardInvocation: 做攔截。若攔截到的 selector 能映射到已註冊的 JPSelector,就說明這是一次被 hook 的調用,此時從 NSInvocation 中取出參數並轉交給 JS。


static void JPForwardInvocation(id slf, SEL selector, NSInvocation *invocation) {
    NSString *selectorName = NSStringFromSelector(invocation.selector);
    NSString *JPSelectorName = [NSString stringWithFormat:@"_JP_%@", selectorName];
    SEL JPSelector = NSSelectorFromString(JPSelectorName);
    if (!class_respondsToSelector(object_getClass(slf), JPSelector)) { return; }

    NSMutableArray *argList = [[NSMutableArray alloc] init];
    [argList addObject:slf];
    // 收集參數後 invoke,進入 JS 實現
    @synchronized(_context) {
        _TMPInvocationArguments = formatOCToJSList(argList);
        [invocation setSelector:JPSelector];
        [invocation invoke];
        _TMPInvocationArguments = nil;
    }
}

Patch 現場恢復

現場恢復主要服務於「需要連續下發多個腳本」的場景。iOS 的應用被切到後台(applicationWillResignActive)後,若進程沒有被終止(applicationWillTerminate),下次回到前台走的是 applicationWillEnterForeground,而不會重新執行 application:didFinishLaunchingWithOptions:。這意味著第二次下發腳本時,如果不做處理,就再也拿不到最開始那份原始實現了。有了恢復能力,我們既能安全疊加多輪補丁,也能隨時撤銷線上腳本、回到應用本身的代碼邏輯。

改造後的代碼開放在:https://github.com/philonpang/JSPatch.git

先在 JPEngine.h 中暴露一對起止接口:


void js_start(NSString* initScript);
void js_end();

恢復邏輯的核心,是利用替換方法與新增方法的緩存表 _JSOverideMethods:把 selector 指回最初的 IMP,讓 JPSelector 與 ORIGSelector 重新指向空轉發實現,同時把 forwardInvocation: 還原回去。


if ([JPSelectorName hasPrefix:@"_JP"]) {
    // 還原 forwardInvocation:
    SEL ORIGforwardSelector = @selector(ORIGforwardInvocation:);
    IMP ORIGforwardImp = class_getMethodImplementation(cls, ORIGforwardSelector);
    class_replaceMethod(cls, @selector(forwardInvocation:), ORIGforwardImp, "v@:@");
    class_replaceMethod(cls, ORIGforwardSelector, _objc_msgForward, "v@:@");

    SEL selector = NSSelectorFromString(selectorName);
    SEL ORIGSelector = NSSelectorFromString(ORIGSelectorName);
    IMP ORIGSelectorImp = class_getMethodImplementation(cls, ORIGSelector);
    class_replaceMethod(cls, selector, ORIGSelectorImp, typeDescription);
    class_replaceMethod(cls, JPSelector, forwardEmptyIMP, typeDescription);
    class_replaceMethod(cls, ORIGSelector, forwardEmptyIMP, typeDescription);
}

那些真實踩過的坑

Wax 的坑不少同事都抱怨過,JSPatch 同樣會遇到。雖然兩個框架如今都能勝任「動態下發可執行代碼」,但把它們用來承載完整業務組件仍然冒險。

舉一個親身遇到的例子:用 JS 腳本去改寫派生類中「並未實現的、來自父類的 optional protocol 方法」時,tableView 刷新不會走到補丁方法;但在 tableView 內部顯式調用該 selector 卻能命中替換結果。如果乾脆在派生類裡重寫這個 protocol 方法,則一切正常。

  1. 上一篇文章:
  2. 下一篇文章:
蘋果刷機越獄教程| IOS教程問題解答| IOS技巧綜合| IOS7技巧| IOS8教程
Copyright © IOS教程網 All Rights Reserved