Leo's Blog

微信Tinker集成

发表于 | 分类于

前言： Tinker 是一个开源项目(Github链接)，它是微信官方的Android热补丁解决方案，它支持动态下发代码、So库以及资源，让应用能够在不需要重新安装的情况下实现更新。

1.1 Gradle 接入

在项目的build.gradle中添加 tinker-patch-gradle-plugin的依赖

1
2
3
4
5
buildscript {
    dependencies {
        classpath ('com.tencent.tinker:tinker-patch-gradle-plugin:1.7.5')
    }
}

在app的build.gradle中添加tinker的库依赖以及apply tinker 的gradle plugin

1
2
3
4
5
6
7
8
dependencies{
    //tinker的核心库
    compile('com.tencent.tinker:tinker-android-lib:1.7.5')
    //可选，用于注解生成application类
    provided('com.tencent.tinker:tinker-android-anno:1.7.5')
}
//　应用plugin 
apply plugin:'com.tencent.tinker.patch'

1.2 Tinker Gradle 配置

参考 Tinker 接入指南
tinkerPatch 全局配置示例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
tinkerPatch {
        // 基准包 path 
        oldApk = getOldApkPath()
        ignoreWarning = false
        useSign = true
        buildConfig {
            // mapping文件
            applyMapping = getApplyMappingPath()
            // R文件
            applyResourceMapping = getApplyResourceMappingPath()
            // tinkerId 必须设置
            tinkerId = getTinkerIdValue()
        }
        dex {
            dexMode = "jar"
            // 是否提前生成dex，而非合成方式，回退成Qzone方案
            usePreGeneratedPatchDex = false
            pattern = ["classes*.dex",
                       "assets/secondary-dex-?.jar"]
            loader = ["com.tencent.tinker.loader.*", "com.rxhui.pay.application.MyApplication",
            ]
        }
        lib {
            pattern = ["lib/armeabi/*.so"]
        }
        res {
            pattern = ["res/*", "assets/*", "resources.arsc", "AndroidManifest.xml"]
            // 生成patch 需要忽略的文件pattern（此处有坑）
//            ignoreChange = []
            ignoreChange = ["*.png"]
            largeModSize = 100
        }
        packageConfig {
            //todo 每次升级时，填写升级信息
            configField("patchMessage", "tinker test")
            configField("platform", "all")
            configField("patchVersion", getTinkerIdValue())
        }
        sevenZip {
            zipArtifact = "com.tencent.mm:SevenZip:1.1.10"
            /**
             * optional，default '7za'
             * todo you can specify the 7za path yourself, it will overwrite the zipArtifact value
             */
//            path = "/usr/bin/7za"
        }
    }

1.3 Patch 生成

  • 执行assemble任务，生成 oldApk
  • 修改代码，bug 修复，资源文件修改等等
  • 修改gradle tinkerPatch 配置，oldApk applyMapping及applyResourceMapping （混淆 mapping 和R文件使用同一份）
  • 执行 tinkerPatch task 生成patch文件

apk路径，mapping 路径，R.txt 路径 示例代码

