阿里最新热修复框架sophix集成详解（三）：生成、上传、调试补丁

文章更新于2017年11月21日。

---

下载打包工具：
patch补丁包生成需要使用到打补丁工具SophixPatchTool, 如还未下载打包工具，请前往下载Android打包工具。

• Mac版本打包工具地址：http://ams-hotfix-repo.oss-cn-shanghai.aliyuncs.com/SophixPatchTool_macos.zip

• Windows版本打包工具地址：http://ams-hotfix-repo.oss-cn-shanghai.aliyuncs.com/SophixPatchTool_windows.zip

• Linux版本打包工具地址：http://ams-hotfix-repo.oss-cn-shanghai.aliyuncs.com/SophixPatchTool_linux.zip

该工具提供了Windows和macOS和Linux版本，Windows下运行SophixPatchTool.exe，macOS下运行SophixPatchTool.app，Linux下（Ubuntu 16.04 64bit最佳）运行SophixPatchTool。并且需要安装Java环境且在JDK7或以上才能正常使用。

我是先 生成调试包，有问题的程序，Build apk，改名字为旧包.apk。然后修复完，再Build apk，改名字为新包.apk。这样能看Log。测试成功后，再生成发布包，再测试一遍。

补丁打包工具主对话框

• 旧包：<必填> 有问题的APK。
• 新包：<必填> 修复过该问题APK。
• 日志：打开日志输出窗口。
• 高级：展开高级选项。
• 设置：补丁输出路径和签名文件设置。
• GO!：开始生成补丁。

点击【高级】，弹出 补丁和签名设置

image.png

• 强制冷启动：勾选的话强制生成补丁包为需要冷启动才能修复的格式。默认不选的话，工具会根据代码变更情况自动选择即时热替换或者冷启动修复。
• 不比较资源：打补丁时不比较资源的变化。
• 不比较SO库：打补丁时不比较SO库的变化。
  所以，高级选项可以不做处理。
  强制冷启动：勾选的话强制生成补丁包为需要冷启动才能修复的格式。默认不选的话，工具会根据代码变更情况自动选择即时热替换或者冷启动修复。
  不比较资源：打补丁时不比较资源的变化。
  不比较SO库：打补丁时不比较SO库的变化。

点击【设置】

image.png

• 补丁输出路径：<必填> 指定生成补丁之后补丁的存放位置，必须是已存在的目录。
• Key Store Path：<选填>本地的签名文件的路径，不输入则不做签名。
• Key Store Password：<选填>证书文件的密码。
• Key Alias：<选填>Key的别名。
• Key Passwrod：<选填>Key的密码。
  下面的一般不做处理：
• AES Key：<选填>自定义aes秘钥, 必须是16位数字或字母的组合。必须与setAesKey中设置的秘钥一致。
• Filter Class File：<选填>本地的白名单类列表文件的路径，放进去的类不会再计算patch，文件格式: 一行一个类名。

Ps:

mac下的补丁工具若出现一打开就崩溃的情况，请将补丁工具移到“应用程序”目录下即可。

点击 Go ，生成的补丁如下图：

补丁

补丁文件名必须为：sophix-patch.jar。不能更改。

---

上传补丁

• 首先进入 移动热修复 管理控制台

  
  
  

  移动热修复 管理控制台

• 点击App列表里的操作-【管理】，进入详情页

  
  
  

  App详情页

• 点击 【添加版本】，也就是应用的版本号
  这里的版本号一定要和工程里的gradle文件里记录的一致。我截图上的一个1.0和1.0.0。搞1.0.0测试了半天，没结果，傻不傻。gradle里默认是“1.0”

• 添加完版本，点击应用版本列表下的 【查看详情】，进入版本详情页

  
  
  

  版本详情页

点击 【上传补丁】，补丁版本列表更新。

• 点击 补丁版本列表 的 【查看详情】，进入 补丁详情页，可以查看补丁属性和补丁状态

  
  
  

  补丁详情页

上图有个二维码，在正式发布前，我们用测试工具扫码测试下。
测试工具是个apk。它是通过扫描补丁二维码，下载到手机上，然后通过在apk界面上输入你要测试的应用包名，将补丁打到应用里。

---

调试补丁

• 调试工具地址：http://ams-hotfix-repo.oss-cn-shanghai.aliyuncs.com/hotfix_debug_tool-release.apk

调试工具App界面

那个截图上的 【断开连接应用】，最开始是 【连接应用】

• 先把你的有bug的apk安装到手机上
• 然后打开该调试工具App，先输入 bug应用 包名，点 【连接应用】
• 点 【扫描二维码】，扫 网页上 补丁详情页 的二维码
  接下来，就不用管了。它会下载补丁，并打到应用上。

看到调试App界面是输出信息，有以下几条，就代表成功了。
app connect successful.
patch download success.
please restart app to reload new patch as exist old patch.

打开你的bug应用，就可以看到变化了。
来个截图示例，应用源码就是该系列（二）里的sample

sophix调试补丁.gif

SophixTest原来只显示个 helloworld，经过Sophix调试工具V3的打补丁后，再次打开SophixTest就变成了有福利字样，并显示张美女图片。

下一篇，阿里最新热修复框架sophix集成详解（四）：补丁灰度发布、全量发布、机型过滤