简介
whome 是一个用户行为收集库，可以用于收集用户的点击、浏览及其它自定义事件的数据。它是一个通用的、轻量级的库，可以在任何 JavaScript 应用中使用。
该库支持通过插件扩展其功能，同时支持本地存储与远程同步两种数据存储方式。
安装
使用 npm 安装最新版本：
npm install whome --save
使用
基本使用
-- -------------------- ---- -------
------ ----- ---- --------
-- --- -----
------------
------ --------------
------- ---------------------
---
-- ----
-------------
---------- ---------------
----- -
--------- -------
-
---配置选项
在初始化时，可以传递一些配置选项：
| 选项 | 类型 | 默认值 | 描述 |
|---|---|---|---|
| appId | string | 无 | 应用 id，必填 |
| logUrl | string | 无 | 日志服务器 URL，必填 |
| plugins | object | {} | 插件配置 |
| isDebug | boolean | false | 是否开启调试模式，会输出调试信息 |
| localStore | boolean | false | 是否启用本地存储，仅在支持 localStorage 的浏览器中有效 |
| maxRetryTimes | number | 3 | 日志上传失败最大重试次数 |
| resetOnError | boolean | false | 日志上传失败之后是否重置事件队列 |
插件功能
whome 支持通过插件扩展其功能，以下是内置的几个插件：
whome-plugin-event-count：统计事件数量whome-plugin-error-catch：捕获页面错误whome-plugin-performance：性能分析whome-plugin-page-info：页面信息收集
只需在初始化中添加插件配置即可启用：
-- -------------------- ---- -------
------ ----- ---- --------
------ ---------------- ---- ---------------------------
------------
------ --------------
------- ----------------------
-------- -
----------- ----------------
-
---
-------------
---------- ---------------
----- -
--------- -------
-
---
----------------------------------------------------------远程同步
whome 支持通过远程接口将用户行为数据上传到服务器，需要在初始化时指定 logUrl 参数。
whome.init({
appId: 'YOUR_APP_ID',
logUrl: 'YOUR_LOG_SERVER_URL'
});本地存储
如果用户的网络环境不好，可以选择启用本地存储，在断网时把数据先存储在本地，后续再上传。
启用本地存储只需在初始化时将 localStore 参数设为 true 即可：
whome.init({
appId: 'YOUR_APP_ID',
logUrl: 'YOUR_LOG_SERVER_URL',
localStore: true
});重试机制
如果日志上传失败，whome 会自动尝试重新上传，最大重试次数可以通过 maxRetryTimes 参数控制，默认为 3。
whome.init({
appId: 'YOUR_APP_ID',
logUrl: 'YOUR_LOG_SERVER_URL',
maxRetryTimes: 5
});错误处理
如果日志上传失败，可以通过 resetOnError 参数控制 whome 该如何处理事件队列：
- 如果为 false（默认值），不做任何处理，保留事件队列，下次上传时继续尝试。
- 如果为 true，清空事件队列，直接停止收集数据。
whome.init({
appId: 'YOUR_APP_ID',
logUrl: 'YOUR_LOG_SERVER_URL',
resetOnError: true
});结论
whome 是一个功能完备的用户行为收集库，支持插件功能和多种数据存储方式，适用于各种类型的 JavaScript 应用。通过本文的介绍，读者可以快速上手 whome，并借此了解用户行为数据采集的基础知识。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005546481e8991b448d1ad7