Android微信Thinker热修复详细接入

快来打我* 2023-07-01 06:29 9阅读 0赞

# 一.Android热修复接入 #

公司app考虑接入热修复，现在流行的也就是阿里的`Sophix`和微信的`Thinker`，接入过程也是坑不断，顺利接入后做个总结。真想吐槽下微信的接入文档简直像坨那啥，两边不统一，还模糊不清。要么人家都是大佬，我是菜鸡。初次接入，有不对滴地方还望指出，共同进步，谢谢。

微信Thinker在GayHub上的 [接入指南][Link 1]  
微信Thinker官网的SDK[接入指南][Link 2]

阿里Sophix[接入指南][Link 3]

本篇是总结微信Thinker的接入流程：

# 二.接入流程 #

## 2.1 ##

在Thinker官网`http://tinkerpatch.com/`用邮箱注册一个账号，新建APP，输入当前APP的版本号，得到该APP的appKey，如图  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MzU2ODMz_size_16_color_FFFFFF_t_70]

## 2.2 ##

在项目的`gradle.properties`文件中，添加

TINKER_VERSION=1.9.2
    TINKERPATCH_VERSION=1.2.2

## 2.3 ##

在`module`app的`build.gradle`的`dependencies`中添加

//若使用annotation需要单独引用,对于tinker的其他库都无需再引用
    annotationProcessor("com.tinkerpatch.tinker:tinker-android-anno:${TINKER_VERSION}") { 
        changing = true
    }
    compileOnly("com.tinkerpatch.tinker:tinker-android-anno:${TINKER_VERSION}") {  changing = true }
    implementation("com.tinkerpatch.sdk:tinkerpatch-android-sdk:${TINKERPATCH_VERSION}") { 
        changing = true
    }

## 2.4 ##

在`工程`的`build.gradle` 中修改

buildscript { 
        repositories { 
            jcenter()
        }
        dependencies { 
            // TinkerPatch 插件
            classpath "com.tinkerpatch.sdk:tinkerpatch-gradle-plugin:${TINKERPATCH_VERSION}"
        }
    }

## 2.5 ##

根目录(`app目录下`)新建`tinkerpatch.gradle`（官方demo文件中有），复制以下内容到该文件：

