Android Tinker的接入与测试

一、注册

http://www.tinkerpatch.com/Docs/start

二、TinkerPatch SDK的接入

1、 添加 gradle 依赖

在项目根目录 build.gradle中添加

        // TinkerPatch 插件
        classpath "com.tinkerpatch.sdk:tinkerpatch-gradle-plugin:1.2.14"

2、集成 TinkerPatch SDK

在 app 的 build.gradle 中添加

    // 若使用annotation需要单独引用,对于tinker的其他库都无需再引用
    provided("com.tinkerpatch.tinker:tinker-android-anno:1.9.2")
    compile("com.tinkerpatch.sdk:tinkerpatch-android-sdk:1.2.2")

三、新建tinkerpatch.gradle文件

可全部复制，后面修改。

apply plugin: 'tinkerpatch-support'
import java.util.regex.Matcher
import java.util.regex.Pattern

/**
 * TODO: 请按自己的需求修改为适应自己工程的参数
 */
def bakPath = file("${buildDir}/bakApk/")
def baseInfo = "app-1.0.4-1111-14-08-53"
def variantName = "release"

/**
 * 对于插件各参数的详细解析请参考
 * http://tinkerpatch.com/Docs/SDK
 */
tinkerpatchSupport {
    /** 可以在debug的时候关闭 tinkerPatch, isRelease() 可以判断BuildType是否为Release **/
    tinkerEnable = true
    // 是否反射实现一键接入
    reflectApplication = true
    /**
     * 是否开启加固模式，只能在APK将要进行加固时使用，否则会patch失败。
     * 如果只在某个渠道使用了加固，可使用多flavors配置
     **/
    protectedApp = false
    /**
     * 实验功能
     * 补丁是否支持新增 Activity (新增Activity的exported属性必须为false)
     **/
    supportComponent = true

    autoBackupApkPath = "${bakPath}"

    // TinkerPatch 管理后台的appId
    appKey = "010f475e92fa05bf"

    /** 注意: 若发布新的全量包, appVersion一定要更新 **/
    appVersion = "1.0.4"

    def pathPrefix = "${bakPath}/${baseInfo}/${variantName}/"
    def name = "${project.name}-${variantName}"

    baseApkFile = "${pathPrefix}/${name}.apk"
    baseProguardMappingFile = "${pathPrefix}/${name}-mapping.txt"
    baseResourceRFile = "${pathPrefix}/${name}-R.txt"

    /**
     * （可选）重命名备份文件的格式化字符串，默认为'${appName}-${variantName}'
     *
     * Available vars:
     * 1. projectName
     * 2. appName
     * 3. packageName
     * 4. buildType
     * 5. versionName
     * 6. versionCode
     * 7. buildTime
     * 8. fileSHA1
     * 9. flavorName
     * 10. variantName
     *
     * default value: '${appName}-${variantName}'
     * Note: plz use single-quotation wrapping this format string
     */
    // 格式化命名备份文件 这里请使用单引号
    backupFileNameFormat = '${appName}-${variantName}'

    /**
     *  若有编译多flavors需求, 可以参照： https://github.com/TinkerPatch/tinkerpatch-flavors-sample
     *  注意: 除非你不同的flavor代码是不一样的,不然建议采用zip comment或者文件方式生成渠道信息（相关工具：walle 或者 packer-ng）
     **/
}

/**
 * 用于用户在代码中判断tinkerPatch是否被使能
 */
android {
    defaultConfig {
        buildConfigField "boolean", "TINKER_ENABLE", "${tinkerpatchSupport.tinkerEnable}"
    }
}

/**
 * 一般来说,我们无需对下面的参数做任何的修改
 * 对于各参数的详细介绍请参考:
 * https://github.com/Tencent/tinker/wiki/Tinker-%E6%8E%A5%E5%85%A5%E6%8C%87%E5%8D%97
 */
tinkerPatch {
    ignoreWarning = false
    useSign = true
    dex {
        dexMode = "jar"
        pattern = ["classes*.dex"]
        loader = []
    }

    lib {
        pattern = ["lib/*/*.so"]
    }

    res {
        pattern = ["res/*", "r/*", "assets/*", "resources.arsc", "AndroidManifest.xml"]
        ignoreChange = []
        largeModSize = 100
    }

    packageConfig {
    }
    sevenZip {
        zipArtifact = "com.tencent.mm:SevenZip:1.1.10"
        // path = "/usr/local/bin/7za"
    }
    buildConfig {
        keepDexApply = false
    }
}

