阿里百川热修复

官网:阿里百川HotFix

SDK集成

SDK下载.png
framework.png

有两个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];
}

其中的secretprivateKey在百川热修复网站控制台获取,其余三个参数需要用百川提供的工具来生成,下文讲解。

AliHotFixDebug.framework可在Debug模式下使用,仅支持真机扫码:

#import <AliHotFixDebug/AliHotFixDebug.h>

// currentViewController 是需要唤起扫码功能的VC
[AliHotFixDebug showDebug:currentViewController];

编写补丁

AliHotFix支持luajavascript两种语言编写补丁,这里只说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启动参数。分别是:privateKeypublicKeyencryptAESKey

AliHotFixCommand.png

功能1的使用需要传入4个参数,分别是:
PATCH-DIRECTORY:patch包所在路径
APP-VERSION:patch绑定的app版本
ENCRYPT-KEY:加密patch文件的密钥(备注:长度不超过32位字符串)
PRIVATE-P12-FILE-PASSWORD:生成RSA密钥时输入的密码

  1. AliHotFixCommand拖到终端,敲-pack
  2. 把存放有src/main.jspatch目录拖到终端,敲空格
  3. 输入这个patch需要修复的app版本,然后空格
  4. 输入自己定的字符串密钥,这个密钥在之前已经定下了,并用于生成了RSA公私钥。然后空格
  5. 输入RSA密钥密码,回车,等待处理完成

打包工具将会生成一个patch.zip的文件,这就是我们需要上传的补丁包。

上传补丁

  1. 每一个App版本可以包含多个补丁,并且可以随时启用/停用某个补丁。
  2. 先新增版本,再于版本内上传补丁。上传xxx.zip文件。
  3. 上传完成的补丁并不会自动发布。此时它会生成一个二维码,使用AliHotFixDebug可以扫码下载此补丁并加载,进行补丁测试、调试。
  4. 在确认补丁正确后,可进行灰度发布,指定最大可以下发给随机多少台设备;或进行全量发布,不限制下发数量。
  5. 注意:无法指定下发给某台设备,即使灰度发布也不行。灰度发布模式下,哪台设备最先请求补丁,就下发给哪台设备,下发数量达到指定值则停止。

附加说明

  1. 所修改的目标方法,必须在方法调用之前已把补丁加载完毕,然后在方法调用时才会生效。
  2. 补丁的下载是异步的,不会阻塞当前线程。补丁的下载受网络环境影响。
  3. 加载过的补丁将会存在于App沙盒,App每一次启动都会加载它,即使断网。App在同步补丁时发现没有更高版本的补丁时,会继续使用本地存放的补丁。所以在百川控制台停用了所有补丁后,App再去同步补丁,依然等同于没有更高版本补丁,并不会删除本地补丁。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 201,784评论 5 474
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,745评论 2 378
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 148,702评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,229评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,245评论 5 363
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,376评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,798评论 3 393
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,471评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,655评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,485评论 2 318
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,535评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,235评论 3 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,793评论 3 304
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,863评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,096评论 1 258
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,654评论 2 348
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,233评论 2 341

推荐阅读更多精彩内容