androidsdk官⽅⽂档,AndroidSDK使⽤指南
Bugly Android SDK 使⽤指南
库⽂件导⼊
Bugly⽀持⾃动集成和⼿动集成两种⽅式,如果您使⽤Gradle编译Apk,我们强烈推荐您使⽤⾃动接⼊⽅式配置库⽂件。
⾃动集成(推荐)
Bugly⽀持JCenter仓库和Maven Central仓库。为了实现更加灵活的配置,Bugly SDK(2.1.5及以上版本)和NDK(SO库)⽬前已经分开成两个独⽴的仓库:
SDK:t.bugly:crashreport
NDK:t.bugly:nativecrashreport
其中,集成Bugly NDK时,需要同时集成Bugly SDK。
集成SDK
sdk在Module的adle⽂件中添加依赖和属性配置:
dependencies {
compile 't.bugly:lease' //其中lease指代最新Bugly SDK版本号,也可以指定明确的版本号,例如2.2.0
}
同时集成SDK和NDK
在Module的adle⽂件中添加依赖和属性配置:
android {
defaultConfig {
ndk {
// 设置⽀持的SO库架构
abiFilters 'armeabi' //, 'x86', 'armeabi-v7a', 'x86_64', 'arm64-v8a'
}
}
}
dependencies {
compile 't.bugly:lease' //其中lease指代最新Bugly SDK版本号,也可以指定明确的版本号,例如2.1.9
compile 't.bugly:lease' //其中lease指代最新Bugly NDK版本号,也可以指定明确的版本号,例如3.0
}
同时集成Bugly SDK和NDK的配置如下图所⽰,后续更新Bugly SDK和NDK时,只需变更配置脚本中的版本号即可。
注意:⾃动集成时会⾃动包含Bugly SO库,建议在Module的adle⽂件中使⽤NDK的“abiFilter”配置,设置⽀持的SO库架构。如果在添加“abiFilter”之后Android Studio出现以下提⽰:
NDK integration is deprecated in the current plugin. Consider trying the new experimental plugin.
则在项⽬根⽬录的gradle.properties⽂件中添加:
android.useDeprecatedNdk=true
⼿动集成
如果您不采⽤上述⾃动导⼊⽅式,也可以⼿动集成Bugly SDK。
下载Bugly库⽂件
如果您的⼯程有Native代码(C/C++)或者集成了其他第三⽅SO库,建议下载Bugly的NDK动态库。
Bugly NDK包含多个架构的SO库:
armeabi
armeabi-v7a
arm64-v8a
x86
x86_64
在集成Bugly SO库时,请注意只保留⽀持的架构SO库。
Eclipse⼯程
将Bugly库⽂件复制到⼯程的libs⽬录下;
Refresh⼀下⼯程;
添加⼯程依赖:⿏标右键点击Bugly的JAR⽂件,添加到编译路径中。
Android Studio⼯程
将Bugly库⽂件复制到⼯程的libs⽬录下;
如果集成Bugly NDK,则在Module的adle⽂件中添加SO库⽬录配置:android {
sourceSets {
main.jniLibs.srcDirs = ['libs']
}
}
点击Sync,同步配置。
为了使APP Crash堆栈的可读性更⾼,建议您配置符号表⽂件,更准确地定位问题:
纯Java代码的⼯程:只需要配置混淆后⽣成的Mapping⽂件即可;
含有Native代码的⼯程:建议配置符号表⼯具从Debug SO中提取的Symbol符号表⽂件。
Bugly⽀持⼿动和⾃动配置两种⽅式,具体的配置⽅法请参考:《Bugly Android符号表配置》
参数配置
在l中添加权限:
注:如果您的App需要上传到google play store,您需要将READ_PHONE_STATE权限屏蔽掉或者移除,否则可能会被下架。请避免混淆Bugly,在Proguard混淆⽂件中增加以下配置:
-t.bugly.**
-keep public t.bugly.**{*;}
最简单的初始化
获取APP ID并将以下代码复制到项⽬Application类onCreate()中,Bugly会为⾃动检测环境并完成配置:
CrashReport.initCrashReport(getApplicationContext(), "注册时申请的APPID", false);
为了保证运营数据的准确性,建议不要在异步线程初始化Bugly。
第三个参数为SDK调试模式开关,调试模式的⾏为特性如下:
输出详细的Bugly SDK的Log;
每⼀条Crash都会被⽴即上报;
⾃定义⽇志将会在Logcat中输出。
建议在测试阶段建议设置成true,发布时设置为false。
此外,Bugly2.0及以上版本还⽀持通过“l”来配置APP信息。如果同时⼜通过代码中配置了APP信息,则最终以代码配置的信息为准。
在“l”的“Application”中增加“meta-data”配置项:
android:name="BUGLY_APPID"
android:value="" />
android:name="BUGLY_APP_VERSION"
android:value="" />
android:name="BUGLY_APP_CHANNEL"
android:value="" />
android:name="BUGLY_ENABLE_DEBUG"
android:value="" />
不同于“android:versionName”,“BUGLY_APP_VERSION”配置的是Bugly平台的APP版本号。
通过“l”配置后的初始化⽅法如下:
CrashReport.initCrashReport(getApplicationContext());
Bugly默认从“l”⽂件中读取“VersionName”作为版本号,⾃定义设置请使⽤参考“⾼级设置”。
MultiDex注意事项
如果使⽤了MultiDex,建议通过Gradle的“multiDexKeepFile”配置等⽅式把Bugly的类放到主Dex,另外建议在Application类的"attachBaseContext"⽅法中主动加载⾮主dex:
public class MyApplication extends SomeOtherApplication {
@Override
protected void attachBaseContext(Context base) {
super.attachBaseContext(context);
Multidex.install(this);
}
}
增加上报进程控制