Bugly 热更新SDK使用指南

一、接入指南

1. 工程目录下添加"build.gradle"文件中添加：

buildscript {
    
    repositories {
        jcenter()
    }
    dependencies {
        classpath "com.tencent.bugly:tinker-support:1.1.1"
    }
}

2. 在app module模块"build.gradle"中添加

android{
     defaultConfig{
        multiDexEnable true 
    }
}
dependencies {
    //bugly hotfix start
     compile 'com.android.support:multidex:1.0.1' 
     compile 'com.tencent.bugly:crashreport_upgrade:1.3.4' 
     compile 'com.tencent.bugly:nativecrashreport:latest.release'
     //bugly hotfix end
 }

apply from: 'tinker-support.gradle'

3. tinker-support.gradle内容如下所示（示例配置）：

apply plugin: 'com.tencent.bugly.tinker-support'

def bakPath = file("${buildDir}/bakApk/")

/**
 * 此处填写每次构建生成的基准包目录 （目录：app module/build/bakApk/...编译有错误的apk 后产生的）
 */
def baseApkDir = "app-0907-21-19-33"

/**
 * 对于插件各参数的详细解析请参考
 */
tinkerSupport {

    // 开启tinker-support插件，默认值true
    enable = true

    // 指定归档目录，默认值当前module的子目录tinker
    autoBackupApkDir = "${bakPath}"

    // 是否启用覆盖tinkerPatch配置功能，默认值false
    // 开启后tinkerPatch配置不生效，即无需添加tinkerPatch
    overrideTinkerPatchConfiguration = true

    // 编译补丁包时，必需指定基线版本的apk，默认值为空
    // 如果为空，则表示不是进行补丁包的编译
    // @{link tinkerPatch.oldApk }
    baseApk = "${bakPath}/${baseApkDir}/app-debug.apk"

    // 对应tinker插件applyMapping
    baseApkProguardMapping = "${bakPath}/${baseApkDir}/app-debug-mapping.txt"

    // 对应tinker插件applyResourceMapping
    baseApkResourceMapping = "${bakPath}/${baseApkDir}/app-debug-R.txt"

    // 构建基准包和补丁包都要指定不同的tinkerId，并且必须保证唯一性
    tinkerId = "base-1.0.1"

    // 构建多渠道补丁时使用
    // buildAllFlavorsDir = "${bakPath}/${baseApkDir}"

    // 是否启用加固模式，默认为false.(tinker-spport 1.0.7起支持）
    // isProtectedApp = true

    // 是否开启反射Application模式
    enableProxyApplication = true

    // 是否支持新增非export的Activity（注意：设置为true才能修改AndroidManifest文件）
    supportHotplugComponent = true

}

/**
 * 一般来说,我们无需对下面的参数做任何的修改
 * 对于各参数的详细介绍请参考:
 * https://github.com/Tencent/tinker/wiki/Tinker-%E6%8E%A5%E5%85%A5%E6%8C%87%E5%8D%97
 */
tinkerPatch {
    //oldApk ="${bakPath}/${appName}/app-release.apk"
    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
        //tinkerId = "1.0.1-base"
        //applyMapping = "${bakPath}/${appName}/app-release-mapping.txt" //  可选，设置mapping文件，建议保持旧apk的proguard混淆方式
        //applyResourceMapping = "${bakPath}/${appName}/app-release-R.txt" // 可选，设置R.txt文件，通过旧apk文件保持ResId的分配
    }
}

4. 初始化SDK

enableProxyApplication = true的情况

public class MyApplication extends Application {

    @Override
    public void onCreate() {
        super.onCreate();
        // 这里实现SDK初始化，appId替换成你的在Bugly平台申请的appId
        // 调试时，将第三个参数改为true 推荐根据BuildConfig.debug来控制

        Bugly.init(this, "ba4bb1784f", false);
    }
    @Override
    protected void attachBaseContext(Context base) {
        super.attachBaseContext(base);
        // you must install multiDex whatever tinker is installed!
        MultiDex.install(base);
        // 安装tinker
        Beta.installTinker();
    }


}

这个基本不用改动，主要是为了降低接入成本AndroidMinifest申明为MyApplication

enableProxyApplication = false 的情况

自定义Application

public class SampleApplication extends TinkerApplication {
    public SampleApplication() {
        super(ShareConstants.TINKER_ENABLE_ALL, "xxx.xxx.SampleApplicationLike",
                "com.tencent.tinker.loader.TinkerLoader", false);
    }
}

