JSPatch實(shí)現(xiàn)原理詳解:讓JS調(diào)用/替換任意OC方法
JSPatch以小巧的體積做到了讓JS調(diào)用/替換任意OC方法,讓iOS APP具備熱更新的能力,在實(shí)現(xiàn) JSPatch 過程中遇到過很多困難也踩過很多坑,有些還是挺值得分享的。本篇文章從基礎(chǔ)原理、方法調(diào)用和方法替換三塊內(nèi)容介紹整個(gè) JSPatch 的實(shí)現(xiàn)原理,并把實(shí)現(xiàn)過程中的想法和碰到的坑也盡可能記錄下來。
基礎(chǔ)原理
能做到通過JS調(diào)用和改寫OC方法最根本的原因是 Objective-C 是動(dòng)態(tài)語言,OC上所有方法的調(diào)用/類的生成都通過 Objective-C Runtime 在運(yùn)行時(shí)進(jìn)行,我們可以通過類名/方法名反射得到相應(yīng)的類和方法:
- Class class = NSClassFromString("UIViewController");
- id viewController = [[class alloc] init];
- SEL selector = NSSelectorFromString("viewDidLoad");
- [viewController performSelector:selector];
也可以替換某個(gè)類的方法為新的實(shí)現(xiàn):
- static void newViewDidLoad(id slf, SEL sel) {}
- class_replaceMethod(class, selector, newViewDidLoad, @"");
還可以新注冊(cè)一個(gè)類,為類添加方法:
- Class cls = objc_allocateClassPair(superCls, "JPObject", 0);
- objc_registerClassPair(cls);
- class_addMethod(cls, selector, implement, typedesc);
對(duì)于 Objective-C 對(duì)象模型和動(dòng)態(tài)消息發(fā)送的原理已有很多文章闡述得很詳細(xì),例如這篇,這里就不詳細(xì)闡述了。理論上你可以在運(yùn)行時(shí)通過類名/方法名調(diào)用到任何OC方法,替換任何類的實(shí)現(xiàn)以及新增任意類。所以 JSPatch 的原理就是:JS傳遞字符串給OC,OC通過 Runtime 接口調(diào)用和替換OC方法。這是最基礎(chǔ)的原理,實(shí)際實(shí)現(xiàn)過程還有很多怪要打,接下來看看具體是怎樣實(shí)現(xiàn)的。
方法調(diào)用
- require('UIView')
- var view = UIView.alloc().init()
- view.setBackgroundColor(require('UIColor').grayColor())
- view.setAlpha(0.5)
引入JSPatch后,可以通過以上JS代碼創(chuàng)建了一個(gè) UIView 實(shí)例,并設(shè)置背景顏色和透明度,涵蓋了require引入類,JS調(diào)用接口,消息傳遞,對(duì)象持有和轉(zhuǎn)換,參數(shù)轉(zhuǎn)換這五個(gè)方面,接下來逐一看看具體實(shí)現(xiàn)。
1.require
調(diào)用 require(‘UIView’) 后,就可以直接使用 UIView 這個(gè)變量去調(diào)用相應(yīng)的類方法了,require 做的事很簡單,就是在JS全局作用域上創(chuàng)建一個(gè)同名變量,變量指向一個(gè)對(duì)象,對(duì)象屬性__isCls表明這是一個(gè) Class,__clsName保存類名,在調(diào)用方法時(shí)會(huì)用到這兩個(gè)屬性。
- var _require = function(clsName) {
- if (!global[clsName]) {
- global[clsName] = {
- __isCls: 1,
- __clsName: clsName
- }
- }
- return global[clsName]
- }
所以調(diào)用require(‘UIView’)后,就在全局作用域生成了 UIView 這個(gè)變量,指向一個(gè)這樣一個(gè)對(duì)象:
- {
- __isCls: 1,
- __clsName: "UIView"
- }
2.JS接口
接下來看看 UIView.alloc() 是怎樣調(diào)用的。
舊實(shí)現(xiàn)
對(duì)于這個(gè)調(diào)用的實(shí)現(xiàn),一開始我的想法是,根據(jù)JS特性,若要讓 UIView.alloc() 這句調(diào)用不出錯(cuò),唯一的方法就是給 UIView 這個(gè)對(duì)象添加 alloc 方法,不然是不可能調(diào)用成功的,JS對(duì)于調(diào)用沒定義的屬性/變量,只會(huì)馬上拋出異常,而不像OC/Lua/ruby那樣會(huì)有轉(zhuǎn)發(fā)機(jī)制。所以做了一個(gè)復(fù)雜的事,就是在require生成類對(duì)象時(shí),把類名傳入OC,OC通過 Runtime 方法找出這個(gè)類所有的方法返回給JS,JS類對(duì)象為每個(gè)方法名都生成一個(gè)函數(shù),函數(shù)內(nèi)容就是拿著方法名去OC調(diào)用相應(yīng)方法。生成的 UIView 對(duì)象大致是這樣的:
- {
- __isCls: 1,
- __clsName: "UIView",
- alloc: function() {…},
- beginAnimations_context: function() {…},
- setAnimationsEnabled: function(){…},
- ...
- }
實(shí)際上不僅要遍歷當(dāng)前類的所有方法,還要循環(huán)找父類的方法直到頂層,整個(gè)繼承鏈上的所有方法都要加到JS對(duì)象上,一個(gè)類就有幾百個(gè)方法,這樣把方法全部加到JS對(duì)象上,碰到了挺嚴(yán)重的問題,引入幾個(gè)類就內(nèi)存暴漲,無法使用。后來為了優(yōu)化內(nèi)存問題還在JS搞了繼承關(guān)系,不把繼承鏈上所有方法都添加到一個(gè)JS對(duì)象,避免像基類 NSObject 的幾百個(gè)方法反復(fù)添加在每個(gè)JS對(duì)象上,每個(gè)方法只存在一份,JS對(duì)象復(fù)制了OC對(duì)象的繼承關(guān)系,找方法時(shí)沿著繼承鏈往上找,結(jié)果內(nèi)存消耗是小了一些,但還是大到難以接受。
新實(shí)現(xiàn)
當(dāng)時(shí)繼續(xù)苦苦尋找解決方案,若按JS語法,這是唯一的方法,但若不按JS語法呢?突然腦洞開了下,CoffieScript/JSX都可以用JS實(shí)現(xiàn)一個(gè)解釋器實(shí)現(xiàn)自己的語法,我也可以通過類似的方式做到,再進(jìn)一步想到其實(shí)我想要的效果很簡單,就是調(diào)用一個(gè)不存在方法時(shí),能轉(zhuǎn)發(fā)到一個(gè)指定函數(shù)去執(zhí)行,就能解決一切問題了,這其實(shí)可以用簡單的字符串替換,把JS腳本里的方法調(diào)用都替換掉。***的解決方案是,在OC執(zhí)行JS腳本前,通過正則把所有方法調(diào)用都改成調(diào)用 __c() 函數(shù),再執(zhí)行這個(gè)JS腳本,做到了類似OC/Lua/Ruby等的消息轉(zhuǎn)發(fā)機(jī)制:
- UIView.alloc().init()
- ->
- UIView.__c('alloc')().__c('init')()
給JS對(duì)象基類 Object 的 prototype 加上 __c 成員,這樣所有對(duì)象都可以調(diào)用到 __c,根據(jù)當(dāng)前對(duì)象類型判斷進(jìn)行不同操作:
- Object.prototype.__c = function(methodName) {
- if (!this.__obj && !this.__clsName) return this[methodName].bind(this);
- var self = this
- return function(){
- var args = Array.prototype.slice.call(arguments)
- return _methodFunc(self.__obj, self.__clsName, methodName, args, self.__isSuper)
- }
- }
_methodFunc() 就是把相關(guān)信息傳給OC,OC用 Runtime 接口調(diào)用相應(yīng)方法,返回結(jié)果值,這個(gè)調(diào)用就結(jié)束了。
這樣做不用去OC遍歷對(duì)象方法,不用在JS對(duì)象保存這些方法,內(nèi)存消耗直降99%,這一步是做這個(gè)項(xiàng)目最爽的時(shí)候,用一個(gè)非常簡單的方法解決了嚴(yán)重的問題,替換之前又復(fù)雜效果又差的實(shí)現(xiàn)。
3.消息傳遞
解決了JS接口問題,接下來看看JS和OC是怎樣互傳消息的。這里用到了 JavaScriptCore 的接口,OC端在啟動(dòng)JSPatch引擎時(shí)會(huì)創(chuàng)建一個(gè) JSContext 實(shí)例,JSContext 是JS代碼的執(zhí)行環(huán)境,可以給 JSContext 添加方法,JS就可以直接調(diào)用這個(gè)方法:
- JSContext *context = [[JSContext alloc] init];
- context[@"hello"] = ^(NSString *msg) {
- NSLog(@"hello %@", msg);
- };
[_context evaluateScript:@"hello('word')"]; //output hello word
JS通過調(diào)用 JSContext 定義的方法把數(shù)據(jù)傳給OC,OC通過返回值傳會(huì)給JS。調(diào)用這種方法,它的參數(shù)/返回值 JavaScriptCore 都會(huì)自動(dòng)轉(zhuǎn)換,OC里的 NSArray, NSDictionary, NSString, NSNumber, NSBlock 會(huì)分別轉(zhuǎn)為JS端的數(shù)組/對(duì)象/字符串/數(shù)字/函數(shù)類型。上述 _methodFunc() 方法就是這樣把要調(diào)用的類名和方法名傳遞給OC的。
4.對(duì)象持有/轉(zhuǎn)換
UIView.alloc() 通過上述消息傳遞后會(huì)到OC執(zhí)行 [UIView alloc],并返回一個(gè)UIView實(shí)例對(duì)象給JS,這個(gè)OC實(shí)例對(duì)象在JS是怎樣表示的呢?怎樣可以在JS拿到這個(gè)實(shí)例對(duì)象后可以直接調(diào)用它的實(shí)例方法 (UIView.alloc().init())?
對(duì)于一個(gè)自定義id對(duì)象,JavaScriptCore 會(huì)把這個(gè)自定義對(duì)象的指針傳給JS,這個(gè)對(duì)象在JS無法使用,但在回傳給OC時(shí)OC可以找到這個(gè)對(duì)象。對(duì)于這個(gè)對(duì)象生命周期的管理,按我的理解如果JS有變量引用時(shí),這個(gè)OC對(duì)象引用計(jì)數(shù)就加1 ,JS變量的引用釋放了就減1,如果OC上沒別的持有者,這個(gè)OC對(duì)象的生命周期就跟著JS走了,會(huì)在JS進(jìn)行垃圾回收時(shí)釋放。
傳回給JS的變量是這個(gè)OC對(duì)象的指針,如果不經(jīng)過任何處理,是無法通過這個(gè)變量去調(diào)用實(shí)例方法的。所以在返回對(duì)象時(shí),JSPatch 會(huì)對(duì)這個(gè)對(duì)象進(jìn)行封裝。
首先,告訴JS這是一個(gè)OC對(duì)象:
- static NSDictionary *toJSObj(id obj)
- {
- if (!obj) return nil;
- return @{@"__isObj": @(YES), @"cls": NSStringFromClass([obj class]), @"obj": obj};
- }
用__isObj表示這是一個(gè)OC對(duì)象,對(duì)象指針也一起返回。接著在JS端會(huì)把這個(gè)對(duì)象轉(zhuǎn)為一個(gè) JSClass 實(shí)例:
- var JSClass
- var _getJSClass = function(className) {
- if (!JSClass) {
- JSClass = function(obj, className, isSuper) {
- this.__obj = obj
- this.__isSuper = isSuper
- this.__clsName = className
- }
- }
- return JSClass
- }
- var _toJSObj = function(meta) {
var JSClass = _getJSClass()
return new JSClass(meta["obj"], meta["cls"])
}
JS端如果發(fā)現(xiàn)返回是一個(gè)OC對(duì)象,會(huì)傳入 _toJSObj(),生成一個(gè) JSClass 實(shí)例,這個(gè)實(shí)例保存著OC對(duì)象指針,類名等。這個(gè)實(shí)例就是OC對(duì)象在 JSPatch 對(duì)應(yīng)的JS對(duì)象,生命周期是一樣的。
回到我們第二點(diǎn)說的 JS接口, 這個(gè) JSClass 實(shí)例對(duì)象同樣有 __c 函數(shù),調(diào)用這個(gè)對(duì)象的方法時(shí),同樣走到 __c 函數(shù), __c 函數(shù)會(huì)把JSClass實(shí)例對(duì)象里的OC對(duì)象指針以及要調(diào)用的方法名和參數(shù)回傳給OC,這樣OC就可以調(diào)用這個(gè)對(duì)象的實(shí)例方法了。
接著看看對(duì)象是怎樣回傳給OC的。上述例子中,view.setBackgroundColor(require(‘UIColor’).grayColor()),這里生成了一個(gè) UIColor 實(shí)例對(duì)象,并作為參數(shù)回傳給OC。根據(jù)上面說的,這個(gè) UIColor 實(shí)例在JS中的表示是一個(gè) JSClass 實(shí)例,所以不能直接回傳給OC,這里的參數(shù)實(shí)際上會(huì)在 __c 函數(shù)進(jìn)行處理,會(huì)把對(duì)象的 .__obj 原指針回傳給OC。
***一點(diǎn),OC對(duì)象可能會(huì)存在于 NSDictionary / NSArray 等容器里,所以需要遍歷容器挑出OC對(duì)象進(jìn)行格式化,OC需要把對(duì)象都替換成JS認(rèn)得的格式,JS要把對(duì)象轉(zhuǎn)成 JSClass 實(shí)例,JS實(shí)例回傳給OC時(shí)需要把實(shí)例轉(zhuǎn)為OC對(duì)象指針。所以O(shè)C流出數(shù)據(jù)時(shí)都會(huì)經(jīng)過 formatOCObj() 方法處理,JS從OC得到數(shù)據(jù)時(shí)都會(huì)經(jīng)過 _formatOCToJS() 處理,JS傳參數(shù)給OC時(shí)會(huì)經(jīng)過 _formatJSToOC() 處理,圖示:
5.類型轉(zhuǎn)換
JS把要調(diào)用的類名/方法名/對(duì)象傳給OC后,OC調(diào)用類/對(duì)象相應(yīng)的方法是通過 NSInvocation 實(shí)現(xiàn),要能順利調(diào)用到方法并取得返回值,要做兩件事:
1.取得要調(diào)用的OC方法各參數(shù)類型,把JS傳來的對(duì)象轉(zhuǎn)為要求的類型進(jìn)行調(diào)用。
2.根據(jù)返回值類型取出返回值,包裝為對(duì)象傳回給JS。
例如開頭例子的 view.setAlpha(0.5), JS傳遞給OC的是一個(gè) NSNumber,OC需要通過要調(diào)用OC方法的 NSMethodSignature 得知這里參數(shù)要的是一個(gè) float 類型值,于是把NSNumber轉(zhuǎn)為float值再作為參數(shù)進(jìn)行OC方法調(diào)用。這里主要處理了 int/float/bool 等數(shù)值類型,并對(duì) CGRect/CGRange 等類型進(jìn)行了特殊轉(zhuǎn)換處理,剩下的就是實(shí)現(xiàn)細(xì)節(jié)了。
方法替換
JSPatch 可以用 defineClass 接口任意替換一個(gè)類的方法,方法替換的實(shí)現(xiàn)過程也是頗為曲折,一開始是用 va_list 的方式獲取參數(shù),結(jié)果發(fā)現(xiàn) arm64 下不可用,只能轉(zhuǎn)而用另一種hack方式繞道實(shí)現(xiàn)。另外在給類新增方法、實(shí)現(xiàn)property、支持self/super關(guān)鍵字上也費(fèi)了些功夫,下面逐個(gè)說明。
基礎(chǔ)原理
OC上,每個(gè)類都是這樣一個(gè)結(jié)構(gòu)體:
- struct objc_class {
- struct objc_class * isa;
- const char *name;
- ….
- struct objc_method_list **methodLists; /*方法鏈表*/
- };
其中 methodList 方法鏈表里存儲(chǔ)的是Method類型:
- typedef struct objc_method *Method;
- typedef struct objc_ method {
- SEL method_name;
- char *method_types;
- IMP method_imp;
- };
Method 保存了一個(gè)方法的全部信息,包括SEL方法名,type各參數(shù)和返回值類型,IMP該方法具體實(shí)現(xiàn)的函數(shù)指針。
通過 Selector 調(diào)用方法時(shí),會(huì)從 methodList 鏈表里找到對(duì)應(yīng)Method進(jìn)行調(diào)用,這個(gè) methodList 上的的元素是可以動(dòng)態(tài)替換的,可以把某個(gè) Selector 對(duì)應(yīng)的函數(shù)指針I(yè)MP替換成新的,也可以拿到已有的某個(gè) Selector 對(duì)應(yīng)的函數(shù)指針I(yè)MP,讓另一個(gè) Selector 跟它對(duì)應(yīng),Runtime 提供了一些接口做這些事,以替換 UIViewController 的 -viewDidLoad: 方法為例:
- static void viewDidLoadIMP (id slf, SEL sel) {
- JSValue *jsFunction = …;
- [jsFunction callWithArguments:nil];
- }
- Class cls = NSClassFromString(@"UIViewController");
- SEL selector = @selector(viewDidLoad);
- Method method = class_getInstanceMethod(cls, selector);
- //獲得viewDidLoad方法的函數(shù)指針
- IMP imp = method_getImplementation(method)
- //獲得viewDidLoad方法的參數(shù)類型
- char *typeDescription = (char *)method_getTypeEncoding(method);
- //新增一個(gè)ORIGViewDidLoad方法,指向原來的viewDidLoad實(shí)現(xiàn)
- class_addMethod(cls, @selector(ORIGViewDidLoad), imp, typeDescription);
- //把viewDidLoad IMP指向自定義新的實(shí)現(xiàn)
- class_replaceMethod(cls, selector, viewDidLoadIMP, typeDescription);
這樣就把 UIViewController 的 -viewDidLoad 方法給替換成我們自定義的方法,APP里調(diào)用 UIViewController 的 viewDidLoad 方法都會(huì)去到上述 viewDidLoadIMP 函數(shù)里,在這個(gè)新的IMP函數(shù)里調(diào)用JS傳進(jìn)來的方法,就實(shí)現(xiàn)了替換 -viewDidLoad 方法為JS代碼里的實(shí)現(xiàn),同時(shí)為 UIViewController 新增了個(gè)方法 -ORIGViewDidLoad 指向原來 viewDidLoad 的IMP,JS可以通過這個(gè)方法調(diào)用到原來的實(shí)現(xiàn)。
方法替換就這樣很簡單的實(shí)現(xiàn)了,但這么簡單的前提是,這個(gè)方法沒有參數(shù)。如果這個(gè)方法有參數(shù),怎樣把參數(shù)值傳給我們新的IMP函數(shù)呢?例如 UIViewController 的 -viewDidAppear: 方法,調(diào)用者會(huì)傳一個(gè)Bool值,我們需要在自己實(shí)現(xiàn)的IMP(上述的viewDidLoadIMP)上拿到這個(gè)值,怎樣能拿到?如果只是針對(duì)一個(gè)方法寫IMP,是可以直接拿到這個(gè)參數(shù)值的:
- static void viewDidAppear (id slf, SEL sel, BOOL animated) {
- [function callWithArguments:@(animated)];
- }
但我們要的是實(shí)現(xiàn)一個(gè)通用的IMP,任意方法任意參數(shù)都可以通過這個(gè)IMP中轉(zhuǎn),拿到方法的所有參數(shù)回調(diào)JS的實(shí)現(xiàn)。
va_list實(shí)現(xiàn)(32位)
最初我是用可變參數(shù)va_list實(shí)現(xiàn):
- static void commonIMP(id slf, ...)
- va_list args;
- va_start(args, slf);
- NSMutableArray *list = [[NSMutableArray alloc] init];
- NSMethodSignature *methodSignature = [cls instanceMethodSignatureForSelector:selector];
- NSUInteger numberOfArguments = methodSignature.numberOfArguments;
- id obj;
- for (NSUInteger i = 2; i < numberOfArguments; i++) {
- const char *argumentType = [methodSignature getArgumentTypeAtIndex:i];
- switch(argumentType[0]) {
- case 'i':
- obj = @(va_arg(args, int));
- break;
- case 'B':
- obj = @(va_arg(args, BOOL));
- break;
- case 'f':
- case 'd':
- obj = @(va_arg(args, double));
- break;
- …… //其他數(shù)值類型
- default: {
- obj = va_arg(args, id);
- break;
- }
- }
- [list addObject:obj];
- }
- va_end(args);
- [function callWithArguments:list];
- }
這樣無論方法參數(shù)是什么,有多少個(gè),都可以通過 va_list 的一組方法一個(gè)個(gè)取出來,組成NSArray在調(diào)用JS方法時(shí)傳回。很***地解決了參數(shù)的問題,一直運(yùn)行正常,直到我跑在arm64的機(jī)子上測試,一調(diào)用就crash。查了資料,才發(fā)現(xiàn)arm64下 va_list 的結(jié)構(gòu)改變了,導(dǎo)致無法上述這樣取參數(shù)。詳見這篇文章。
ForwardInvocation實(shí)現(xiàn)(64位)
后來找到另一種非常hack的方法解決參數(shù)獲取的問題,利用了OC消息轉(zhuǎn)發(fā)機(jī)制。
當(dāng)調(diào)用一個(gè) NSObject 對(duì)象不存在的方法時(shí),并不會(huì)馬上拋出異常,而是會(huì)經(jīng)過多層轉(zhuǎn)發(fā),層層調(diào)用對(duì)象的 -resolveInstanceMethod:, -forwardingTargetForSelector:, -methodSignatureForSelector:, -forwardInvocation: 等方法,這篇文章說得比較清楚,其中*** -forwardInvocation: 是會(huì)有一個(gè) NSInvocation 對(duì)象,這個(gè) NSInvocation 對(duì)象保存了這個(gè)方法調(diào)用的所有信息,包括 Selector 名,參數(shù)和返回值類型,最重要的是有所有參數(shù)值,可以從這個(gè) NSInvocation 對(duì)象里拿到調(diào)用的所有參數(shù)值。我們可以想辦法讓每個(gè)需要被JS替換的方法調(diào)用***都調(diào)到 -forwardInvocation:,就可以解決無法拿到參數(shù)值的問題了。
具體實(shí)現(xiàn),以替換 UIViewController 的 -viewWillAppear: 方法為例:
把UIViewController的 -viewWillAppear: 方法通過 class_replaceMethod() 接口指向一個(gè)不存在的IMP: class_getMethodImplementation(cls, @selector(__JPNONImplementSelector)),這樣調(diào)用這個(gè)方法時(shí)就會(huì)走到 -forwardInvocation:。
為 UIViewController 添加 -ORIGviewWillAppear: 和 -_JPviewWillAppear: 兩個(gè)方法,前者指向原來的IMP實(shí)現(xiàn),后者是新的實(shí)現(xiàn),稍后會(huì)在這個(gè)實(shí)現(xiàn)里回調(diào)JS函數(shù)。
改寫 UIViewController 的 -forwardInvocation: 方法為自定義實(shí)現(xiàn)。一旦OC里調(diào)用 UIViewController 的 -viewWillAppear: 方法,經(jīng)過上面的處理會(huì)把這個(gè)調(diào)用轉(zhuǎn)發(fā)到 -forwardInvocation: ,這時(shí)已經(jīng)組裝好了一個(gè) NSInvocation,包含了這個(gè)調(diào)用的參數(shù)。在這里把參數(shù)從 NSInvocation 反解出來,帶著參數(shù)調(diào)用上述新增加的方法 -JPviewWillAppear: ,在這個(gè)新方法里取到參數(shù)傳給JS,調(diào)用JS的實(shí)現(xiàn)函數(shù)。整個(gè)調(diào)用過程就結(jié)束了,整個(gè)過程圖示如下:
***一個(gè)問題,我們把 UIViewController 的 -forwardInvocation: 方法的實(shí)現(xiàn)給替換掉了,如果程序里真有用到這個(gè)方法對(duì)消息進(jìn)行轉(zhuǎn)發(fā),原來的邏輯怎么辦?首先我們?cè)谔鎿Q -forwardInvocation: 方法前會(huì)新建一個(gè)方法 -ORIGforwardInvocation:,保存原來的實(shí)現(xiàn)IMP,在新的 -forwardInvocation: 實(shí)現(xiàn)里做了個(gè)判斷,如果轉(zhuǎn)發(fā)的方法是我們想改寫的,就走我們的邏輯,若不是,就調(diào) -ORIGforwardInvocation: 走原來的流程。
實(shí)現(xiàn)過程中還碰到一個(gè)坑,就是從 -forwardInvocation: 里的 NSInvocation 對(duì)象取參數(shù)值時(shí),若參數(shù)值是id類型,我們會(huì)這樣取:
- id arg;
- [invocation getArgument:&arg atIndex:i];
但這樣取某些時(shí)候會(huì)導(dǎo)致莫名其妙的crash,而且不是crash在這個(gè)地方,似乎這里的指針取錯(cuò)導(dǎo)致后續(xù)的內(nèi)存錯(cuò)亂,crash在各種地方,這個(gè)bug查了我半天才定位到這里,至今不知為什么。后來以這樣的方式解決了:
- void *arg;
- [invocation getArgument:&arg atIndex:i];
- id a = (__bridge id)arg;
其他就是實(shí)現(xiàn)上的細(xì)節(jié)了,例如需要根據(jù)不同的返回值類型生成不同的IMP,要在各處處理參數(shù)轉(zhuǎn)換等。
新增方法
在 JSPatch 剛開源時(shí),是不支持為一個(gè)類新增方法的,因?yàn)橛X得能替換原生方法就夠了,新的方法純粹添加在JS對(duì)象上,只在JS端跑就行了。另外OC為類新增方法需要知道各個(gè)參數(shù)和返回值的類型,需要在JS定一種方式把這些類型傳給OC才能完成新增方法,比較麻煩。后來挺多人比較關(guān)注這個(gè)問題,不能新增方法導(dǎo)致 action-target 模式無法用,我也開始想有沒有更好的方法實(shí)現(xiàn)添加方法。一開始想到,反正新增的方法都是JS在用,不如新增的方法返回值和參數(shù)全統(tǒng)一成id類型,這樣就不用傳類型了,但還是需要知道參數(shù)個(gè)數(shù),后來跟Lancy聊天時(shí)找到了解決方案,JS可以獲得函數(shù)參數(shù)個(gè)數(shù),直接封裝一下把參數(shù)個(gè)數(shù)一并傳給OC就行了。
現(xiàn)在 defineClass 定義的方法會(huì)經(jīng)過JS包裝,變成一個(gè)包含參數(shù)個(gè)數(shù)和方法實(shí)體的數(shù)組傳給OC,OC會(huì)判斷如果方法已存在,就執(zhí)行替換的操作,若不存在,就調(diào)用 class_addMethod() 新增一個(gè)方法,通過傳過來的參數(shù)個(gè)數(shù)和方法實(shí)體生成新的 Method,把 Method 的參數(shù)和返回值類型都設(shè)為id。
這里有個(gè)問題,若某個(gè)類實(shí)現(xiàn)了某protocol,protocol方法里有可選的方法,它的參數(shù)不全是id類型,例如 UITableViewDataSource 的一個(gè)方法:
- - (NSInteger)tableView:(UITableView *)tableView sectionForSectionIndexTitle:(NSString *)title atIndex:(NSInteger)index;
若原類沒有實(shí)現(xiàn)這個(gè)方法,在JS里實(shí)現(xiàn)了,會(huì)走到新增方法的邏輯,每個(gè)參數(shù)類型都變成id,與這個(gè) protocol 方法不匹配,產(chǎn)生錯(cuò)誤。后續(xù)會(huì)處理 protocol 的問題,若新增的方法是 protocol 實(shí)現(xiàn)的方法,會(huì)取這個(gè)方法的 NSMethodSignature 獲得正確的參數(shù)類型進(jìn)行添加。
Property實(shí)現(xiàn)
- defineClass('JPTableViewController : UITableViewController', {
- dataSource: function() {
- var data = self.getProp('data')
- if (data) return data;
- data = [1,2,3]
- self.setProp_forKey(data, 'data')
- return data;
- }
- }
JSPatch 可以通過 -getProp:, -setProp:forKey: 這兩個(gè)方法給對(duì)象添加成員變量。實(shí)現(xiàn)上用了運(yùn)行時(shí)關(guān)聯(lián)接口 objc_getAssociatedObject() 和 objc_setAssociatedObject() 模擬,相當(dāng)于把一個(gè)對(duì)象跟當(dāng)前對(duì)象 self 關(guān)聯(lián)起來,以后可以通過當(dāng)前對(duì)象 self 找到這個(gè)對(duì)象,跟成員的效果一樣,只是一定得是id對(duì)象類型。
本來OC有 class_addIvar() 可以為類添加成員,但必須在類注冊(cè)之前添加完,注冊(cè)完成后無法添加,這意味著可以為在JS新增的類添加成員,但不能為OC上已存在的類添加,所以只能用上述方法模擬。
self關(guān)鍵字
- defineClass("JPViewController: UIViewController", {
- viewDidLoad: function() {
- var view = self.view()
- ...
- },
- }
JSPatch支持直接在 defineClass 里的實(shí)例方法里直接使用 self 關(guān)鍵字,跟OC一樣 self 是指當(dāng)前對(duì)象,這個(gè) self 關(guān)鍵字是怎樣實(shí)現(xiàn)的呢?實(shí)際上這個(gè)self是個(gè)全局變量,在 defineClass 里對(duì)實(shí)例方法 方法進(jìn)行了包裝,在調(diào)用實(shí)例方法之前,會(huì)把全局變量 self 設(shè)為當(dāng)前對(duì)象,調(diào)用完后設(shè)回空,就可以在執(zhí)行實(shí)例方法的過程中使用 self 變量了。這是一個(gè)小小的trick。
super關(guān)鍵字
- defineClass("JPViewController: UIViewController", {
- viewDidLoad: function() {
- self.super.viewDidLoad()
- },
- }
OC里 super 是一個(gè)關(guān)鍵字,無法通過動(dòng)態(tài)方法拿到 super,那么 JSPatch 的super是怎么實(shí)現(xiàn)的?實(shí)際上調(diào)用 super 的方法,OC做的事是調(diào)用父類的某個(gè)方法,并把當(dāng)前對(duì)象當(dāng)成 self 傳入父類方法,我們只要模擬它這個(gè)過程就行了。
首先JS端需要告訴OC想調(diào)用的是當(dāng)前對(duì)象的 super 方法,做法是調(diào)用 self.super時(shí),會(huì)返回一個(gè)新的 JSClass 實(shí)例,這個(gè)實(shí)例同樣保存了OC對(duì)象的引用,同時(shí)標(biāo)識(shí) __isSuper=1。
- JSClass = function(obj, className, isSuper) {
- this.__obj = obj
- this.__isSuper = isSuper
- this.__clsName = className
- }
- JSClass.prototype.__defineGetter__('super', function(){
- if (!this.__super) {
- this.__super = new JSClass(this.__obj, this.__clsName, 1)
- }
- return this.__super
- })
調(diào)用方法時(shí),__isSuper 會(huì)傳給OC,告訴OC要調(diào) super 的方法。OC做的事情是,如果是調(diào)用 super 方法,找到 superClass 這個(gè)方法的IMP實(shí)現(xiàn),為當(dāng)前類新增一個(gè)方法指向 super 的IMP實(shí)現(xiàn),那么調(diào)用這個(gè)類的新方法就相當(dāng)于調(diào)用 super 方法。把要調(diào)用的方法替換成這個(gè)新方法,就完成 super 方法的調(diào)用了。
- static id callSelector(NSString *className, NSString *selectorName, NSArray *arguments, id instance, BOOL isSuper) {
- ...
- if (isSuper) {
- NSString *superSelectorName = [NSString stringWithFormat:@"SUPER_%@", selectorName];
- SEL superSelector = NSSelectorFromString(superSelectorName);
- Class superCls = [cls superclass];
- Method superMethod = class_getInstanceMethod(superCls, selector);
- IMP superIMP = method_getImplementation(superMethod);
- class_addMethod(cls, superSelector, superIMP, method_getTypeEncoding(superMethod));
- selector = superSelector;
- }
- ...
- }
總結(jié)
整個(gè) JSPatch 實(shí)現(xiàn)原理就大致描述完了,剩下的一些小點(diǎn),例如GCD接口,block實(shí)現(xiàn),方法名下劃線處理等就不細(xì)說了,可以直接看代碼。JSPatch 還在持續(xù)改進(jìn)中,希望能成為iOS平臺(tái)動(dòng)態(tài)更新的***解決方案,歡迎大家一起建設(shè)這個(gè)項(xiàng)目,github地址: https://github.com/bang590/JSPatc