Vue手动埋点设计的方法实例

 更新时间:2022年03月11日 09:19:11   作者:奇幻心灵  
这篇文章主要给大家介绍了关于Vue手动埋点设计的相关资料,内容简明扼要并且容易理解,绝对能使你眼前一亮,需要的朋友可以参考下

目标

  • 使用简单;
  • 减少代码侵入性,不影响业务代码阅读

简述

  • 埋点一般是按页面来管理的;
  • 埋点的事件类型一般分为:点击、曝光和页面的进入和离开;
  • 埋点的实质就是在恰当的时机去发送请求,上送业务参数

按页面管理埋点

在每个页面目录下创建events.js,管理当前页面的所有埋点事件。

为了减少埋点对业务代码的影响,events.js中每个埋点的设置都是一个方法,可以在这个方法中处理数据得到埋点需要上送的数据。

该埋点设置的方法,返回一个埋点需要上送的参数的对象。

// src/views/PageA/events.js

export default {
  // 按事件类型管理
  CLICK: {
    back(ctx, data) {
      let { param1, param2 } = data;
      // ...处理传入的数据
      return {
        eventValue: '返回',
        elementId: 'pageA-返回',
        // 需要上送的处理后的业务参数
        customData: {
          param1,
          param2
        }
      };
    }
  }
}

遵循使用简单的原则,调用埋点

// src/views/PageA/index.vue

this.$track('CLICK.back', data);

实现上面的调用

  • 使用require.context()聚合各个页面目录下的埋点设置(events.js)。
  • 聚合后的埋点设置按页面作为模块管理,使用页面文件夹名称作为模块名。
  • 结合路由管理,可以获得当前页面的埋点配置模块名。
  • 在Vue.prototype下新增一个$track()方法。
// src/events/index.js
import router from '@/router';

const ctx = require.context('@/views', true, /events\.js/);
const configs = {};
ctx.keys().reduce((configs, path) => {
  if (/\.\/(\w+?)\/events\.js/.test(path)) {
    const moduleName = RegExp.$1; // 第一个子项
    configs[moduleName] = resolveModule(moduleName, ctx(path));
  }
  return configs;
}, configs);

function resolveModule(moduleName, module) {
  return Object.entries(module.default).reduce((all, [EVENT_TYPE, events]) => {
    all[EVENT_TYPE] = Object.keys(events).reduce((typeAll, key) => {
      typeAll[key] = buildTrackRequest(
        EVENT_TYPE.toLowerCase(),
        key,
        events[key]
      );
      return typeAll;
    }, {});
  });
}

function buildTrackRequest(eventType, trackName, trackSetting) {
  return function trackRequest(...args) {
    // 看完后面再回过来看
    if (typeof trackSetting !== 'function') {
      trackSetting = obj2fn(trackSetting);
    }
    // 执行用户定义的方法,返回埋点上送参数
    const [success, result] = invokeUserFn(trackSetting.bind(this, {}));
    if (!success) return result;
    // 传入参数,发送埋点请求
    return tracker(result);
  }
}

export function track(eventPath, ...args) {
  let event = configs;
  let seg;
  const segs = eventPath.split('.');
  // 2段式 没有提供模块名,则需要去路由配置上取
  if (segs.length === 2) {
    const moduleName = router.currentRoute.meta?.eventModule;
    if (!moduleName) {
      throwError(`${eventPath} 没有在路由配置中设置"meta.eventModule" 或者配置成3段式`);
    }
    event = event[moduleName];
  }
  while ((seg = segs.shift())) event = event[seg];
  if (!event) throwError(`${eventPath} 不存在`);
  // 给event绑定当前调用环境
  return event.call(this, ...args);
}

function throwError(err) {
  throw Error(`[Track Error] ${err}`);
}

export default function install(Vue) {
  Vue.prototype.$track = track;
}

埋点设置支持对象形式

很多时候,可能不需要上送业务参数,写成一个对象更加简单。

{
  CLICK: {
    back: {
      eventValue: '返回',
      elementId: 'pageA-返回',
    }
  }
}

有时候只需要上送简单的业务字段,无需额外处理,也想使用对象的形式。

支持{{param1}}模板语法,同vue-template用法。(param1是埋点调用组件的属性)

{
  CLICK: {
    back: {
      eventValue: '返回',
      elementId: 'pageA-返回',
      customData: {
        param1: '{{param1}}'
      }
    }
  }
}

将对象格式的埋点配置转成方法形式的

