Tinker实践记

作者: 夜远曦白 | 来源:发表于2018-07-04 09:41 被阅读68次

    话说热修复技术也是个热门技术噢,一直没玩过,现在来写个Demo做个测试吧,选来选去,就选定Tinker啦!

    tinker的Github地址:https://github.com/Tencent/tinker
    (介绍也挺详细的,认真看看)

    emmmm,最好先把示例项目代码下载下来,跑一遍,跑通了,然后参考 tinker-sample-android 代码写好自己的demo,这里下载了整个工程后,打开的时候记得单独导入 tinker-sample-android,然后自己修改点点配置,比如TINKER_ID,打补丁包的时候,修改下 app 中 build.gradle 中的基准包地址什么的,就OK啦。

    所以,跟着文档一起吧,开始写个测试demo接入下吧,先新建一个项目TinkerTest 。

    首先,在项目的 build.gradle 加入插件 tinker-gradle-plugin 作为依赖,我的项目中代码如下所示:

    dependencies {
            classpath 'com.android.tools.build:gradle:3.1.3'
            classpath "com.tencent.tinker:tinker-patch-gradle-plugin:${TINKER_VERSION}"
    
            // NOTE: Do not place your application dependencies here; they belong
            // in the individual module build.gradle files
        }
    

    然后,就是 app 模块下的 build.gradle 引入插件,以及添加依赖这类,由于还有tinker的一些其他配置,主要配置详情都是从 tinker-sample-android 配置拷贝来的,不需要更改太多,个别可以根据自己需求来,代码如下:

    apply plugin: 'com.android.application'
    
    def javaVersion = JavaVersion.VERSION_1_8
    
    android {
        compileSdkVersion 28
        buildToolsVersion '27.0.3'
    
        compileOptions {
            sourceCompatibility javaVersion
            targetCompatibility javaVersion
        }
    
        //recommend
        dexOptions {
            jumboMode = true
        }
    
        defaultConfig {
            applicationId "com.pyn.tinkertest"
            minSdkVersion 14
            targetSdkVersion 28
            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\""
        }
    
        signingConfigs {
            release {
                try {
                    storeFile file("./keystore/tinkertest.jks")
                    storePassword "123456"
                    keyAlias "tinkertest"
                    keyPassword "123456"
                } catch (ex) {
                    throw new InvalidUserDataException(ex.toString())
                }
            }
        }
    
        buildTypes {
            release {
                minifyEnabled true
                signingConfig signingConfigs.release
                proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
            }
            debug {
                debuggable true
                minifyEnabled false
            }
        }
    
        sourceSets {
            main {
                jniLibs.srcDirs = ['libs']
            }
        }
    }
    
    repositories {
        flatDir {
            dirs 'libs'
        }
    }
    
    def gitSha() {
        try {
            String gitRev = 'git rev-parse --short HEAD'.execute(null, project.rootDir).text.trim()
            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 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-release-0702-13-41-18.apk"
        //proguard mapping file to build patch apk
        tinkerApplyMappingPath = "${bakPath}/app-release-0702-13-41-18-mapping.txt"
        //resource R.txt to build patch apk, must input if there is resource changed
        tinkerApplyResourcePath = "${bakPath}/app-release-0702-13-41-18-R.txt"
    
        //only use for build all flavor, if not, just ignore this field
        tinkerBuildFlavorDirectory = "${bakPath}/app-0702-13-41-18"
    }
    
    
    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") ? Boolean.parseBoolean(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 = false
    
            /**
             * 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 = true
    
                /**
                 * optional, default 'false'
                 * Whether tinker should support component hotplug (add new component dynamically).
                 * If this attribute is true, the component added in new apk will be available after
                 * patch is successfully loaded. Otherwise an error would be announced when generating patch
                 * on compile-time.
                 *
                 * <b>Notice that currently this feature is incubating and only support NON-EXPORTED Activity</b>
                 */
                supportHotplugComponent = 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.first().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"
                        }
    
                    }
                }
            }
        }
    }
    
    dependencies {
        implementation fileTree(include: ['*.jar'], dir: 'libs')
        implementation 'com.android.support:appcompat-v7:28.+'
        implementation 'com.android.support.constraint:constraint-layout:1.0.2'
        //optional, help to generate the final application
        annotationProcessor("com.tencent.tinker:tinker-android-anno:${TINKER_VERSION}") {
            changing = true
        }
        compileOnly("com.tencent.tinker:tinker-android-anno:${TINKER_VERSION}") { changing = true }
        //tinker's main Android lib
        implementation("com.tencent.tinker:tinker-android-lib:${TINKER_VERSION}") { changing = true }
        implementation 'com.tbruyelle.rxpermissions2:rxpermissions:0.9.5@aar'
        implementation 'io.reactivex.rxjava2:rxandroid:2.0.2'
        implementation 'io.reactivex.rxjava2:rxjava:2.1.16'
        implementation 'com.android.support:multidex:1.0.1'
        testImplementation 'junit:junit:4.12'
        androidTestImplementation 'com.android.support.test:runner:1.0.1'
        androidTestImplementation 'com.android.support.test.espresso:espresso-core:3.0.1'
        implementation(name: 'myaar-release2', ext: 'aar')
        implementation(name: 'NewAAR-release', ext: 'aar')
    }
    

    像 TINKER_ID 、TINKER_VERSION 我这是配置在 gradle.properties 中的:

    image.png

    新建一个 MyTinkerApplicationLike 类继承 DefaultApplicationLike :

    @DefaultLifeCycle(
            application = "com.pyn.MyTinkerApplication",  //application name to generate
            flags = ShareConstants.TINKER_ENABLE_ALL,
            loadVerifyFlag = false)
    public class MyTinkerApplicationLike extends DefaultApplicationLike {
    
        public MyTinkerApplicationLike(Application application, int tinkerFlags, boolean tinkerLoadVerifyFlag, long applicationStartElapsedTime, long applicationStartMillisTime, Intent tinkerResultIntent) {
            super(application, tinkerFlags, tinkerLoadVerifyFlag, applicationStartElapsedTime, applicationStartMillisTime, tinkerResultIntent);
        }
    
        @Override
        public void onBaseContextAttached(Context base) {
            super.onBaseContextAttached(base);
            MultiDex.install(base);
        }
    
        @Override
        public void onCreate() {
            super.onCreate();
            TinkerInstaller.install(this);
        }
    }
    

    AndroidManifest.xml:

    image.png

    MainActivity:

    public class MainActivity extends AppCompatActivity {
    
        private static final String TAG = "MainActivity";
    
        RxPermissions rxPermission;
        TextView tvContent;
        Button btnRepair;
    
        @Override
        protected void onCreate(Bundle savedInstanceState) {
            super.onCreate(savedInstanceState);
            setContentView(R.layout.activity_main);
    
            rxPermission = new RxPermissions(MainActivity.this);
            rxPermission.requestEach(Manifest.permission.READ_EXTERNAL_STORAGE,
                    Manifest.permission.WRITE_EXTERNAL_STORAGE)
                    .subscribe(new Consumer<Permission>() {
                        @Override
                        public void accept(Permission permission) throws Exception {
                            if (permission.granted) {
                                // 用户已经同意该权限
                                Log.d(TAG, permission.name + " is granted.");
                            } else if (permission.shouldShowRequestPermissionRationale) {
                                // 用户拒绝了该权限,没有选中『不再询问』(Never ask again),那么下次再次启动时,还会提示请求权限的对话框
                                Log.d(TAG, permission.name + " is denied. More info should be provided.");
                            } else {
                                // 用户拒绝了该权限,并且选中『不再询问』
                                Log.d(TAG, permission.name + " is denied.");
                            }
                        }
                    });
    
            initViews();
        }
    
        private void initViews() {
            tvContent = findViewById(R.id.tv_content);
            btnRepair = findViewById(R.id.btn_repair);
    
            btnRepair.setOnClickListener(new View.OnClickListener() {
                @Override
                public void onClick(View view) {
                    loadPatch();
                }
            });
        }
    
        private void loadPatch() {
            TinkerInstaller.onReceiveUpgradePatch(getApplicationContext(),
                    Environment.getExternalStorageDirectory().getAbsolutePath() + "/patch.apk");
        }
    }
    
    

    然后就是编译了,先来个debug包:

    image.png 产生了基准包:

    image.png
    随意改点代码,新增 jar 包也好,改 xml 文件也好,代码改动改动,在 app 的 build.gradle 中配置基准包的文件名改成刚刚生成的:

    image.png 再编译补丁包:

    image.png image.png OK啦,完成了,基准包和补丁包都成了,先把基准包装手机,然后补丁包位置吧,就看自己原来代码中写的位置了,我这里是写了按钮事件去读取手机外部内存中的补丁包,所以我这直接把补丁包改了名,放在那位置了,测试成功。

    我这里有个配置 isProtectedApp = true 是为了让包支持加固,测试爱加固也是成功的,默认的配置都是false,要支持加固得设置成 true 。

    当然还有一些配置的具体意义, GitHub 也有详细的描述,还有 TinkerPatch 是官方提供的补丁管理后台,这个集成更加简单了,如果不想用自己公司的后台管理补丁,直接用人家也蛮方便的,不过超过一定的量收费噢~ 哈哈,现在 bugly 平台中的热修复也是 tinker 方案,这个就免费,真是良心啊。

    最后再来补充一点,在补丁包加载的时候,应用会直接关闭,感觉就是有bug闪退了一般,当然这种体验是极度不好的, tinker-sample-android 中写好了最佳实践的代码,可以自定义一些加载回调啊,服务啊,来满足自己的需求,建议直接拷贝 SampleResultService.java 这个 Service 类(记得在AndroidManifest.xml中注册),它在应用退入后台或手机灭屏时,才杀掉进程,神不知鬼不觉的就把补丁包打好了,啧啧啧,这样也大大提升了用户体验。然后在初始化 tinker 这里,MyTinkerApplicationLike中,修改一下代码,如截图所示:

    image.png 其他参数用默认的就好,当然有需求的话,参考示例项目,自行实现自己的需求喽~

    相关文章

      网友评论

      本文标题:Tinker实践记

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