官网:阿里百川HotFix
SDK集成
有两个framework,其中
AliHotFix.framework
是必须导入项目的,是热修复SDK。
AliHotFixDebug.framework
是调试工具,仅在补丁未全量发布的时候,使用它提供的方法来主动拉取某个补丁。拉取的方法是通过扫描百川热修复控制台上生成的二维码,每一个上传的补丁都会生成一个二维码。在调试完成后请删除此framework。
调用方法
在didFinishLaunchingWithOptions
方法中启用热修复:
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
// 初始化AliHotFix
[AliHotFix startWithAppID:@"15986-2"
secret:secret
privateKey:privateKey
publicKey:rsaPublicDerData
encryptAESKey:aesEncryptKeyData];
}
在程序每一次重新进入前台激活时,同步补丁。这是由于App用户习惯的原因。
假如用户从来不关闭App,只是切到后台挂起。那么在挂起的这段期间,我们发布了补丁,当App从挂起状态重新激活时,就需要同步一次补丁。
- (void)applicationDidBecomeActive:(UIApplication *)application {
[AliHotFix sync];
}
其中的secret
和privateKey
在百川热修复网站控制台获取,其余三个参数需要用百川提供的工具来生成,下文讲解。
AliHotFixDebug.framework
可在Debug
模式下使用,仅支持真机扫码:
#import <AliHotFixDebug/AliHotFixDebug.h>
// currentViewController 是需要唤起扫码功能的VC
[AliHotFixDebug showDebug:currentViewController];
编写补丁
AliHotFix支持lua
和javascript
两种语言编写补丁,这里只说javascript。
可以借助在线转换工具Patch Convertor把objective-c代码大致转换成javascript。
但是工具无法做到100%完美转换,所以在转换完成后还需要人工一行一行检查。
Patch Convertor不支持以下几种OC/C的语法,需要手动转换:
- 宏/枚举/常量
- C函数调用
- GCD函数
- 指针/结构体
- 私有变量的Getting/Setting
具体的编写方法参考JSPatch
:
https://github.com/bang590/JSPatch/wiki/JSPatch-基础用法
打包补丁
文件目录
javascript补丁文件必须以main.js
命名,并且必须放在一个src
目录下。
例如:patch/src/main.js
在打包时,将会对整个patch
目录进行打包
打包工具
打开终端,把AliHotFixCommand
拖到终端,回车直接运行,它将会列出3个功能,分别是:
1.打包,2.生成RSA公私钥,3.输出密钥代码。
功能1打包需要在2和3完成后才能使用。
功能2生成本地公私钥,用于SDK请求下发补丁时的加解密,以保证所请求的补丁正确。
功能3借助了2的结果来生成代码,用于贴到项目中作为SDK启动参数。分别是:privateKey
、publicKey
、encryptAESKey
。
功能1的使用需要传入4个参数,分别是:
PATCH-DIRECTORY
:patch包所在路径
APP-VERSION
:patch绑定的app版本
ENCRYPT-KEY
:加密patch文件的密钥(备注:长度不超过32位字符串)
PRIVATE-P12-FILE-PASSWORD
:生成RSA密钥时输入的密码
- 把
AliHotFixCommand
拖到终端,敲-pack - 把存放有
src/main.js
的patch
目录拖到终端,敲空格 - 输入这个patch需要修复的app版本,然后空格
- 输入自己定的字符串密钥,这个密钥在之前已经定下了,并用于生成了RSA公私钥。然后空格
- 输入RSA密钥密码,回车,等待处理完成
打包工具将会生成一个patch.zip
的文件,这就是我们需要上传的补丁包。
上传补丁
- 每一个App版本可以包含多个补丁,并且可以随时启用/停用某个补丁。
- 先新增版本,再于版本内上传补丁。上传xxx.zip文件。
- 上传完成的补丁并不会自动发布。此时它会生成一个二维码,使用
AliHotFixDebug
可以扫码下载此补丁并加载,进行补丁测试、调试。 - 在确认补丁正确后,可进行灰度发布,指定最大可以下发给随机多少台设备;或进行全量发布,不限制下发数量。
- 注意:无法指定下发给某台设备,即使灰度发布也不行。灰度发布模式下,哪台设备最先请求补丁,就下发给哪台设备,下发数量达到指定值则停止。
附加说明
- 所修改的目标方法,必须在方法调用之前已把补丁加载完毕,然后在方法调用时才会生效。
- 补丁的下载是异步的,不会阻塞当前线程。补丁的下载受网络环境影响。
- 加载过的补丁将会存在于App沙盒,App每一次启动都会加载它,即使断网。App在同步补丁时发现没有更高版本的补丁时,会继续使用本地存放的补丁。所以在百川控制台停用了所有补丁后,App再去同步补丁,依然等同于没有更高版本补丁,并不会删除本地补丁。