天天看點

buglly熱更新內建遇到的那些坑

首先說明使用熱修複的意義,那就是你的apk包發出去了,萬一發生了緊急異常需要修複,怎麼辦?這時候再發包上市場稽核,也是有點慢了吧?而且錯誤發生在apk中,無法通過背景接口修複,這時候你就需要一個強大的工具了,那就是熱修複了.熱修複有多個架構,目前騰訊的buglly的tinker是已經提供工具內建了,并且許多的應用都在使用,看看官方對它的介紹:

熱更新能力是Bugly為解決開發者緊急修複線上bug,而無需重新發版讓使用者無感覺就能把問題修複的一項能力。Bugly目前采用

微信Tinker

的開源方案,開發者隻需要內建我們提供的SDK就可以實作自動下載下傳更新檔包、合成、并應用更新檔的功能,我們也提供了熱更新管理背景讓開發者對每個版本更新檔進行管理。

為什麼使用Bugly熱更新?

  • 無需關注Tinker是如何合成更新檔的
  • 無需自己搭建更新檔管理背景
  • 無需考慮背景下發更新檔政策的任何事情
  • 無需考慮更新檔下載下傳合成的時機,處理背景下發的政策
  • 我們提供了更加友善內建Tinker的方式
  • 我們通過HTTPS及簽名校驗等機制保障更新檔下發的安全性
  • 豐富的下發次元控制,有效控制更新檔影響範圍
  • 我們提供了應用更新一站式解決方案

下面看看內建步驟如何:

第一步:添加插件依賴

工程根目錄下“build.gradle”檔案中添加

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        // tinkersupport插件, 其中lastest.release指拉取最新版本,也可以指定明确版本号,例如1.0.4
        classpath "com.tencent.bugly:tinker-support:1.1.2"
    }
}      

第二步:內建SDK

gradle配置

在app module的“build.gradle”檔案中添加(示例配置):

android {
        defaultConfig {
          ndk {
            //設定支援的SO庫架構
            abiFilters 'armeabi' //, 'x86', 'armeabi-v7a', 'x86_64', 'arm64-v8a'
          }
        }
      }
      dependencies {
          compile "com.android.support:multidex:1.0.1" // 多dex配置
          //注釋掉原有bugly的倉庫
          //compile 'com.tencent.bugly:crashreport:latest.release'//其中latest.release指代最新版本号,也可以指定明确的版本号,例如1.3.4
          compile 'com.tencent.bugly:crashreport_upgrade:1.3.5'
          // 指定tinker依賴版本(注:應用更新1.3.5版本起,不再内置tinker)
          compile 'com.tencent.tinker:tinker-android-lib:1.9.6'
          compile 'com.tencent.bugly:nativecrashreport:latest.release' //其中latest.release指代最新版本号,也可以指定明确的版本号,例如2.2.0
      }      

在app module的“build.gradle”檔案中添加:

// 依賴插件腳本
apply from: 'tinker-support.gradle'      

tinker-support.gradle内容如下所示(示例配置):

同級目錄下建立tinker-support.gradle這個檔案。

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

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

/**
 * 此處填寫每次建構生成的基準包目錄
 */
def baseApkDir = "app-0208-15-10-00"

/**
 * 對于插件各參數的詳細解析請參考
 */
tinkerSupport {

    // 開啟tinker-support插件,預設值true
    enable = true

    // 指定歸檔目錄,預設值目前module的子目錄tinker
    autoBackupApkDir = "${bakPath}"

    // 是否啟用覆寫tinkerPatch配置功能,預設值false
    // 開啟後tinkerPatch配置不生效,即無需添加tinkerPatch
    overrideTinkerPatchConfiguration = true

    // 編譯更新檔包時,必需指定基線版本的apk,預設值為空
    // 如果為空,則表示不是進行更新檔包的編譯
    // @{link tinkerPatch.oldApk }
    baseApk = "${bakPath}/${baseApkDir}/app-release.apk"

    // 對應tinker插件applyMapping
    baseApkProguardMapping = "${bakPath}/${baseApkDir}/app-release-mapping.txt"

    // 對應tinker插件applyResourceMapping
    baseApkResourceMapping = "${bakPath}/${baseApkDir}/app-release-R.txt"

    // 建構基準包和更新檔包都要指定不同的tinkerId,并且必須保證唯一性
    tinkerId = "base-1.0.1"

    // 建構多管道更新檔時使用
    // buildAllFlavorsDir = "${bakPath}/${baseApkDir}"

    // 是否啟用加強模式,預設為false.(tinker-spport 1.0.7起支援)
    // isProtectedApp = true

    // 是否開啟反射Application模式
    enableProxyApplication = false

    // 是否支援新增非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的配置設定
    }
}      

第三步:初始化SDK

enableProxyApplication = true 的情況

public class MyApplication extends Application {

    @Override
    public void onCreate() {
        super.onCreate();
        // 這裡實作SDK初始化,appId替換成你的在Bugly平台申請的appId
        // 調試時,将第三個參數改為true
        Bugly.init(this, "900029763", false);
    }

    @Override
    protected void attachBaseContext(Context base) {
        super.attachBaseContext(base);
        // you must install multiDex whatever tinker is installed!
        MultiDex.install(base);


        // 安裝tinker
        Beta.installTinker();
    }

}      

注:無須改造Application,主要是為了降低接入成本,插件會動态替換AndroidMinifest檔案中的Application為定義好用于反射真實Application的類(需要接入SDK 1.2.2版本 和 插件版本 1.0.3以上)。

enableProxyApplication = false 的情況

這是Tinker推薦的接入方式,一定程度上會增加接入成本,但具有更好的相容性。