1
2
3
4
5
6
7
8
9
10
def bakPath = file("${rootDir}/tinker/bakApk")
ext {
    // 普通生成patch模式
    tinkerOldApkPath = "${bakPath}/base-app-release-v1.0.1-2016-1125.apk"
    tinkerApplyMappingPath = "${bakPath}/base-app-release-v1.0.1-2016-1125-mapping.txt"
    tinkerApplyResourcePath = "${bakPath}/base-app-release-v1.0.1-2016-1125-R.txt"
    // 包含多个flavor时配置  
    tinkerBuildFlavorDirectory = "${bakPath}/app-2016-1209"
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
tinkerPatch中：
List<String> flavors = new ArrayList<>();
    project.android.productFlavors.each {flavor ->
        flavors.add(flavor.name)
    }
    boolean hasFlavors = flavors.size() > 0
    /**
    * 备份apk mapping R文件值bakPath
    */
    android.applicationVariants.all { variant ->
        /**
         * task type, you want to bak
         */
        def taskName = variant.name
        def date = new Date().format("MMdd-HH-mm-ss")
        tasks.all {
            if ("assemble${taskName.capitalize()}".equalsIgnoreCase(it.name)) {
                it.doLast {
                    copy {
                        def fileNamePrefix = "${project.name}-${variant.baseName}"
                        def newFileNamePrefix = hasFlavors ? "${fileNamePrefix}" : "${fileNamePrefix}-${date}"
                        def destPath = hasFlavors ? file("${bakPath}/${project.name}-${date}/${variant.flavorName}") : bakPath
                        from variant.outputs.outputFile
                        into destPath
                        rename { String fileName ->
                            fileName.replace("${fileNamePrefix}.apk", "${newFileNamePrefix}.apk")
                        }
                        from "${buildDir}/outputs/mapping/${variant.dirName}/mapping.txt"
                        into destPath
                        rename { String fileName ->
                            fileName.replace("mapping.txt", "${newFileNamePrefix}-mapping.txt")
                        }
                        from "${buildDir}/intermediates/symbols/${variant.dirName}/R.txt"
                        into destPath
                        rename { String fileName ->
                            fileName.replace("R.txt", "${newFileNamePrefix}-R.txt")
                        }
                    }
                }
            }
        }
    }
    
    /**
    * 多flavor 处理  配置每个flavor的tinkerPatch task 
    */
    project.afterEvaluate {
        //sample use for build all flavor for one time
        if (hasFlavors) {
            task(tinkerPatchAllFlavorRelease) {
                group = 'tinker'
                def originOldPath = getTinkerBuildFlavorDirectory()
                for (String flavor : flavors) {
                    def tinkerTask = tasks.getByName("tinkerPatch${flavor.capitalize()}Release")
                    dependsOn tinkerTask
                    def preAssembleTask = tasks.getByName("process${flavor.capitalize()}ReleaseManifest")
                    preAssembleTask.doFirst {
                        String flavorName = preAssembleTask.name.substring(7, 8).toLowerCase() + preAssembleTask.name.substring(8, preAssembleTask.name.length() - 15)
                        project.tinkerPatch.oldApk = "${originOldPath}/${flavorName}/${project.name}-${flavorName}-release.apk"
                        project.tinkerPatch.buildConfig.applyMapping = "${originOldPath}/${flavorName}/${project.name}-${flavorName}-release-mapping.txt"
                        project.tinkerPatch.buildConfig.applyResourceMapping = "${originOldPath}/${flavorName}/${project.name}-${flavorName}-release-R.txt"
                    }
                }
            }
            task(tinkerPatchAllFlavorDebug) {
                group = 'tinker'
                def originOldPath = getTinkerBuildFlavorDirectory()
                for (String flavor : flavors) {
                    def tinkerTask = tasks.getByName("tinkerPatch${flavor.capitalize()}Debug")
                    dependsOn tinkerTask
                    def preAssembleTask = tasks.getByName("process${flavor.capitalize()}DebugManifest")
                    preAssembleTask.doFirst {
                        String flavorName = preAssembleTask.name.substring(7, 8).toLowerCase() + preAssembleTask.name.substring(8, preAssembleTask.name.length() - 13)
                        project.tinkerPatch.oldApk = "${originOldPath}/${flavorName}/${project.name}-${flavorName}-debug.apk"
                        project.tinkerPatch.buildConfig.applyMapping = "${originOldPath}/${flavorName}/${project.name}-${flavorName}-debug-mapping.txt"
                        project.tinkerPatch.buildConfig.applyResourceMapping = "${originOldPath}/${flavorName}/${project.name}-${flavorName}-debug-R.txt"
                    }
                }
            }
        }
    }

1.4 Tinker patch 加载

  • 1.4.1 改造Application类（实现补丁包可以对Application做修改），两种方式（建议使用注解的方式）：

    • （1）定义代理类实现DefaultApplicationLike
      Tinker自定义扩展
    • （2）Annotation 方式，需要引入 tinker-android-anno。保证无法修改Application，避免误操作
    1
    2
    3
    4
    5
    6
     @DefaultLifeCycle(
    application = ".SampleApplication",                       //application类名
    flags = ShareConstants.TINKER_ENABLE_ALL,                 //tinkerFlags
    loaderClass = "com.tencent.tinker.loader.TinkerLoader",   //loaderClassName, 我们这里使用默认即可!
    loadVerifyFlag = false)                                   //tinkerLoadVerifyFlag
    public class SampleApplicationLike extends DefaultApplicationLike

注：将原来的application类删掉，初始化操作全部放在代理类中。

  • 1.4.2 gradle tinker patch 配置

    1
    2
    3
    4
    5
    dex {
    loader = ["com.tencent.tinker.loader.*",
             // 配置成自己的application 
              "tinker.sample.android.YourApplication",       
    }

  • 1.4.3 安装tinker 

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    @SuppressWarnings("unused")
    @DefaultLifeCycle(application = "tinker.sample.android.app.SampleApplication",
                      flags = ShareConstants.TINKER_ENABLE_ALL,
                      loadVerifyFlag = false)
    public class SampleApplicationLike extends DefaultApplicationLike {
        private static final String TAG = "Tinker.SampleApplicationLike";
        public SampleApplicationLike(Application application, int tinkerFlags, boolean tinkerLoadVerifyFlag,
                                     long applicationStartElapsedTime, long applicationStartMillisTime, Intent tinkerResultIntent,
                                     Resources[] resources, ClassLoader[] classLoader, AssetManager[] assetManager) {
            super(application, tinkerFlags, tinkerLoadVerifyFlag, applicationStartElapsedTime, applicationStartMillisTime, tinkerResultIntent, resources, classLoader, assetManager);
        }
        @TargetApi(Build.VERSION_CODES.ICE_CREAM_SANDWICH)
        @Override
        public void onBaseContextAttached(Context base) {
            super.onBaseContextAttached(base);
           
            MultiDex.install(base);
            SampleApplicationContext.application = getApplication();
            SampleApplicationContext.context = getApplication();
            //installTinker after load multiDex
            //or you can put com.tencent.tinker.** to main dex
            TinkerInstaller.install(this);
        }
    }

  • 1.4.4 加载补丁
    将生成的补丁包，推送到指定目录，运行app时调用下面的代码进行加载。

    1
    TinkerInstaller.onReceiveUpgradePatch(getApplicationContext(), Environment.getExternalStorageDirectory().getAbsolutePath() + "/patch_signed_7zip.apk");

在实际开发过程中，我们是需要将补丁存到服务器，由服务器进行补丁分发，Tinker的开发团队已经提供，集成文档很详细，我就不做搬运工了。Tinker Server SDK集成文档