Firbase-Crashlytics SDK 接入指南

原 Twitter Fabric 已經(jīng)被 Google 收購(gòu),其中 Crashlytics 組件被集成進(jìn) Firbase 服務(wù)中驯杜,所以顶籽,要使用 Crashlytics 功能需要首先接入 Firbase 基礎(chǔ)服務(wù),再接入 Crashlytics SDK 組件琐脏。

接入需要如下幾步:

  1. 接入 Firbase 基礎(chǔ)服務(wù)依賴(lài)
  2. 接入 Crashlytics 組件依賴(lài)
  3. 自定義 Crashlytics SDK 初始化(可選)
  4. 接入 NDK Crash 收集依賴(lài)(可選)
  5. 自定鍵值對(duì)(可選)

一南捂、接入 Firbase 基礎(chǔ)服務(wù)

  1. 下載 google-services.json 文件吴裤,并復(fù)制到和 app/buil.gradle 文件平級(jí)目錄下
  2. gradle 配置 Firbase 依賴(lài)

a. 在根項(xiàng)目 build.gradle 文件里添加 Firbase 插件依賴(lài):

buildscript {

  repositories {
    google()  // Google's Maven repository
  }

  dependencies {
    // ...
    classpath 'com.google.gms:google-services:4.3.3'  // Google Services plugin
  }
}

allprojects {
  repositories {
    google()  // Google's Maven repository
    // ...
  }
}

b. 在 app/build.gradle 文件應(yīng)用插件

apply plugin: 'com.android.application'

// Google Play services Gradle plugin
apply plugin: 'com.google.gms.google-services' 

android {
  // ...
}

c. 添加 Firbase SDK 依賴(lài)

dependencies {
 // ...
 implementation 'com.google.firebase:firebase-core:17.4.1'
}

詳細(xì)查看 Google Firebase 服務(wù)文檔

二、接入 Crashlytics SDK

  1. 將 Crashlytics 代碼庫(kù)和依賴(lài)項(xiàng)添加到您的項(xiàng)目級(jí) build.gradle 文件中:
buildscripts {
    repositories {
        // ...
        maven {
           url 'https://maven.fabric.io/public'
        }
    }

    dependencies {
        // ...
        classpath 'io.fabric.tools:gradle:1.31.2'
    }
}

allprojects {
    repositories {
       maven {
           url 'https://maven.fabric.io/public'
       }
    }
}
  1. 將 Crashlytics 插件溺健、代碼庫(kù)和依賴(lài)項(xiàng)添加到您的應(yīng)用級(jí) build.gradle 中:
apply plugin: 'io.fabric'

dependencies {
  implementation 'com.crashlytics.sdk.android:crashlytics:2.10.1'
}
  1. 設(shè)置標(biāo)志以啟用 SDK

將 useFirebaseAppId 字符串添加到 strings.xml 中:

<string name="com.crashlytics.useFirebaseAppId">true</string>

創(chuàng)建一個(gè) app/fabric.properties 文件麦牺,其中包含以下行:

USE_FIREBASE_APP_ID=true

詳細(xì)查看 Google Firebase Crashlytics 文檔

三钮蛛、測(cè)試 Crash

可在 MainActivity.kt 點(diǎn)擊事件里制造一個(gè) Crash,重新打開(kāi) App剖膳,測(cè)試 Crash 是否上報(bào)成功魏颓。

findViewById<TextView>(R.id.tv).setOnClickListener {
    // force a crash
    Crashlytics.getInstance().crash();
}

四、自定義 Crashlytics SDK 初始化(可選)

完成以上步驟后吱晒,Crashlytics SDK 內(nèi)部會(huì)自動(dòng)初始化甸饱。如果你需要自己初始化 SDK,比如設(shè)置在 debug 模式下不啟用 Crash 上報(bào)仑濒,在 release 下啟用叹话。就需要做如下修改:

  1. 在 AndroidManifest.xml 文件中添加如下配置,不啟用默認(rèn)初始化
    <meta-data
        android:name="firebase_crashlytics_collection_enabled"
        android:value="false"/>
  1. 選擇合適時(shí)機(jī)手動(dòng)初始化 Crashlytics
private void configureCrashReporting() {
        CrashlyticsCore crashlyticsCore = new CrashlyticsCore.Builder()
                .disabled(BuildConfig.DEBUG) // debug 模式下不啟用 crash 上報(bào)
                .build();
        // ... 其它一些配置
        Fabric.with(this, new Crashlytics.Builder().core(crashlyticsCore).build());
}

五墩瞳、NDK Crash監(jiān)控(可選)

Firebase Crashlytics 的官方文檔只列出來(lái)了 Java 代碼的 Crash 監(jiān)控使用方式驼壶,并沒(méi)有提及 NDK Crash 的監(jiān)控。
對(duì)于大部分 Android 開(kāi)發(fā)者來(lái)說(shuō)喉酌,NDK 的 Crash 也確實(shí)沒(méi)有監(jiān)控的必要热凹,但是考拉這邊用了很多第三方 so 庫(kù),這些 so 庫(kù)也是有必要監(jiān)控起來(lái)的泪电。
Firebase Crashlytics 是由 Firebase 收購(gòu) Fabric 而來(lái)的項(xiàng)目般妙,技術(shù)方案也幾乎沒(méi)有變化,所以可以用 Fabric 監(jiān)控 NDK Crash 的使用方式使用 Firebase Crashlytics相速。

  1. 在應(yīng)用級(jí) build.gradle 中股冗,添加 Crashlytics NDK Crash Reporting 相關(guān)配置
