JSPatch原理剖析


一、热修原理

JSPatch 是一个 iOS 动态更新框架,只需在项目中引入极小的引擎,就可以使用 JavaScript 调用任何 Objective-C 原生接口,获得脚本语言的优势:为项目动态添加模块,或替换项目原生代码动态修复BUG

JSPatch 能做到通过 JS 调用和改写 OC 方法最根本的原因是 Objective-C 是动态语言,OC 上所有方法的调用/类的生成都通过 Objective-C Runtime 在运行时进行,我们可以通过类名/方法名反射得到相应的类和方法。

所以 JSPatch 的基本原理就是:JS 传递字符串给 OCOC 通过 Runtime 接口调用和替换 OC 方法,这是最基础的原理。

1.1 热修的方法替换过程
JSPatch准备过程
热修文件示例
第1步:[JPEngine startEngine]的调用

通过苹果官方提供的JavaScriptCore框架,使用JSContext对象实现 JSNative 的交互。这个框架很简单但非常强大,可以网上搜索掌握它的用法,这里不再细说,但是掌握这个框架的基本使用才能继续分析JSPatch框架。

context[@"_OC_defineClass"] = ^(NSString *classDeclaration, JSValue *instanceMethods, JSValue *classMethods) {
        return defineClass(classDeclaration, instanceMethods, classMethods);
};

如上OC代码是指向 JS 注入了全局的 _OC_defineClass 方法,其具体实现对应着 Nativeblock,这就是JavaScriptCore的强大之处。这样一来,我们可以在 JS 代码中直接调用 _OC_defineClass 这个方法,即可调用到 Native 中了。

global.defineClass = function(declaration, instMethods, clsMethods) {
    var newInstMethods = {}, newClsMethods = {}
    _formatDefineMethods(instMethods, newInstMethods)
    _formatDefineMethods(clsMethods, newClsMethods)
    var ret = _OC_defineClass(declaration, newInstMethods, newClsMethods)
    return require(ret["cls"])
}
第2步:global.defineClass方法解析

defineClass方法接收的参数是:

1:类名字符串。
2:类的实例方法和类方法列表(都是js对象的形式)。

defineClass方法会首先分别对这两个对象调用 _formatDefineMethods 方法。

JSPatch的全局函数
var _formatDefineMethods = function(methods, newMethods) {
    for (var methodName in methods) {
      (function(){
       var originMethod = methods[methodName]
        newMethods[methodName] = [originMethod.length, function() {
          var args = _formatOCToJS(Array.prototype.slice.call(arguments))
          var lastSelf = global.self
          var ret;
          try {
            global.self = args[0]
            args.splice(0,1)
            ret = originMethod.apply(originMethod, args)
            global.self = lastSelf
          } catch(e) {
            _OC_catch(e.message, e.stack)
          }
          return ret
        }]
      })()
    }
  }

_formatDefineMethods 作用,简单的说就是它把defineClass中传递过来的JS对象进行了修改:

原来的形式是:
  {
     methodName:function(){...}
  }
修改之后是:
  {
     methodName: [argCount, function(){...新的实现}]
  }

传递参数个数的目的是:runtime 在修复类的时候,无法直接解析原始的JS实现函数,那么就不知道参数的个数,特别是在创建新的方法的时候,需要根据参数个数生成方法签名,所以只能在JS端拿到JS函数的参数个数,传递到OC端。

第3步:_OC_defineClass方法实现
context[@"_OC_defineClass"] = ^(NSString *classDeclaration, JSValue *instanceMethods, JSValue *classMethods) {
    return defineClass(classDeclaration, instanceMethods, classMethods);
};

JPEngine中,定了一个名为defineClass的函数,这个函数对类进行真正的重写操作。我们知道runtime重写一个方法,需要几个最基本的参数:类名selector方法实现(IMP)方法签名defineClass做的就是把这些信息提取出来:

1、首先是对类名进行解析,把协议名、类名、父类名都解析出来。如果类不存在,那么创建并注册该类。
2、分别对实例方法和类方法进行处理,JS函数 _formatDefineMethods 处理返回的是JS对象,传递到OC这边会被JavaScriptCore转换为JSValue对象,可以对该对象直接调用toDictionaryJS对象转换成OC字典。这样我们就可以取到方法名参数个数具体实现

JSValue与Object的转换

3、遍历字典的key,即方法名,根据方法名取出的值还是JSValue对象,不过它代表的是数组,第一个值是参数的个数,第二个值是函数的实现。
4、方法名的处理:这块涉及到方法名的格式要求和处理,例如:在JS中的 tableView_numberOfRowsInSection,下划线需要被替换成':'
5、最后拿着处理好的方法名和具体实现等调用 overrideMethod 函数。

