背景介绍
IOS平台提交审核的周期太长,快则45天,慢则半个月或者20天,如果碰到圣诞节等假日,可能一个月都有可能,如果碰到被拒,那就更坑爹了,那时基本靠人品。现在苹果的审核周期变短了,有可能是12天审核就通过了,具体是不是以后都是这么快,就不清楚了。
JSPatch利用javascript调用任何Objective-C原生接口,替换任意的Objective-C原生接口,修复线上bug。主要通过下发JS脚本替换原生Objective-C代码。
JSPatch:GitHub地址
SDK接入
准备
该demo的GitHub地址
-
在JSPatch平台上注册账号,添加新App,会生成唯一AppKey
- 在该平台下载SDK解压后将JSPatch.framework拖入项目
- 添加依赖框架libz.dylib和JavaScriptCore.framework
添加代码
在AppDelegate.m的didFinishLaunchingWithOptions中添加如下代码:
//添加头文件
#import <JSPatch/JSPatch.h>
//1
[JSPatch startWithAppKey:JSPatchKey] //JSPatchKey是创建App获得的AppKey
//2
[JSPatch sync]
//1中startWithAppKey传入平台申请的appKey,启动JSPatch SDK,同时会自动执行已下载到本地的patch.
//2中sync与JSPatch平台后台更新,询问是否有patch更新,如果有更新会自动下载并执行。startWithAppKey并不会询问后台patch更新,必须调用sync方法。
注意:实时性不高的App只需在didFinishLaunchingWithOptions处调用一次,用户启动时就会同步patch信息;实时性要求高的App,在applicationDidBecomeActive处调用,用户每次唤醒App时就同步一次后台
测试本地脚本
在上线之前需要对脚本进行本地测试查看运行是否正常,注意JSPatch平台规范,JS脚本文件名必须是main.js。SDK提供了方法+testScriptInBundle用于发布前测试,调用该方法后,JSPatch会在当前项目的bundle寻找main.js。
注意:+testScriptInBundle不能与+startWithAppKey一起调用,+testScriptInBundle只能用于本地测试,测试完需删除
Demo本地实例
新建一个工程,在Main.storyboard中添加UITableView,并添加相应约束,具体如图,设置距离上下左右的距离都是0:
设置好tableView的delegate和dataSource之后,在ViewController中定义一个数组,并初始化:
self.dataArray = [NSMutableArray arrayWithObjects:@"one",@"two",@"three",@"four",@"five", nil];
之后设置tableView的相关委托代理的方法,如下:
- (NSInteger)tableView:(UITableView *)tableView numberOfRowsInSection:(NSInteger)section{
return 5;
}
- (UITableViewCell*)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath{
static NSString* cellIdentifier=@"cell";
UITableViewCell* cell=[tableView dequeueReusableCellWithIdentifier:cellIdentifier];
if (cell==nil) {
cell=[[UITableViewCell alloc] initWithStyle:UITableViewCellStyleDefault reuseIdentifier:cellIdentifier];
}
cell.textLabel.text=[self.dataArray objectAtIndex:indexPath.row];
return cell;
}
运行结果如下:
OK,Done!一切看起来非常好。
动手修改Demo
在numberOfRowsInSection方法中,替换 return 5
为 return 6
,如下:
// return 5;
return 6; //超出dataArray的数组范围
这样在cellForRowAtIndexPath方法中获取数组中的数据就会超出范围,因为数组中只有5条数据,而我们返回了6行,少了一行。如果这种错误出现在线上版本导致App崩溃,那上传新版本的话,耗时比较长,所以我们现在用JSPatch来解决。
按照我们上面讲的到JSPatch官网下载SDK,然后把JSPatch.framework拖入项目中
-
添加JavaScriptCore.framework和libz.tbd依赖框架(tbd是xcode7新增的一种文件)
-
AppDelegate中添加JSPatch/JSPatch.h头文件,在didFinishLaunchingWithOptions中输入:
[JSPatch startWithAppKey:JSPatchKey]; [JSPatch sync];
由于我们这个不是线上产品,只是在本地测试,所以我们注释掉该代码,替换为
JSPatch testScriptInBundle
,注意该行代码测试完本地之后需删除。-
通过vi编写main.js,也可以用其他的编辑器
defineClass("ViewController", { tableView_cellForRowAtIndexPath: function(tableView, indexPath) { var cell = tableView.dequeueReusableCellWithIdentifier("cell") if (!cell) { cell = require('UITableViewCell').alloc().initWithStyle_reuseIdentifier(0, "cell") } cell.textLabel().setText("1") return cell },
}
)
```
我只是把ViewController中的cellForRowAtIndexPath中每行显示的数据显示为1,这样就可以避免崩溃了,当然根据自己的需要自行修改,具体可以参考JSPatch基础用法。结果如下:
线上版本
-
进入JSPatch平台后台,在我的App中添加App版本
该版本号可以通过项目TARGETS->General->version找到。版本号必须一致,JSPatch平台只对该版本号下发js脚本。
- 点击刚添加的版本,上传main.js即可。上传可以直接全量下发,也可选择开发预览或灰度或条件下发,也可以使用自定义RSA key对脚本进行加密签名。上传完成后,对应版本App会请求下载脚本保持到本地,这样线上bug就修复了
- 若后续需要对这个脚本进行修改,可以重新上传,App客户端会在请求时发现脚本已更新,下载最新脚本覆盖原来的,下次启动时执行。想直接取消某个App版本的JS脚本,直接在App版本界面删除此App版本,App客户端请求时发现脚本已被删除,即可删除本地js脚本,下次启动不再加载。
开发预览
从SDK1.4支持发布脚本时先针对开发版本下发。
首先开启开发模式,建议只在debug模式下开启。
[JSPatch startAppWithKey:JSPatchKey]
#ifdef DEBUG
[JSPatch setupDevelopment]
#endif
[JSPatch sync]
接着在图中下发:
灰度和条件下发
-
灰度:SDK1.2以上,按比例下发,可以修改灰度值,直至全量下发
-
条件下发:只有满足条件设备才会执行,可以通过条件语句规则筛选。需要事先通过+setupUserData,支持多个字段,用NSDictionary表示,比如:
[JSPatch setupUserData:@{@"userID":userID,@"isMale":isMale}]
,需要在setupWithAppKey之前调用。
条件更新:后面的条件更新不会影响之前的条件,之前的条件依然满足。想撤销条件全量发布,提交空条件即可。SDK内置2个信息可供条件判断:iOS和isPad,iOS版本号只会精确到2位。
自定义RSA密钥和安全问题
为避免js脚本传输过程被中间人篡改,我们需要对js文件进行RSA签名加密,具体流程:
- 服务端
- 计算js文件MD5值
- 用RSA私钥对MD值加密,与JS文件一起下发给客户端
- 客服端
- 拿到加密数据,用RSA公钥解密出MD5值
- 本地计算返回的js文件MD5值
- 对比2个MD5值,相等则校验通过,保存JS文件到本地
当保存到本地时,越狱机器会有点风险,我们可以通过对称加密保存,然后读取时解密。
客户端和JSPatch后台默认有一对RSA密钥,默认会对这对密钥进行加解密验证。也可以自定义RSA密钥。
自定义RSA密钥
-
生成RSA密钥。在终端输入下列代码后再当前目录就有rsa_private_key.pem和rsa_public_key.pem。密钥长度可选1024/2048/3072/4096...
openssl > genrsa -out rsa_private_key.pem 1024 pkcs8 -topk8 -inform PEM -in rsa_private_key.pem -outform PEM -nocrypt rsa -in rsa_private_key.pem -pubout -out rsa_public_key.pem
SDK设置RSA Public Key。客户端接入SDK后调用
+setupRSAPublicKey:
设置定义的RSA Public Key,必须在+sync
之前调用。Public Key以字符串方式传入,换行处需要手动加换行符\n。使用Private Key下发脚本。下发脚本时勾选使用自定义RSA Key 选项,选择本地的rsa_private_key.pem与脚本一起上传。JSPatch平台使用上传的Private Key对脚本MD5值进行加密,然后下发客户端。客户端通过第二部设置的Public Key对脚本进行验证,通过则运行。注意:上传的rsa_private_key.pem只是一次性使用,用户必须保存rsa_private_key.pem文件
相关
JSPatch官网:http://www.jspatch.com/
总结
JSPatch的介绍就到此为止,欢迎指正,谢谢!!!