apply plugin: 'tinkerpatch-support'
    
    /** * TODO: 请按自己的需求修改为适应自己工程的参数 */
    def bakPath = file("${buildDir}/bakApk/")
    def baseInfo = "app-4.2.21-1029-10-28-25"
    def variantName = "dev_test-release"
    
    /** * 对于插件各参数的详细解析请参考 * http://tinkerpatch.com/Docs/SDK */
    tinkerpatchSupport { 
        /** 可以在debug的时候关闭 tinkerPatch **/
        /** 当disable tinker的时候需要添加multiDexKeepProguard和proguardFiles, 这些配置文件本身由tinkerPatch的插件自动添加，当你disable后需要手动添加 你可以copy本示例中的proguardRules.pro和tinkerMultidexKeep.pro, 需要你手动修改'tinker.sample.android.app'本示例的包名为你自己的包名, com.xxx前缀的包名不用修改 **/
        tinkerEnable = true
        reflectApplication = true
        /** * 是否开启加固模式，只能在APK将要进行加固时使用，否则会patch失败。 * 如果只在某个渠道使用了加固，可使用多flavors配置 **/
        protectedApp = false
        /** * 实验功能 * 补丁是否支持新增 Activity (新增Activity的exported属性必须为false) **/
        supportComponent = true
    
        autoBackupApkPath = "${bakPath}"
    
    	/** 注意: 使用自己申请的appkey，这个是demo里的 **/
        appKey = "0d36f053a76c76c"
    
        /** 注意: 若发布新的全量包, appVersion一定要更新 **/
        appVersion = "1.0.0"
    
        def pathPrefix = "${bakPath}/${baseInfo}/${variantName}/"
        def name = "${project.name}-${variantName}"
    
        baseApkFile = "${pathPrefix}/${name}.apk"
        baseProguardMappingFile = "${pathPrefix}/${name}-mapping.txt"
        baseResourceRFile = "${pathPrefix}/${name}-R.txt"
    
        /** * 若有编译多flavors需求, 可以参照： https://github.com/TinkerPatch/tinkerpatch-flavors-sample * 注意: 除非你不同的flavor代码是不一样的,不然建议采用zip comment或者文件方式生成渠道信息（相关工具：walle 或者 packer-ng） **/
    }
    
    /** * 用于用户在代码中判断tinkerPatch是否被使能 */
    android { 
        defaultConfig { 
            buildConfigField "boolean", "TINKER_ENABLE", "${tinkerpatchSupport.tinkerEnable}"
        }
    }
    
    /** * 一般来说,我们无需对下面的参数做任何的修改 * 对于各参数的详细介绍请参考: * https://github.com/Tencent/tinker/wiki/Tinker-%E6%8E%A5%E5%85%A5%E6%8C%87%E5%8D%97 */
    tinkerPatch { 
        ignoreWarning = false
        useSign = true
        dex { 
            dexMode = "jar"
            pattern = ["classes*.dex"]
            loader = []
        }
        lib { 
            pattern = ["lib/*/*.so"]
        }
    
        res { 
            pattern = ["res/*", "r/*", "assets/*", "resources.arsc", "AndroidManifest.xml"]
            ignoreChange = []
            largeModSize = 100
        }
    
        packageConfig { 
        }
        sevenZip { 
            zipArtifact = "com.tencent.mm:SevenZip:1.1.10"
    // path = "/usr/local/bin/7za"
        }
        buildConfig { 
            keepDexApply = false
        }
    }

## 2.6 ##

tinkerpatch.gradle 文件一些参数说明  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MzU2ODMz_size_16_color_FFFFFF_t_70 1]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MzU2ODMz_size_16_color_FFFFFF_t_70 2]

注意替换appKey

## 2.7 ##

在`moudule`app的`build.gradle`顶部 引入该文件，添加如下代码

apply from: 'tinkerpatch.gradle'

## 2.8 ##

在项目的`Application`文件`onCreate`中添加`Thinker初始化代码`

ApplicationLike thinkerApplicationLike = TinkerPatchApplicationLike.getTinkerPatchApplicationLike();
    TinkerPatch.init(thinkerApplicationLike)
            .reflectPatchLibrary()
            .fetchPatchUpdate(true)
            .setPatchRollbackOnScreenOff(true)
            .setPatchRestartOnSrceenOff(true)
            .setFetchPatchIntervalByHours(3);
    TinkerPatch.with().fetchPatchUpdateAndPollWithInterval();

## 2.9 ##

开始打包基准包(旧的，有bug需要修改的包) 如图  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MzU2ODMz_size_16_color_FFFFFF_t_70 3]

根据左边方框里，生成的`文件路径`，修改对应的`baseInfo` 和 `variantName` 的值，`打补丁包的时候需要，否则找不到文件`。如图

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MzU2ODMz_size_16_color_FFFFFF_t_70 4]  
生成的有bug的基准包安装到手机上，打开后清除该app进程。 如图  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MzU2ODMz_size_16_color_FFFFFF_t_70 5]

## 2.10 ##

修改项目里有bug的地方，即需要热修复的问题，添加日志，修改文字，颜色等。就是修改代码。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MzU2ODMz_size_16_color_FFFFFF_t_70 6]

## 2.11 ##

打补丁包，生成补丁，如图

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MzU2ODMz_size_16_color_FFFFFF_t_70 7]

生成的`patch_signed_7zip.apk` 文件就是热修复补丁，位置如下图

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MzU2ODMz_size_16_color_FFFFFF_t_70 8]

## 2.12 ##

