热修复框架Tinker最完整讲解(01)—集成之路

700 阅读8分钟

作者相关:作者:wildma 博客地址:http://www.jianshu.com/p/ed17f00a3d23

前言

上个月我们的产品又更新了一个版本,当一个测试把产品上传了十几个应用市场的时候,另外一个测试突然测出一个重要bug。项目经理就说把全部渠道上传的先退回来,重新改好bug再发布。这时候我们就苦逼了,又要走一遍 签名打包->加固->签名->上传应用市场的流程。要知道我们的渠道有接近20个,整个流程又要花上2,3小时。只能全部加班加点了。。。

为了解决有一个bug又要重新发布版本的问题,项目经理就叫我赶紧把热修复集成到项目中去。一开始觉得3天就能搞定,就跟项目经理要了4天时间。结果是整整搞了5天!集成tinker Demo确实一天可以搞定,但是还要自定义Application类(我们项目的Application还比较复杂),集成美团Walle多渠道打包(我们以前多渠道打包是采用productFlavors实现的),与后台沟通接口的设计(补丁包的存放),svn的分支管理,测试整个流程等等就花了很多时间了。这其中遇到了很多坑和问题。这个系列文章都会一一讲解,新手看了肯定会少走很多弯路。

Tinker是什么

Tinker是微信官方的Android热补丁解决方案,它支持动态下发代码、So库以及资源,让应用能够在不需要重新安装的情况下实现更新。当然,你也可以使用Tinker来更新你的插件。

为什么使用Tinker

当前市面的热补丁方案有很多,其中比较出名的有阿里的AndFix、美团的Robust以及QZone的超级补丁方案。但它们都存在无法解决的问题,这也是正是我们推出Tinker的原因。

总的来说:1、AndFix作为native解决方案,首先面临的是稳定性与兼容性问题,更重要的是它无法实现类替换,它是需要大量额外的开发成本的;2、Robust兼容性与成功率较高,但是它与AndFix一样,无法新增变量与类只能用做的bugFix方案; 3、Qzone方案可以做到发布产品功能,但是它主要问题是插桩带来Dalvik的性能问题,以及为了解决Art下内存地址问题而导致补丁包急速增大的。

特别是在Android N之后,由于混合编译的inline策略修改,对于市面上的各种方案都不太容易解决。而Tinker热补丁方案不仅支持类、So以及资源的替换,它还是2.X-7.X的全平台支持。利用Tinker我们不仅可以用做bugfix,甚至可以替代功能的发布。Tinker已运行在微信的数亿Android设备上,那么为什么你不使用Tinker呢?

Tinker的已知问题

由于原理与系统限制,Tinker有以下已知问题:1、Tinker不支持修改AndroidManifest.xml,Tinker不支持新增四大组件;2、由于Google Play的开发者条款限制,不建议在GP渠道动态更新代码;3、在Android N上,补丁对应用启动时间有轻微的影响;4、不支持部分三星android-21机型,加载补丁时会主动抛出”TinkerRuntimeException:checkDexInstall failed”;5、对于资源替换,不支持修改remoteView。例如transition动画,notification icon以及桌面图标。

以上关于Tinker的介绍来自Tinker官方Wiki

Tinker集成

1,在项目的gradle.properties文件中添加Tinker的版本号

#Tinker版本号
TINKER_VERSION=1.7.11

2,在项目的build.gradle中,添加tinker-patch-gradle-plugin的依赖

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:2.2.2'
        //tinker
        classpath "com.tencent.tinker:tinker-patch-gradle-plugin:${TINKER_VERSION}"
    }
}

3,在app的gradle文件app/build.gradle,添加tinker的库依赖(有注释的3个)

dependencies {    compile fileTree(include: ['*.jar'], dir: 'libs')
    testCompile 'junit:junit:4.12'
    compile 'com.android.support:appcompat-v7:23.1.1'       // 多dex 打包的类库
    compile 'com.android.support:multidex:1.0.1'       //tinker的核心库
    compile("com.tencent.tinker:tinker-android-lib:${TINKER_VERSION}") { changing = true }       //用于生成application类
    provided("com.tencent.tinker:tinker-android-anno:${TINKER_VERSION}") { changing = true }
}

4,在app的gradle文件app/build.gradle,添加tinker的相关配置

下面就把整个app/build.gradle配置贴出来,其中标有Tinker相关配置即为tinker的相关配置,其中比较重要的属性都标有中文注释,其余属性解释可以自行参考 Tinker 接入指南

二、自定义Application类

