SOT热更新接入例子1

936 阅读4分钟

文档已过时

SOT学习和使用的成本主要集中在前期,主要涉及编译流程的修改。编译相关的机制比较底层,门槛相对较高,大多数iOS开发没怎么接触过。为了让大家更好地评估和接入SOT技术,后续会以一些开源的iOS项目为例,展示怎么一步步修改它们接入SOT。相信读者读完会更熟悉SOT技术,更好地将它应用到自己的项目中。

本文以facebook开源的「 Shimmer 」为例,该工程主要用Objective-C开发。clone下来后,进入根目录,打开FBShimmering.xcworkspace工程,scheme选择Logo-iOS:...

直接编译会有错误,先修复一下,将下图的两个storyboard文件修改为7.0以上:...

编译成功启动APP能看到画面,下面的Shimmer字体会一闪一闪:...

下面使用SOT热更的方式来将Shimmer字改成hello SOT。

Step1: 配置编译环境

参考「 免费版 」的step1到step3,step3拷贝的sotconfig.sh放到项目的Examples的目录下:...

用文本编辑器打开sotconfig.sh,修改EnableSot=1:...

Step2: 修改编译选项

添加热更需要的编译选项,添加SOT虚拟机静态库等,步骤如下:

  1. 选中Examples工程,然后选择Logo-iOS这个Target,再选择Build Settings:...

  2. 在Other Linker Flags添加-sotmodule $(PRODUCT_NAME) /Users/sotsdk-1.0/libs/libsot_free.a -sotsaved $(SRCROOT)/sotsaved/$(CONFIGURATION)/$(CURRENT_ARCH) -sotconfig $(SRCROOT)/sotconfig.sh,每个选项的意义如下:

    • -sotmodule是module的名字,可以直接用$(PRODUCT_NAME),也可以自定义名字;
    • -sotsaved是编译中间产物保存的目录,补丁自动化生成需要对比前后编译的产物来生成补丁;
    • -sotconfig指定了项目sotconfig.sh的路径,该脚本控制sot编译器的工作,用$(SRCROOT)引用到
    • /Users/sotsdk-1.0/libs/libsot_free.a是SOT虚拟机静态库的路径,链接的是免费版的虚拟机
  3. 在Other C Flags添加-sotmodule $(PRODUCT_NAME) -sotconfig $(SRCROOT)/sotconfig.sh,意义跟上一步是一样的,需要保持一致。经过上面两步,相关的编译配置结果如下图:...

  4. 因为SDK库文件编译时不带Bitcode,所以也需要把Target的Enable Bitcode设为No...


Step3: 增加拷贝补丁脚本

SDK里提供了一个便利脚本,路径在sdk目录的project-script/sot_package.sh,它会把生成的补丁拷贝到Bundle文件夹下,在每次项目编译成功时调用该脚本,添加步骤如下:

...

脚本内容为:sh /Users/sotsdk-1.0/project-script/sot_package.sh "$SOURCE_ROOT/sotconfig.sh" "$SOURCE_ROOT/sotsaved/$CONFIGURATION" Logo-iOS...


Step4: 链接C++库

SOT需要压缩库和c++标准库的支持,还是在这个页面下,打开Link Binary With Libraries页...

点击加号,分别加入这两,libz.tbdlibc++.tbd...


Step5: 调用SDK API

这个例子只演示免费版的使用,打开main.m文件,添加头文件#import "/Users/sotsdk-1.0/libs/SotWebService.h",在函数主体加入代码调用API:[SotWebService ApplyBundleShip],至此项目配置完成。...


测试热更

Step1: 热更注入

按上面配置完之后,确保sotconfig.sh的配置是,EnableSot=1以及GenerateSotShip=0,先Clean Build Folder一下,然后再Build:...

然后看编译日志的输出,.m文件的日志展开可以看到run sot clang compile输出,Link日志可以看到run sot link等输出:...

项目编译成功了,该程序可以正常启动。同时它具备了热更能力,可以加载补丁改变程序的代码逻辑。


Step2: 生成补丁

上一步进行了热更注入的编译,当时的代码保存到了Examples/sotsaved这个文件夹下,用来和新代码比较生成补丁。生成补丁步骤如下:

  1. 首先启动SOT生成补丁模式,修改sotconfig.sh为EnableSot=1,GenerateSotShip=1;
  2. 接下来直接在XCode里修改源代码,把”Shimmer“改成了”hello SOT“:...
  3. Build项目(不需要Clean),展开Link Logo-iOS(x86_64)的编译日志,可以看到此时的Link是用来生成补丁的,日志里也显示了函数viewDidLoad被修改了:...
  4. 生成出来的补丁保存到了Examples/sotsaved/Debug/x86_64/ship/ship.sot,还记得之前加了一个script到Build Phase中吗?就是把这个补丁拷贝到了Bundle目录中,并且加了CPU架构到文件名中,把APP的安装包打开可以看到如下图所示:...
  5. 启动APP,调用ApplyBundleShip接口之后,会自动判断Bundle内是否有补丁,有则加载,加载成功使用的就是补丁里的代码:...此时去XCode断点调试viewDidLoad,发现无法断住了,因为实际执行补丁代码的是SOT虚拟机。还有就是GenerateSotShip=1时,编译APP用的是保存在sotsaved目录下的代码,所以无论怎么修改XCode里的代码,如果没有把补丁拷贝到Bundle目录下,那么程序的结果都是热更注入时的结果,显示的还是Shimmer。

Step3: 总结

  1. EnableSot=1,GenerateSotShip=0,是生成热更注入版本,可以用来发布
  2. EnableSot=1,GenerateSotShip=1,不会重新编译APP,只是用当前代码跟上个发布版本的代码比较,然后生成补丁
  3. APP加载了补丁之后,才会发生逻辑变更,修改加载补丁之前就执行的函数,是不会生效的