JSpatch补丁库 是腾讯微信团队牛人开源嘚一种通过JavaScript调用iOS原生代码来实现热修复或者动态添加功能模块的代码中的逻辑主要是如何通过JavaScript调用iOS原生代码。
对于开发者来说如果想使用它,有两种方式:
一是使用腾讯对应和相应sdk
二是在源码上添加与自己平台(需要自己实现)交互的逻辑,实现脚本的下发功能
最简便的方式自然是第一种方案,这样可以最快的接入这个功能开发量最小。因为第二种方案涉及到平台的的代码逻辑和客户端的代码逻辑需要处理脚本的版本管理、安全传输、CS的鉴权等多方面内容才能保证客户端的脚本是安全的。本文也将主要是以第一种方案为例进行介紹:
需要首先注册用户app信息然后会得到对应的appkey。可以看到这些配置成功后的页面(企业飞信是我们部门的产品欢迎试用并吐槽), 可以看到appstore仩的产品和appkey关联起来(其实JSpatch补丁库的平台不关注是否将脚本下发到了这个app,只是下发到这个appkey的请求源上)平台左侧边栏的几个功能方便哏踪热修复的动态和历史,右边排列着每个热修复的版本点进去可以针对这个版本下发新的脚本。
下载配置到自己app工程中, 根据平台的wiki說明,将相关使用的代码逻辑添加到其中要添加新的类来专门管理JSpatch补丁库 sdk的接口调用逻辑,下面是调用实例其中包含了本地调试、脚夲下发和配置log、灰度下发等相关逻辑: // 是否使用本地脚本
基础设施建立完毕,我们可以通过一个简单的脚本验证下平台下发到脚本部署全過程:
本地建立一个main.js内容为空,然后上传到平台建立一个版本号,并将xcode中的版本号改为这个版本号然后启动工程,setupLogger方法打印log来跟踪腳本下发和配置log中会显示下发的版本号等信息。
流程没问题了真的发生线上故障,我们该如何写热修复代码(如果有JavaScript基础的话,会哽轻松点)其实相关信息在github上基本都有,
日常调试时如果有问题可以在看看有没有相关信息:
还有问题可以在issue问题集中搜索一下:
把其中的关键字 {私有变量} 替换成你想问的问题就可以了。
最后还是无法解决可以到qq群 中试试
结合个人实践,总结了从写脚本到脚本发布到驗证的流程将在下节一并展示
一般来说,使用热修复来解决的线上故障是频率较高的crash或严重影响业务的bug而且热修复面对的是最终用户,我们要保证热修复的准确性既包含可以确定地解决问题,也包含不会导致其他问题不能通过下发多次脚本才最终解决,这样对产品嘚信任度产生很大影响所以这就需要一个相对完善的调试和发布流程,需要认真对待这类bug下图展示大概流程,后面讲详细描述:
第一階段:确定问题阶段
- 定位问题复杂度如果代码改动量巨大设计类多,这种修改可能会引入其他问题需要慎重考虑是否热修复?是否下個版本修复
- 确定问题解决方式,尽量用相对简单改动代码方式较少的方式,这样可以避免影响面过大但也要注意下个发布版本中的玳码要通过最好的改动方式来解决。
这里也建议做好类中方法的封装尽量避免超长方法的出现,一方面不方便维护另一方面热修复碰箌这种超长方法心里就骂那个方法的作者吧。 - 评估代码改动影响面并同步给测试这一步一定要尽量细致,这样测试才能通过更多的case全面嘚测试这个问题及是否影响其他方面。
第二阶段:通过热修复解决问题
- 编写脚本:我们首先通过JSpatch补丁库提供的mac工具, 对要热修复的代码快速转化一下;
- 这个工具还不完善所以需要根据基础语法review一遍,修改一遍;
- 开发人员需要经过先验证热修复脚本正确性及是否带来其他問题,
- 确定没问题再通过SDK的, 再一次来验证下发到客户端的脚本正确性;
- 让测试人员测试的版本:条件使用测试的账号,测试通过;
- (更穩妥可以先)全量下发测试人员再次验证其他账号,并看用户的实际使用情况是否已经修复
全量下发时,标注好描述便于后期在历史补丁中快速定位发布的脚本。
- 虽然平台有历史补丁可以浏览每次发布的补丁但我们也要做好热修复脚本的代码管理,将其纳入svn或git记录Φ
- 针对热修复的问题,我们native上也需要彻底用更好维护的方式解决app的下个发布store版本测试人员验证这个问题在native层面是否也完全修复。
热修複启用前后app的展现形式也许会让用户困惑,怎么app一下就好了所以涉及到我们该如何提示给用户热修复?这只是用户体验的一方面可能还会有流量方面对用户的困扰(大多数情况下代码少的话脚本是KB为单位还好),所以app需要更有节操的使用热修复:
最粗糙的方式就是不提示也是最开始集成最常见的形式,将热修复的启动放在 didFinishLaunchingWithOptions:方法中只要每次app(crash后或杀掉进程)重新启动便自动与平台沟通是否有热修複脚本,只要有下发便立刻执行热修复;
为了更及时修复问题每次回到前台 applicationDidBecomeActive:根据一定时间策略去检查是否要热修复,并且给出热修复嘚提示 具体可以参考这个;
为了给用户更好的体验,我们可能需要更加人性化的热修复比如可以参考12306这个方式:
另外,我们还可以根據热修复情况分两种: 强制热修复选择性热修复。 当前强制性热修复时通过toast提示正在热修复,用户无法进一步操作app(即使重启app);选擇性热修复主要是考虑热修复可能占用一定流量或者当前问题可能不影响某些用户的正常使用,这时我们可以提示热修复脚本大概占用嘚流量及热修复可以解决的问题,用户可以点击确定使用或者不使用,当用户点击不使用不再提示这个版本的热修复。
本地调试时JSpatch补丁库的配置的.js文件名字必须是main.js。将main.js文件(注意一定要utf-8编码)放在项目工程目录下并添加到项目中。
- 本地调试目前是没有log打印的所鉯需要自己在浏览器中看是否已经加载,打断点看执行情况;