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

智能推荐

FTP命令字和返回码_ftp 登录返回230-程序员宅基地

文章浏览阅读3.5k次,点赞2次,收藏13次。为了从FTP服务器下载文件,需要要实现一个简单的FTP客户端。FTP(文件传输协议) 是 TCP/IP 协议组中的应用层协议。FTP协议使用字符串格式命令字,每条命令都是一行字符串,以“\r\n”结尾。客户端发送格式是:命令+空格+参数+"\r\n"的格式服务器返回格式是以:状态码+空格+提示字符串+"\r\n"的格式,代码只要解析状态码就可以了。读写文件需要登陆服务器,特殊用..._ftp 登录返回230

centos7安装rabbitmq3.6.5_centos7 安装rabbitmq3.6.5-程序员宅基地

文章浏览阅读648次。前提:systemctl stop firewalld 关闭防火墙关闭selinux查看getenforce临时关闭setenforce 0永久关闭sed-i'/SELINUX/s/enforcing/disabled/'/etc/selinux/configselinux的三种模式enforcing:强制模式,SELinux 运作中,且已经正确的开始限制..._centos7 安装rabbitmq3.6.5

idea导入android工程,idea怎样导入Android studio 项目?-程序员宅基地

文章浏览阅读5.8k次。满意答案s55f2avsx2017.09.05采纳率:46%等级:12已帮助:5646人新版Android Studio/IntelliJ IDEA可以直接导入eclipse项目,不再推荐使用eclipse导出gradle的方式2启动Android Studio/IntelliJ IDEA,选择 import project3选择eclipse 项目4选择 create project f..._android studio 项目导入idea 看不懂安卓项目

浅谈AI大模型技术:概念、发展和应用_ai大模型应用开发-程序员宅基地

文章浏览阅读860次,点赞2次,收藏6次。AI大模型技术已经在自然语言处理、计算机视觉、多模态交互等领域取得了显著的进展和成果,同时也引发了一系列新的挑战和问题,如数据质量、计算效率、知识可解释性、安全可靠性等。城市运维涉及到多个方面,如交通管理、环境监测、公共安全、社会治理等,它们需要处理和分析大量的多模态数据,如图像、视频、语音、文本等,并根据不同的场景和需求,提供合适的决策和响应。知识搜索有多种形式,如语义搜索、对话搜索、图像搜索、视频搜索等,它们可以根据用户的输入和意图,从海量的数据源中检索出最相关的信息,并以友好的方式呈现给用户。_ai大模型应用开发

非常详细的阻抗测试基础知识_阻抗实部和虚部-程序员宅基地

文章浏览阅读8.2k次,点赞12次,收藏121次。为什么要测量阻抗呢?阻抗能代表什么?阻抗测量的注意事项... ...很多人可能会带着一系列的问题来阅读本文。不管是数字电路工程师还是射频工程师,都在关注各类器件的阻抗,本文非常值得一读。全文13000多字,认真读完大概需要2小时。一、阻抗测试基本概念阻抗定义:阻抗是元器件或电路对周期的交流信号的总的反作用。AC 交流测试信号 (幅度和频率)。包括实部和虚部。​图1 阻抗的定义阻抗是评测电路、元件以及制作元件材料的重要参数。那么什么是阻抗呢?让我们先来看一下阻抗的定义。首先阻抗是一个矢量。通常,阻抗是_阻抗实部和虚部

小学生python游戏编程arcade----基本知识1_arcade语言 like-程序员宅基地

文章浏览阅读955次。前面章节分享试用了pyzero,pygame但随着想增加更丰富的游戏内容,好多还要进行自己编写类,从今天开始解绍一个新的python游戏库arcade模块。通过此次的《连连看》游戏实现,让我对swing的相关知识有了进一步的了解,对java这门语言也有了比以前更深刻的认识。java的一些基本语法,比如数据类型、运算符、程序流程控制和数组等,理解更加透彻。java最核心的核心就是面向对象思想,对于这一个概念,终于悟到了一些。_arcade语言 like

随便推点

【增强版短视频去水印源码】去水印微信小程序+去水印软件源码_去水印机要增强版-程序员宅基地

文章浏览阅读1.1k次。源码简介与安装说明:2021增强版短视频去水印源码 去水印微信小程序源码网站 去水印软件源码安装环境(需要材料):备案域名–服务器安装宝塔-安装 Nginx 或者 Apachephp5.6 以上-安装 sg11 插件小程序已自带解析接口,支持全网主流短视频平台,搭建好了就能用注:接口是公益的,那么多人用解析慢是肯定的,前段和后端源码已经打包,上传服务器之后在配置文件修改数据库密码。然后输入自己的域名,进入后台,创建小程序,输入自己的小程序配置即可安装说明:上传源码,修改data/_去水印机要增强版

verilog进阶语法-触发器原语_fdre #(.init(1'b0) // initial value of register (1-程序员宅基地

文章浏览阅读557次。1. 触发器是FPGA存储数据的基本单元2. 触发器作为时序逻辑的基本元件,官方提供了丰富的配置方式,以适应各种可能的应用场景。_fdre #(.init(1'b0) // initial value of register (1'b0 or 1'b1) ) fdce_osc (

嵌入式面试/笔试C相关总结_嵌入式面试笔试c语言知识点-程序员宅基地

文章浏览阅读560次。本该是不同编译器结果不同,但是尝试了g++ msvc都是先计算c,再计算b,最后得到a+b+c是经过赋值以后的b和c参与计算而不是6。由上表可知,将q复制到p数组可以表示为:*p++=*q++,*优先级高,先取到对应q数组的值,然后两个++都是在后面,该行运算完后执行++。在电脑端编译完后会分为text data bss三种,其中text为可执行程序,data为初始化过的ro+rw变量,bss为未初始化或初始化为0变量。_嵌入式面试笔试c语言知识点

57 Things I've Learned Founding 3 Tech Companies_mature-程序员宅基地

文章浏览阅读2.3k次。57 Things I've Learned Founding 3 Tech CompaniesJason Goldberg, Betashop | Oct. 29, 2010, 1:29 PMI’ve been founding andhelping run techn_mature

一个脚本搞定文件合并去重,大数据处理,可以合并几个G以上的文件_python 超大文本合并-程序员宅基地

文章浏览阅读1.9k次。问题:先讲下需求,有若干个文本文件(txt或者csv文件等),每行代表一条数据,现在希望能合并成 1 个文本文件,且需要去除重复行。分析:一向奉行简单原则,如无必要,绝不复杂。如果数据量不大,那么如下两条命令就可以搞定合并:cat a.txt >> new.txtcat b.txt >> new.txt……去重:cat new...._python 超大文本合并

支付宝小程序iOS端过渡页DFLoadingPageRootController分析_类似支付宝页面过度加载页-程序员宅基地

文章浏览阅读489次。这个过渡页是第一次打开小程序展示的,点击某个小程序前把手机的开发者->network link conditioner->enable & very bad network 就会在停在此页。比如《支付宝运动》这个小程序先看这个类的.h可以看到它继承于DTViewController点击左上角返回的方法- (void)back;#import "DTViewController.h"#import "APBaseLoadingV..._类似支付宝页面过度加载页

推荐文章

热门文章

相关标签