Android 集成Tinker踩坑记录_android tinker-程序员宅基地

技术标签: 补丁管理  android  加固包生成补丁  Tinker  热修复  Android  

背景

热修复早已不是什么新鲜技术了,各个大厂基本都有自己的热修复方案。
关于各个热修方案的对比就不赘述了,网上一搜一大堆。直接看Tinker官方文档 就行。

这里说下为什么选择Tinker吧
先说优点

  1. 开源免费,讲道理,要不是免费肯定用集成起来更简单的Sophix了
  2. 目前仍处于维护状态
  3. 腾讯背书,官方说微信也在用,那我们自然没什么好顾虑的了

说完优点再吐槽下缺点

  1. 文档基本没怎么更新了,项目稍微新一点的集成起来需要踩坑
  2. demo比较老,agp版本很低
  3. 集成使用比较麻烦,代码量相较于常规的其它三方sdk多很多
  4. 处于open状态的issues数量比较多,开源项目遇到奇奇怪怪的问题只能尽量自己解决,肯定不会像商业sdk有技术快速支持的。
  5. 补丁的版本管理和维护需要自己搭建

集成步骤

这里我说下我自己比较推荐的集成步骤

  1. 先把源码下载下来,跑通,能够在demo上实现热修的功能
  2. 新建一个干净的空项目,从0开始集成tinker,同样要实现热修的功能
  3. 最后再往自己的项目中集成

集成步骤官方文档写的也比较清楚了,只是demo的agp版本比较老,一些配置的增加也没有在文档中更新。因此,在高版本的AGP项目中集成起来还是要踩一些坑的。

这里我把我集成tinker时踩的坑记录一下,有些坑也花了点时间去解决,希望能帮到需要的同学。
先说下我的AGP版本,这个可能会影响到Tinker

  1. AGP版本是7.0.4
  2. gradle版本是7.3.3
  3. tinker用的就是最新的版本(目前是:v1.9.14.25.3)

AGP7.x 配置Tinker

我们都知道AGP7开始,之前的classpath配置有所变更,如果你是AGP7以上的版本,需要在settings.gradle添加tinker的配置

pluginManagement {
    
    repositories {
    
        google()
        mavenCentral()
        gradlePluginPortal()
    }

    resolutionStrategy {
    
        /*配置tinker*/
        eachPlugin {
    
            if (requested.id.id == "com.tencent.tinker.patch") {
    
                useModule("com.tencent.tinker:tinker-patch-gradle-plugin:1.9.14.25.3")
            }
        }
    }
}

随后就正常在App模块里的build.gradle添加tinker所需依赖即可
示例:

plugins {
    
    id 'com.android.application'
    id 'org.jetbrains.kotlin.android'
    id 'com.tencent.tinker.patch'//tinker插件
    id 'kotlin-kapt'
}

生成补丁包时提示 Could not resolve all files for configuration ‘:app:sevenZipToolsLocator’.

我是在M1的电脑上生成补丁包,过程中提示找不到7zip。
根据报错的信息 Could not find SevenZip-1.1.10-osx-aarch_64.exe (com.tencent.mm:SevenZip:1.1.10). 中的.exe 也能猜出来是平台相关的问题。
在这里插入图片描述
这里我们可以按照以下步骤做解决这个问题

  1. brew install p7zip 本地安装下7zip
  2. 获取本地安装的7zip路径 which 7za
  3. 更改下配置,把zipArtifact配置注释掉,path更改为本机安装的7za路径
        sevenZip {
    
            /**
             * optional,default '7za'
             * the 7zip artifact path, it will use the right 7za with your platform
             */
//            zipArtifact = "com.tencent.mm:SevenZip:1.1.10"
            /**
             * optional,default '7za'
             * you can specify the 7za path yourself, it will overwrite the zipArtifact value
             */
            /*这里改成本地安装的7za路径*/
            path = "/opt/homebrew/bin/7za"
        }

然后再次执行生成补丁任务即可。
这个问题我看其他人也遇到了,也回答了一下,参照这个也可以:https://github.com/Tencent/tinker/issues/1718

Tinker配置

官方文档和demo中的配置不是很全,毕竟文档很久没更新了,而且demo的配置比较复杂,我这里实际上用不到这么复杂的配置,下面是精简后的配置,仅供参考

/*我这里直接就用版本号来作为tinkerid了*/
def versionName = android.defaultConfig.versionName
print("versionName:" + versionName)

/*存放要生成补丁的文件夹*/
def tinkerPath = "${projectDir}/tinker/"

/**
 * 生成补丁包的配置
 * 参考官方文档:https://github.com/Tencent/tinker/wiki/Tinker-%E6%8E%A5%E5%85%A5%E6%8C%87%E5%8D%97
 */