apply plugin: 'com.android.application'

// set NDK Crash Reporting enable
crashlytics {
    enableNdk true
}

dependencies {
    // ...
    // Add ndk dependency
    implementation 'com.crashlytics.sdk.android:crashlytics-ndk:2.0.5'
}

六、自定鍵值對(duì)(可選)

// 設(shè)置唯一標(biāo)識(shí)
Crashlytics.setUserIdentifier("unique identifier")

// 設(shè)置其他輔助鍵值對(duì)
Crashlytics.setString(key, value);
Crashlytics.setBool(key, value);
Crashlytics.setInt(key, value);

七和蚪、混淆處理

Crashlytics 使用 ProGuard 和 DexGuard 映射文件來(lái)將您應(yīng)用的堆棧軌跡呈現(xiàn)為經(jīng)過(guò)反混淆處理、人能閱讀的代碼烹棉。要生成適當(dāng)?shù)挠成湮募芘?qǐng)為 Crashlytics 配置 Proguard 或 Dexguard:

  1. 為了保留所需的信息,以便 Crashlytics 生成人能閱讀的崩潰報(bào)告浆洗,請(qǐng)?jiān)谀?Proguard 或 Dexguard 配置文件中添加以下行:
-keepattributes *Annotation*
-keepattributes SourceFile,LineNumberTable
-keep public class * extends java.lang.Exception
  1. 要讓 Crashlytics 自動(dòng)上傳 ProGuard 或 DexGuard 映射文件催束,請(qǐng)從配置文件中移除以下行(若存在):
-printmapping mapping.txt

tips: 要使用 ProGuard 更快速地進(jìn)行編譯,可以排除 Crashlytics伏社。 請(qǐng)?jiān)谀?ProGuard 配置文件中添加以下行:

-keep class com.crashlytics.** { *; }
-dontwarn com.crashlytics.**

八抠刺、參考文檔

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市摘昌,隨后出現(xiàn)的幾起案子速妖,更是在濱河造成了極大的恐慌,老刑警劉巖聪黎,帶你破解...
    沈念sama閱讀 216,372評(píng)論 6 498
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件罕容,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡,警方通過(guò)查閱死者的電腦和手機(jī)锦秒,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,368評(píng)論 3 392
  • 文/潘曉璐 我一進(jìn)店門(mén)露泊,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái),“玉大人旅择,你說(shuō)我怎么就攤上這事惭笑。” “怎么了生真?”我有些...
    開(kāi)封第一講書(shū)人閱讀 162,415評(píng)論 0 353
  • 文/不壞的土叔 我叫張陵沉噩,是天一觀的道長(zhǎng)。 經(jīng)常有香客問(wèn)我汇歹,道長(zhǎng)屁擅,這世上最難降的妖魔是什么? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 58,157評(píng)論 1 292
  • 正文 為了忘掉前任产弹,我火速辦了婚禮派歌,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘痰哨。我一直安慰自己胶果,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,171評(píng)論 6 388
  • 文/花漫 我一把揭開(kāi)白布斤斧。 她就那樣靜靜地躺著早抠,像睡著了一般。 火紅的嫁衣襯著肌膚如雪撬讽。 梳的紋絲不亂的頭發(fā)上蕊连,一...
    開(kāi)封第一講書(shū)人閱讀 51,125評(píng)論 1 297
  • 那天,我揣著相機(jī)與錄音游昼,去河邊找鬼甘苍。 笑死,一個(gè)胖子當(dāng)著我的面吹牛烘豌,可吹牛的內(nèi)容都是我干的载庭。 我是一名探鬼主播,決...
    沈念sama閱讀 40,028評(píng)論 3 417
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼廊佩,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼囚聚!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起标锄,我...
    開(kāi)封第一講書(shū)人閱讀 38,887評(píng)論 0 274
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤顽铸,失蹤者是張志新(化名)和其女友劉穎,沒(méi)想到半個(gè)月后料皇,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體跋破,經(jīng)...
    沈念sama閱讀 45,310評(píng)論 1 310
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡簸淀,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,533評(píng)論 2 332
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了毒返。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片租幕。...
    茶點(diǎn)故事閱讀 39,690評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖拧簸,靈堂內(nèi)的尸體忽然破棺而出劲绪,到底是詐尸還是另有隱情,我是刑警寧澤盆赤,帶...
    沈念sama閱讀 35,411評(píng)論 5 343
  • 正文 年R本政府宣布贾富,位于F島的核電站,受9級(jí)特大地震影響牺六,放射性物質(zhì)發(fā)生泄漏颤枪。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,004評(píng)論 3 325
  • 文/蒙蒙 一淑际、第九天 我趴在偏房一處隱蔽的房頂上張望畏纲。 院中可真熱鬧,春花似錦春缕、人聲如沸盗胀。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 31,659評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)票灰。三九已至,卻和暖如春宅荤,著一層夾襖步出監(jiān)牢的瞬間屑迂,已是汗流浹背。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 32,812評(píng)論 1 268
  • 我被黑心中介騙來(lái)泰國(guó)打工冯键, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留惹盼,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 47,693評(píng)論 2 368
  • 正文 我出身青樓琼了,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親夫晌。 傳聞我的和親對(duì)象是個(gè)殘疾皇子雕薪,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,577評(píng)論 2 353