RocooFix 热修复框架

3,617 阅读2分钟

Another hotfix framework

之前的HotFix项目太过简单,也有很多同学用Nuwa遇到很多问题,作者也不再修复,所以重新构建了一套工具。

大部分功能抄自Nuwa,解决了其一些bug。 我重新写了一个RocooFix框架,解决了Nuwa因为Gradle Android 1.40 里Transform API无法打包的情况,现在兼容Gradle 1.3-Gradle 2.1.0版本

Features

  • 制作补丁更加方便
  • 支持com.android.tools.build:gradle:1.3.0->com.android.tools.build:gradle:2.1.0 (解决了Nuwa 这个issue)
  • 支持混淆和Mulitdex
  • 无需关注hash.txtmapping.txt文件的生成和保存

Use

public class RocooApplication extends Application {
    @Override
    protected void attachBaseContext(Context base) {
        super.attachBaseContext(base);
        //打补丁
        RocooFix.init(this);
    }
}

Configuration

在你项目的build.gradle文件里添加如下配置

rocoo_fix {
    includePackage = ['com/dodola/rocoofix']//限制需要制作补丁的package
    excludeClass = ['BaseApplication.class']//将不需要加到patch里的类写在这里

    preVersionPath = '1'//注意:此项属性只在需要制作补丁的时候才需开启!!如果不需要制作补丁则需要去掉此项

    enable = true//注意:关掉此项会无法生成Hash.txt文件
}

这里主要介绍一下preVersionPath这个属性的作用。

rocoo_fix将制作补丁的步骤透明化,用户无需手动备份hash.txt文件,插件会自动根据当前的versionCode生成hash.txtmapping.txt文件到指定目录,比如:

上一个版本发布的时候版本号是1,那么生成的文件会放在app源码目录/rocooFix/version1/[debug]|[release]的目录下,如果需要制作补丁那么在配置里指定preVersionPath 属性,它的值是上一个版本的版本号,这里的值是1

然后将build.gradleversionCode的号码修改,这里修改成2,只要和之前的版本不同就可以,没有具体值的要求

Proguard

-keep class com.dodola.rocoofix.** {*;}

Build Patch

下面演示一下使用项目demo生成补丁的制作过程

package com.dodola.rocoosample;

public class HelloHack {

    public String showHello() {
        return "hello world";
    }
}

此时build.gradle里的VersionCode1

enter description here

  1. 运行一次应用,这时会在app的目录下生成如下文件:

enter description here

这里可以看做是我们已经发布版本的hash.txt

  1. 假设我们需要修复步骤1 里的showHello方法,修改如下:
package com.dodola.rocoosample;

public class HelloHack {

    public String showHello() {
        return "hello Hack";//此处修复,补丁加载后该方法返回hello hack
    }
}
  1. 修改build.gradle 文件里rocoo_fix项,让其执行patch 的task,配置如下
rocoo_fix {

    preVersionPath = '1'//注意:这里指定的是需要打补丁的VersionCode
    enable = true
}
  1. 修改当前项目的versionCode2,说明这个是一个升级fix版本。

enter description here

  1. 正常发布应用,此时会在下图所示的路径中生成补丁文件: enter description here

  2. 我们可以反编译一下来确认补丁是否正常 enter description here