import java.util.regex.Matcher
import java.util.regex.Pattern

/**
 * 如果只想在Release中打开tinker，可以把tinkerEnable赋值为这个函数的return
 * @return 是否为release
 */
def isRelease() {
    Gradle gradle = getGradle()
    String  tskReqStr = gradle.getStartParameter().getTaskRequests().toString()

    Pattern pattern;
    if (tskReqStr.contains("assemble")) {
        println tskReqStr
        pattern = Pattern.compile("assemble(\\w*)(Release|Debug)")
    } else {
        pattern = Pattern.compile("generate(\\w*)(Release|Debug)")
    }
    Matcher matcher = pattern.matcher(tskReqStr)

    if (matcher.find()) {
        String task = matcher.group(0).toLowerCase()
        println("[BuildType] Current task: " + task)
        return task.contains("release")
    } else {
        println "[BuildType] NO MATCH FOUND"
        return true;
    }
}

四、配置tinkerpatch.gradle参数

1、修改成自己的bakPath和baseInfo

def bakPath = file("${buildDir}/bakApk/")
def baseInfo = "app-1.0.4-1111-14-08-53"
def variantName = "release"

2、 修改成自己注册的appkey

    // TinkerPatch 管理后台的appId
    appKey = "010f475e92fa05bf"

3、 版本要和平台上的版本一致

    /** 注意: 若发布新的全量包, appVersion一定要更新 **/
    appVersion = "1.0.4"

4、将tinkerpatch.gradle文件添加到 app 的 build.gradle 中

apply from: 'tinkerpatch.gradle'

 五、初始化 TinkerPatch SDK

若reflectApplication = true 的情况：若我们使用 reflectApplication 模式，我们无需为接入 Tinker 而改造我们的 Application 类，相当于自己写一个Application。

class MyApplication:Application {
    var tinkerApplicationLike:ApplicationLike? = null

    constructor()

    override fun attachBaseContext(base: Context?) {
        super.attachBaseContext(base)

    }


    override fun onCreate() {
        super.onCreate()
        initTinkerPatch()
    }


    /**
     * 我们需要确保至少对主进程跟patch进程初始化 TinkerPatch
     */
    private fun initTinkerPatch() {
        if(BuildConfig.TINKER_ENABLE){
            // 我们可以从这里获得Tinker加载过程的信息
            tinkerApplicationLike = TinkerPatchApplicationLike.getTinkerPatchApplicationLike()
            //初始化TinkerPatch SDK
            TinkerPatch.init(tinkerApplicationLike)
                .reflectPatchLibrary()
                .setPatchRestartOnSrceenOff(true)
                .setPatchRollbackOnScreenOff(true)
                    //每隔3个小时(通过setFetchPatchIntervalByHours设置)去访问后台时候有更新,通过handler实现轮训的效果
                .setFetchPatchIntervalByHours(3)

            //获取当前的补丁版本
            Log.e("eee","Current patch version is"+TinkerPatch.with().patchVersion)

            TinkerPatch.with().fetchPatchUpdateAndPollWithInterval()
        }
    }

}

六、在AndroidManifest.xml中完成配置

    <uses-permission android:name="android.permission.INTERNET"/>
    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
    <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>

    <application
        android:name=".MyApplication"

七、安装

生成apk，安装

八、生成并发布 patch 包

修改xml中的代码，把字体变成黑色，双击以下，生成 patch 包。

成功的结果：

可能会报错：

解决：

在 app 的 build.gradle 的android中添加

    signingConfigs {
        config {
                storeFile file('D://tinker_apk/tinker.jks')
                storePassword '123456'
                keyAlias 'key0'
                keyPassword '654321'
        }
    }

修改成自己的信息。

buildTypes中添加signingConfig signingConfigs.config

    buildTypes {
        release {
            minifyEnabled true
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
            signingConfig signingConfigs.config
        }
    }

注意：signingConfigs要写在buildTypes 前面。

 

成功后项目会出现：

将patch_signed_7zip.apk发布到 TinkerPatch 平台上

杀掉刚才安装的应用，重新启动，字体变成黑色了！

TinkerPatch 平台上也发生了变化。

完成！