hx-event v1.1.6

打点SDK-小程序

介绍

基于 Taro开发，为公司内部小程序项目提供独立的打点SDK。

安装

npm install hx-event / yarn add hx-event

使用

1.在小程序启动入口app.jsx的初始化方法componentDidMount中调用SDK初始化方法init

 componentDidMount() {
   /**
    * @appId 当前项目所对应的appId
    * 患者端微信小程序 - 013
    * 患者端QQ小程序  - 015
    */
    hxEvent.init(appId);
  }

具体获取参照 https://shimo.im/sheets/uhbR1dP8Pb0Tzno4/H4iy7，获取过程有任何问题，可直接联系索隆。

2.SDK提供了onEvent、onPageStart、onPageEnd三个打点方法，分别用于事件打点、页面统计。

  /**
   * 事件打点
   * @param  eventId 事件id
   * @param  params 携带参数
   */
  onEvent(eventId = "", params = {}) 

  /**
   * 页面可见的时候调用onPageStart
   */
  onPageStart(eventId) 
  /**
   * 页面不可见的时候调用onPageEnd
   */
  onPageEnd(eventId, params)

页面统计是在页面可见与不可见时调用，在页面的生命周期方法中直接调用。

进阶

1.事件统计的参数会默认携带eventDate、userAgent、userId。

userId用做统计当前事件的PV。 需要手动进行设置setUserId，只需设置一次。若不进行设置，则需要开发人员放入额外参数中。

  /**
   * 存入userId
   * @param {} userId
   */
  setUserId(userId)

2.为了避免线下测试产生脏数据，SDK中提供线下线上两个域名进行打点。

生产：https://gw.aistarfish.com/api/log/upload
测试：https://gateway-d9200.aistarfish.net/api/log/upload

SDK中默认设置isDebug=true为测试环境，发布生产环境，需手动修改isDebug=false

/**
 * 设置打点开发环境
 * @param {*} b 
 */
 setIsDebug(isDebug)