Android SDK集成-腾讯WeTest

Bugly Android SDK 集成

1.Android 接入演示

1）创建一个APP（如有，可以跳过）

2）在“1”处选择Project（项目），然后将下载好的bugly sdk jar包拖入"2“中的lib文件夹下。如果拖入后无法看到，可以右键选择”Synchronize ‘libs’ "。如果还是无法看到，请在资源管理器相应文件夹下确认文件已经拖入。

3）在主界面（MainActivity.java)入口添加包引用，在Oncrete函数中初始化Bugly, 代码如下。

 ```java
    package com.example.bugly_sdk_demo;

    import android.os.Bundle;

    import com.google.android.material.floatingactionbutton.FloatingActionButton;
    import com.google.android.material.snackbar.Snackbar;

    import androidx.appcompat.app.AppCompatActivity;
    import androidx.appcompat.widget.Toolbar;

    import android.view.View;
    import android.view.Menu;
    import android.view.MenuItem;

    import com.tencent.bugly.crashreport.CrashReport;

    public class MainActivity extends AppCompatActivity {

        @Override
        protected void onCreate(Bundle savedInstanceState) {
            super.onCreate(savedInstanceState);

            setContentView(R.layout.activity_main);
            Toolbar toolbar = findViewById(R.id.toolbar);
            setSupportActionBar(toolbar);

            FloatingActionButton fab = findViewById(R.id.fab);
            fab.setOnClickListener(new View.OnClickListener() {
                @Override
                public void onClick(View view) {
                    Snackbar.make(view, "Replace with your own action", Snackbar.LENGTH_LONG)
                            .setAction("Action", null).show();
                }
            });

            CrashReport.initCrashReport(getApplicationContext());
        }
    }

    ```

4）在安卓配置文件（AndroidManifest.xml)中添加相应的配置，如下图:

5）此时已经完成基础的安卓Bugly SDK接入，可以在编译运行应用，可以在logcat日志中看到下图所示日志：（可以尝试制造崩溃，并在web端查看崩溃信息）

2.下载Bugly库文件

下载Bugly的Android SDK包；
如果您的工程有Native代码（C/C++）或者集成了其他第三方SO库，建议下载Bugly的N动态库。
Bugly NDK包含多个架构的SO库：
armeabi
armeabi-v7a
arm64-v8a
x86
x86_64
在集成Bugly SO库时，请注意只保留支持的架构SO库。

3.添加库文件

Eclipse工程

将Bugly库文件复制到工程的libs目录下；
Refresh一下工程；
添加工程依赖：鼠标右键点击Bugly的JAR文件，到编译路径中。

Android Studio工程
将Bugly库文件复制到工程的libs目录下；
如果集成Bugly NDK，则在Module的buid.gradle文件中添加SO库目录配置：

ndroid {
    sourceSets {
        main.jniLibs.srcDirs = ['libs']
    }
}

点击Sync，同步配置。

为了使APP Crash堆栈的可读性更高，建议您配置符号表文件，更准确地定位问题：
纯Java代码的工程：只需要配置混淆后生成的Mapping文件即可；
含有Native代码的工程：建议配置符号表工具从Debug SO中提取的Symbol符号表文件。
Bugly支持手动和自动配置两种方式，具体的配置方法请参考：《Bugly Android符号表配置》

4.参数配置

在AndroidManifest.xml中添加权限：

uses-permission android:name="android.permission.READ_PHE_STATE" />
<uses-permission android:n="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" />

注：如果您的App需要上传到 google play store，您需要将READ_PHONE_STATE
权限屏蔽掉或者移除，否则可能会被下架。

请避免混淆Bugly，在Proguard混淆文件中增加置：

dontwarn com.tencent.bugly.**
-keep public class com.tencent.bugly.**{*;}

可通过“AndroidManifest.xml”来配置A息。如果同时又通过代码中配置了APP信息，则最终以代码配置的信息为准。（BGLY_AREA必须配置）
在“AndroidManifest.xml”“Apliion”中增加“meta-data”配置项：

