SDK集成指南

SDK集成

本地

一、预置Bonree SDK环境

解压BonreeSDK_TDEM_Android.v${VERSION_NAME}.zip暂存本地（如E:）；

拷贝jniLibs目录内容覆盖打包module目录级别下存放so动态库的jniLibs目录中（如果项目中没有jniLibs目录，请创建jniLibs目录）；

拷贝repo文件夹到所有的Project根目录下，与module目录同级；

拷贝com.bonree.sdk.jar到module级别的libs目录下；

注意：Mac下，解压的文件夹路径最好放在/Users/xxxx/目录下，放在系统目录下，由于权限可能导致一些难以预计的问题

二、配置Gradle

1. Gradle 7.0 以下版本

打开所有Project级别根目录下的build.gradle文件

在build.gradle文件中加入以下红框内的三项配置脚本，并点击Sync Now按钮

ext.brsdk_version = '8.0.0' //ext.brsdk_version的值是sdk的版本号，通常在您下载的压缩包文件名的末尾或在下载中心查看。

maven { url uri('./repo') }

classpath "com.bonree.agent.android:bonree:$brsdk_version"

打开所有module级别目录下的build.gradle文件

在dependencies模块中加入代码

implementation files('libs/com.bonree.sdk.jar')

在文件头部引入Bonree插件

apply plugin: 'bonree'

2. Gradle 7.0 及以上版本

打开Project根目录下的settings.gradle文件

在settings.gradle文件中加入以下红框内的配置内容,并点击SyncNow按钮

maven { url uri('./repo') }

打开Project根目录下的build.gradle文件

添加红框部分的内容并点击Sync Now按钮

  buildscript {
    ext.brsdk_version = '8.0.0'
    dependencies {
        classpath "com.bonree.agent.android:bonree:$brsdk_version"
    }
}

打开主Module目录下的build.gradle文件,在dependencies中加入以下配置,并点击SyncNow按钮

implementation files('libs/com.bonree.sdk.jar')

并在该文件头部引入Bonree插件,并点击SyncNow按钮

三、Rebuid & Clean项目

Rebuild & Clean项目，确保Bonree配置生效。

远程

一、配置Gradle

1. Gradle 7.0 以下版本

打开所有Project级别根目录下的build.gradle文件

在build.gradle文件中加入以下红框内的三项配置脚本，并点击Sync Now按钮

ext.brsdk_version = '8.0.0'
//ext.brsdk_version的值是sdk的版本号，具体版本号可在下载中心查阅

maven {
  url 'https://gitlab.bonree.com/BonreeSDK_TAPM/Android/raw/master'
}

classpath "com.bonree.agent.android:bonree:$brsdk_version"

打开所有module级别目录下的build.gradle文件

在dependencies模块中加入代码

implementation "com.bonree.agent.android:agent-lib:$brsdk_version"

在文件头部引入Bonree插件

apply plugin: 'bonree'

1. Gradle 7.0 及以上版本

打开Project根目录下的settings.gradle文件

在settings.gradle文件中加入以下红框内的配置内容,并点击SyncNow按钮

maven {
  url 'https://gitlab.bonree.com/BonreeSDK_TAPM/Android/raw/master'
}

打开Project根目录下的build.gradle文件

添加红框部分的内容并点击Sync Now按钮

  buildscript {
    ext.brsdk_version = '8.0.0'
    dependencies {
        classpath "com.bonree.agent.android:bonree:$brsdk_version"
    }
}

打开主Module目录下的build.gradle文件,在dependencies中加入以下配置,并点击SyncNow按钮

implementation "com.bonree.agent.android:agent-lib:$brsdk_version"

并在该文件头部引入Bonree插件,并点击SyncNow按钮

二、Rebuid & Clean项目

Rebuild & Clean项目，确保Bonree配置生效。

SDK接入

一、配置授权信息

检查应用程序AndroidManifest.xml配置文件，尽量确保已引入如下授权：

//详情说明可参阅《隐私政策》中权限说明部分
//必要权限:
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
//非必要权限:
<uses-permission android:name="android.permission.BLUETOOTH" />
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
<uses-permission android:name="android.permission.READ_PHONE_STATE" />

二、配置混淆信息

若您的应用使用proguard混淆，请添加如下配置：

#ProGuard configurations for Bonree-Agent
-keep class com.bonree.**{*;}
-keep class bonree.**{*;}
-keep class okhttp3.** { *; }
-keep class okio.**{*;}

-dontwarn com.bonree.**
-dontwarn bonree.**
-dontwarn okhttp3.**
-dontwarn okio.**
#End Bonree-Agent

若您的proguard混淆配置文件中没有-dontoptimize配置，请务必追加如下配置：