第4步:overrideMethod 函数实现
static void overrideMethod(Class cls, NSString *selectorName, JSValue *function, BOOL isClassMethod, const char *typeDescription)

1、把selector对应的具体实现使用 class_replaceMethod 替换成 _objc_msgForward,我们知道这个对应着消息转发机制。
2、把 forwardInvocation 的具体实现替换成 JPForwardInvocation 实现。
3、向class添加名为 ORIGforwardInvocation 的方法,实现是原始的 forwardInvocationIMP
4、向class添加名为ORIG+selector,对应原始selectorIMPJS 可以通过这个方法调用到原来的实现。
5、向class添加名为_JP + selector,对应JS重写的函数实现。

1.2 热修的方法执行流程
热修流程
第1步:JPForwardInvocation函数

经过上一步的处理,调用被热修的selector时,其实调用的是objc_msgForward,即走到了消息转发的环节。而在此的上一步中把 forwardInvocation 方法的实现替换成了 JPForwardInvocation 方法。

1、把selector前面加上 _JP 前缀,构成的新的selector,如果本地存储的字典中没有存储对应的JS方法实现,说明这个不是我们重写的方法,那么走原来的消息转发;否则调用JS方法实现。

2、把self和其他的参数都转换称JS对象,JS端重写的函数传递过来是JSValue类型,这里对应着JS函数,可以对其调用callWithArgument方法,参数转换成JS对象,执行函数。

实际上这个方法的细节是非常多的,根据方法签名,取出每个参数的类型,进行参数的封装、对于结构体的处理等等。

讲到这里,就完成了函数调用环节。

第2步:callSelector函数

在最开始startEngine的时候,会把这些热修的JS代码统一进行正则表达式的匹配替换,也就是把所有的函数都替换成对名为 __c() 函数的调用,例如:

UIView.alloc().init()
->
UIView.__c('alloc')().__c('init')()

__c() 具体的实现就是调用了 _methodFunc() 函数。

var _methodFunc = function(instance, clsName, methodName, args, isSuper, isPerformSelector) {
    var selectorName = methodName
    if (!isPerformSelector) {
      methodName = methodName.replace(/__/g, "-")
      selectorName = methodName.replace(/_/g, ":").replace(/-/g, "_")
      var marchArr = selectorName.match(/:/g)
      var numOfArgs = marchArr ? marchArr.length : 0
      if (args.length > numOfArgs) {
        selectorName += ":"
      }
    }
    var ret = instance ? _OC_callI(instance, selectorName, args, isSuper):
                         _OC_callC(clsName, selectorName, args)
    return _formatOCToJS(ret)
}

参见源码我们可以知道 _methodFunc() 函数会调用 _OC_call 函数,而在startEngine的一开始,我们就为JSContext注入了 _OC_callI_OC_callC 函数,具体实现是一个调用了OCcallSelectorblock:

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);
};

callSelector 函数中主要做的事情有:

1、把JS对象和JS参数转换为OC对象;
2、判断是否调用的是父类的方法,如果是就走父类的方法实现;
3、把参数等信息封装成NSInvocation对象并执行,然后返回结果;

具体的实现细节包括对methodSignature的字符处理,根据这些字符对JS对象进行处理和转换,还有对结构体对支持等。


二、热修语法

1.JSPatch实现原理教程:https://github.com/bang590/JSPatch/wiki/JSPatch-%E5%AE%9E%E7%8E%B0%E5%8E%9F%E7%90%86%E8%AF%A6%E8%A7%A3

2.JSPatch官方的热修语法文档:https://github.com/bang590/JSPatch/wiki/JSPatch-%E5%9F%BA%E7%A1%80%E7%94%A8%E6%B3%95

3.在线OC代码翻译成热修JS的工具:http://bang590.github.io/JSPatchConvertor/


三、其他问题

3.1.为什么要重启,热修文件才会生效的原因。
JS文件下载的位置是:applicationDidBecomeActive: 方法,使用JS的代码放在 didFinishLaunchingWithOptions: 这个方法。因为这个方法在程序启动和后台回到前台时都会调用,并且端上可以设置一个间隔时间的策略,也就是说每次来到这个方法时,先要检测是距离上次发请求的时间间隔是否超过1小时,超过则发请求,否则跳过。因为如果这个app用户一直放在手机的后台(比如微信),并且也没出现内存警告的话,这个 didFinishLaunchingWithOptions: 方法应该一直不会调用。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,029评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,395评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,570评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,535评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,650评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,850评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,006评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,747评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,207评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,536评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,683评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,342评论 4 330
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,964评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,772评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,004评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,401评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,566评论 2 349

推荐阅读更多精彩内容