1、简介
JSPatch诞生于2015年5月,最初是腾讯广研高级iOS开发@bang的个人项目。
它能够使用JavaScript调用Objective-C的原生接口,从而动态植入代码来替换旧代码,以实现修复线上bug。
JSPatch在Github.com上开源后获得了3000多个star和500多fork,广受关注,目前已被应用在大量腾讯/阿里/百度的App中。
项目主页: https://github.com/bang590/JSPatch
示例下载: https://github.com/ios122/ios122
2、优势
在项目中引入JSPatch,就可以在发现bug时下发JS脚本替换原生方法,可以做到无需更新整个APP即时修复bug!
JSPatch用iOS内置的 JavaScriptCore.framework作为引擎;JSPatch也符合苹果的规则。苹果不允许动态下发可执行代码,但通过苹果 JavaScriptCore.framework 或 WebKit 执行的代码除外,JS 正是通过 JavaScriptCore.framework 执行的。
JSPatch非常小巧
3、JSPatch实现原理
基础原理
Objective-C是动态语言,具有运行时特性,该特性可通过类名称和方法名的字符串获取该类和该方法,并实例化和调用。
Class class = NSClassFromString(“UIViewController");
id viewController = [[class alloc] init];
SEL selector = NSSelectorFromString(“viewDidLoad");
[viewController performSelector:selector];
也可以替换某个类的方法为新的实现:
static void newViewDidLoad(id slf, SEL sel) {}
class_replaceMethod(class, selector, newViewDidLoad, @"");
还可以新注册一个类,为类添加方法:
Class cls = objc_allocateClassPair(superCls, "JPObject", 0);
objc_registerClassPair(cos);
class_addMethod(cls, selector, implement, typedesc);
Javascript调用
我们可以用Javascript对象定义一个Objective-C类:
{
__isCls: 1,
__clsName: "UIView"
}
在OC执行JS脚本前,通过正则把所有方法调用都改成调用 __c()
函数,再执行这个JS脚本,做到了类似OC/Lua/Ruby等的消息转发机制:
UIView.alloc().init()
->
UIView.__c('alloc')().__c('init')()
给JS对象基类 Object 的 prototype 加上 **c 成员,这样所有对象都可以调用到 **c,根据当前对象类型判断进行不同操作:
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)
}
}
互传消息
JS和OC是通过JavaScriptCore互传消息的。OC端在启动JSPatch引擎时会创建一个 JSContext 实例,JSContext 是JS代码的执行环境,可以给 JSContext 添加方法。JS通过调用 JSContext 定义的方法把数据传给OC,OC通过返回值传会给JS。调用这种方法,它的参数/返回值 JavaScriptCore 都会自动转换,OC里的 NSArray, NSDictionary, NSString, NSNumber, NSBlock 会分别转为JS端的数组/对象/字符串/数字/函数类型。对于一个自定义id对象,JavaScriptCore 会把这个自定义对象的指针传给JS,这个对象在JS无法使用,但在回传给OC时OC可以找到这个对象。对于这个对象生命周期的管理,如果JS有变量引用时,这个OC对象引用计数就加1 ,JS变量的引用释放了就减1,如果OC上没别的持有者,这个OC对象的生命周期就跟着JS走了,会在JS进行垃圾回收时释放。
方法替换
1.把UIViewController的-viewWillAppear:
方法通过class_replaceMethod()
接口指向_objc_msgForward
,这是一个全局 IMP,OC 调用方法不存在时都会转发到这个 IMP 上,这里直接把方法替换成这个 IMP,这样调用这个方法时就会走到-forwardInvocation:
。
2.为UIViewController
添加-ORIGviewWillAppear:
和-_JPviewWillAppear:
两个方法,前者指向原来的IMP实现,后者是新的实现,稍后会在这个实现里回调JS函数。
3.改写UIViewController
的-forwardInvocation:
方法为自定义实现。一旦OC里调用UIViewController
的-viewWillAppear:
方法,经过上面的处理会把这个调用转发到-forwardInvocation:
,这时已经组装好了一个 NSInvocation
,包含了这个调用的参数。在这里把参数从 NSInvocation
反解出来,带着参数调用上述新增加的方法-JPviewWillAppear:
,在这个新方法里取到参数传给JS,调用JS的实现函数。整个调用过程就结束了,整个过程图示如下:
最后一个问题,我们把 UIViewController
的-forwardInvocation:
方法的实现给替换掉了,如果程序里真有用到这个方法对消息进行转发,原来的逻辑怎么办?首先我们在替换-forwardInvocation:
方法前会新建一个方法-ORIGforwardInvocation:
,保存原来的实现IMP,在新的-forwardInvocation:
实现里做了个判断,如果转发的方法是我们想改写的,就走我们的逻辑,若不是,就调-ORIGforwardInvocation:
走原来的流程。
3、OC中使用JSPatch
请查看 JSPatch技术文档
4、swift中使用JSPatch(这里只是demo简单使用,正常使用可以查看官网文档)
1、通过 cocoapods 集成
在 podfile 中添加命令:
pod 'JSPatchPlatform'
再执行 pod install 即可。
2、引用 import JSPatchPlatform
3、配置JSPatch
let path = Bundle.main.path(forResource: "demo", ofType: "js")
do {
let patch = try String(contentsOfFile: path!)
JPEngine.start()
JPEngine.evaluateScript(patch)
} catch {}
在viewConroller
中添加两个label和一个点击事件
var aaaa = "aaaa 被点击了"
@IBOutlet weak var lab1: UILabel!
@IBOutlet weak var lab2: UILabel!
@IBAction func btnClick(_ sender: Any) {
lab1.text=aaaa
}
override func viewDidLoad() {
super.viewDidLoad()
// Do any additional setup after loading the view, typically from a nib.
lab1.text=aaaa
aaaa = "我是label1 被点击了"
lab2.text="我是label2"
}
在js文件中简单实现调用JSPatch修改点击事件
defineClass('LSJSPatchDemo.ViewController', {
btnClicked: function(sender) {
var data = self.aaaa()
console.log('aaaa output: ' + data.toJS())
self.setAaaa('JSPatch 被点击了')
var data = self.aaaa()
console.log('aaaa output: ' + data.toJS())
console.log('aaaa output: ')
self.ORIGbtnClicked(sender)
}
});