前言

大家好,我是林三心,用最通俗易懂的话讲最难的知识点是我的座右铭,基础是进阶的前提是我的初心。

背景

公司有很多的项目,但是并不是每一个项目都很重要,其实重要的项目就那么几个,上面也是很重视这几个项目,尤其是对一些生产问题的关注度很高。

这几天上面交代下来了,需要对这些项目做一些用户行为的记录,主要是为了更好地还原用户在某一个时间点的操作过程

注意点

想要完成这个需求,仔细想了一下,需要注意几个点:

  • 跨框架使用: 这些项目有vue、angular、react,需要都能适用
  • 能录制用户行为: 能把用户在页面上的操作录制下来
  • 能回放录制: 如果不能回放,那么这个录制就无意义了
  • 用户无感知: 必须做到用户无感知才行

思考 & 技术方案

说到前端视频的录制,我们会想到 webRTC 这个技术,他能做到录制屏幕的效果,但是通过 webRTC 去完成这个方案的话,有几个缺点:

  • 做不到用户无感知,需要用户同意才能录制
  • 录制的视频太大了,太占内存了
  • 学习成本比较高,这也是原因之一

那怎么才能做到:

  • 用户无感知
  • 不录制视频

其实只要不录制视频了,那么用户肯定就无感知,因为一旦要录视频,浏览器肯定要询问用户同意不同意。

所以我们选择了另一个方案 rrweb,一个用来录制用户页面行为的库~

rrweb

rrwebrecord and replay the web 的简写,旨在利用现代浏览器所提供的强大 API 录制并回放任意 web 界面中的用户操作。

效果展示

基本使用

我们先定义好 html 结构,三个按钮

  • 录制:点击开始录制
  • 回放:点击开始回放
  • 返回:点击重新再来

还有一个 replayer ,用来当做回放的容器

 1<template>
 2  <div class="main">
 3    <div >
 4      <el-button @click="record">录制</el-button>
 5      <el-button @click="replay">回放</el-button>
 6      <el-button @click="reset">返回</el-button>
 7    </div>
 8    <div v-if="!showReplay">
 9      <div>
10        <el-input style="width: 300px" v-model="value" />
11      </div>
12      <div>
13        <el-button>按钮1</el-button>
14      </div>
15      <div>
16        <el-button>按钮2</el-button>
17      </div>
18      <div>
19        <el-button>按钮3</el-button>
20      </div>
21    </div>
22    <div ref="replayer"></div>
23  </div>
24</template>
25

我们需要先安装两个包:npm i rrweb rrwebPlayer

  • **rrweb:**用来录制网页的
  • **rrwebPlayer:**用来回放的

rrweb拥有一个 record 函数来进行录制操作,并可传入配置,emit属性就是用户操作的监听函数,接收一个参数event,这个参数是什么,我们后面会说~

然后我们定义三个函数:

  • record:录制函数
  • replay:回放函数
  • reset:返回/重置函数
 1const rrweb = require("rrweb");
 2import rrwebPlayer from "rrweb-player";
 3
 4const events = ref([]);
 5const stopFn = ref(null);
 6const showReplay = ref(false);
 7const replayer = ref(null)
 8
 9const record = () => {
10  console.log("开始录制");
11  stopFn.value = rrweb.record({
12    emit: (event) => {
13      events.value.push(event);
14    },
15    
16    recordCanvas: true,
17    collectFonts: true,
18  });
19};
20const replay = () => {
21  stopFn.value();
22  showReplay.value = true;
23  new rrwebPlayer({
24    
25    target: replayer.value,
26    
27    props: {
28      
29      events: events.value,
30    },
31  });
32};
33const reset = () => {
34  showReplay.value = false;
35  events.value = []
36};

录的是视频吗?

我们之前说了:一旦要录视频,浏览器肯定要询问用户同意不同意。但是我们发现我们使用 rrweb 去录制,浏览器并没有询问,做到了无感知~所以我们可以推断出,rrweb 录制的并不是视频,那录制的是什么呢?

我们其实可以试着去输出一下刚刚的参数 event 看看是什么

 1rrweb.record({
 2    emit: (event) => {
 3        
 4+      console.log(event)
 5      events.value.push(event);
 6    },
 7});

我们可以看到这个event记录的东西是当前页面的DOM结构,当用户操作页面时,rrweb会将每一次的DOM结构转换成对象形式,通过 emit 函数的第一个参数输出,我们使用一个数组去记录这一次次的DOM结构,然后把它传给rrweb-player,它能将这些DOM结构按照先后顺序,一个一个展示出来,自然就相当于是视频的展示效果了~

rrweb能记录这些页面的 DOM 行为:

  • 节点创建、销毁
  • 节点属性变化
  • 文本变化
  • 鼠标移动
  • 鼠标交互
  • 页面或元素滚动
  • 视窗大小改变
  • 输入

上传 & 优化

我们记录的这些数据,需要上传到后端那边去,方便后续在后台管理系统里管理这些回放~

很多人会说这样一直录制,那岂不是数据量很大?所以我觉得只有在一些重要的页面,才需要做录制行为的操作,而不是每一个页面都去做这样的操作~

并且每次上传需要一定的时间间隔,不能上传太频繁,不然浏览器压力会增大~

 1const record = () => {
 2  console.log("开始录制");
 3  stopFn.value = rrweb.record({
 4    emit: (event) => {
 5      events.value.push(event);
 6    },
 7    recordCanvas: true,
 8    collectFonts: true,
 9  });
10};
11
12const report = async () => {
13  await reportRequest(events.value);
14  events.value = [];
15}
16
17
18setInterval(report, 10 * 2000);

同时,虽然现在上传的是DOM结构的对象,大小远远比视频小,但是其实还是不小的

所以我们需要采取措施,去压缩一下数据,压缩后再进行上传,这样能降低服务器的压力~我们可以使用packFn属性来对录制的数据进行压缩,同时回放时也要用unpackFn去解码

 1const record = () => {
 2  console.log("开始录制");
 3  stopFn.value = rrweb.record({
 4    emit: (event) => {
 5      events.value.push(event);
 6    },
 7    recordCanvas: true,
 8    collectFonts: true,
 9+    packFn: rrweb.pack
10  });
11};
12
13const replay = () => {
14  stopFn.value();
15  showReplay.value = true;
16  new rrwebPlayer({
17    
18    target: replayer.value,
19    
20    props: {
21      
22      events: events.value,
23+      unpackFn: rrweb.unpack,
24    },
25  });
26};

结语 & 加学习群 & 摸鱼群

我是林三心

  • 一个待过小型toG型外包公司、大型外包公司、小公司、潜力型创业公司、大公司的作死型前端选手;
  • 一个偏前端的全干工程师;
  • 一个不正经的掘金作者;
  • 一个逗比的B站up主;
  • 一个不帅的小红书博主;
  • 一个喜欢打铁的篮球菜鸟;
  • 一个喜欢历史的乏味少年;
  • 一个喜欢rap的五音不全弱鸡

如果你想一起学习前端,一起摸鱼,一起研究简历优化,一起研究面试进步,一起交流历史音乐篮球rap,可以来俺的摸鱼学习群哈哈,点这个,有7000多名前端小伙伴在等着一起学习哦 —> 摸鱼沸点

个人笔记记录 2021 ~ 2025