application
    <!-- 配置APP ID -->
    <meta-data
            android:name="BUGLY_APPID"
            android:value=PP_ID>" />
    <!-- 配置APP版本号 -->
    <meta-data
            android:name="BUGLY_APP_VERSION"
            android:value="<APP_Version>" />
    <!-- 配置APP渠道号 -->
    <meta-data
            android:name="BUGLY_APP_CHANNEL"
            android:value="<APP_Channel>" />
    <!-- 配置Bugly调试模式（true或者false）-->
    <meta-data
            android:name="BUGLY_ENABLE_DEBUG"
            android:value="<isDebug>" />
    <!-- 配置Bugly上报区域-->
    <meta-data
            android:name="BUGLY_AREA"
            android:value="oversea" />
    </application>

同于“android:versionName”，“BUGLY_APP_VERSION”配置的是Bugly平台的APP版本号。

通过“AndroidManifest.xml”配置后的初始化方法如下：

rashReportitChReport(getApplicationContext());

Bugly默认从“AndroidManifest.xml”文件中VersionName”作为版本号。

5.简单的初始化

获取APP ID并将以下代码复制到项目Application类onCreate()中，Bugly会为自动检测环境并完成配置：（为了保证运营数据的准确性，建议不要在异步线程初始化Bugly。）
CrashReport.initCrashReport(getApplationContext(), “注册时申请的APPID”, false);
第三个参数为SDK调试模式开关，调试模式的行为特性如下：

输出详细的Bugly SDK的Log；
每一条Crash都会被立即上报；
自定义日志将会在Logcat中输出。
建议在测试阶段建议设置成true，发布时设置为false。

6.动态配置域名

rashReport.java
/**
* 设置上报URL.
*
*@param url 上报URL
*/
public static void setServerUrl(String url)

管理端上报域名
国内公有云crashsightq.com：httpsandroid.crashsight.qq.com/rd/async
海外有crashsight.wetest.net：https://android.crashsight.wetest.net/rqd/ac

7. MultiDex注意事项

如果使用了MultiDex，建议通过Gradle的“

ultiDexKeepFile

”配置等方式把Bugly的类放到主Dex，另外建议在

pplication

类的"ttachBaseContext"方法中主动加载非主dex：

ublic class MyApplication extends SomeOthpplication {
  @Overrid protected void attachBaseCont(Context base) {
  supettachBaseContext(context     Multidex.inst(this);
  }
}

增加上报进程控制
如果App使用了多进程且各个进程都会初始化Bugly（例如在Application类onCreate()中初始化Bugly），那么每个进程下的Bugly都会进行数据上报，造成不必要的资源浪费。
因此，为了节省流量、内存等资源，建议初始化的时候对上报进程进行控制，只在主进程下上报数据：判断是否是主进程（通过进程名是否为包名来判断），并在初始化Bugl加一个上报进程的策略配置。

ontext context = getApplicationContext();
// 获取当前包名
String packageName = context.getPackageName();
// 获取当前进程名
String processName = getProcessName(android.os.Process.myPid());
// 设置是否为上报进serStrategy strategy = new UserStrategy(context);
strategy.setUploadProcess(processName == null || processName.equals(packageName));
// 初始化Bugly
CrashReport.initCrashReport(context, "注册时申请的APPID", isDebug, strategy);
// 如果通过“AndroidManifest.xml”来配置APP信息，初始化方法如下
// CrashReport.initCrashReport(context, strategy);

其中获取进程名的方法“getProcessName”有多种实现方法，推荐方法如下：

**
 * 获取进程号对应的进程名
 * 
 * @param pid 进程号
 * @return 进程名
 */
private static String getProcessName(int pid) {
    BufferedReader reader = null;
    tr
        reader = new BufferedReader(new Fileder("/proc/" + pid + "/cmdline"));
        String processName = reader.readLine();
        if (!TextUtils.isEmpty(processName)) {
            processName = processName.trim();
        }
        return processName;
    } catch (Throwable throwable) {
        throwable.printStackTrace();
    } finally {
        try {
            if (reader != null) {
                reader.close();
            }
        } catch (IOException exception) {
            exception.printStackTrace();
        }
    }
    return null;
}

8.接入结果测试

现在您可以制造一个Crash（建议通过“按键”来触发），来体验Bugly的能力了。在初始化Bugly的之后，调用Bugly测Java Crash接口。

rashReport.testJavaCrash();

执行到这段代码时会发生一个Crash，Logcat的TAG=CrashReportInfo中输出为：