const templateRE = /\{\{(.+?)\}\}/g;
// 处理对象形式的埋点设置
function obj2fn(obj) {
  return function() {
    const that = this;
    // 处理模板字符串
    (function resolveObj(obj) {
      Object.keys(obj).forEach(key => {
        const val = obj[key];
        // 解析模板字符串
        if (typeof val === 'string' && templateRE.test(val)) {
          obj[key] = val.replace(templateRE, (...match) => {
            // js严格模式下无法执行with语法,以下是一种变通
            return new Function(`with(this){return ${match[1]}}`).call(that);
          });
        }
        // 递归处理
        else if (isPlainObject(val)) resolve(val);
      });
    })(obj);
    return obj;
  };
}

提供页面级别的参数设置

很多时候一个页面下的埋点都需要上送相同的参数,如页面名称等。

提供beforeModuleEach和afterModuleEach两个钩子。

一般使用beforeModuleEach设置模块(页面)通用的埋点参数,再合并单独的埋点设置参数,得到所有需要上送的参数。

function resolveModule(moduleName, module) {
  // 获取`events.js`文件中设置的钩子
  const { beforeModuleEach, afterModuleEach } = module;
  // 获取动态设置钩子
  const { beforeHooks, afterHooks } = getHooksByModule(moduleName);
  beforeModuleEach && beforeHooks.unshift(beforeModuleEach);
  afterModuleEach && afterHooks.unshift(afterModuleEach);
  
  return Object.entries(module.default).reduce((all, [EVENT_TYPE, events]) => {
    all[EVENT_TYPE] = Object.keys(events).reduce((typeAll, key) => {
      typeAll[key] = buildTrackRequest(
        EVENT_TYPE.toLowerCase(),
        key,
        events[key],
        beforeHooks,
        afterHooks
      );
      return typeAll;
    }, {});
  });
}

总结

到此这篇关于Vue手动埋点设计的文章就介绍到这了,更多相关Vue手动埋点设计内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • vue 集成jTopo 处理方法

    vue 集成jTopo 处理方法

    这篇文章主要介绍了vue 集成jTopo 处理方法,非常不错,具有一定的参考借鉴价值 ,需要的朋友可以参考下
    2019-08-08
  • vue搜索页开发实例代码详解(热门搜索,历史搜索,淘宝接口演示)

    vue搜索页开发实例代码详解(热门搜索,历史搜索,淘宝接口演示)

    这篇文章主要介绍了vue搜索页开发实例(热门搜索,历史搜索,淘宝接口演示),本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-04-04
  • 详解vue beforeRouteEnter 异步获取数据给实例问题

    详解vue beforeRouteEnter 异步获取数据给实例问题

    这篇文章主要介绍了vue beforeRouteEnter 异步获取数据给实例问题,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-08-08
  • Vue仿今日头条实例详解

    Vue仿今日头条实例详解

    这篇文章主要介绍了Vue仿今日头条实例详解,并把相关代码做了说明,对此有兴趣的朋友参考下吧。
    2018-02-02
  • Vue中对iframe实现keep alive无刷新的方法

    Vue中对iframe实现keep alive无刷新的方法

    这篇文章主要介绍了Vue中对iframe实现keep alive无刷新的方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-07-07
  • vue实现分页组件

    vue实现分页组件

    这篇文章主要为大家详细介绍了vue实现分页组件的具体代码,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-12-12
  • vue项目webpack中配置src路径别名及使用方式

    vue项目webpack中配置src路径别名及使用方式

    这篇文章主要介绍了vue项目webpack中配置src路径别名及使用方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-03-03
  • Vue使用Proxy代理后仍无法生效的解决

    Vue使用Proxy代理后仍无法生效的解决

    这篇文章主要介绍了Vue使用Proxy代理后仍无法生效的解决,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-11-11
  • vue解决跨域问题的几种方式

    vue解决跨域问题的几种方式

    这篇文章主要给大家介绍了关于vue解决跨域问题的几种方式,跨域跨域报错是前端开发中非常经典的一个错误,文中通过代码示例介绍的非常详细,需要的朋友可以参考下
    2023-07-07
  • 浅谈vue中使用图片懒加载vue-lazyload插件详细指南

    浅谈vue中使用图片懒加载vue-lazyload插件详细指南

    本篇文章主要介绍了浅谈vue中使用图片懒加载vue-lazyload插件详细指南,具有一定的参考价值,感兴趣的小伙伴们可以参考一下。
    2017-10-10

最新评论