美文网首页Tinker热修复知识整理
一次集成使用Tinker热更新的体验

一次集成使用Tinker热更新的体验

作者: 小小程序员jh | 来源:发表于2017-12-21 10:07 被阅读2081次

    对于热修复也学习了2天,基本了解它是怎么操作与实现的,自己在做的时候也遇到了一些坑,看到好的文庄总是忍不住要收藏,要学习,下面这篇文章内容写的很好,借此分享非大家!
    转载地址:
    http://blog.csdn.net/qq_34306963/article/details/76926930

    官方文档:https://github.com/Tencent/tinker
    下面我们按照官方文档和这个里面的tinker-sample-android来进行集成Tinker。
    注意说明,
    官方demo的使用https://github.com/Tencent/tinker/wiki/Tinker-接入指南里面的使用步骤详解

    热加载

    简单的说 如果Android要加载一个类 就会调用ClassLoader的findClass方法 在dex中查找这个类 找到后加载到内存
    而我们要做的就是在findClass的时候让类加载找到的是我们修复过后的类,而不是未修复的类。

    这里写图片描述

    至于是如何做到的暂时还没有深究,个人理解大概是通过反射替换了ClassLoader,通过自定义的ClassLoader去加载更新之后的类文件从而完成替换

    直接上手

    关于热更新介绍和机制,网上很多介绍,这里简单记录一下小白使用Tinker热更新的经历

    跑通demo,稍后再说导入

    https://github.com/Tencent/tinker

    1. 将tinker-sample-android 导入
      这里要注意的是


      20170808173726600.png

    需要将app 下的gradle 中 gitRev 字段自己赋值,因为在没有配置git的情况下,无法获取,这个值作为Tinker 的Id,我好像没感觉这个玩意有啥用,应该是唯一的即可,然后这个项目就可以根据编译打包啦(即带有bug需要修复的线上版本)

    1. 修改Bug

    比如给随便一个按钮点击事件中多打印一个Toast

    1. 打差异包

    首先在Gradle中配置带有bug的apk路径,以及资源文件txt路径,以便让Tinker新老apk进行比较,生成差异包


    这里写图片描述

    在AS自带命令行中输入 gradlew tinkerPatchDebug,如果其中报错
    Warning:ignoreWarning is false, but resources.arsc is changed, you should use applyResourceMapping mode to build the new apk, otherwise, it may be crash at some times
    com.tencent.tinker.build.util.TinkerPatchException: ignoreWarning is false, but resources.arsc is changed, you should use applyResourceMapping mode to build the new apk, otherwise, it may be crash at some times

    FAILURE: Build failed with an exception.

    • What went wrong:
      Could not dispatch a message to the daemon.

    • Try:
      Run with –stacktrace option to get the stack trace. Run with –info or –debug option to get more log output.

    ,可在Gradle中尝试打开警告忽略

    20170808175604998.png

    4.将生成的Patch包导入代码中的加载路径,默认项目中MainActivity中写死了,在存储卡根目录
    TinkerInstaller.onReceiveUpgradePatch(getApplicationContext(), Environment.getExternalStorageDirectory().getAbsolutePath() + “/patch_signed_7zip.apk”);

    patch默认生成在


    20170808180945296.png

    5.最后一步,调用

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

    即可,然后将程序关闭,重新打开,就执行的是新的代码啦~

    导入到自己的工程

    推荐使用Gradle导入

    在app下添加

    apply plugin: 'com.tencent.tinker.patch'
    
      compile('com.tencent.tinker:tinker-android-anno:1.7.11')
        //tinker的核心库
        compile('com.tencent.tinker:tinker-android-lib:1.7.11')
        compile "com.android.support:multidex:1.0.1"
    

    project.gradle

     classpath ('com.tencent.tinker:tinker-patch-gradle-plugin:1.7.11')
    

    附上我的完整gradle文件,注意,一定要配置签名文件

    apply plugin: 'com.android.application'
    apply plugin: 'com.tencent.tinker.patch'
    
    def gitSha() {
        try {
    //        String gitRev = 'git rev-parse --short HEAD'.execute(null, project.rootDir).text.trim()
            String gitRev = "fushuang666"
            if (gitRev == null) {
                throw new GradleException("can't get git rev, you should add git to system path or just input test value, such as 'testTinkerId'")
            }
            return gitRev
        } catch (Exception e) {
            throw new GradleException("can't get git rev, you should add git to system path or just input test value, such as 'testTinkerId'")
        }
    }
    
    def javaVersion = JavaVersion.VERSION_1_7
    
    def bakPath = file("${buildDir}/bakApk/")
    
    /**
     * you can use assembleRelease to build you base apk
     * use tinkerPatchRelease -POLD_APK=  -PAPPLY_MAPPING=  -PAPPLY_RESOURCE= to build patch
     * add apk from the build/bakApk
     */
    ext {
        //for some reason, you may want to ignore tinkerBuild, such as instant run debug build?
        tinkerEnabled = true
    
        //for normal build
        //old apk file to build patch apk
        tinkerOldApkPath = "${bakPath}/app-debug-0808-17-04-26.apk"
        //proguard mapping file to build patch apk
        tinkerApplyMappingPath = "${bakPath}/app-debug-1018-17-32-47-mapping.txt"
        //resource R.txt to build patch apk, must input if there is resource changed
        tinkerApplyResourcePath = "${bakPath}/app-debug-0808-17-04-26.txt"
    
        //only use for build all flavor, if not, just ignore this field
        tinkerBuildFlavorDirectory = "${bakPath}/app-1018-17-32-47"
    }
    
    def getOldApkPath() {
        return hasProperty("OLD_APK") ? OLD_APK : ext.tinkerOldApkPath
    }
    
    def getApplyMappingPath() {
        return hasProperty("APPLY_MAPPING") ? APPLY_MAPPING : ext.tinkerApplyMappingPath
    }
    
    def getApplyResourceMappingPath() {
        return hasProperty("APPLY_RESOURCE") ? APPLY_RESOURCE : ext.tinkerApplyResourcePath
    }
    
    def getTinkerIdValue() {
        return hasProperty("TINKER_ID") ? TINKER_ID : gitSha()
    }
    
    def buildWithTinker() {
        return hasProperty("TINKER_ENABLE") ? TINKER_ENABLE : ext.tinkerEnabled
    }
    
    def getTinkerBuildFlavorDirectory() {
        return ext.tinkerBuildFlavorDirectory
    }
    
    if (buildWithTinker()) {
        apply plugin: 'com.tencent.tinker.patch'
    
        tinkerPatch {
            /**
             * necessary,default 'null'
             * the old apk path, use to diff with the new apk to build
             * add apk from the build/bakApk
             */
            oldApk = getOldApkPath()
            /**
             * optional,default 'false'
             * there are some cases we may get some warnings
             * if ignoreWarning is true, we would just assert the patch process
             * case 1: minSdkVersion is below 14, but you are using dexMode with raw.
             *         it must be crash when load.
             * case 2: newly added Android Component in AndroidManifest.xml,
             *         it must be crash when load.
             * case 3: loader classes in dex.loader{} are not keep in the main dex,
             *         it must be let tinker not work.
             * case 4: loader classes in dex.loader{} changes,
             *         loader classes is ues to load patch dex. it is useless to change them.
             *         it won't crash, but these changes can't effect. you may ignore it
             * case 5: resources.arsc has changed, but we don't use applyResourceMapping to build
             */
            ignoreWarning = true
    
            /**
             * optional,default 'true'
             * whether sign the patch file
             * if not, you must do yourself. otherwise it can't check success during the patch loading
             * we will use the sign config with your build type
             */
            useSign = true
    
            /**
             * optional,default 'true'
             * whether use tinker to build
             */
            tinkerEnable = buildWithTinker()
    
            /**
             * Warning, applyMapping will affect the normal android build!
             */
            buildConfig {
                /**
                 * optional,default 'null'
                 * if we use tinkerPatch to build the patch apk, you'd better to apply the old
                 * apk mapping file if minifyEnabled is enable!
                 * Warning:
                 * you must be careful that it will affect the normal assemble build!
                 */
                applyMapping = getApplyMappingPath()
                /**
                 * optional,default 'null'
                 * It is nice to keep the resource id from R.txt file to reduce java changes
                 */
                applyResourceMapping = getApplyResourceMappingPath()
    
                /**
                 * necessary,default 'null'
                 * because we don't want to check the base apk with md5 in the runtime(it is slow)
                 * tinkerId is use to identify the unique base apk when the patch is tried to apply.
                 * we can use git rev, svn rev or simply versionCode.
                 * we will gen the tinkerId in your manifest automatic
                 */
                tinkerId = getTinkerIdValue()
    
                /**
                 * if keepDexApply is true, class in which dex refer to the old apk.
                 * open this can reduce the dex diff file size.
                 */
                keepDexApply = false
    
                /**
                 * optional, default 'false'
                 * Whether tinker should treat the base apk as the one being protected by app
                 * protection tools.
                 * If this attribute is true, the generated patch package will contain a
                 * dex including all changed classes instead of any dexdiff patch-info files.
                 */
                isProtectedApp = false
            }
    
            dex {
                /**
                 * optional,default 'jar'
                 * only can be 'raw' or 'jar'. for raw, we would keep its original format
                 * for jar, we would repack dexes with zip format.
                 * if you want to support below 14, you must use jar
                 * or you want to save rom or check quicker, you can use raw mode also
                 */
                dexMode = "jar"
    
                /**
                 * necessary,default '[]'
                 * what dexes in apk are expected to deal with tinkerPatch
                 * it support * or ? pattern.
                 */
                pattern = ["classes*.dex",
                           "assets/secondary-dex-?.jar"]
                /**
                 * necessary,default '[]'
                 * Warning, it is very very important, loader classes can't change with patch.
                 * thus, they will be removed from patch dexes.
                 * you must put the following class into main dex.
                 * Simply, you should add your own application {@code tinker.sample.android.SampleApplication}
                 * own tinkerLoader, and the classes you use in them
                 *
                 */
                loader = [
                        //use sample, let BaseBuildInfo unchangeable with tinker
                        "tinker.sample.android.app.BaseBuildInfo"
                ]
            }
    
            lib {
                /**
                 * optional,default '[]'
                 * what library in apk are expected to deal with tinkerPatch
                 * it support * or ? pattern.
                 * for library in assets, we would just recover them in the patch directory
                 * you can get them in TinkerLoadResult with Tinker
                 */
                pattern = ["lib/*/*.so"]
            }
    
            res {
                /**
                 * optional,default '[]'
                 * what resource in apk are expected to deal with tinkerPatch
                 * it support * or ? pattern.
                 * you must include all your resources in apk here,
                 * otherwise, they won't repack in the new apk resources.
                 */
                pattern = ["res/*", "assets/*", "resources.arsc", "AndroidManifest.xml"]
    
                /**
                 * optional,default '[]'
                 * the resource file exclude patterns, ignore add, delete or modify resource change
                 * it support * or ? pattern.
                 * Warning, we can only use for files no relative with resources.arsc
                 */
                ignoreChange = ["assets/sample_meta.txt"]
    
                /**
                 * default 100kb
                 * for modify resource, if it is larger than 'largeModSize'
                 * we would like to use bsdiff algorithm to reduce patch file size
                 */
                largeModSize = 100
            }
    
            packageConfig {
                /**
                 * optional,default 'TINKER_ID, TINKER_ID_VALUE' 'NEW_TINKER_ID, NEW_TINKER_ID_VALUE'
                 * package meta file gen. path is assets/package_meta.txt in patch file
                 * you can use securityCheck.getPackageProperties() in your ownPackageCheck method
                 * or TinkerLoadResult.getPackageConfigByName
                 * we will get the TINKER_ID from the old apk manifest for you automatic,
                 * other config files (such as patchMessage below)is not necessary
                 */
                configField("patchMessage", "tinker is sample to use")
                /**
                 * just a sample case, you can use such as sdkVersion, brand, channel...
                 * you can parse it in the SamplePatchListener.
                 * Then you can use patch conditional!
                 */
                configField("platform", "all")
                /**
                 * patch version via packageConfig
                 */
                configField("patchVersion", "1.0")
            }
            //or you can add config filed outside, or get meta value from old apk
            //project.tinkerPatch.packageConfig.configField("test1", project.tinkerPatch.packageConfig.getMetaDataFromOldApk("Test"))
            //project.tinkerPatch.packageConfig.configField("test2", "sample")
    
            /**
             * if you don't use zipArtifact or path, we just use 7za to try
             */
            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
                 */
    //        path = "/usr/local/bin/7za"
            }
        }
    
        List<String> flavors = new ArrayList<>();
        project.android.productFlavors.each {flavor ->
            flavors.add(flavor.name)
        }
        boolean hasFlavors = flavors.size() > 0
        def date = new Date().format("MMdd-HH-mm-ss")
    
        /**
         * bak apk and mapping
         */
        android.applicationVariants.all { variant ->
            /**
             * task type, you want to bak
             */
            def taskName = variant.name
    
            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")
                            }
                        }
                    }
                }
            }
        }
        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"
                        }
    
                    }
                }
            }
        }
    }
    
    android {
        compileSdkVersion 26
        buildToolsVersion "26.0.0"
    
        compileOptions {
            sourceCompatibility javaVersion
            targetCompatibility javaVersion
        }
    
        //recommend
        dexOptions {
            jumboMode = true
        }
    
        signingConfigs {
            release {
                try {
                    storeFile file("./keystore/key.jks")
                    storePassword "123456"
                    keyAlias "key"
                    keyPassword "123456"
                } catch (ex) {
                    throw new InvalidUserDataException(ex.toString())
                }
            }
    
            debug {
                storeFile file("./keystore/key.jks")
                storePassword "123456"
                keyAlias "key"
                keyPassword "123456"
            }
        }
    
        defaultConfig {
            applicationId "com.example.admin.tinker"
            minSdkVersion 19
            targetSdkVersion 26
            versionCode 1
            versionName "1.0"
            testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
    
            /**
             * you can use multiDex and install it in your ApplicationLifeCycle implement
             */
            multiDexEnabled true
            /**
             * buildConfig can change during patch!
             * we can use the newly value when patch
             */
            buildConfigField "String", "MESSAGE", "\"I am the base apk\""
    //        buildConfigField "String", "MESSAGE", "\"I am the patch apk\""
            /**
             * client version would update with patch
             * so we can get the newly git version easily!
             */
            buildConfigField "String", "TINKER_ID", "\"${getTinkerIdValue()}\""
            buildConfigField "String", "PLATFORM",  "\"all\""
    
        }
        buildTypes {
            release {
                minifyEnabled true
                signingConfig signingConfigs.release
                proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
            }
            debug {
                debuggable true
                minifyEnabled false
                signingConfig signingConfigs.debug
            }
        }
    
    }
    
    dependencies {
        compile fileTree(dir: 'libs', include: ['*.jar'])
        androidTestCompile('com.android.support.test.espresso:espresso-core:2.2.2', {
            exclude group: 'com.android.support', module: 'support-annotations'
        })
        compile 'com.android.support:appcompat-v7:26.+'
        compile 'com.android.support.constraint:constraint-layout:1.0.2'
        testCompile 'junit:junit:4.12'
        //可选,用于生成application类
        compile('com.tencent.tinker:tinker-android-anno:1.7.11')
        //tinker的核心库
        compile('com.tencent.tinker:tinker-android-lib:1.7.11')
        compile "com.android.support:multidex:1.0.1"
    
    }
    
    

    将demo中的类导入


    这里写图片描述

    修改Manifast文件


    这里写图片描述

    好啦,你的工程可以和Demo工程一样愉快的使用了。具体加载Patch清除Patch 看Demo就可以了

    githubDemo地址:https://github.com/fushuangdage/Tinker

    相关文章

      网友评论

      • Bury丶冬天:网上这些文章都是你一个人写的吗?为什么都是一模一样的,照着步骤一步一步来的,根本没什么卵用,差分包加载了跟没加载一样,不知道哪步出了问题
        TTLLong:兄弟,上面不是有转载地址吗
        nodzhang:这个是他粘贴复制的

      本文标题:一次集成使用Tinker热更新的体验

      本文链接:https://www.haomeiwen.com/subject/ovpowxtx.html