现在您已经可以在“崩溃”页面看到刚才触发的Crash issue了（般在10s以内）。
如果项目包含了Native工程或者使用了代码混淆，置符号表文件，具体请参考“符号表配置”

9.Bugly Android SDK 高级配置

更多的Bugly行为控制
我们提供了UserStrategy类作为Bugly的初始化扩展，在这里您可以修改本次初始化Bugly数据的版本、渠道及部分初始化行为。通过以下方式传入：

serStrategy strategy = new UserStrategy(appContext);
//...在这里设置strategy的属性，在bugly初始化时传入
//...rashReport.initCrashReport(appContext, APPID, true, strategy);

如果通过UserStrategy设置了版本号和渠道号，则会覆盖“AndroidManifest.x里面配置的版本号和渠道。
用户策略（UserStrategy）
设置App版本、渠道、包名
Bugly默认读取AndroidManifest.xml文件中VersionName、Package信息。若您有自己的版本或渠道设定需求，可通过该接口修改。

trategy.setAppChannel("myChannel  /渠道
strategy.setAppVersion("1.0.1");      //App的版本
strategy.setAppPackagme("com.tencent.xx");  //App的包名

设置Bugly初始化延迟
Bugly会在启动10s后联网同步数据。若您有特别需求，可以修改这个时间。

trategy.setAppReportDelay(00);   //改为20s

设置标签
自定义标签，用于标明App的某个“场景”。在发生Crash时会显示该Crash所在的“场景”，以最后设置的标签为准，标签id需大于0。例：当用户进入界面A时，打上9527的标签：

rashReport.setUserSceneTag(context, 9); // 上报后的Crash会显示该标签

打标签之前，需要在Bugly产品页配置中添加标签，取得标签在代码中上报。
设置自定义Map参数
自定义Map参数可以保存发生Crash时的一些自定义的环境信息。Crash时会随着异常信息一起上报并在页面展示。

rashReport.putUserData(context, "userkey", "uservalue");

最多可以有9对的key-value（超过则添加失败）；
key限长50字节，value限长200字节，过长截断；
key必须匹配正则：a-z[0-9]]+

设置开发设备
在开发测试阶段，可以在初始化Bugly之前通过以下接口把调试设备设置成“开发设备”。

rashReport.setIsDevelopmentDevice(context, true)

ADT 17增加了BuildConfig特性，可以通过获取BuildConfig类的DEBUG变量来设置：

rashort.setIsDevelopmentDevice(context, BuildConfig.DEBUG);

设置Crash回调
Crash回调类ashReport的子类）的定义如下：

ublic abstract static class CrashHandleCallback {

   blic static final int CRASHTYPE_JAVA_CRASH = 0; // Java ch
    public static final int CRASHTYPE_JAVA_CATCH = 1; /ava caught exception
    public static final int CRASHTYPE_NATIVE = 2; Native crash
    public static final int CRTYPE_U3D = 3; // Unity error
    public static final int CRASHTYPE_ANR = 4; // ANR
    public static final int CRASHTYPE_COCOS2DX_JS = 5; // Cocos JS error
    public static final int CRASHTYPE_COCOS2DX_LUA = 6; // Cocos Lua error

    /**
     * Crash处理.
     *
     * @param crashType 错误类型：CRASHTYPE_JAVA，CRASHTYPE_NATIVE，CRASHTYPE_U3D ,CRASHTYPE_ANR
     * @param errorType 错误的类型名
     * @param errorMessage 错误的消息
     * @param errorStack 错误的堆栈
     * @return 返回额外的自定义信息上报
     */
    public abstract Map<String, String> onCrashHandleStart(int crashType, String errorType,
            String errorMessage, String errorStack);

    /**
     * Crash处理.
   *
     * @param crashType 错误类型：CRASHTYPE_JAVA，CRASHTYPE_NATIVE，CRASHTYPE_U3D ,CRASHTYPE_ANR
     * @param errorType 错误的类型名
     * @param errorMessage 错误的消息
     * @param errorStack 错误的堆栈
     * @return byte[] 额外的2进制内容进行上报
     */
    public abstract byte[] onCrashHandleStart2GetExtraDatas(int crashType, String errorType, 
            String errorMessage, String errorStack);

}

设置方法如下：

