讲师中心 微信公众号
AI工具推荐 视频效率加速

WebSocket实现协同编辑功能教程 WebSocket实时文档开发步骤【案例】

夏涛大大_8966

夏涛大大_8966

发布时间:2026-06-01 17:25:25

|

746人浏览过

|

来源于php中文网

原创

协同编辑必须采用操作指令同步而非文档快照,核心是基于单调递增seq的因果序广播与客户端严格序号驱动的应用逻辑,否则必然导致错位、乱序与不一致。

websocket实现协同编辑功能教程 websocket实时文档开发步骤【案例】

协同编辑不是靠“同步文档快照”,而是靠“同步操作指令”——发错一条 insert 操作,所有客户端就可能错位、崩溃或卡死。

为什么不能直接广播 HTML 或 JSON 文档全量内容

全量同步看似简单,实际在多人编辑中会迅速暴露问题:网络抖动导致旧版本覆盖新版本、光标位置丢失、折叠状态错乱、输入法组合字符被截断。更关键的是,它无法解决“两个用户同时在第 5 行插入文字”的根本冲突。

真实生产环境(如 Luckysheet、Monaco 集成场景)全部采用操作粒度同步,典型消息结构必须包含:type(如 "insert"、"delete")、position(带行列/索引上下文)、text 或 value、clientId 和单调递增的 seq。

  • 服务端收到 {type: "insert", row: 4, col: 12, text: "x=", seq: 105} 后,不修改自身文档副本,只校验 seq 是否连续、row/col 是否越界
  • 校验通过即广播,**不做 OT 变换也必须保证广播顺序与接收顺序一致**——这点常被忽略,却直接决定最终一致性
  • 前端编辑器必须提供原子 apply 接口(如 Luckysheet 的 luckysheet.setCellValue、CodeMirror 6 的 view.dispatch),否则本地状态会漂移

WebSocket 连接管理必须绑定业务上下文

单纯用 setAllowedOrigins("*") 或全局 active_connections 列表,会在真实协作中引发权限越界和消息泄露。

每个连接必须携带且验证以下上下文:

WebSocket 8.18.2
WebSocket 8.18.2

WebSocket 8.18.2 是该协议规范的一个重要迭代版本,主要优化了连接稳定性与数据传输效率。它通过全双工通信机制,允许客户端与服务器在单一长连接上实时交换数据,大幅降低传统 HTTP 轮询的开销。该版本增强了心跳保活、自动重连及二进制帧传输能力,适用于即时通讯、在线游戏及金融行情推送等低延迟场景,为开发者提供更可靠的实时网络交互基础。

下载
  • worksheet_id 或 doc_id:用于路由,避免 A 用户编辑的表格消息推送给 B 用户打开的文档
  • user_id + role("viewer"/"editor"):服务端在广播前过滤——学生发来的 delete 操作,教师未授予权限时应直接丢弃,而非转发后由前端拦截
  • client_seq 初始值:由服务端在 accept() 后下发,客户端后续每条消息附带该值+自增,服务端据此识别重连后的状态断点

FastAPI 示例中,别写 @app.websocket("/ws") 这种泛化路径;必须是 @app.websocket("/ws/{doc_id}"),并在 websocket_endpoint 函数内校验 doc_id 对应的团队空间权限和用户角色。

seq 序号不是可选字段,而是去重与因果排序的唯一依据

没有 seq 的 WebSocket 协同系统,在弱网或重连场景下必然出现操作乱序、重复应用、光标跳变。它不是日志序号,而是操作因果链的锚点。

正确做法:

  • 客户端每次发送操作前,本地 seq += 1,并随消息体发出(不要依赖服务端生成)
  • 服务端维护每个 clientId 的最新已收 seq,收到 seq ≤ 已收 的消息直接丢弃(防重传)
  • 广播时**不重排**,但要求客户端按 seq 严格排队应用:若收到 seq: 107 而本地只到 105,缓存该消息,等待 106 到达后再批量执行
  • 避免用 timestamp 替代 seq:多设备时钟不同步,毫秒级误差即可导致因果颠倒

最易被跳过的细节是:前端必须实现操作队列缓冲与严格序号驱动的应用逻辑,而不是“收到就 apply”。一旦漏掉这个环节,协同就退化为竞态编辑——表面实时,实则不可靠。

热门AI工具

更多
UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

3209

2023.06.20

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2328

2023.07.25

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

1260

2023.08.02

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

1218

2023.08.09

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

1356

2023.09.05

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2178

2023.09.20

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

3500

2023.09.20

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

15975

2023.09.22

OpenJDK JVM参数怎么调优
OpenJDK JVM参数怎么调优

Java应用运行缓慢,如何调整JVM参数?本专题介绍OpenJDK JVM性能调优的基本流程,涵盖性能指标确认、运行数据采集、内存配置和垃圾回收分析,帮助你先定位瓶颈,再通过对照测试验证效果,避免直接套用参数而影响应用稳定性。

20

2026.10.16

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WebSocket手册
WebSocket手册

共0课时 | 0人学习

Webman中文手册
Webman中文手册

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn