轉(zhuǎn)載:原文鏈接 http://blog.cnbang.net/tech/2808/
JSPatch以小巧的體積做到了讓JS調(diào)用/替換任意OC方法,讓iOS APP具備熱更新的能力闷尿,在實(shí)現(xiàn) JSPatch 過(guò)程中遇到過(guò)很多困難也踩過(guò)很多坑驼鹅,有些還是挺值得分享的方援。本篇文章從基礎(chǔ)原理黎休、方法調(diào)用和方法替換三塊內(nèi)容介紹整個(gè) JSPatch 的實(shí)現(xiàn)原理欢揖,并把實(shí)現(xiàn)過(guò)程中的想法和碰到的坑也盡可能記錄下來(lái)陶耍。
基礎(chǔ)原理
能做到通過(guò)JS調(diào)用和改寫(xiě)OC方法最根本的原因是 Objective-C 是動(dòng)態(tài)語(yǔ)言,OC上所有方法的調(diào)用/類的生成都通過(guò) Objective-C Runtime 在運(yùn)行時(shí)進(jìn)行她混,我們可以通過(guò)類名/方法名反射得到相應(yīng)的類和方法:
Class class=NSClassFromString("UIViewController");
idviewController = [[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í)通過(guò)類名/方法名調(diào)用到任何OC方法馒过,替換任何類的實(shí)現(xiàn)以及新增任意類。所以 JSPatch 的原理就是:JS傳遞字符串給OC酗钞,OC通過(guò) Runtime 接口調(diào)用和替換OC方法腹忽。這是最基礎(chǔ)的原理,實(shí)際實(shí)現(xiàn)過(guò)程還有很多怪要打砚作,接下來(lái)看看具體是怎樣實(shí)現(xiàn)的窘奏。
方法調(diào)用
require('UIView')
var view = UIView.alloc().init()
view.setBackgroundColor(require('UIColor').grayColor())
view.setAlpha(0.5)
引入JSPatch后,可以通過(guò)以上JS代碼創(chuàng)建了一個(gè) UIView 實(shí)例葫录,并設(shè)置背景顏色和透明度着裹,涵蓋了require引入類,JS調(diào)用接口米同,消息傳遞骇扇,對(duì)象持有和轉(zhuǎn)換,參數(shù)轉(zhuǎn)換這五個(gè)方面面粮,接下來(lái)逐一看看具體實(shí)現(xiàn)少孝。
1.require
調(diào)用require(‘UIView’)后,就可以直接使用UIView這個(gè)變量去調(diào)用相應(yīng)的類方法了但金,require 做的事很簡(jiǎn)單韭山,就是在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接口
接下來(lái)看看UIView.alloc()是怎樣調(diào)用的凿歼。
舊實(shí)現(xiàn)
對(duì)于這個(gè)調(diào)用的實(shí)現(xiàn)褪迟,一開(kāi)始我的想法是,根據(jù)JS特性答憔,若要讓UIView.alloc()這句調(diào)用不出錯(cuò)味赃,唯一的方法就是給UIView這個(gè)對(duì)象添加alloc方法,不然是不可能調(diào)用成功的虐拓,JS對(duì)于調(diào)用沒(méi)定義的屬性/變量心俗,只會(huì)馬上拋出異常,而不像OC/Lua/ruby那樣會(huì)有轉(zhuǎn)發(fā)機(jī)制。所以做了一個(gè)復(fù)雜的事城榛,就是在require生成類對(duì)象時(shí)揪利,把類名傳入OC,OC通過(guò) 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)重的問(wèn)題,引入幾個(gè)類就內(nèi)存暴漲昭齐,無(wú)法使用尿招。后來(lái)為了優(yōu)化內(nèi)存問(wèn)題還在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語(yǔ)法,這是唯一的方法隧甚,但若不按JS語(yǔ)法呢车荔?突然腦洞開(kāi)了下,CoffieScript/JSX都可以用JS實(shí)現(xiàn)一個(gè)解釋器實(shí)現(xiàn)自己的語(yǔ)法戚扳,我也可以通過(guò)類似的方式做到忧便,再進(jìn)一步想到其實(shí)我想要的效果很簡(jiǎn)單,就是調(diào)用一個(gè)不存在方法時(shí)帽借,能轉(zhuǎn)發(fā)到一個(gè)指定函數(shù)去執(zhí)行珠增,就能解決一切問(wèn)題了,這其實(shí)可以用簡(jiǎn)單的字符串替換砍艾,把JS腳本里的方法調(diào)用都替換掉蒂教。最后的解決方案是,在OC執(zhí)行JS腳本前脆荷,通過(guò)正則把所有方法調(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è)非常簡(jiǎn)單的方法解決了嚴(yán)重的問(wèn)題寂祥,替換之前又復(fù)雜效果又差的實(shí)現(xiàn)。
3.消息傳遞
解決了JS接口問(wèn)題七兜,接下來(lái)看看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通過(guò)調(diào)用 JSContext 定義的方法把數(shù)據(jù)傳給OC狠裹,OC通過(guò)返回值傳會(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()通過(guò)上述消息傳遞后會(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無(wú)法使用噪奄,但在回傳給OC時(shí)OC可以找到這個(gè)對(duì)象死姚。對(duì)于這個(gè)對(duì)象生命周期的管理,按我的理解如果JS有變量引用時(shí)勤篮,這個(gè)OC對(duì)象引用計(jì)數(shù)就加1 都毒,JS變量的引用釋放了就減1,如果OC上沒(méi)別的持有者碰缔,這個(gè)OC對(duì)象的生命周期就跟著JS走了账劲,會(huì)在JS進(jìn)行垃圾回收時(shí)釋放。
傳回給JS的變量是這個(gè)OC對(duì)象的指針,如果不經(jīng)過(guò)任何處理瀑焦,是無(wú)法通過(guò)這個(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 newJSClass(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)說(shuō)的 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ù)上面說(shuō)的徽职,這個(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)過(guò)formatOCObj()方法處理煞额,JS從OC得到數(shù)據(jù)時(shí)都會(huì)經(jīng)過(guò)_formatOCToJS()處理思恐,JS傳參數(shù)給OC時(shí)會(huì)經(jīng)過(guò)_formatJSToOC()處理沾谜,圖示:
5.類型轉(zhuǎn)換
JS把要調(diào)用的類名/方法名/對(duì)象傳給OC后,OC調(diào)用類/對(duì)象相應(yīng)的方法是通過(guò) NSInvocation 實(shí)現(xiàn)胀莹,要能順利調(diào)用到方法并取得返回值基跑,要做兩件事:
1.取得要調(diào)用的OC方法各參數(shù)類型,把JS傳來(lái)的對(duì)象轉(zhuǎn)為要求的類型進(jìn)行調(diào)用嗜逻。
2.根據(jù)返回值類型取出返回值涩僻,包裝為對(duì)象傳回給JS。
例如開(kāi)頭例子的view.setAlpha(0.5)栈顷, JS傳遞給OC的是一個(gè) NSNumber,OC需要通過(guò)要調(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)過(guò)程也是頗為曲折晓折,一開(kāi)始是用 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è)說(shuō)明梁肿。
基礎(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ù)指針填抬。
通過(guò) 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方法,指向原來(lái)的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)來(lái)的方法蚌讼,就實(shí)現(xiàn)了替換-viewDidLoad方法為JS代碼里的實(shí)現(xiàn),同時(shí)為 UIViewController 新增了個(gè)方法-ORIGViewDidLoad指向原來(lái) viewDidLoad 的IMP个榕,JS可以通過(guò)這個(gè)方法調(diào)用到原來(lái)的實(shí)現(xiàn)篡石。
方法替換就這樣很簡(jiǎn)單的實(shí)現(xiàn)了,但這么簡(jiǎn)單的前提是西采,這個(gè)方法沒(méi)有參數(shù)凰萨。如果這個(gè)方法有參數(shù),怎樣把參數(shù)值傳給我們新的IMP函數(shù)呢械馆?例如 UIViewController 的-viewDidAppear:方法胖眷,調(diào)用者會(huì)傳一個(gè)Bool值,我們需要在自己實(shí)現(xiàn)的IMP(上述的viewDidLoadIMP)上拿到這個(gè)值霹崎,怎樣能拿到珊搀?如果只是針對(duì)一個(gè)方法寫(xiě)IMP,是可以直接拿到這個(gè)參數(shù)值的:
static void viewDidAppear (id slf,SEL sel,BOOL animated) {
[function callWithArguments:@(animated)];
}
但我們要的是實(shí)現(xiàn)一個(gè)通用的IMP尾菇,任意方法任意參數(shù)都可以通過(guò)這個(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;
idobj;
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];
}
這樣無(wú)論方法參數(shù)是什么派诬,有多少個(gè)劳淆,都可以通過(guò)va_list的一組方法一個(gè)個(gè)取出來(lái),組成NSArray在調(diào)用JS方法時(shí)傳回默赂。很完美地解決了參數(shù)的問(wèn)題沛鸵,一直運(yùn)行正常,直到我跑在arm64的機(jī)子上測(cè)試放可,一調(diào)用就crash谒臼。查了資料,才發(fā)現(xiàn)arm64下va_list的結(jié)構(gòu)改變了耀里,導(dǎo)致無(wú)法上述這樣取參數(shù)蜈缤。詳見(jiàn)這篇文章。
ForwardInvocation實(shí)現(xiàn)(64位)
后來(lái)找到另一種非常hack的方法解決參數(shù)獲取的問(wèn)題冯挎,利用了OC消息轉(zhuǎn)發(fā)機(jī)制底哥。
當(dāng)調(diào)用一個(gè) NSObject 對(duì)象不存在的方法時(shí),并不會(huì)馬上拋出異常房官,而是會(huì)經(jīng)過(guò)多層轉(zhuǎn)發(fā)趾徽,層層調(diào)用對(duì)象的-resolveInstanceMethod:,-forwardingTargetForSelector:,-methodSignatureForSelector:,-forwardInvocation:等方法,這篇文章說(shuō)得比較清楚翰守,其中最后-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:载绿,就可以解決無(wú)法拿到參數(shù)值的問(wèn)題了粥诫。
具體實(shí)現(xiàn),以替換 UIViewController 的-viewWillAppear:方法為例:
把UIViewController的-viewWillAppear:方法通過(guò)class_replaceMethod()接口指向一個(gè)不存在的IMP:class_getMethodImplementation(cls, @selector(__JPNONImplementSelector))崭庸,這樣調(diào)用這個(gè)方法時(shí)就會(huì)走到-forwardInvocation:怀浆。
為 UIViewController 添加-ORIGviewWillAppear:和-_JPviewWillAppear:兩個(gè)方法,前者指向原來(lái)的IMP實(shí)現(xiàn)怕享,后者是新的實(shí)現(xiàn)执赡,稍后會(huì)在這個(gè)實(shí)現(xiàn)里回調(diào)JS函數(shù)。
改寫(xiě) UIViewController 的-forwardInvocation:方法為自定義實(shí)現(xiàn)函筋。一旦OC里調(diào)用 UIViewController 的-viewWillAppear:方法搀玖,經(jīng)過(guò)上面的處理會(huì)把這個(gè)調(diào)用轉(zhuǎn)發(fā)到-forwardInvocation:,這時(shí)已經(jīng)組裝好了一個(gè) NSInvocation驻呐,包含了這個(gè)調(diào)用的參數(shù)。在這里把參數(shù)從 NSInvocation 反解出來(lái)芳来,帶著參數(shù)調(diào)用上述新增加的方法-JPviewWillAppear:含末,在這個(gè)新方法里取到參數(shù)傳給JS,調(diào)用JS的實(shí)現(xiàn)函數(shù)即舌。整個(gè)調(diào)用過(guò)程就結(jié)束了佣盒,整個(gè)過(guò)程圖示如下:
最后一個(gè)問(wèn)題,我們把 UIViewController 的-forwardInvocation:方法的實(shí)現(xiàn)給替換掉了顽聂,如果程序里真有用到這個(gè)方法對(duì)消息進(jìn)行轉(zhuǎn)發(fā)肥惭,原來(lái)的邏輯怎么辦?首先我們?cè)谔鎿Q-forwardInvocation:方法前會(huì)新建一個(gè)方法-ORIGforwardInvocation:紊搪,保存原來(lái)的實(shí)現(xiàn)IMP蜜葱,在新的-forwardInvocation:實(shí)現(xiàn)里做了個(gè)判斷,如果轉(zhuǎn)發(fā)的方法是我們想改寫(xiě)的耀石,就走我們的邏輯牵囤,若不是,就調(diào)-ORIGforwardInvocation:走原來(lái)的流程滞伟。
實(shí)現(xiàn)過(guò)程中還碰到一個(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查了我半天才定位到這里鳖轰,至今不知為什么。后來(lái)以這樣的方式解決了:
void *arg;
[invocation getArgument:&arg atIndex:i];
ida = (__bridgeid)arg;
其他就是實(shí)現(xiàn)上的細(xì)節(jié)了督禽,例如需要根據(jù)不同的返回值類型生成不同的IMP脆霎,要在各處處理參數(shù)轉(zhuǎn)換等。
新增方法
在 JSPatch 剛開(kāi)源時(shí)狈惫,是不支持為一個(gè)類新增方法的睛蛛,因?yàn)橛X(jué)得能替換原生方法就夠了,新的方法純粹添加在JS對(duì)象上胧谈,只在JS端跑就行了忆肾。另外OC為類新增方法需要知道各個(gè)參數(shù)和返回值的類型,需要在JS定一種方式把這些類型傳給OC才能完成新增方法菱肖,比較麻煩客冈。后來(lái)挺多人比較關(guān)注這個(gè)問(wèn)題,不能新增方法導(dǎo)致 action-target 模式無(wú)法用稳强,我也開(kāi)始想有沒(méi)有更好的方法實(shí)現(xiàn)添加方法场仲。一開(kāi)始想到,反正新增的方法都是JS在用退疫,不如新增的方法返回值和參數(shù)全統(tǒng)一成id類型渠缕,這樣就不用傳類型了,但還是需要知道參數(shù)個(gè)數(shù)褒繁,后來(lái)跟Lancy聊天時(shí)找到了解決方案亦鳞,JS可以獲得函數(shù)參數(shù)個(gè)數(shù),直接封裝一下把參數(shù)個(gè)數(shù)一并傳給OC就行了棒坏。
現(xiàn)在defineClass定義的方法會(huì)經(jīng)過(guò)JS包裝燕差,變成一個(gè)包含參數(shù)個(gè)數(shù)和方法實(shí)體的數(shù)組傳給OC,OC會(huì)判斷如果方法已存在坝冕,就執(zhí)行替換的操作徒探,若不存在,就調(diào)用class_addMethod()新增一個(gè)方法徽诲,通過(guò)傳過(guò)來(lái)的參數(shù)個(gè)數(shù)和方法實(shí)體生成新的 Method刹帕,把 Method 的參數(shù)和返回值類型都設(shè)為id。
這里有個(gè)問(wèn)題谎替,若某個(gè)類實(shí)現(xiàn)了某protocol偷溺,protocol方法里有可選的方法,它的參數(shù)不全是id類型钱贯,例如UITableViewDataSource的一個(gè)方法:
- (NSInteger)tableView:(UITableView *)tableView sectionForSectionIndexTitle:(NSString*)title atIndex:(NSInteger)index;
若原類沒(méi)有實(shí)現(xiàn)這個(gè)方法挫掏,在JS里實(shí)現(xiàn)了,會(huì)走到新增方法的邏輯秩命,每個(gè)參數(shù)類型都變成id尉共,與這個(gè) protocol 方法不匹配褒傅,產(chǎn)生錯(cuò)誤。后續(xù)會(huì)處理 protocol 的問(wèn)題袄友,若新增的方法是 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 可以通過(guò)-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)起來(lái)鸠按,以后可以通過(guò)當(dāng)前對(duì)象 self 找到這個(gè)對(duì)象礼搁,跟成員的效果一樣,只是一定得是id對(duì)象類型目尖。
本來(lái)OC有class_addIvar()可以為類添加成員馒吴,但必須在類注冊(cè)之前添加完,注冊(cè)完成后無(wú)法添加瑟曲,這意味著可以為在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í)例方法的過(guò)程中使用 self 變量了示辈。這是一個(gè)小小的trick。
super關(guān)鍵字
defineClass("JPViewController: UIViewController", {
viewDidLoad:function() {
self.super.viewDidLoad()
},
}
OC里 super 是一個(gè)關(guān)鍵字遣蚀,無(wú)法通過(guò)動(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è)過(guò)程就行了玖喘。
首先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 = newJSClass(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ì)說(shuō)了弛车,可以直接看代碼。JSPatch 還在持續(xù)改進(jìn)中蒲每,希望能成為iOS平臺(tái)動(dòng)態(tài)更新的最佳解決方案纷跛,歡迎大家一起建設(shè)這個(gè)項(xiàng)目,github地址:https://github.com/bang590/JSPatch