-optimizations !code/simplification/*,!field/*,!class/merging/*,!method/propagation/*,!class/unboxing/enum,!code/allocation/variable

三、初始化SDK

<#Config地址#> 与 <#AppID#> 请于平台上获取，获取方式参见《如何查询AppID和Config地址？》。如有问题请联系技术支持。

请在自定义Application的onCreate函数中，添加如下代码:

java:

Bonree.withAppID("<#AppID#>")
    .withConfigAddress("<#Config地址#>")
    .start(getApplicationContext());

kotlin:

Bonree.withAppID("<#AppID#>")
    .withConfigAddress("<#Config地址#>")
    .start(getApplicationContext());

调用示例：

public class App extends Application {

    @Override
    public void onCreate() {
        super.onCreate();
        Bonree.withAppID("#AppID#>")
                .withConfigAddress("<#Config地址#>")
                .start(getApplicationContext());
    }
}

四、Webview数据采集

采集WebView数据需调用WebViewClient和WebChromeClient组件的支持。

情况1:如果业务代码中不需要添加自定义的client，可以不额外增加对setWebViewClient或setWebChromeClient的设置调用。

情况2:如果业务需要设置client，请在设置时不要出现如下代码.

java:

没有正确重写结构体, 影响webview数据正常采集!
错误示例:
webview.setWebViewClient(new WebViewClient());
或
webview.setWebChromeClient(new WebChromeClient());

在代码中正确的重写结构体，则不会影响webview的数据采集！
正确示例:
webView.setWebChromeClient(new WebChromeClient(){});
webView.setWebViewClient(new WebViewClient(){});
或
CustomWebClient customWebClient = new CustomWebClient();
// CustomWebClient 继承自WebViewClient
webView.setWebViewClient(customWebClient);
或
webView.setWebViewClient(new WebViewClient(){
@Override
public void onPageStarted(WebView view, String url, Bitmap favicon) {
super.onPageStarted(view, url, favicon);
//do something...
}
});

kotlin:

没有正确重写结构体, 影响webview数据正常采集!
错误示例:
webView!!.webViewClient = WebViewClient()
或
webView!!.webChromeClient = WebChromeClient()

在代码中正确的重写结构体，则不会影响webview的数据采集！
正确示例:
webView!!.webChromeClient = object : WebChromeClient() {}
webView!!.webViewClient = object : WebViewClient() {}
或
// CustomWebClient 继承自WebViewClient
val customWebClient = CustomWebClient()
webView!!.webViewClient = customWebClient
或
webView!!.webViewClient = object : WebViewClient() {
override fun onPageStarted(view: WebView, url: String, favicon: Bitmap) {
super.onPageStarted(view, url, favicon)
//do something...
}
}

五、嵌码验证

启动已嵌码的apk，查看logcat日志，搜索brsdk关键字(或者过滤BRSDK-Agent标签)，出现如下log则表示嵌码成功且数据开始采集：

Brsdk is starting （注：BRAgent 集成成功） 
BRAgent enable （注：BRAgent 启动成功） 
BRAgent connect server success （注：BRAgent 数据设置成功） 
BRAgent v*** （注： ***为当前zip包文件名后所对应的BRAgent版本）

Log探针集成

本地集成

一、预置Bonree SDK环境

将下载的日志SDK的com.bonree.log.jar文件复制到工程（此处截图示例Demo为例子）module级别的 libs 目录下。如图所示：

dir

二、同步gradle

打开module级别目录下的build.gradle文件, 在dependencies模块中加入代码并点击Sync Now按钮。

implementation files('libs/com.bonree.log.jar')

dependency

三、Rebuid & Clean项目

Rebuild & Clean项目，确保Bonree配置生效。

clean

四、配置授权信息

检查应用程序AndroidManifest.xml配置文件，尽量确保已引入如下授权：

⁢uses-permission android:name="android.permission.INTERNET"/>
uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
⁢uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>

五、配置混淆信息

#ProGuard configurations for Bonree-Log
-keep class com.bonree.**{*;} 
-keep class bonree.**{*;}
-dontwarn com.bonree.** 
-dontwarn bonree.** 
#End Bonree-Log

远程依赖

一、集成版本

下载中心查看Bonree Log SDK最新版本号，确定想要集成的版本。

二、同步gradle

打开module级别目录下的build.gradle文件，在dependencies模块中加入代码并点击Sync Now按钮。

implementation 'com.bonree.log:log:1.0.0'

三、Rebuid & Clean项目

Rebuild & Clean项目，确保Bonree配置生效。

clean

SDK集成​

本地​

一、预置Bonree SDK环境​

二、配置Gradle​

1. Gradle 7.0 以下版本​

2. Gradle 7.0 及以上版本​

三、Rebuid & Clean项目​

远程​

一、配置Gradle​

1. Gradle 7.0 以下版本​

1. Gradle 7.0 及以上版本​

二、Rebuid & Clean项目​

SDK接入​

一、配置授权信息​

二、配置混淆信息​

三、初始化SDK​

四、Webview数据采集​

五、嵌码验证​

Log探针集成​

本地集成​

一、预置Bonree SDK环境​

二、同步gradle​

三、Rebuid & Clean项目​

四、配置授权信息​

五、配置混淆信息​

远程依赖​

一、 集成版本​

二、同步gradle​

三、Rebuid & Clean项目​

SDK集成

本地

一、预置Bonree SDK环境

二、配置Gradle

1. Gradle 7.0 以下版本

2. Gradle 7.0 及以上版本

三、Rebuid & Clean项目

远程

一、配置Gradle

1. Gradle 7.0 以下版本

1. Gradle 7.0 及以上版本

二、Rebuid & Clean项目

SDK接入

一、配置授权信息

二、配置混淆信息

三、初始化SDK

四、Webview数据采集

五、嵌码验证

Log探针集成

本地集成

一、预置Bonree SDK环境

二、同步gradle

三、Rebuid & Clean项目

四、配置授权信息

五、配置混淆信息

远程依赖

一、集成版本

二、同步gradle

三、Rebuid & Clean项目