然后在官网平台新建的APP中，`添加新的补丁`，输入版本号即`VersionName` ，然后选择刚刚的补丁文件后提交，如图  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MzU2ODMz_size_16_color_FFFFFF_t_70 9]

注意默认是全量下发，先需要开发预览测试成功后，才可灰度(免费版木有)或者全量下发。

## 2.13 ##

测试需要使用测试工具，官网文档里说明，可点击 [下载][Link 4]

使用如图，打开即可  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MzU2ODMz_size_16_color_FFFFFF_t_70 10]

## 2.14 ##

开关打开后，`杀掉之前打开的旧包app的进程`，然后`重新启动`，热修复即可生效。如图  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MzU2ODMz_size_16_color_FFFFFF_t_70 11]

## 三.总结 ##

步骤感觉很多，其实都很简单，只是写的比较详细了点儿。  
有几点需要注意的地方：

## 3.1 tinkerpatch.gradle里的一些字段要注意，比如是否开启加固模式，只能在APK将要进行加固时使用，否则会patch失败。 ##

## 3.2 tinkerpatch.gradle里的appVersion 一定要和app、补丁的版本号对应，比如都是1.0 ##

## 3.3 打基准包和打补丁包，都会在bakApk下和output下新生成文件。要选对应的。 ##

## 3.4 有时候生效慢，但是后台检测很快，可以在补丁检测里查看到下载成功后，再次尝试杀进程，重启app，看是否生效，如果后台检测都没有数据，基本上是哪一步走错了。如图 ##

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MzU2ODMz_size_16_color_FFFFFF_t_70 12]

[Link 1]: https://github.com/Tencent/tinker/wiki/Tinker-%E6%8E%A5%E5%85%A5%E6%8C%87%E5%8D%97
[Link 2]: http://tinkerpatch.com/Docs/SDK
[Link 3]: https://helpcdn.aliyun.com/document_detail/61082.html?spm=a2c4g.11186623.4.2.12303c12WIsd3H
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MzU2ODMz_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200120105745800.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MzU2ODMz,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MzU2ODMz_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20200120102138697.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MzU2ODMz,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MzU2ODMz_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20200119174328252.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MzU2ODMz,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MzU2ODMz_size_16_color_FFFFFF_t_70 3]: https://img-blog.csdnimg.cn/20200120110042373.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MzU2ODMz,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MzU2ODMz_size_16_color_FFFFFF_t_70 4]: https://img-blog.csdnimg.cn/20200120110245709.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MzU2ODMz,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MzU2ODMz_size_16_color_FFFFFF_t_70 5]: https://img-blog.csdnimg.cn/20200120104828599.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MzU2ODMz,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MzU2ODMz_size_16_color_FFFFFF_t_70 6]: https://img-blog.csdnimg.cn/20200120110416546.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MzU2ODMz,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MzU2ODMz_size_16_color_FFFFFF_t_70 7]: https://img-blog.csdnimg.cn/20200120102449229.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MzU2ODMz,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MzU2ODMz_size_16_color_FFFFFF_t_70 8]: https://img-blog.csdnimg.cn/20200120110534500.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MzU2ODMz,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MzU2ODMz_size_16_color_FFFFFF_t_70 9]: https://img-blog.csdnimg.cn/20200120105143760.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MzU2ODMz,size_16,color_FFFFFF,t_70
[Link 4]: http://ogmj51oem.bkt.clouddn.com/TinkerDebugTool.apk
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MzU2ODMz_size_16_color_FFFFFF_t_70 10]: https://img-blog.csdnimg.cn/20200119175609328.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MzU2ODMz,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MzU2ODMz_size_16_color_FFFFFF_t_70 11]: https://img-blog.csdnimg.cn/20200120110735642.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MzU2ODMz,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MzU2ODMz_size_16_color_FFFFFF_t_70 12]: https://img-blog.csdnimg.cn/20200120111659254.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MzU2ODMz,size_16,color_FFFFFF,t_70