程序启动时会加载默认的Application类,这导致补丁包无法对它做修改。所以Tinker官方说不建议自己去实现Application,而是由Tinker自动生成。即需要创建一个SampleApplication类,继承DefaultApplicationLike,然后将我们自己的MyApplication中所有逻辑放在SampleApplication中的onCreate中。最后需要将我们项目中之前的MyApplication类删除。如下:

@SuppressWarnings("unused")@DefaultLifeCycle(  application = "com.wildma.wildmatinker.MyApplication",// 自定义生成
                    flags = ShareConstants.TINKER_ENABLE_ALL,
                    loadVerifyFlag = false)public class SampleApplication extends DefaultApplicationLike {    public static SampleApplication sampleApplication;    public SampleApplication(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();
        sampleApplication = this;        //将我们自己的MyApplication中的所有逻辑放在这里,例如初始化一些第三方

    }        @TargetApi(Build.VERSION_CODES.ICE_CREAM_SANDWICH)        @Override
    public void onBaseContextAttached(Context base) {                super.onBaseContextAttached(base);               // 其原理是分包架构,所以在加载初要加载其余的分包
        MultiDex.install(base);               // Tinker管理类,保存当前对象
        TinkerManager.setTinkerApplicationLike(this);        // 崩溃保护
        TinkerManager.initFastCrashProtect();        // 是否重试
        TinkerManager.setUpgradeRetryEnable(true);        //Log 实现,打印加载补丁的信息
        TinkerInstaller.setLogIml(new MyLogImp());                // 运行Tinker ,通过Tinker添加一些基本配置
        TinkerManager.installTinker(this);
        Tinker tinker = Tinker.with(getApplication());

    }                @TargetApi(Build.VERSION_CODES.ICE_CREAM_SANDWICH)        public void registerActivityLifecycleCallbacks(Application.ActivityLifecycleCallbacks callback) {               // 生命周期,默认配置
        getApplication().registerActivityLifecycleCallbacks(callback);
    }                  /**
     * 获取SampleApplication实例
     * @return
     */
    public static SampleApplication getSampleApplication(){               return sampleApplication;
    }

}

其中DefaultLifeCycle中的MyApplication为我们真正的Application,清单文件中的Application的name改为MyApplication的全路径。如下:

<application
        android:name="com.wildma.wildmatinker.MyApplication"
        android:allowBackup="true"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:supportsRtl="true"
        android:theme="@style/AppTheme">
        <activity android:name=".MainActivity">
            <intent-filter>
                <action android:name="android.intent.action.MAIN"/>

                <category android:name="android.intent.category.LAUNCHER"/>
            </intent-filter>
        </activity>
    </application>
三、添加Tinker相关类

这些类主要是加载补丁包过程的回调,打印log,崩溃保护等。具体见 Tinker 自定义扩展

四、在清单文件添加读写sd卡的权限
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
五、加载补丁包代码
package com.wildma.wildmatinker;public class MainActivity extends AppCompatActivity {        @Override
    protected void onCreate(Bundle savedInstanceState) {        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);         //加载补丁包
        TinkerInstaller.onReceiveUpgradePatch(getApplicationContext(), Environment.getExternalStorageDirectory().getAbsolutePath() + "/patch_signed_7zip");
    }        //Tinker相关配置
    protected void onResume() {        super.onResume();
        Utils.setBackground(false);

    }        //Tinker相关配置
    @Override
    protected void onPause() {        super.onPause();
        Utils.setBackground(true);
    }
}

其中第9行代码的路径为我们放在sd卡中的补丁包路径。

六、测试Tinker热修复

这里只讲release版本。

1.按正常流程打包出带签名的APK,并装到手机上

打包完成,会自动在项目的app/build文件夹下生成bakAPK文件夹并有三个文件(基础包的一些文件),如图:

2. 将上面的三个文件路径复制到app.build中对应的位置,如图

3 . 修复bug >测试的时候随便改动一点代码 4 . 运行补丁命令获取补丁包

运行补丁命令,单击AS右侧顶部gradle→双击tinkerPatchRelease,如图:

运行完成会在build->outputs->tinkerPatch->release文件夹中生成一个名为patch_signed_7zip.apk的补丁包,如图:

5 . 将该补丁包复制到之前加载补丁包中对应的SD卡路劲即可。 6 . 运行项目发现bug并没有修复,因为tinker是不支持即时修复的,关掉APP重启。恭喜你!bug已修复!

Tinker集成在这里讲的已经非常详细了,有不足的地方希望指出。遇到不懂的问题都可以直接在这里问我,只要我遇到过并且能回答出来的都会乐意回答。

Demo下载地址:https://github.com/wildma/WildmaTinker

推荐阅读

1

Android关于沉浸式状态栏的一些总结

2

Android 底部导航栏(底部Tab)最佳实践

3

图片加载框架Picasso - 源码分析

长按二维码关注