serStrategy strategy = new UserStrategy(appContext);
strategy.setCrashHandleCallback(new CrashReport.CrashHandleCallback() {
    public Map<String, String> onCrashHandleStart(int crashType, String errorType, 
            String errorMessage, String errorStack) {
        LinkedHashMap<Stg, String> ma new LinkedHashMap<String, String>();
        map.put("Key", "Value");
        return map;
    }

    @Override
    public byte[] onCrashHandleStart2GetExtraDatas(int crashType, String errorType, 
            String errorMessage, String errorStack) {
        try {
            return "Extra data.".getBytes("UTF-8");
        } catch (Exception e) {
            return null;
        }
    }

});
CrashReport.initCrashReport(appContext, APPID, true, strategy);

两个回调返回的数据将伴随Crash一起上报到Bugly平台，并展示在附件中：

注意，需要尽量保证回调的逻辑简单和稳定，绝对不能在回调中Kill掉进程，否则会影响Crash的上报。如果需要执行类似于Crash之后Kill掉进程并重新拉起的动作，建议自定义一个Crash handler，并在初始化Bugly之前注册。

10.Javascript的异常捕获功能

Bugly Android SDK 1.2.8及以上版本提供了Javaspt的异常捕获和上报能力，以便开发者可以感知到 WebView中发生的Javascript异常。

**
* 设置Javascript的异常监控
* 
* @param webView 指定被监控的webView
* @param autoInject 是否自动注入Bugly.js文件
* @return true 设置成功；false 设置失败
*/
CrashReport.setJavascriptMonitor(WebView webView, boolean autoInject)

“Bugly.js”文件在Bugly SDK包中，可以在HTML手动嵌入；
如果使用自动集成SDK方式，可以使用自动注入和手动注入两种方式。如果使用自动集成＋手动注入的方式需要下载“Bugly.js”文件；
ndroid 4.4下版本存在反射漏洞，接口默认只对Androi 4.4及以上版本有效；
接口不会设置webView的WbViewClient和Listener；
接口默认会开启webViw的JS执行能力；
如果使用了非Android官方的WebView（例如使用X5内核），需要下载2.5.0或以上版本Bugly Android SDK并按照以下方法使用：

 CrashReport.ViewInterface webView = new CrashReport.WebViewInterface() {
    /**
     * 获取WebView URL.
     *
     * @return WebView URL
     */
    @Override
    public String getUrl() {
        // 下面仅为例子，请用真正逻辑代替
        return <第三方WebView对象>.getUrl();
    }

    /**
     * 开启JavaScript.
     *
     * @param flag e表示开启，false表示关闭
     */
    @Override
    public void setJavaScriptEnabled(boolean flag) {
        // 下面仅为例子，请用真正逻辑代替
        WebSettings webSettings = <第三方WebView对象>.getSettings();
        webSettings.setJavaScriptEnabled(flag);
    }

    /**
     * 加载URL.
     *
     * @param url 要加载的URL
     */
    @Override
    public void loadUrl(String url) {
        // 下面仅为例子，请用真正逻辑代替
        <第三方WebView对象>.loadUrl();
    }

    /**
     * 添加JavaScript接口对象.
     *
     * @param jsInterface JavaScript接口对象
     * @param name JavaScript接口对象名称
     */
    @Override
    public void addJavascriptInterface(H5JavaScriptInterface jsInterface, String name) {
        // 下面仅为例子，请用真正逻辑代替
        <第三方WebView对象>.addJavascriptInterface(jsInterface, name);
    }

/**
     * 获取WebView的内容描述.
     *
     * @return WebView的内容描述.
     */
    @Override
    public CharSequence getContentDescription() {
        // 下面仅为例子，请用真正逻辑代替
        return <第三方WebView对象>.getContentDescription();
    }
};
// 调用Bugly设置JS异常捕获接口时传入创建的WebView接口对象即可

自动注入
建议在WebChromeClient的onProgressChanged函数中调用接口：

CrashReport.setJavascriptMonitor(webView, true);

例子如下：