注意：这个类集成TinkerApplication类，这里面不做任何操作，所有Application的代码都会放到ApplicationLike继承类当中
参数解析
参数1：tinkerFlags 表示Tinker支持的类型 dex only、library only or all suuport，default: TINKER_ENABLE_ALL
参数2：delegateClassName Application代理类 这里填写你自定义的ApplicationLike
参数3：loaderClassName Tinker的加载器，使用默认即可
参数4：tinkerLoadVerifyFlag 加载dex或者lib是否验证md5，默认为false

自定义ApplicationLike

public class SampleApplicationLike extends DefaultApplicationLike {

    public static final String TAG = "Tinker.SampleApplicationLike";

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


    @Override
    public void onCreate() {
        super.onCreate();
        // 这里实现SDK初始化，appId替换成你的在Bugly平台申请的appId

        // 调试时，将第三个参数改为true 推荐根据BuildConfig.debug来控制

        Bugly.init(getApplication(), "900029763", false);
    }


    @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);

        // 安装tinker
        // TinkerManager.installTinker(this); 替换成下面Bugly提供的方法 注意：这里的this不能忘记
        Beta.installTinker(this);
    }

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

}

注：AndroidMinifest文件中声明具体的"SampleApplication“，Tinker需要你开启MultiDex,你需要在dependencies中进行配置compile "com.android.support:multidex:1.0.1"才可以使用MultiDex.install方法； SampleApplicationLike这个类是Application的代理类，以前所有在Application的实现必须要全部拷贝到这里，在onCreate方法调用SDK的初始化方法，在onBaseContextAttached中调用Beta.installTinker(this);

5. AndroidManifest.xml配置

在AndroidMainfest.xml中进行以下配置：

1. 权限配置

2. Activity配置

3. 配置FileProvider

注意：如果您想兼容Android N或者以上的设备，必须要在AndroidManifest.xml文件中配置FileProvider来访问共享路径的文件。

如果你使用的第三方库也配置了同样的FileProvider, 可以通过继承FileProvider类来解决合并冲突的问题，示例如下：

这里要注意一下，FileProvider类是在support-v4包中的，检查你的工程是否引入该类库。

在res目录新建xml文件夹，创建provider_paths.xml文件如下：

这里配置的两个外部存储路径是升级SDK下载的文件可能存在的路径，一定要按照上面格式配置，不然可能会出现错误。

注：1.3.1及以上版本，可以不用进行以上配置，aar已经在AndroidManifest配置了，并且包含了对应的资源文件。

6.proguard混淆配置

为了避免混淆SDK，在Proguard混淆文件中增加以下配置：

-dontwarn com.tencent.bugly.**
-keep public class com.tencent.bugly.**{*;}
# tinker混淆规则
-dontwarn com.tencent.tinker.**
-keep class com.tencent.tinker.** { *; }

如果你使用了support-v4包，你还需要配置以下混淆规则：


-keep class android.support.**{*;}

至此，客户端关于Bugly 热更新 SDK的配置就完成了。

二、使用指南

1. 配置基准包的tinkerId

​

tinkerId最好是一个唯一标识，例如git版本号、versionName等等。 如果你要测试热更新，你需要对基线版本进行联网上报。

这里强调一下，基线版本配置一个唯一的tinkerId，而这个基线版本能够应用补丁的前提是集成过热更新SDK，并启动上报过联网，这样我们后台会将这个tinkerId对应到一个目标版本，例如tinkerId = "bugly_1.0.0" 对应了一个目标版本是1.0.0，基于这个版本打的补丁包就能匹配到目标版本。

执行assembleRelease编译生成基准包：

​

这个会在build/outputs/bakApk路径下生成每次编译的基准包、混淆配置文件、资源Id文件，如下图所示：

​

实际应用中，请注意保存线上发布版本的基准apk包、mapping文件、R.txt文件，如果线上版本有bug，就可以借助我们tinker-support插件进行补丁包的生成。

启动apk，上报联网数据

我们每次冷启动都会请求补丁策略，会上报当前版本号和tinkerId，这样我们后台就能将这个唯一的tinkerId对应到一个版本，大家测试的时候可以打开logcat查看我们的日志，如下图所示：

​

如果看不到log，您需要将bugly初始化的第三个参数设置为true才能看到。

2、对基线版本的bug修复

未修复前

​

这个类有一个会造成空指针的方法。

修复后

​

