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

WebSocket消息格式怎么定义 WebSocket自定义通信协议JSON封装【案例】

酷敏小哥_9764

酷敏小哥_9764

发布时间:2026-06-02 19:26:01

|

1002人浏览过

|

来源于php中文网

原创

WebSocket仅定义传输帧格式,消息内容与序列化由业务层决定;JSON封装因可读性强、多语言支持好、主流框架内置send_json/receive_json而成为最轻量高效的选择。

websocket消息格式怎么定义 websocket自定义通信协议json封装【案例】

WebSocket本身不规定消息内容格式,只负责传输帧;你传什么、怎么解析,全由业务层决定。直接用裸字符串或原始字节当然可以,但一到多类型、带元数据、要路由或做鉴权时,就会立刻失控。所以实际项目里,90%以上都得自己定义消息格式——JSON封装是最轻量且落地最快的起点。

为什么选JSON封装而不是裸字符串或纯二进制

裸字符串(比如 "online:user123")写起来快,但没法扩展字段、难加时间戳、无法嵌套结构;纯二进制(如Protobuf)性能好,但调试困难、前端要额外解码、协议变更成本高。JSON折中:人类可读、几乎所有语言原生支持、send_json() 和 receive_json() 在 FastAPI / Socket.IO / websockets 等主流库中都有现成封装,开发效率和维护性明显占优。

常见错误现象:

  • 用 websocket.send("{'type':'ping'}") 手动拼接 JSON 字符串 → 遇到中文或特殊字符直接解析失败
  • 前端发了 {type: "chat", content: "hello"}(没引号),后端 json.loads() 报 JSONDecodeError
  • 消息里混用数字和字符串 ID(如 "id": 123 vs "id": "123"),导致下游类型判断混乱

标准JSON消息结构该怎么设计

一个最小可用的自定义协议结构,必须包含类型标识、有效载荷和基础元数据。参考 CustomMessage 的 Go 实现和 FastAPI 中的实践,建议固定以下字段:

Aria2 Json Rpc
Aria2 Json Rpc

通过 JSON‑RPC 2.0 与 aria2 下载管理器交互,使用自然语言命令管理下载、查询状态并控制任务。适用于 aria2、下载管理或种子操作。

下载
  • type:字符串,必填,用于路由分发(如 "auth"、"chat"、"heartbeat")
  • data:任意合法 JSON 值,承载业务数据,保持空对象 {} 或 null 也合法
  • timestamp:毫秒级 Unix 时间戳(int64),服务端生成,避免客户端时间不可信
  • seq(可选):单调递增序号,用于检测丢包或乱序(尤其在非可靠子协议下)
  • metadata(可选):键值对,存 trace_id、user_id、device_type 等上下文,不参与业务逻辑但利于排查

示例消息体:

{"type":"chat","data":{"to":"user456","text":"Hi there"},"timestamp":1748443800123,"seq":42,"metadata":{"trace_id":"abc123"}}

FastAPI + websockets 库中如何安全收发JSON消息

别手动 json.dumps() / json.loads() —— 大部分现代 WebSocket 库已内置 JSON 支持,用错方法反而引入编码/解码隐患。

  • 发送端统一走 websocket.send_json(data_dict):自动处理 UTF-8 编码、转义、序列化,不需 json.dumps()
  • 接收端必须用 await websocket.receive_json():它会校验 JSON 合法性并抛出 WebSocketInvalidPayload 异常,比手动 json.loads() 更安全
  • 如果收到的是二进制帧(比如误配了 send_bytes),receive_json() 会直接报错,此时应检查上游是否混用了 send_text/send_binary
  • 前端对应用 socket.send(JSON.stringify(msg)),不能漏掉 JSON.stringify,也不能发 Object 原始对象

容易被忽略的边界问题

JSON 封装看似简单,但真实环境里最容易栽在三个地方:

  • data 字段里塞了不可 JSON 序列化的值(如 datetime、bytes、自定义 class 实例)→ 发送前务必预处理,转成 str 或 dict
  • 前端未设置 Content-Type 或 Accept,但其实 WebSocket 不走 HTTP 头,这个影响为零;真正要防的是跨域连接时服务端未正确响应 Sec-WebSocket-Protocol(如用了 json.reliable.webpubsub.azure.v1 子协议却没声明)
  • 没有做 type 白名单校验:攻击者可能发 {"type":"rm -rf /","data":{}},后端必须先校验 type 是否在允许列表内,再进入具体处理器

协议越早约定死字段含义和类型,后期加字段、改前端、对接新客户端时就越省事。别把“先跑起来再说”当成默认选项。

热门AI工具

更多
PixTV
PixTV Hot

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

UpDream
UpDream Hot

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

豆包大模型

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

DeepSeek

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

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

WorkBuddy

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

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

相关专题

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

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

2789

2023.06.20

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

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

2168

2023.07.25

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

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

1140

2023.08.02

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

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

1078

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,随机排序。

1296

2023.09.05

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

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

1998

2023.09.20

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

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

3080

2023.09.20

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

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

13555

2023.09.22

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

0

2026.09.30

热门下载

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

精品课程

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

共0课时 | 0人学习

Webman中文手册
Webman中文手册

共0课时 | 0人学习

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

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