Android集成微信Tinker热修复及使用

Tinker集成

准备工作

1.打开Tinker官网http://www.tinkerpatch.com创建自己的Tinker账号。
2.在Tinker控制台上创建自己的项目，获取AppKey。

第一步 添加 gradle 插件依赖

打开项目的build.gradle文件

在下图位置中添加：

classpath "com.tinkerpatch.sdk:tinkerpatch-gradle-plugin:1.2.2"

第二步 集成 TinkerPatch SDK

打开app的gradle文件build.gradle，如下图所示：

在下图位置中添加：

compile "com.tinkerpatch.sdk:tinkerpatch-android-sdk:1.2.2"

第三步 配置 tinkerpatch.gradle文件

在项目的app文件夹下创建tinkerpatch.gradle文件，不会创建的话就直接复制build.grale（反正我也不会）

添加如下配置：

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

apply plugin: 'tinkerpatch-support'

def bakPath = file("${buildDir}/bakApk/")
def baseInfo = "app-1.0.0-0307-15-03-35"//旧包信息
def variantName = "debug"

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

    appKey = "3d5f8f06d46c8f5f"/**！！！！！注意替换成自己项目的appKey！！！！！**/

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

    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需求,可在flavors中覆盖以下参数
     *  你也可以直接通过tinkerPatchAllFlavorDebug/tinkerPatchAllFlavorRelease, 一次编译所有的flavor补丁包
     *  注意的是:除非你不同的flavor代码是不一样的,不然建议采用zip comment或者文件方式生成渠道信息
     **/
    productFlavors {
        flavor {
            flavorName = "protect"
            appVersion = "${tinkerpatchSupport.appVersion}_${flavorName}"

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

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

            /** 开启加固开关，上传此flavor的apk到加固网站进行加固 **/
            protectedApp = false
        }

        flavor {
            flavorName = "flavor1"
            appVersion = "${tinkerpatchSupport.appVersion}_${flavorName}"

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

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

/**
 * 用于用户在代码中判断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
    }
}

/**
 * 如果只想在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 SDK

在自己项目的application中添加SDK的初始化代码：

public class App extends Application {
    private ApplicationLike tinkerApplicationLike;

    @Override
    public void onCreate() {
        super.onCreate();

        initTinker();
    }

    //初始化Tinker热修复
    private void initTinker() {
        if (BuildConfig.TINKER_ENABLE) {
            tinkerApplicationLike = TinkerPatchApplicationLike.getTinkerPatchApplicationLike();

            // 初始化TinkerPatch SDK
            TinkerPatch.init(tinkerApplicationLike)
                    .reflectPatchLibrary()
                    .setPatchRollbackOnScreenOff(true)
                    .setPatchRestartOnSrceenOff(true)
                    .setFetchPatchIntervalByHours(3);

            // 每隔3个小时(通过setFetchPatchIntervalByHours设置)去访问后台时候有更新,通过handler实现轮训的效果
            TinkerPatch.with().fetchPatchUpdateAndPollWithInterval();
        }
    }
}

记得要在AndroidManifest文件中添加如下权限：

<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"/>

第五步 写测试代码

public class MainActivity extends AppCompatActivity {

    private Context context;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        context = this;
        initView();
    }

    private void initView() {
        View.OnClickListener listener = new View.OnClickListener() {
            @Override
            public void onClick(View view) {
                switch (view.getId()) {
                    case R.id.btn_check_update:
                        //强制检查补丁更新
                        TinkerPatch.with().fetchPatchUpdate(true);
                        break;
                    case R.id.btn_test:
                        //测试
                        Toast.makeText(context, "我是有bug的App", Toast.LENGTH_LONG).show();
                        break;
                    default:
                        break;
                }
            }
        };

        findViewById(R.id.btn_check_update).setOnClickListener(listener);
        findViewById(R.id.btn_test).setOnClickListener(listener);
    }
}

第六步 编译一个有bug的测试apk

编译：

打包好后生成的apk会在这个目录下：

把这个apk先安装到手机上，打开app，点击“测试”按钮，可以看到如下：

第六步 生成补丁

首先修改代码，修改Toast的显示文字：

在tinkerpatch.gradle文件中修改旧apk信息：

点击Studio 右侧的Gradle 工具栏，展开之后找到自己的Module 找到tinker, 双击其中的 tinkerPatchDebug,开始编译补丁包

编译补丁包中……

补丁包编译完后会在这个文件夹下，打红框的那个文件就是补丁包：

第七步 下发补丁

打开自己的Tinker控制台：

添加App版本：

然后打开：

选择自己的补丁，然后发布：

成功发布补丁后，打开测试app，点击“检查补丁更新”按钮，获取最新补丁，然后刷新Tinker控制台，可以看到如下：

这说明app已经获取到最新的补丁并且合成补丁成功了，然后关闭app，再次打开，点击“测试”按钮，可以看到：

OK！成功修复！