ebView webView = new WebView(this);
// 设置WebChromeClient
webView.setWebChromeClient(new WebChromeClient() {
    @Override
    public void onProgressChanged(WebView webView, int progress) {
        // 增加Javascript异
        CrashReport.setJavascriptMonitor(webView, tr;
        super.onProgressChanged(webView, progress);
 }
});
// TML
webView.loadUrl(url);

手动注入

下载Bugly.js文件并添加到需要监控Javascript异常的HTML中：

<html>
  <script src="bugly.js" ></script>
<body>
    ...
</body>
</html>

在WebView加载完该HTML后设置Javascript的异常捕获功能：

ebView webView = new WebView(this);
// 加载HTML
webView.loadUrl(url);
// 增加Javascript异常监控
CrashReport.setJavascriptMonitor(webView, false);

在Bugly Android SDK捕获到Javascript异常后会上报以下信息：

Android设备的相关信息；
Javascript异常堆栈和其他信息；
ava堆栈；
WebView的信息，目前只包括ContentDescription。

11.更多的Bugly日志附加信息

我们提供了一些信息记录AP补充额外的内容。这些信息会随着异常一起上报。例如App环境、用户属性等等。主要包含以下
1）设置用户ID
您可能会希望能精确定位到某个用户的异常，我们提供了用户ID记录接口。例：网游用户登录后，通过该接口记录用户ID，在页面上可以精确定位到每个用户发生Crash的情况。

rashReport.setUserId("9527");  //该用户本次启动后的异常日志D都将是9527

2）主动上报开发者Catch的异常
您可能会关注某些重要异常的Catch情况。我们提供了上报这类异常的接口。例：统计某个重要的数据库读写问题比例。

try {
    //...
} catch (Throwable thr) {
    ashReport.postCatchedException(thr);  // bugly会将这个throwable上报
}

3）自定义日志功能
我们提供了自定义Log的接口，用于记录一些开发者关心的调试日志，可以更全面地反应App异常时的前后文环境。使用方式与android.util.Log一致。用户传入TAG和日志内容。该日志将在Logca，并在发生异常时上报。有如下

BuglyLog.v(tag, log)
BuglyLog.d(tag, log)
Bugly.i(tag, log)
BuglyLog.w(tag, log)
BuglyLog.e(tag, log)

注意：

使用BuglyLog接口时，为磁盘IO次数，我们会先将日志缓存在内存中。当缓存大于一定阈值（默认10K），会将它持久化至文件。您可以通过setCache(int byteSize)接口设置缓存大小，范围为0-30K。例：BuglyLog.setCache(12 * 4) //将Cache设置为12K
如果您没有使用BuglyLog接口，且初始化Bugly时isDebug参数设置为false，该Log功能将不会有新的资源占用；
为了方便开发者调试，当初始化Bugly的isDebug参数为true时，异常日志同时还会记录ly本身的日志。请在App发布时将其设置为false；
上报Log最大30K。
4）添加额外的SO文件信息
为了更好得区分不同构建或者版本的SO文件以方便地管理Native代码，建议给SO文件加上独立的版本号或者UUI5）SO文件的版本号
在任意一个源码文件（建议是专门控制版本相关信息的源码文件）中加入一行：

extern "C" const char SO_FILE_VERSION[]  __attribute__ ((section (".bugly_version"))) = "<SO文件版本号>"

此后，NDK编译的SO文件将带有一个具有版本信息的段（.bugly_version）。之所以把段名定义为“.bugly_version”，是为了Bugly的NDK解析的统一性。查看SO文件的版本号的一个方法如下（需要readelf或类似工具）：

eadelf -p .bugly_version libxxx.so

其中“readelf”是GNU Binary Utilities一个工具，用于解析ELF格式文件（SO文件属于ELF格式文件）。Linux下默认安装了；Windows下可使用NDK提供的readelf（\toolchains\xxx\prebuitndowsxxx\bin\xxxreadelf.exe）或者安装MinGW或者Cygwin；Mac下如果没有该工具，可从GNU Binary Utilities官网下载安装或者使用NDK提供的readelf。
6SO文件的UUID
在“Android.mk”文件中加上一行：
LOCAL_LDFLAGS += -Xlinker --build-id
此后，NDK构建的SO文件将带有一个段（.note.gnu.buildid）专门存放构建的UUID。查看SO文件的D的一个方法如下（需要readelf或类似工具）：

readelf -x .notnu.build-id libxxx.so

Native堆栈例子如下图（UUID不在堆栈中显示）：

Android SDK集成