Android集成tinker热升级框架

太过爱你忘了你带给我的痛 2022-07-15 19:23 232阅读 0赞

# 微信热升级tinker集成项目 #

总项目工程，使用的是tinker v1.7.9版本  
[https://github.com/Tencent/tinker][https_github.com_Tencent_tinker]

## 步骤一 ##

1.root目录bulid.gradle添加

buildscript {
        repositories {
            jcenter()
        }
        dependencies {
            classpath 'com.android.tools.build:gradle:2.3.1'
            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
        }
    }

2.gradle.properties添加版本号

TINKER_VERSION=1.7.9

3.build.gradle添加

*  Tinker依赖库

dependencies {
       //Tinker
       //optional, help to generate the final application
       provided('com.tencent.tinker:tinker-android-anno:1.7.9')
       //tinker's main Android lib
       compile('com.tencent.tinker:tinker-android-lib:1.7.9')
       //必须添加，没有请添加
       compile "com.android.support:multidex:1.0.1"
    }

*  defaultConfig配置

def gitSha() {
        try {
            //String gitRev = 'git rev-parse --short HEAD'.execute(null, project.rootDir).text.trim()
            String gitRev = '1163f71'//我使用的是我git提交的 -short HEAD，参考官方建议
            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'")
        }
    }
    //定义java版本号
    def javaVersion = JavaVersion.VERSION_1_7
    
     android {
       compileSdkVersion 25
        buildToolsVersion "25.0.2"
      defaultConfig {
            applicationId "com.doublechina.myapplication"
            minSdkVersion 15
            targetSdkVersion 25
            versionCode 1
            versionName "1.0"
    
             //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\""
    
    
             // 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 false
                proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
            }
        }
     }

*  其他配置

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-0503-14-20-29.apk"
        //proguard mapping file to build patch apk
        tinkerApplyMappingPath = "${bakPath}/app-debug-0503-14-20-29-mapping.txt"
        //resource R.txt to build patch apk, must input if there is resource changed
        tinkerApplyResourcePath = "${bakPath}/app-debug-0503-14-20-29-R.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 = 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 = 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"
                        }
    
                    }
                }
            }
        }
    }

## 步骤二 ##

*  **SampleApplicationLike自定义**
    
    ![这里写图片描述][SouthEast]
 *  注解，头部添加注解

//SampleApplication可以自己随便命名，不要定义为TinerApplication就行了，碰到这坑了
    @DefaultLifeCycle(
            application = "tinker.sample.android.app.SampleApplication",             //application name to generate
            flags = ShareConstants.TINKER_ENABLE_ALL)
    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) {
            super(application, tinkerFlags, tinkerLoadVerifyFlag, applicationStartElapsedTime, applicationStartMillisTime, tinkerResultIntent);
        }
      @Override
        public void onCreate() {
            super.onCreate();
            getApplication().getApplicationContext();
        }
        @Override
        public void onBaseContextAttached(Context base) {
            super.onBaseContextAttached(base);
            //you must install multiDex whatever tinker is installed!
            LegendApplication.mApplication = getApplication();
            TinkerManager.setTinkerApplicationLike(this);
    
            TinkerManager.initFastCrashProtect();
            //should set before tinker is installed
            TinkerManager.setUpgradeRetryEnable(true);
    
            //optional set logIml, or you can use default debug log
            TinkerInstaller.setLogIml(new MyLogImp());
    
            //installTinker after load multiDex
            //or you can put com.tencent.tinker.** to main dex
            TinkerManager.installTinker(this);
            Tinker tinker = Tinker.with(getApplication());
            //-------------------------------------------
            //自定义Application的逻辑写到这里
            ApplicationUtil.init(getApplication());
            //getApplication().getApplicationContext()这种用法这里会为空，特别注意，在oncreate调用
    
        }
        @TargetApi(Build.VERSION_CODES.ICE_CREAM_SANDWICH)
        public void registerActivityLifecycleCallbacks(Application.ActivityLifecycleCallbacks callback) {
            getApplication().registerActivityLifecycleCallbacks(callback);
        }
    
    
    
    }

## 步骤三 ##

*  **自定义MyApplication改造后**

public class MyApplication {
        public static Application mApplication;
    }

## 步骤四 ##

*  **AndroidManifest改造**

//特别注意
    // android:name="tinker.sample.android.app.SampleApplication"是我在SampleApplicationLike中定义的
    <application android:allowBackup="true" android:icon="@mipmap/ic_launcher" android:label="@string/app_name" android:roundIcon="@mipmap/ic_launcher_round" android:supportsRtl="true" android:name="tinker.sample.android.app.SampleApplication" android:theme="@style/AppTheme">
            <activity android:name=".MainActivity">
                <intent-filter>
                    <action android:name="android.intent.action.MAIN" />
    
                    <category android:name="android.intent.category.LAUNCHER" />
                </intent-filter>
            </activity>
            <activity android:name=".TestActivity"/>
        </application>

demo下载地址 ：[https://github.com/doublechina/MultipleFix][https_github.com_doublechina_MultipleFix]

[https_github.com_Tencent_tinker]: https://github.com/Tencent/tinker
[SouthEast]: /images/20220715/423d3a2ca7da40eca05feb63a7236075.png
[https_github.com_doublechina_MultipleFix]: https://github.com/doublechina/MultipleFix