小程序SDK接入说明

1、SDK的说明

该SDK结合超同工具的算法可以计算出小程序、小游戏的首屏加载时间和非首屏加载时间，并将这类数据结合SDK中捕获到的运行时Js-Error堆栈信息一起上报以做数据分析使用。

2、SDK的兼容性介绍

目前已支持多种平台的小程序和小游戏使用，具体支持情况如下：

• 微信小程序
• 微信小游戏
• qq小程序
• qq小游戏
• uniapp小程序
• mpvue小程序

注意：
1.JsError捕获的是微信运行时错误，目前SDK暂不支持上报非运行时错误堆栈信息。
2.对于使用第三方游戏引擎开发的小游戏，目前SDK无法捕获到其运行时的报错。

3、小程序SDK接入操作步骤

使用说明
请确保导入SDK的位置位于项目入口文件的顶部，以便SDK能正常工作。以下是各项目入口文件参考(“/”代表根目录)：

• 小程序: /app.js
• 小游戏: /game.js
• uniapp: /main.js
• mpvue: /src/main.js

以下是几种 sdk 的导入方式：
（1）下载指定环境的js文件到本地项目中（下载文件联系客服获取，建议使用下面第二种npm包导入方式），使用模块化方式导入：

- require('./utils/applet-sdk') // CommonJs 方式导入
- import './utils/applet-sdk' // 或者 ESM 方式导入，具体看项目环境的支持情况

（2）在项目中使用 npm 包的方式导入
1.安装 applet-sdk 依赖包

# 在项目根目录中使用开发者工具打开终端并执行
npm install applet-sdk

2.使用开发者工具构建 npm ，将 npm 包拷贝到 miniprogram_npm 目录中，具体操作如下图所示：

在项目中导入即可生效

import 'applet-sdk'

注意: 对于小游戏项目，必须将 sdk 导入代码放到游戏主包或者游戏适配器文件加载的后面，不然可能会导致游戏画面黑屏，具体如下：

import Main from './js/main'
import 'applet-sdk'
new Main()

4、配置域名

登录微信公众平台，进入到开发->开发管理，找到服务器域名模块，将wetest域名https://atc.cloudtest.qq.com添加到request合法域名中。

5、SDK是否生效检查

SDK接入成功后， 启动小程序/小游戏会检测后台是否配置atc.cloudtest.qq.com白名单，并弹框提示检测结果。如下图：

• 已配置白名单将出现提示，如下图所示：
  
• 未配置白名单将出现提示，如下图所示：
  
• 剪贴板格式设置
  SDK接入成功后，会弹框提示剪贴板解析错误，如下图所示：
  

注：这是因为SDK通过剪贴板与平台进行数据互通。接入SDK后可忽略此问题。
出现上述任何一个弹框，都说明SDK接入成功。如果没有弹框，说明SDK未接入。
如果后续没有出现其他报错弹框，则表示SDK数据上报成功。