对产生bug的类进行修复，作为补丁下次覆盖基线版本的类。

3、根据基线版本生成补丁包

修改待修复apk路径、mapping文件路径、resId文件路径

​

执行构建补丁包的task

​

如果你要生成不同编译环境的补丁包，只需要执行TinkerSupport插件生成的task，比如buildTinkerPatchRelease就能生成release编译环境的补丁包。 注：TinkerSupport插件版本低于1.0.4的，需要使用tinkerPatchRelease来生成补丁包 。

生成的补丁包在build/outputs/patch目录下：

​

大家这里可能会有一个疑问，补丁版本是怎么匹配到目标版本的，可以双击patch包，我们提供的插件会在tinker生成的patch包基础上插入一个MF文件：

​

​

4、上传补丁包到平台

上传补丁包到平台并下发编辑规则

​

​

​

点击发布新补丁，上传前面生成的patch包，我们平台会自动为你匹配到目标版本，你可以选择下发范围（开发设备、全量设备、自定义），填写完备注之后，点击立即下发让补丁生效，这样你就可以在客户端当中收到我们的策略，SDK会自动帮你把补丁包下到本地。

下载成功之后，我们会立即去合成补丁，可以看到patch合成的日志：

​

5.  然后重启app查看修复效果了。

三、issue

1.在实际使用中发现当配置shareUserId="android.system.uid"时，下发补丁成功后重启点击APP launcher图标，6.0以下会发生crash.主要原因是在tinker会在冷启动当新旧补丁版本不一致时，tinker会去杀死和当前应用Uid相同但PID不同的进程，由于

   配置了shareUserId="android.system.uid"，正好触发这个条件，就把系统进程给kill了。而6.0以上虽然tinker也依然尝试去杀死系统进程，但是收到如下日志

   type=1400 audit(0.0:65): avc: denied { sigkill } for scontext=u:r:system_app:s0 tcontext=u:r:system_server:s0       tclass=process permissive=0 ,系统进程并没有被杀死

   而6.0以下日志为：Shutting  down VM .

 

  导致杀死进程源码：

 

public class DefaultLoadReporter implements LoadReporter {
    private static final String TAG = "Tinker.DefaultLoadReporter";
 protected final Context context;

 public DefaultLoadReporter(Context context) {
        this.context = context;
 }

    public void onLoadPatchListenerReceiveFail(File patchFile, int errorCode) {
        TinkerLog.i("Tinker.DefaultLoadReporter", "patch loadReporter onLoadPatchListenerReceiveFail: patch receive fail: %s, code: %d", new Object[]{patchFile.getAbsolutePath(), errorCode});
 }

    public void onLoadPatchVersionChanged(String oldVersion, String newVersion, File patchDirectoryFile, String currentPatchName) {
        TinkerLog.i("Tinker.DefaultLoadReporter", "patch loadReporter onLoadPatchVersionChanged: patch version change from " + oldVersion + " to " + newVersion, new Object[0]);
 if (oldVersion != null && newVersion != null) {
            if (!oldVersion.equals(newVersion)) {
                if (Tinker.with(this.context).isMainProcess()) {
                    TinkerLog.i("Tinker.DefaultLoadReporter", "onLoadPatchVersionChanged, try kill all other process", new Object[0]);
 ShareTinkerInternals.killAllOtherProcess(this.context);
 UpgradePatchRetry.getInstance(this.context).onPatchResetMaxCheck(newVersion);
 File[] var5 = patchDirectoryFile.listFiles();
 if (var5 != null) {
                        File[] var6 = var5;
 int var7 = var5.length;

 for(int var8 = 0; var8 < var7; ++var8) {
                            File var9 = var6[var8];
 String var10 = var9.getName();
 if (var9.isDirectory() && !var10.equals(currentPatchName)) {
                                SharePatchFileUtil.deleteDir(var9);
 }
                        }
                    }

                }
            }
        }
    }

 

public static void killAllOtherProcess(Context context) {
    ActivityManager var1 = (ActivityManager)context.getSystemService("activity");
 if (var1 != null) {
        List var2 = var1.getRunningAppProcesses();
 if (var2 != null) {
            Iterator var3 = var2.iterator();

 while(var3.hasNext()) {
                RunningAppProcessInfo var4 = (RunningAppProcessInfo)var3.next();
 if (var4.uid == Process.myUid() && var4.pid != Process.myPid()) {
                    Process.killProcess(var4.pid);
 }
            }

        }
    }
}