tinkerPatch {
    
    tinkerEnable = true
    /*旧包*/
//    oldApk = "${buildDir.path}/outputs/apk/xxx.apk"
    oldApk = "${tinkerPath}/app-release.apk"
    // 补丁输出路径 选填:默认在app/build/outputs/tinkerPatch下
    outputFolder = "${tinkerPath}/patch/"
    ignoreWarning = true // 是否忽略警告
    allowLoaderInAnyDex = true // 是否支持在任意dex中加载类
    removeLoaderForAllDex = true
    useSign = true // 在运行过程中需要验证基准apk包与补丁包的签名是否一致,release包肯定是需要签名的,默认值是true
    buildConfig {
    
        /*指定旧APK的mapping文件 可减少补丁包大小*/
        applyMapping = "${tinkerPath}/mapping.txt"
        /*旧APK的resource_mapping文件 可减少补丁包大小*/
        applyResourceMapping = "${tinkerPath}/R.txt"
        /*生成tinkerid 补丁包在合并时会验证布丁包的id和基准包的id是否一致 简单点可以用versionName*/
        tinkerId = versionName
        /*是否使用加固模式,只在加固包的情况下设置为true*/
        isProtectedApp = false
        /*是否支持新增非export的activity 测试设置为true也不知道新增页面,会报错*/
        supportHotplugComponent = false
        /*如果keepDexApply为true,则dex所在的类引用旧的apk。打开这个可以减少dex-diff文件的大小。*/
        keepDexApply = false
    }

    // dex相关的配置项
    dex {
    
        /**
         * 只能是'raw'或者'jar'。 对于'raw'模式,我们将会保持输入dex的格式。对于'jar'模式,我们将会把输入dex重新压缩封装到jar。
         * 如果你的minSdkVersion小于14,你必须选择‘jar’模式,而且它更省存储空间,但是验证md5时比'raw'模式耗时。默认我们并不会去校验md5,一般情况下选择jar模式即可。
         */
        dexMode = "jar"
        /**
         * 需要处理dex路径,支持*、?通配符,必须使用'/'分割。路径是相对安装包的,例如assets/...
         * */
        pattern = ["classes*.dex", "assets/secondary-dex-?.jar"]
        // 需要处理dex路径,支持*、?通配符,必须使用'/'分割。路径是相对安装包的,例如assets/...
        /**
         * 这一项非常重要,它定义了哪些类在加载补丁包的时候会用到。这些类是通过Tinker无法修改的类,也是一定要放在main dex的类。
         * 这里需要定义的类有:
         * 1. 你自己定义的Application类;
         * 2. Tinker库中用于加载补丁包的部分类,即com.tencent.tinker.loader.*;
         * 3. 如果你自定义了TinkerLoader,需要将它以及它引用的所有类也加入loader中;
         * 4. 其他一些你不希望被更改的类,例如Sample中的BaseBuildInfo类。这里需要注意的是,这些类的直接引用类也需要加入到loader中。或者你需要将这个类变成非preverify。
         * 5. 使用1.7.6版本之后的gradle版本,参数1、2会自动填写。若使用newApk或者命令行版本编译,1、2依然需要手动填写
         * */
        loader = [
             "com.yzq.hotfix.App"//这里写你自己的Application类
        ]
    }
    //  lib相关的配置项
    lib {
    
        /**
         * 需要处理lib路径,支持*、?通配符,必须使用'/'分割。与dex.pattern一致, 路径是相对安装包的,例如assets/...
         * 一般来讲我们的so文件都放在下面两个路径下面
         */
        pattern = ["lib/*/*.so", "src/main/jniLibs/*/*.so"]
    }
    // res相关的配置项
    res {
    
        /**
         * 需要处理res路径,支持*、?通配符,必须使用'/'分割。与dex.pattern一致, 路径是相对安装包的,例如assets/...,务必注意的是,只有满足pattern的资源才会放到合成后的资源包。
         */
        pattern = ["res/*", "assets/*", "resources.arsc", "AndroidManifest.xml"]
        /**
         * 支持*、?通配符,必须使用'/'分割。若满足ignoreChange的pattern,在编译时会忽略该文件的新增、删除与修改。 最极端的情况,ignoreChange与上面的pattern一致,即会完全忽略所有资源的修改。
         */
        ignoreChange = [
                "assets/sample_meta.txt"
        ]
        largeModSize = 100
        // 对于修改的资源,如果大于largeModSize,我们将使用bsdiff算法。这可以降低补丁包的大小,但是会增加合成时的复杂度。默认大小为100kb
    }
    // 7zip路径配置项,执行前提是useSign为true
    sevenZip {
    
//        zipArtifact = "com.tencent.mm:SevenZip:1.2.17"
        /**
         * 系统中的7za路径,例如"/usr/local/bin/7za"。path设置会覆盖zipArtifact,若都不设置,将直接使用7za去尝试。
         * 这里改成本地安装的7za路径
         * */
        path = "/opt/homebrew/bin/7za"
//        path = "/Users/yuzhiqiang/.gradle/caches/modules-2/files-2.1/com.tencent.mm/SevenZip/1.2.17"
    }
}

