Nginx利用WebSocket代理实现在线协作编辑器

老伟姑娘_8769

老伟姑娘_8769

2026-04-05

309人浏览

原创

Nginx代理WebSocket需配置HTTP/1.1升级、透传Upgrade头、设置长超时(如3600秒)、关闭缓冲,并精准匹配/ws等路径,否则会导致连接中断、光标不同步等问题。

nginx利用websocket代理实现在线协作编辑器

用 Nginx 代理 WebSocket 是在线协作编辑器(如多人实时编辑文档)的关键一环。它本身不处理业务逻辑,但必须正确透传连接、维持长连接、避免超时中断,否则会出现“突然断连”“光标不同步”“操作丢失”等问题。

WebSocket 连接需显式升级

Nginx 默认把所有请求当 HTTP 处理,而 WebSocket 建立依赖 HTTP 升级协议(Upgrade: websocket)。若不配置,Nginx 会直接返回 400 或 502,前端收不到 101 Switching Protocols 响应,连接失败。

必须在 location 块中添加以下头信息:

  • proxy_http_version 1.1; —— 启用 HTTP/1.1,支持 Upgrade 头
  • proxy_set_header Upgrade $http_upgrade; —— 透传 Upgrade 请求头
  • proxy_set_header Connection "upgrade"; —— 显式声明连接升级,不能写成 ’Upgrade’ 或省略引号

防止连接被意外关闭

默认情况下,Nginx 的 proxy_read_timeout 和 proxy_send_timeout 都是 60 秒。WebSocket 是长连接,空闲时无数据收发,超时后 Nginx 会主动断开,导致前端重连、状态丢失。

建议设为较大值(如 1 小时),或根据业务容忍度调整:

  • proxy_read_timeout 3600; —— 等待后端响应的最大时间
  • proxy_send_timeout 3600; —— 向后端发送请求的最大等待时间
  • proxy_buffering off; —— 关闭缓冲,避免延迟转发消息(协作场景对实时性敏感)

匹配路径与后端服务对齐

协作编辑器通常将 WebSocket 路径设计为 /ws?docId=xxx 或 /api/v1/editor/ws。Nginx 的 location 必须能准确捕获这些路径,且注意是否带查询参数。

推荐写法(兼容带参和无参):

  • location ^~ /ws { —— 前缀匹配,高效且避免正则干扰
  • proxy_pass http://backend_ws; —— 后端需支持同路径,不要自动改写 URI(除非明确需要)
  • 如需保留 query string,确保不加 / 结尾或使用 rewrite 显式传递

验证与常见问题定位

配置完别急着上线,先做三件事:

  • 用 curl -i -N -H "Connection: Upgrade" -H "Upgrade: websocket" http://your-domain/ws 检查是否返回 101
  • 浏览器开发者工具 Network 标签中查看 WS 连接的 Status 是否为 101,而非 200/502
  • 后端日志确认 upgrade 成功、连接未被 Nginx 中断(搜索 “client closed connection” 或 “upstream prematurely closed”)
PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

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

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

2023.06.20

3769

3

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

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

2023.07.25

2488

9

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

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

2023.08.02

1420

5

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

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

2023.08.09

1358

4

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

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

2023.09.05

1436

5

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

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

2023.09.20

2418

7

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

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

2023.09.20

4040

8

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

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

2023.09.22

19255

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

549

3

热门下载

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

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 134.1万人学习