Tinker集成步骤

Tinker是腾讯出品的一款强大的热修复框架，今天我们来学习一下如何集成Tinker。

第一步：在project的build.gradle中添加tinker的插件配置，如下红色部分

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:2.1.0'
        classpath 'com.google.gms:google-services:3.0.0'
        classpath "com.tencent.tinker:tinker-patch-gradle-plugin:${TINKER_VERSION}"
    }
}

allprojects {
    repositories {
        jcenter()
        flatDir{
            dirs '../daniulive/libs';
        }
    }
}

同时在gradle.properties中添加TINKER_VERSION的配置

TINKER_VERSION=1.7.7

第二步：在Module的build.gradle中添加配置，如下红色部分：

apply plugin: 'com.android.application'
apply plugin: 'com.tencent.tinker.patch'

dependencies {
    compile fileTree(include: '*.so', dir: 'libs')
    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:24.2.1'
    testCompile 'junit:junit:4.12'
    compile files('libs/smartavengine.jar')
    compile 'com.squareup.okhttp3:okhttp:3.6.0'
    compile files('libs/gson-2.2.4.jar')
    //腾讯Bugly集成
    compile 'com.tencent.bugly:crashreport:latest.release'
    //GA集成
    compile 'com.google.android.gms:play-services-analytics:10.2.1'

    compile("com.tencent.tinker:tinker-android-lib:${TINKER_VERSION}") { changing = true }
    provided("com.tencent.tinker:tinker-android-anno:${TINKER_VERSION}") { changing = true }
    compile 'com.android.support:multidex:1.0.1'
}

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 0
    } 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

android {
    lintOptions{
        abortOnError false
    }

    signingConfigs {
        config {
            keyAlias 'androiddebugkey'
            keyPassword 'android'
            storeFile file('./debug.keystore')
            storePassword 'android'
        }
    }

    compileSdkVersion 23
    buildToolsVersion "23.0.2"

    tasks.whenTaskAdded { task ->
        if (task.name.equals("lint")) {
            task.enabled = false
        }
    }

    sourceSets.main {
        jni.srcDirs = []
        jniLibs.srcDir 'src/main/libs'
    }


    defaultConfig {
        applicationId "com.daniulive.smartpublisher"
        minSdkVersion 14
        targetSdkVersion 24
        versionCode 8
        versionName "1.3"

        testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"

        multiDexEnabled true
        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 {
        debug {
            signingConfig signingConfigs.config
        }
        release {
            debuggable false
            signingConfig signingConfigs.config
        }
    }

    packagingOptions {
        exclude 'META-INF/LICENSE'
        exclude 'META-INF/ASL2.0'
        exclude 'META-INF/INDEX.LIST'
    }

    compileOptions {
        sourceCompatibility javaVersion
        targetCompatibility javaVersion
    }
//recommend
    dexOptions {
        jumboMode = true
        incremental true
        javaMaxHeapSize "4g"
    }

    sourceSets.main {
        jni.srcDirs = []
        jniLibs.srcDir 'src/main/libs'
    }
}
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}/daniulive-release-0406-13-26-31.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}/daniulive-release-0406-13-26-31-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
        }

        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
/**
 * bak apk and mapping
 */
    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")
                        }
                    }
                }
            }
        }
    }
    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"
                    }

                }
            }
        }
    }
}

apply plugin: 'com.google.gms.google-services'

第三步：对application进行改造，通过代理方式生成application，目的是使application也可以通过热修复来修改。

（1）拷贝Tinker sample中的一些类到自己工程中

BuildConfig
BuildInfo
MyLogImp
SampleLoadReporter
SamplePatchListener
SamplePatchReporter
SampleTinkerReport
SampleUncaughtExceptionHandler
SampleResultService
TinkerManager
UpgradePatchRetry
Utils

（2）新建一个类继承自DefaultApplicationLike类，参考如下：

/**
 * Created by LiuQing on 2015/8/25.
 */
@DefaultLifeCycle(application = "com.daniulive.smartpublisher.application.TestApplication",
        flags = ShareConstants.TINKER_ENABLE_ALL,
        loadVerifyFlag = false)
public class TestApplicationLike extends DefaultApplicationLike {

    public TestApplicationLike (Application application, int tinkerFlags, boolean tinkerLoadVerifyFlag, long applicationStartElapsedTime, long applicationStartMillisTime, Intent tinkerResultIntent) {
        super(application, tinkerFlags, tinkerLoadVerifyFlag, applicationStartElapsedTime, applicationStartMillisTime, tinkerResultIntent);
    }

    /**
     * install multiDex before install tinker
     * so we don't need to put the tinker lib classes in the main dex
     *
     * @param base
     */
    @TargetApi(Build.VERSION_CODES.ICE_CREAM_SANDWICH)
    @Override
    public void onBaseContextAttached(Context base) {
        super.onBaseContextAttached(base);
        //you must install multiDex whatever tinker is installed!
        MultiDex.install(base);
        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());
//        TinkerInstaller.install(this);
    }

    @TargetApi(Build.VERSION_CODES.ICE_CREAM_SANDWICH)
    public void registerActivityLifecycleCallbacks(Application.ActivityLifecycleCallbacks callback) {
        getApplication().registerActivityLifecycleCallbacks(callback);
    }

    @Override
    public void onCreate() {
       //原application中要做的初始化操作
    }
}
（3）在清单文件AndroidManifest.xml配置application

<application
    android:name="com.daniulive.smartpublisher.application.TestApplication"
    tools:replace="android:label"
    android:allowBackup="true"
    android:icon="@drawable/startimes"
    android:label="@string/app_name"
    android:largeHeap="true"
    android:theme="@style/AppTheme">
以上就是Tinker的集成步骤，下面补充几个常用的方法：
1、运行后在build -- bakapk中会生成apk和txt文件  将两个文件的名称配置Module的build.gradle的如下位置，生成补丁时会按照这个配置去对比生成，
如果发布了新版的apk，记得更新此处配置
    tinkerOldApkPath = "${bakPath}/daniulive-release-0406-13-26-31.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}/daniulive-release-0406-13-26-31-R.txt"
2、生成补丁的方法
运行tinker自带命令即可生成测试或正式的补丁：
补丁生成位置如图：

我们一般使用的patch_signed_7zip.apk这个补丁
3、补丁下载到本地后 加载补丁的方法
//安装patch
TinkerInstaller.onReceiveUpgradePatch(getApplicationContext(), patchLocation);
其中patchLocation是patch下载后的完整路径例如：“mnt/sdcard/xxx.xxx”
完毕！