这里说一下applyMapping和applyResourceMapping的文件从哪里来。
一般我们通过assembleRelease打完包后,可以在build文件夹中找到apk文件和mapping文件
在这里插入图片描述
R文件则是在intermediates文件夹内
在这里插入图片描述

tinker-patch-cli jar包如何获取

如果你的补丁需要通过命令行来生成,那么你就需要用到tinker-patch-cli的jar包。那这个jar包如何获取呢?
也比较简单,首先,把tinker源码拉下来,找到buildTinkerSdk这个task,执行一下

在这里插入图片描述

随后在build目录中就能获取到jar包了。
在这里插入图片描述
至于如何使用看遵循官方文档即可。
不想编译的直接下载这个 Tinker Cli Jar文件 就行,已经生成好了。

Tinker加固包的补丁如何生成

加固包的补丁生成步骤如下

  1. isProtectedApp 配置要设置为true
  2. 编译出加固前的基准包,保存好,后面生成补丁要用。
  3. 加固前的基准包进行加固,正常上应用商店,用户使用的是加固后的基准包
  4. 发现bug,进行修复。编译出加固前的新包
  5. 使用加固前的基准包加固前的新包产生补丁
  6. 测试补丁是否正常,通过测试后发布补丁

也就是说,产生补丁都是加固前的包。使用补丁是在加固后的包上使用。不要搞错了。

补丁管理规则

这里我们需要跟服务端一起制定规则,给个参考如下:

  1. 版本和补丁之间的关系是通过配置的tinkerId关联的,补丁和App的tinkerid必须一致才能正常加载,否则校验是不通过的。
  2. App一旦发布就是基准包,此时一定要保存好这个基准包(未加固前的包)以及mapping.txt和R.txt文件,后续改版本补丁的生成都是基于该基准包生成
  3. App在一个版本内可以包含多个补丁,新补丁必须要包含旧补丁已修复的代码。
  4. 补丁生效前一定要先通过测试才能下发。
  5. 服务端给补丁时一定是当前App版本所对应的最新版本的补丁。

看官方文档也能看出来,Tinker的集成以及使用还是比较繁琐的,代码量也不小,具体的代码还需要根据自己的App来做更改。

好了,本篇文章就是这样,希望能帮到你。


如果你觉得本文对你有帮助,麻烦动动手指顶一下,可以帮助到更多的开发者,如果文中有什么错误的地方,还望指正,转载请注明转自喻志强的博客 ,谢谢!

版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://blog.csdn.net/yuzhiqiang_1993/article/details/132761063

智能推荐

wince下sources\sources.cmn\Makefile.def的相关作用_“\makefile.def”-程序员宅基地

文章浏览阅读866次。wince下sourcessources.cmnMakefile.def的相关作用_“\makefile.def”

wap svg 第八章 文字text--上拿-理疗-脚底安磨_html中如何设置svg<text>文字大小-程序员宅基地

文章浏览阅读1.8w次,点赞3次,收藏10次。虽然它可能是真实的,每一个画面讲述了一个故事,这是完全正确的,用言语来帮助讲故事。因此,SVG有几个元素,让你将文本添加到您的图形。文本术语Text Terminology在我们调查的主要方法添加文本,的<TEXT>元素之前,我们应该定义一些术语,你会看到,如果你读了SVG规范,或者如果你的工作与文字在任何图形环境:字符一个字符,作为一个XML文档而言,是一个数..._html中如何设置svg文字大小

GreenPlum运维监控工具-gpcc-web安装_gpcc安装-程序员宅基地

文章浏览阅读7.3k次,点赞4次,收藏3次。Greenplum Command Center(GPCC)是由Pivotal Software推出的一款监控和管理Greenplum Database的Web应用程序。它提供了一个易于使用的界面,可以帮助管理员监控集群的性能、诊断问题、管理用户和权限、设置预警和警报,并执行其他管理任务。GPCC具有以下主要功能:监控集群性能:GPCC提供了关于Greenplum集群中各个组件的性能指标的详细信息,包括查询性能、磁盘和内存使用情况、系统负载、网络流量等。_gpcc安装

中文编程,最精致的python访客登记系统实例项目,微信机器人不再只当人工智障------07_基于python的访客管理系统-程序员宅基地

