嵌码向导工具
帮助使用相关SDK产品的用户,提供快速便捷的嵌码方式。
适配范围
当前仅适配Android、iOS、Web应用。
工具下载
用户根据当前系统架构,到ONE平台下载二进制可执行文件(支持架构:macOS arm64、macOS x64、win-x64)。

执行方式
针对不同运行环境,建议通过命令行执行。 在需要嵌码的项目根目录启动终端,将可执行文件拖入进去,并执行。
iOS
以iOS项目的根目录(.xcodeproj所在的目录)为工作目录,执行${ONE-SDK-wizard} -i ios。
ONE-SDK wizard执行以下操作:
- 向 Podfile 中添加
BonreeRUM,并执行pod repo update、pod install --silent; - 向 AppDelegate 或者 SwiftUI 应用的 init 方法中添加探针启动代码;
Android
以Android项目的根目录(包含 settings.gradle 或 build.gradle 的目录)为工作目录,执行${ONE-SDK-wizard} -i android。
ONE-SDK wizard执行以下操作:
Gradle自动化配置,会自动修改以下文件:settings.gradle(.kts):- 在
pluginManagement中注入博睿专用Maven仓库(用于解析插件)。 - 在
dependencyResolutionManagement中注入仓库(用于解析库依赖)。
- 在
- 根目录
build.gradle(.kts):- 自动添加
buildscript闭合块及classpath插件依赖。
- 自动添加
- App 模块
build.gradle(.kts):- 应用插件:
apply plugin: 'bonree'。 - 添加依赖:
implementation 'com.bonree.agent.android:agent-lib:...'。
- 应用插件:
AndroidManifest.xml清单文件与权限处理:- 自动在
Application.onCreate()或MainActivity.onCreate()的super.onCreate()之后插入初始化代码 - 修改
proguard-rules.pro文件,加入混淆规则。
Web
以Web项目的根目录为工作目录,执行${ONE-SDK-wizard} -i web。
ONE-SDK wizard执行以下操作:
- 扫描列举出项目中存在的所有
html文件,供用户选择需要嵌码的文件(可多选)。 - 平台选择相关环境和应用后,下载相关版本的
BonreeSDK_JS.min.js文件。 - 扫描项目是否存在
package.json文件,根据结果判断BonreeSDK_JS.min.js文件存放位置(因为Web项目比较灵活和多变,所以BonreeSDK_JS.min.js文件保存位置,采用通用的方式)。 - 将嵌码片段和
BonreeSDK_JS.min.js文件引用路径构成的script标签添加到html文件中。