iOS JSPatch 使用

17/03/08更新
有不少小伙伴反应苹果发送了邮件要求去除项目中用于动态改变应用的代码 ，看来 JSPatch 要被禁止使用了

Your app, extension, and/or linked framework appears to contain code designed explicitly with the capability to change your app’s behavior or functionality after App Review approval, which is not in compliance with section 3.3.2 of the Apple Developer Program License Agreement and App Store Review Guideline 2.5.2. This code, combined with a remote resource, can facilitate significant changes to your app’s behavior compared to when it was initially reviewed for the App Store. While you may not be using this functionality currently, it has the potential to load private frameworks, private methods, and enable future feature changes.
This includes any code which passes arbitrary parameters to dynamic methods such as dlopen(), dlsym(), respondsToSelector:, performSelector:, method_exchangeImplementations(), and running remote scripts in order to change app behavior or call SPI, based on the contents of the downloaded script. Even if the remote resource is not intentionally malicious, it could easily be hijacked via a Man In The Middle (MiTM) attack, which can pose a serious security vulnerability to users of your app.
Please perform an in-depth review of your app and remove any code, frameworks, or SDKs that fall in line with the functionality described above before submitting the next update for your app for review.
Best regards,
App Store Review

JSPatch 平台关于苹果警告的解决方案 --bang

前言

App 上线后可能存在测试时未发现的 bug，影响用户使用，利用 JSPatch 在 App 不进行版本迭代的情况下进行 bug 修复。

什么是 JSPatch ？

JSPatch 是一个开源项目(Github链接)，只需要在项目里引入极小的引擎文件，就可以使用 JavaScript 调用任何 Objective-C 的原生接口，替换任意 Objective-C 原生方法。目前主要用于下发 JS 脚本替换原生 Objective-C 代码，实时修复线上 bug。
除了修复 bug，JSPatch 也可以用于动态运营，实时修改线上 APP 行为，或动态添加功能。

什么是 JSPatch 平台？

JSPatch 需要使用者有一个后台可以下发和管理脚本，并且需要处理传输安全等部署工作，JSPatch 平台帮你做了这些事，提供了脚本后台托管，版本管理，保证传输安全等功能，让你无需搭建一个后台，无需关心部署操作，只需引入一个 SDK 即可立即使用 JSPatch。

引用自 JSPatch 的官方文档(文档链接)，下面讲一下 JSPatch 的使用。

JSPatch 使用

新建一个项目

项目名称

然后在 ViewController.m 中写一段会造成崩溃的代码(这里只是参考)

#import "ViewController.h"

@interface ViewController ()

@property (nonatomic , strong) NSArray *arr;
@end
@implementation ViewController

- (void)viewDidLoad {
    [super viewDidLoad];
    NSLog(@"%@" , self.arr[2]);
}
- (NSArray *)arr {
    if (!_arr) {
        _arr = [NSArray array];
    }
   return _arr;
}

集成 SDK

1、通过 cocoapods 导入

在 podfile 中添加命令：
pod 'JSPatchPlatform', :git => 'https://github.com/bang590/JSPatchPlatform.git'
再执行 pod install 即可。

2、手动导入

下载 SDK 后解压，将** JSPatchPlatform.framework** 拖入项目中，勾选 "Copy items if needed"，并确保 "Add to targets" 勾选了相应的 target。

将SPatchPlatform.framework 拖入项目

pods 导入或手动导入SDK后添加依赖框架：TARGETS -> Build Phases -> Link Binary With Libraries -> + 添加libz.dylib(Xcode7之后是libz.tbd)和 JavaScriptCore.framework。

添加依赖框架

测试使用

1、测试本地脚本

本地测试 AppDelegate.m 按如下写法即可，SDK 提供了+testScriptInBundle 方法用于开发状态下测试。

#import "AppDelegate.h"
// 引入头文件
#import 

@interface AppDelegate ()

@end

@implementation AppDelegate


- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    /*
     用于发布前测试脚本。先把脚本放入项目中，调用后，会在当前项目的 bundle 里寻找 main.js 文件执行
     测试完成后请删除，改为调用 +startWithAppKey: 和 +sync
     */
     [JSPatch testScriptInBundle];
    return YES;
}

然后在我们的 demo 中新建一个 empty 文件，叫 main.js，注意这是 JSPatch 平台规范，js 脚本文件名必须是 main.js。

新建main.js

命名

完成之后是这样

2025675-86251bfd522e2882.png.jpeg

现在我们就可以通过在 main.js 写 js 修复 demo 中的 bug，代码如下：

require('NSArray');
defineClass('ViewController', {
            viewDidLoad: function() {
            self.super().viewDidLoad();
            self.setArr(["1","2","阿西吧","3"]);
            var str = self.arr().objectAtIndex(2);
            console.log("JSPatch调用" , str);
            },
            });

运行，OK

控制台打印表示 bug 修复成功

2、线上版本测试

热修复针对的是线上版本，所以本地测试只是验证可行性，重要的还是线上 bug 的修复。下面我们进行线上测试。
到 JSPatch官网 注册，登录，我的 App，添加 App，获取 app key，添加 App 版本，发布补丁

添加 App

获取 appKey,添加 App 版本

01AD1159-1A7F-4200-AFD1-31F33A9A99F1.png

提交之后点进去就可以进行补丁发布：

补丁发布

注：有关开发预览、灰度下发、条件下发请查看官方文档开发预览和灰度与条件下发了解。补丁发布之后，对应版本的 APP 会请求下载这个脚本保存在本地，以后每次启动都会执行这个脚本。至此线上 bug 修复完成。
现在只是发布了补丁，而我们的测试 demo 里的代码还没有修改，所以还不能进行线上测试。下面修改我们的测试代码。
-application:didFinishLaunchingWithOptions:调用 +startWithAppKey:方法，参数为之前获得的 appKey。接着调用 +sync方法检查更新。

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    //[JSPatch testScriptInBundle]; // 用于发布前测试脚本，测试完成后请删除，改为调用 +startWithAppKey: 和 +sync
    [JSPatch startWithAppKey:@"210a38abb83a9689"];
    [JSPatch sync];
    return YES;
}

注意：+testScriptInBundle不能与+startWithAppKey:一起调用，+testScriptInBundle只用于本地测试，测试完毕后需要去除，项目中的 main.js 文件也要删除(可拷贝一份至桌面留作上传的补丁使用)。另外，通过 JSPatch 平台上传的脚本文件都会保存在七牛云存储上，而七牛云存储的下载使用的是 http 协议，因此需要在项目的 info.plist 文件中添加如下字段(这个应该都知道的...忽略)

info.plist

OK，现在我们来运行 demo

3788F246-7484-4D73-904B-BA424EB903BA.png

和本地测试一样线上测试bug也修复成功。

修改/删除 js 脚本

若后续需要对这个脚本进行修改，可以重新上传新的脚本，APP 客户端会在请求时发现脚本已更新，下载最新脚本覆盖原来的，下次启动时执行。
若想直接取消某个 APP 版本的 JS 脚本补丁，可以直接在 APP 版本界面删除此 APP 版本，APP 客户端会在请求时发现脚本已被删除，即刻删除本地 JS 脚本文件，下次启动时不再加载。

补充

JSPatch 作者@bang提供了一个转换工具 JSPatch Converto，可以将 OC 转换为 js 。

JSPatch Converto

此外， @bang 大神还给我们准备了 JSPatch XCode代码自动补全插件，让我们使用 JSPatch 更得心应手。

JSPatch XCode代码自动补全插件

结语

对 JSPatch 研究有限，这里只是介绍了 JSPatch 的基础用法，有错误或不当的地方欢迎指正、交流。如果你想学习更多 JSPatch 的用法可以到 JSPatch 平台使用文档了解。如果你想知道 JSPatch 实现原理，看这里：JSPatch 实现原理详解。
本文 demo 后续会上传 GitHub，链接留在留言中。