rrweb

rrweb 纪录片（中文）

我已开通 Github Sponsor， 您可以通过赞助的形式帮助 rrweb 的开发。

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

指南

📚 rrweb 使用指南 📚

🍳 场景示例 🍳

项目结构

rrweb 主要由 3 部分组成：

• rrweb-snapshot，包含 snapshot 和 rebuild 两个功能。snapshot 用于将 DOM 及其状态转化为可序列化的数据结构并添加唯一标识；rebuild 则是将 snapshot 记录的数据结构重建为对应的 DOM。
• rrweb，包含 record 和 replay 两个功能。record 用于记录 DOM 中的所有变更（mutation）；replay 则是将记录的变更按照对应的时间一一重放。
• rrweb-player，为 rrweb 提供一套 UI 控件，提供基于 GUI 的暂停、快进、拖拽至任意时间点播放等功能。

Roadmap

• storage engine: 对大规模 rrweb 数据进行去重
• 在常见场景下对 mutation 数据进行压缩
• 基于新的插件 API 提供更多插件，包括:
  • XHR 插件
  • fetch 插件
  • GraphQL 插件
  • ...

Internal Design

• 序列化
• 增量快照
• 回放
• 沙盒

Contribute Guide

为了保证录制和回放时可以对应到一致的数据结构，rrweb 采用 typescript 开发以提供更强的类型支持。

Typescript 手册

1. Fork 需要修改的 rrweb 组件仓库
2. yarn install 安装所需依赖
3. 修改代码并通过测试
4. 提交代码，创建 pull request

除了添加集成测试和单元测试之外，rrweb 还提供了交互式的测试工具。

使用 REPL 工具

Sponsors

Become a sponsor and get your logo on our README on Github with a link to your site.

Gold Sponsors 🥇

<a href="https://opencollective.com/rrweb/tiers/gold-sponsor/0/website?requireActive=false" target="_blank"></a> <a href="https://opencollective.com/rrweb/tiers/gold-sponsor/1/website?requireActive=false" target="_blank"></a> <a href="https://opencollective.com/rrweb/tiers/gold-sponsor/2/website?requireActive=false" target="_blank"></a> <a href="https://opencollective.com/rrweb/tiers/gold-sponsor/3/website?requireActive=false" target="_blank"></a> <a href="https://opencollective.com/rrweb/tiers/gold-sponsor/4/website?requireActive=false" target="_blank"></a> <a href="https://opencollective.com/rrweb/tiers/gold-sponsor/5/website?requireActive=false" target="_blank"></a> <a href="https://opencollective.com/rrweb/tiers/gold-sponsor/6/website?requireActive=false" target="_blank"></a>

Silver Sponsors 🥈

<a href="https://opencollective.com/rrweb/tiers/silver-sponsor/0/website?requireActive=false" target="_blank"></a> <a href="https://opencollective.com/rrweb/tiers/silver-sponsor/1/website?requireActive=false" target="_blank"></a> <a href="https://opencollective.com/rrweb/tiers/silver-sponsor/2/website?requireActive=false" target="_blank"></a> <a href="https://opencollective.com/rrweb/tiers/silver-sponsor/3/website?requireActive=false" target="_blank"></a> <a href="https://opencollective.com/rrweb/tiers/silver-sponsor/4/website?requireActive=false" target="_blank"></a> <a href="https://opencollective.com/rrweb/tiers/silver-sponsor/5/website?requireActive=false" target="_blank"></a> <a href="https://opencollective.com/rrweb/tiers/silver-sponsor/6/website?requireActive=false" target="_blank"></a>

Bronze Sponsors 🥉

<a href="https://opencollective.com/rrweb/tiers/sponsors/0/website?requireActive=false" target="_blank"></a> <a href="https://opencollective.com/rrweb/tiers/sponsors/1/website?requireActive=false" target="_blank"></a> <a href="https://opencollective.com/rrweb/tiers/sponsors/2/website?requireActive=false" target="_blank"></a> <a href="https://opencollective.com/rrweb/tiers/sponsors/3/website?requireActive=false" target="_blank"></a> <a href="https://opencollective.com/rrweb/tiers/sponsors/4/website?requireActive=false" target="_blank"></a> <a href="https://opencollective.com/rrweb/tiers/sponsors/5/website?requireActive=false" target="_blank"></a> <a href="https://opencollective.com/rrweb/tiers/sponsors/6/website?requireActive=false" target="_blank"></a> <a href="https://opencollective.com/rrweb/tiers/sponsors/7/website?requireActive=false" target="_blank"></a> <a href="https://opencollective.com/rrweb/tiers/sponsors/8/website?requireActive=false" target="_blank"></a>

Backers

<a href="https://opencollective.com/rrweb#sponsor" rel="nofollow"></a>

Core Team Members

_{<b>Yuyz0112</b>}

  </a>
</td>
<td align="center">
  <a href="https://github.com/YunFeng0817">
    
    

_{<b>Yun Feng</b>}

  </a>
</td>
<td align="center">
  <a href="https://github.com/eoghanmurray">
    
    

_{<b>eoghanmurray</b>}

  </a>
</td>
<td align="center">
  <a href="https://github.com/Juice10">
    
    

_{<b>Juice10</b>}

_{open for rrweb consulting} </a> </td>

Who's using rrweb?

  </a>
</td>
<td align="center">
  <a href="https://posthog.com?utm_source=rrweb&utm_medium=sponsorship&utm_campaign=open-source-sponsorship" target="_blank">
    
  </a>
</td>
<td align="center">
  <a href="https://statcounter.com/session-replay/" target="_blank">
    
  </a>
</td>
<td align="center">
  <a href="https://recordonce.com/" target="_blank">
    
  </a>
</td>

  </a>
</td>
<td align="center">
  <a href="https://remsupp.com" target="_blank">
    
  </a>
</td>
<td align="center">
  <a href="https://highlight.io" target="_blank">
    
  </a>
</td>
<td align="center">
  <a href="https://analyzee.io" target="_blank">
    
  </a>
</td>

  </a>
</td>
<td align="center">
  <a href="https://gleap.io" target="_blank">
    
  </a>
</td>
<td align="center">
  <a href="https://uxwizz.com" target="_blank">
    
  </a>
</td>
<td align="center">
  <a href="https://www.howdygo.com" target="_blank">
    
  </a>
</td>