SDK 接入

添加gradle插件依赖

在整个项目的gradle中添加远程仓库依赖：

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

注意，在这里 SDK 使用了 fat 打包的模式，故不能再引入任何 Tinker 的相关依赖，否则会造成版本冲突。
在app的build.gradle中添加 TinkerPatch SDK 库的 denpendencies 依赖：

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

配置tinkerpatch

为了简单方便，开发人员将 TinkerPatch 相关的配置都放于 tinkerpatch.gradle 中，放在项目的app目录下，与app的build.gradle同级。

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

/**
 * TODO: 请按自己的需求修改为适应自己工程的参数
 */
def bakPath = file("${buildDir}/bakApk/")
def baseInfo = "app-3.0.1-0718-17-19-26"
def variantName = "release"

/**
 * 对于插件各参数的详细解析请参考
 * http://tinkerpatch.com/Docs/SDK
 */
tinkerpatchSupport {
    /** 可以在debug的时候关闭 tinkerPatch, isRelease() 可以判断BuildType是否为Release **/
    tinkerEnable = true
    reflectApplication = true
    /**
     * 是否开启加固模式，仅仅打包改变的类，只能在加固中使用。
     * 如果只在某个渠道使用了加固，可使用多flavors配置
     **/
    protectedApp = false

    autoBackupApkPath = "${bakPath}"

    appKey = "f938475486f91936"

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

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

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

    /**
     *  若有编译多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;
    }
}

然后在app的build.gradle中引用它，就是在末尾加一行：

` apply from: 'tinkerpatch.gradle'`

参考项目：tinkerpatch-easy-sample

初始化tinkerpatch SDK

最后在我们的代码中，只需简单的初始化 TinkerPatch 的 SDK 即可，我们无需考虑 Tinker 是如何下载/合成/应用补丁包，也无需引入各种各样 Tinker 的相关类。
由于本项目app目录下的application类继承自其他模块下的相关类，无法改造本身的application类以满足随时更新application类的要求。故采取另外一种方法。这需要在application中添加一些代码：

    @Override
    public void onCreate() {
        //之所以把tinker的初始化放在super.onCreate()之前
        //是因为在父类初始化之前初始化才能完成对application的修改
        initTinkerPatch();
        super.onCreate();
        ...
    }
/**
     * 需要确保至少对主进程跟patch进程初始化 TinkerPatch
     */
    private void initTinkerPatch() {
        // 我们可以从这里获得Tinker加载过程的信息
        if (BuildConfig.TINKER_ENABLE) {
            tinkerApplicationLike = TinkerPatchApplicationLike.getTinkerPatchApplicationLike();
            // 初始化TinkerPatch SDK
            TinkerPatch.init(
                    tinkerApplicationLike
//                new TinkerPatch.Builder(tinkerApplicationLike)
//                    .requestLoader(new OkHttp3Loader())
//                    .build()
            )
                    .reflectPatchLibrary()
                    .setPatchRollbackOnScreenOff(true)
                    .setPatchRestartOnSrceenOff(true)
                    .setFetchPatchIntervalByHours(3)
            ;
            // 获取当前的补丁版本
            Log.d(TAG, "Current patch version is " + TinkerPatch.with().getPatchVersion());

            // fetchPatchUpdateAndPollWithInterval 与 fetchPatchUpdate(false)
            // 不同的是，会通过handler的方式去轮询
            TinkerPatch.with().fetchPatchUpdate(true);
            Toast.makeText(getApplicationContext(),"热更新成功",Toast.LENGTH_SHORT).show();
        }
    }

这种方法是采取的反射的方式，效率稍低，但只需要在自己的application中加入以上配置即可。
以下是一份详细的配置参数，可做参考：

/**
     * 在这里给出TinkerPatch的所有接口解释
     * 更详细的解释请参考:http://tinkerpatch.com/Docs/api
     */
    private void useSample() {
        TinkerPatch.init(tinkerApplicationLike)
            //是否自动反射Library路径,无须手动加载补丁中的So文件
            //注意,调用在反射接口之后才能生效,你也可以使用Tinker的方式加载Library
            .reflectPatchLibrary()
            //向后台获取是否有补丁包更新,默认的访问间隔为3个小时
            //若参数为true,即每次调用都会真正的访问后台配置
            .fetchPatchUpdate(false)
            //设置访问后台补丁包更新配置的时间间隔,默认为3个小时
            .setFetchPatchIntervalByHours(3)
            //向后台获得动态配置,默认的访问间隔为3个小时
            //若参数为true,即每次调用都会真正的访问后台配置
            .fetchDynamicConfig(new ConfigRequestCallback() {
                @Override
                public void onSuccess(HashMap hashMap) {

                }

                @Override
                public void onFail(Exception e) {

                }
            }, false)
            //设置访问后台动态配置的时间间隔,默认为3个小时
            .setFetchDynamicConfigIntervalByHours(3)
            //设置当前渠道号,对于某些渠道我们可能会想屏蔽补丁功能
            //设置渠道后,我们就可以使用后台的条件控制渠道更新
            .setAppChannel("default")
            //屏蔽部分渠道的补丁功能
            .addIgnoreAppChannel("googleplay")
            //设置tinkerpatch平台的条件下发参数
            .setPatchCondition("test", "1")
            //设置补丁合成成功后,锁屏重启程序
            //默认是等应用自然重启
            .setPatchRestartOnSrceenOff(true)
            //我们可以通过ResultCallBack设置对合成后的回调
            //例如弹框什么
            //注意，setPatchResultCallback 的回调是运行在 intentService 的线程中
            .setPatchResultCallback(new ResultCallBack() {
                @Override
                public void onPatchResult(PatchResult patchResult) {
                    Log.i(TAG, "onPatchResult callback here");
                }
            })
            //设置收到后台回退要求时,锁屏清除补丁
            //默认是等主进程重启时自动清除
            .setPatchRollbackOnScreenOff(true)
            //我们可以通过RollbackCallBack设置对回退时的回调
            .setPatchRollBackCallback(new RollbackCallBack() {
                @Override
                public void onPatchRollback() {
                    Log.i(TAG, "onPatchRollback callback here");
                }
            });
    }

当然也可参考官方demo中的SampleApplication 类。

使用步骤

生成基准包

点选窗口右侧的gradle中选择assembleDebug。

这里写图片描述

然后会在项目的apk/build/bakapk/文件夹下生成基准apk文件。

这里写图片描述

然后在终端定位到该文件夹下执行以下命令行将apk安装到手机上：

Adb install –r apkname.apk

生成补丁包

首先，需要修改tinkerpatch中的baseinfo,将其修改为刚刚生成的文件名。
随后，修改下项目文件，比如在mainActivity的oncreate中启动一个activity，然后修改下这个页面的布局。
然后，点击窗口右侧的gradle中选择tinker目录下的tinkerPatchDebug：

这里写图片描述

会在app的build/outpus/apk目录下生成数个安装包，这些都是生成的补丁包，选择其中较小的一个。

这里写图片描述

上传至tinkerplatform

Tinker 需要使用者有一个后台可以下发和管理补丁包，并且需要处理传输安全等部署工作，TinkerPatch 平台帮你做了这些工作，提供了补丁后台托管，版本管理，保证传输安全等功能，这样只需要引入一个 SDK 即可立即使用 Tinker。
Tinker platform的具体使用步骤参考官网。

这里写图片描述

我们需要把build.gradle中appkey与平台上的保持一致。
值得注意的一点是，这个平台提供了发布测试版本修复包的功能，只需要在官网上下载一个tools apk然后再调试应用前点开即可。下载链接
然后上传刚刚选择的apk。
新建的补丁版本号必须与上一步骤中的appversion中保持一致。否则会在logcat中报无法访问的错误。

这里写图片描述

注意事项

注意：以下代码都在application中的tinker配置中设置。

向后台请求补丁升级配置

向后台请求在线参数配置，默认的访问间隔为3个小时, 若参数设置为 true, 即每次调用都会真正的访问后台是否有更新。

`TinkerPatch.with().fetchDynamicConfig(false)；`

也可以通过以下方法，设置访问的时间间隔，单位为小时。若为－1，即禁止以后都不再请求后台在线配置更新。

`TinkerPatch.with().setFetchDynamicConfigIntervalByHours(1)；`

补丁何时生效

TinkerPatch SDK 默认在补丁合成成功后，等应用的主进程重新启动时生效。若希望用户可以尽快的生效，可以指定用户锁屏时自动重启应用：

// 默认为false
TinkerPatch.with().setPatchRestartOnSrceenOff(true);
若也不想在锁屏的时候重启，例如弹出对话框咨询。可以采取自定义回调接口：
TinkerPatch.with().setPatchResultCallback(new ResultCallBack() {
        @Override
        public void onPatchResult(PatchResult patchResult) {
            Log.i(TAG, "onPatchResult callback here");
        }
});

库的加载

默认 Tinker 中需要手动加载补丁中的 Library 更改，具体参考Tinker 文档Library 库的加载。
TinkerPatch 平台实现了一键反射 Library 路径，调用以下接口后即可自动优先加载补丁中的 Library 文件。

TinkerPatch.with().reflectPatchLibrary();

其他

其他SDK API解释请参考官方文档。

关于版本号的一些问题

因为发布补丁需要填写版本号

这里写图片描述

在Android studio 的 tinkerpatch.gradle文件中也需要填写版本号。

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

在此处谈一谈联系与区别：
首先，安装的基准apk一定是有一个版本号的，比如3.0.0，而修改部分文件之后的新的apk包也会有一个版本号，比如3.0.1。tinker会根据这两个版本的差异生成一个补丁，然后把这个补丁上传到平台上去。
重点来了，这个基准apk安装后产生的应用就一定会访问后台的版本为3.0.0的补丁。然后补丁安装之后呢，客户端再去访问补丁会访问3.0.1吗？不会，测试表明应用访问的仍然是3.0.0的补丁。
这样的话想要继续打补丁怎么办，办法是有的，比如又有一个新的版本3.0.2，需要生成的就是3.0.2与3.0.0的差异补丁包而不是3.0.2与3.0.1的差异补丁包，然后继续放到服务端的3.0.0的补丁里面去。

总结

经测试，三星galaxy note2（android 4.3），三星galaxy note3（android 5.0），三星galaxy note4（android 6.0）都可以正常运行。

TinkerPatch 傻瓜式接入

SDK 接入

添加gradle插件依赖

配置tinkerpatch

初始化tinkerpatch SDK

使用步骤

生成基准包

生成补丁包

上传至tinkerplatform

注意事项

向后台请求补丁升级配置

补丁何时生效

库的加载

其他

关于版本号的一些问题

总结

你可能感兴趣的:(TinkerPatch 傻瓜式接入)