內建Bugly更新SDK之後,我們需要按照以下方式自定義ApplicationLike來實作Application的代碼(以下是示例):

自定義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

需要将以前的Applicaton配置為繼承TinkerApplication的類

buglly熱更新內建遇到的那些坑

自定義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
        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提供的方法
        Beta.installTinker(this);
    }

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

}      

注意:tinker需要你開啟MultiDex,你需要在dependencies中進行配置

compile "com.android.support:multidex:1.0.1"

才可以使用MultiDex.install方法; SampleApplicationLike這個類是Application的代理類,以前所有在Application的實作必須要全部拷貝到這裡,在

onCreate

方法調用SDK的初始化方法,在

onBaseContextAttached

中調用

Beta.installTinker(this);

第四步:AndroidManifest.xml配置

在AndroidMainfest.xml中進行以下配置:

1. 權限配置

<uses-permission android:name="android.permission.READ_PHONE_STATE" />
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
<uses-permission android:name="android.permission.READ_LOGS" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />      

2. Activity配置

<activity
    android:name="com.tencent.bugly.beta.ui.BetaActivity"
    android:configChanges="keyboardHidden|orientation|screenSize|locale"
    android:theme="@android:style/Theme.Translucent" />      

3. 配置FileProvider

注意:如果想相容Android N或者以上的裝置,必須要在AndroidManifest.xml檔案中配置FileProvider來通路共享路徑的檔案。

<provider
    android:name="android.support.v4.content.FileProvider"
    android:authorities="${applicationId}.fileProvider"
    android:exported="false"
    android:grantUriPermissions="true">
    <meta-data
        android:name="android.support.FILE_PROVIDER_PATHS"
        android:resource="@xml/provider_paths"/>
</provider>      

如果你使用的第三方庫也配置了同樣的FileProvider, 可以通過繼承FileProvider類來解決合并沖突的問題,示例如下

<provider
    android:name=".utils.BuglyFileProvider"
    android:authorities="${applicationId}.fileProvider"
    android:exported="false"
    android:grantUriPermissions="true"
    tools:replace="name,authorities,exported,grantUriPermissions">
    <meta-data
        android:name="android.support.FILE_PROVIDER_PATHS"
        android:resource="@xml/provider_paths"
        tools:replace="name,resource"/>
</provider>      

這裡要注意一下,FileProvider類是在support-v4包中的,檢查你的工程是否引入該類庫。

在res目錄建立xml檔案夾,建立provider_paths.xml檔案如下:

<?xml version="1.0" encoding="utf-8"?>
<paths xmlns:android="http://schemas.android.com/apk/res/android">
    <!-- /storage/emulated/0/Download/${applicationId}/.beta/apk-->
    <external-path name="beta_external_path" path="Download/"/>
    <!--/storage/emulated/0/Android/data/${applicationId}/files/apk/-->
    <external-path name="beta_external_files_path" path="Android/data/"/>
</paths>      

這裡配置的兩個外部存儲路徑是更新SDK下載下傳的檔案可能存在的路徑,一定要按照上面格式配置,不然可能會出現錯誤。

注:1.3.1及以上版本,可以不用進行以上配置,aar已經在AndroidManifest配置了,并且包含了對應的資源檔案。

第五步:混淆配置

為了避免混淆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.**{*;}      

以上就配置完成了,生成基準包,在tinker-support.gradle中修改基準包的路徑名稱,運作下面的腳本即可生成patch.如圖

buglly熱更新內建遇到的那些坑
buglly熱更新內建遇到的那些坑
buglly熱更新內建遇到的那些坑

生成的patch如下:

buglly熱更新內建遇到的那些坑

其中的patch_signed_7zip.apk拷出來,這就是patch更新檔.然後上傳到buglly背景就可以了.

遇到的一些坑:

1.為什麼沒有mapping檔案生成?

一定要檢查下面的配置有沒有.

buglly熱更新內建遇到的那些坑

2.在build中配置了簽名檔案發現還是沒有mappingfile,這時候你要檢查下面這個配置

buglly熱更新內建遇到的那些坑

3.配置上面的發現還是沒有mappingfile,這時候一定要檢查這個配置.

buglly熱更新內建遇到的那些坑

4.這時候你發現終于有了mappingfile,很開心對不對,然後修改了代碼配置好了基準包,做好了patch,一上傳發現提示,沒有基準包,這時候是不是懵逼了. 你趕緊的把基準包安裝一下,然後再上傳patch就可以了.

5.關于調試資訊,一定要打開開關,通過日志 tinker,檢查有關輸出資訊

Bugly.init(getApplication(), LApplicaiton.S_BUGLY_APPID, true);      

6.一個小秘密:其實項目的住model中的這個配置可以不用

dependencies {
          compile "com.android.support:multidex:1.0.1" // 多dex配置
          //注釋掉原有bugly的倉庫
          //compile 'com.tencent.bugly:crashreport:latest.release'//其中latest.release指代最新版本号,也可以指定明确的版本号,例如1.3.4
          compile 'com.tencent.bugly:crashreport_upgrade:1.3.5'
          // 指定tinker依賴版本(注:應用更新1.3.5版本起,不再内置tinker)
          compile 'com.tencent.tinker:tinker-android-lib:1.9.6'
          compile 'com.tencent.bugly:nativecrashreport:latest.release' //---這個可以不要的,兄弟e
      }      

7.萬能的,如果你發現怎麼配置都沒有生成patch了,這時候請采用不反射的方式,繼承tinker的application

// 是否采用反射Application的方式內建,無須改造Application
enableProxyApplication = false      

8.其他的問題可以檢視

官網

 或者留言給我.