  本来是想继承 DefaultLoadReporter 重写LoadReport ，但是后来通过查看源码发现，真正起作用的是这个

public class TinkerLoadReporter extends DefaultLoadReporter {

public void onLoadPatchVersionChanged(String oldVersion, String newVersion, File patchDirectoryFile, String currentPatchName) {
    super.onLoadPatchVersionChanged(oldVersion, newVersion, patchDirectoryFile, currentPatchName);
 if (this.userLoadReporter != null) {
        this.userLoadReporter.onLoadPatchVersionChanged(oldVersion, newVersion, patchDirectoryFile, currentPatchName);
 }

}

    

}

即使重写，只不过是多加了一个回调，依然会调用父类DefaultLoadReporter的方法。

但是如果经过下面处理，发现onLoadPatchVersionChanged(String oldVersion, String newVersion, File patchDirectoryFile, String currentPatchName)里的oldVersion和newVersion都会是最新的且相等，此时就不会kill系统进程。

 

 经过实际测试，需要如下处理：

 方案一（推荐）：arr 需要自己下载

implementation 'com.android.support:multidex:1.0.1'
implementation(name:'crashreport_upgrade-1.3.4', ext:'aar')
implementation(name:'nativecrashreport-3.3.1', ext:'aar')

 1.将上述两个组件添加到工程libs目录下面， build.gradle加入以下配置：

 repositories{
    flatDir{
        dirs 'libs'
 }
}

2.将引用的依赖库改成：

dependencies {
    //bugly hotfix start
 compile 'com.android.support:multidex:1.0.1'
 compile(name:'crashreport_upgrade-1.3.4', ext:'aar')
 compile(name:'nativecrashreport-3.3.1', ext:'aar')
   //bugly hotfix end
}

其他什么都不用更改。

原理：

crashreport_upgrade-1.3.4.aar已经对字节码进行修改重新打包，修改代码为：

public static void killAllOtherProcess(Context var0) {
    ActivityManager var1 = (ActivityManager)var0.getSystemService("activity");
 if (var1 != null) {
        List var2 = var1.getRunningAppProcesses();
 if (var2 != null) {
            Iterator var3 = var2.iterator();

 while(var3.hasNext()) {
                RunningAppProcessInfo var4 = (RunningAppProcessInfo)var3.next();
 if (var4.uid == Process.myUid() && var4.pid != Process.myPid() && var4.processName.startsWith(var0.getPackageName())) {
                    Process.killProcess(var4.pid);
 }
            }
        }
    }

}

因此只会杀和我们包名相关的进程。

 方案二：

 1. enableProxyApplication =true

  2.   需要按照enableProxyApplication = false的方式去配置，此时经测试tinker会返回相同的补丁版本从而绕过杀死系统进程。

2. 关于补丁重签名问题

鉴于我厂有重签名的流程，而Tinker的热修复方案是打包侵入式的，因此打包完APK的基线版本并不是实际发布版本，需要重签名，按照上述流程合成的补丁包的签名也不是真正的发布版本的签名，因此需要以下流程处理：

  1. 对于产生的基线版本APK重签名发布。

  2.按照上述流程产生补丁包文件，删除里面的META-INF目录，然后去重签名，签名完成后上传bugly 云端。 

四、注意事项

1.一般的类、方法、字段，甚至是so库，图片、布局等资源都是可以尽快更新修复的。但不支持新增四大组件，但可以更改，换句话说也就是不能更改AndroidManifest.xml清单文件，tinker1.9.0版本开始支持export=false的Activity，其他依然不支持。
2.由于Google Play的开发者条款限制，不建议在GP渠道动态更新代码.
3.在Android N上,补丁对应用的启动时间有轻微的影响。
4.bugly(本质还是tinker)或者tinker不支持部分三星android-21机型，加载补丁会主动抛出出"TinkerRuntimeException:checkDexInstall failed"；
5.对于资源替换，不支持修改remoteView,transition动画，notification icon以及桌面图标。
6.对于构建打包是侵入式的。

7.我们需要保留发布的每个基线版本和对应的混淆mapping文件。

五、相关文档链接

1.bugly 热更新官方指南：https://bugly.qq.com/docs/user-guide/instruction-manual-android-hotfix/?v=20180709165613

2.bugly 热更新tinkerSupport插件: https://bugly.qq.com/docs/utility-tools/plugin-gradle-hotfix/?v=20180709165613

3.tinker GitHub: https://github.com/Tencent/tinker/