文章浏览阅读473次。中文编程,最精致的python访客登记系统实例项目,微信机器人不再只当人工智障------07 - 浩海泛舟的文章 - 知乎 https://zhuanlan.zhihu.com/p/51771041面向套路编程(上)泛舟n天没更新,终于把这篇琢磨出来了.在泛舟的零基础入门系列里,开篇就指明了编程就是一个 数据输入>>>方法计算>>>输出结果 ..._基于python的访客管理系统

定积分华里士公式推广_分部积分法与点火公式|第四十六回|高数(微积分)...-程序员宅基地

文章浏览阅读1.3w次,点赞17次,收藏34次。原标题:分部积分法与点火公式|第四十六回|高数(微积分)之前几次我们都在讲定积分计算的换元法,换元法对于定积分的计算确实很重要,也非常好用,因为定积分的结果是一个固定的数,所以相比于不定积分的换元法,我们最后不需要再换回去,这是多么的喜人!今天我们要来学习定积分计算的分部积分法,同样还是要记住那个五字真言“反对幂指三”,顺序靠后的和 dx 凑: 下面来看例题:例一 例二 例三 例四 例五 例六 一..._华里士公式推广到0-2π

openstack多个外部网络可能引发的网络问题_openstack路由接口down-程序员宅基地

文章浏览阅读2.9k次。在多个外部网络的环境中,如果_openstack路由接口down

随便推点

中国嵌入式应用市场四大热点及趋势_目前嵌入式系统是热点-程序员宅基地

文章浏览阅读2.2k次。嵌入式系统的广泛应用已经渗入到我们日常生活的各个方面。在手机、MP3、PDA、数码相机、电视机,甚至电饭锅、手表里都有嵌入式系统的身影,工业自动化控制、仪器仪表、汽车、航空航天等领域更是嵌入式系统的天下。据估计,每年全球嵌入式系统带来的相关工业产值已超过1万亿美元。随着多功能手机、便携式多媒体播放机、数码相机、HDTV和机顶盒等新兴产品逐渐获得市场的认可,嵌入式系统的市场正在以每年30%的速度递增_目前嵌入式系统是热点

java安全体系之JCA、JCE、JAAS、JSSE及其关系-程序员宅基地

文章浏览阅读341次。首先、如果是运行在internet上的系统,并且如果是个涉及到利益性的系统,不可避免的会遭受各种攻击(我们公司的很多系统从OS到DB到webapp就实时有收到攻击和破解),所以尽可能保证安全性将不再是架构师和安全部门唯一应该考虑的事,所有的开发、运维都应该有相应的安全意识。在文本中,将普及下java的安全体系。java安全体系包括四个部分:JCA、JCE、JSSE、JAAS。JCA,包括了..._安全管理中jca含义

[Android]-[adb] user版本开启adb且去掉adb授权弹框_免adb授权修改-程序员宅基地

文章浏览阅读2.3k次。配置两个属性即可:1.使user版本可以adbdevice/mediatek/mt6739/device.mk ifeq ($(TARGET_BUILD_VARIANT),user)- PRODUCT_DEFAULT_PROPERTY_OVERRIDES += persist.sys.usb.config=mtp+ PRODUCT_DEFAULT_PROPERTY_OVERRIDES += persist.sys.usb.config=mtp,adb2.去掉user版本授权usb弹框b_免adb授权修改

FreeBSD软件安装卸载工具:Ports和Packages详解-程序员宅基地

文章浏览阅读432次。FNP:FAQ - Ports and Packages v 1.52004.08.20 Table of Contents1、如何只抓取 tarball?2、如何仅做到解开 tarball的步骤?3、如何仅做到解开 tarball 并补上官方提供的 patch?4、如何安装一个新的 port?5、如何安装一个新的 port,并将打包(package)起来?6、如何打包一个 port,并将其所有相..._linux ports

终于,狂神说SSM及SpringBoot系列文章完更!!!_狂神博客-程序员宅基地

文章浏览阅读10w+次,点赞1.3k次,收藏8.5k次。经过了近一个月的时间,小狂神终于将SSM及SpringBoot视频对应文章更新完毕!!!记得文末喜欢走一波,码字不易,从公众号开通,就保持日更,何尝不是一种打卡呢?你们都坚持看了吗~如果..._狂神博客

HDFS的EditLog和FsImage作用详细解析,超详细!(含部分非原创图片,大部分原创总结)_hdfs editlog-程序员宅基地

文章浏览阅读698次,点赞7次,收藏10次。EditLog和FsImage的概念,以及与SecondaryNameNode的关系问题,以及EditLog和FsImage的重要性问题。_hdfs editlog

推荐文章

热门文章

相关标签