使用Netty实现私有WebSocket协议开发 自定义编解码器实现方法【教程】

夏静酱_1947

夏静酱_1947

2026-05-30

551人浏览

原创

websocketserverprotocolhandler仅处理标准握手、帧封装与心跳,不负责私有协议编解码;需在其后添加messagetomessagedecoder/encoder处理业务消息,不可直接使用bytetomessagedecoder。

websocketserverprotocolhandler 不是万能的,它只处理标准 websocket 协议握手、帧封装和心跳,不负责业务消息的编解码。如果你需要在 websocket 之上跑私有协议(比如带指令头、长度域、加密字段),必须在 websocketserverprotocolhandler 之后再加自定义编解码器。


为什么不能直接在 WebSocket 上用 ByteToMessageDecoder?

因为 WebSocketServerProtocolHandler 已经把原始 ByteBuf 解包成 TextWebSocketFrame 或 BinaryWebSocketFrame,后续 handler 收到的是「已解帧」的对象,不是裸字节流。

常见错误现象:
- 在 WebSocketServerProtocolHandler 前插入 ByteToMessageDecoder → 解码器收不到数据(被前面的 HTTP/WS handler 吃掉了)
- 在 WebSocketServerProtocolHandler 后插入 ByteToMessageDecoder → decode() 方法入参类型是 TextWebSocketFrame,但你试图调用 in.readableBytes() → 报 ClassCastException 或空指针

  • 正确做法:继承 MessageToMessageDecoder,泛型指定为 TextWebSocketFrame 或 BinaryWebSocketFrame
  • 解码目标对象应是你自己的业务 POJO(如 LoginRequest、ChatMessage)
  • 编码器同理,用 MessageToMessageEncoder,输入是 POJO,输出是 TextWebSocketFrame 或 BinaryWebSocketFrame

如何实现带长度+指令头的 BinaryWebSocketFrame 编解码?

适用于二进制私有协议(如 Protobuf、FlatBuffer 序列化体),需解决粘包/半包问题 —— 但注意:WebSocket 帧本身已有边界,所以「粘包」发生在应用层协议内(即一个 BinaryWebSocketFrame 里可能含多条业务消息,或一条消息跨多个帧)。实际中更常见的是「单帧单消息」,所以重点在帧内解析。

典型结构:[int length][short cmd][byte[] body]

  • 解码器(MessageToMessageDecoder<binarywebsocketframe></binarywebsocketframe>):
    • 先 frame.content().readableBytes() 检查是否 ≥ 6 字节(4+2)
    • 用 frame.content().slice() 截出 length 和 cmd,再截出 body
    • 用 ByteBuf.readBytes(int) 拷贝 body 到新数组,反序列化为 POJO
    • 若长度不足,ctx.channel().config().setAutoRead(false) 暂停读取,等下个帧来拼接(需自行缓存 buffer)
  • 编码器(MessageToMessageEncoder<mymessage></mymessage>):
    • msg.toByteArray() 得到 body
    • ctx.alloc().buffer(6 + body.length) 分配空间
    • 依次 writeInt(body.length)、writeShort(cmd)、writeBytes(body)
    • 封装为 new BinaryWebSocketFrame(byteBuf) 加入 out

TextWebSocketFrame 场景下如何安全解析 JSON?

文本帧本质是 UTF-8 字符串,看似简单,但容易踩坑:

WebSocket 8.18.2
WebSocket 8.18.2

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

下载
  • 客户端发的 JSON 可能换行、缩进、含 BOM 头 → frame.text() 直接调用会失败
  • 大 JSON 被分片发送(ContinuationWebSocketFrame)→ 单个 TextWebSocketFrame 不完整
  • 没做最大长度限制 → OOM 风险

实操建议:

  • 在 WebSocketServerProtocolHandler 后加 HttpObjectAggregator(设 maxContentLength=1024*1024),强制合并分片帧
  • 解码器继承 MessageToMessageDecoder<textwebsocketframe></textwebsocketframe>,用 frame.text().trim() 去空格后 parse
  • 用 Jackson 的 ObjectMapper.readValue(String, Class),捕获 JsonProcessingException 并关闭 channel
  • 避免用 frame.content().toString(CharsetUtil.UTF_8) —— 它不处理 BOM,且忽略 TextWebSocketFrame.isFinalFragment()

共享与线程安全:@ChannelHandler.Sharable 能乱加吗?

很多教程无脑加 @ChannelHandler.Sharable,但这是危险操作:

  • MessageToMessageCodec 类如果持有非线程安全状态(如 StringBuilder、缓存 ByteBuf、未同步的 map)→ 多 channel 并发访问时数据错乱
  • WebSocketServerProtocolHandler 本身是 sharable 的,但你的自定义编解码器通常要维护 per-channel 状态(如解码缓冲区)
  • Netty 4.1+ 默认每个 ChannelPipeline 实例化 handler 新对象;只有显式标注 @Sharable 才复用

结论:除非你确认 handler 是纯函数式(无任何可变成员变量),否则不要加 @ChannelHandler.Sharable。尤其涉及 buffer 缓存、计数器、上下文 map 的场景,必须每个 channel 独享实例。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

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

下载

相关标签:

websocket

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

相关专题

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

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

2023.06.20

3309

3

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

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

2023.07.25

2348

9

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

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

2023.08.02

1280

5

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

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

2023.08.09

1238

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

1376

5

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

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

2023.09.20

2218

7

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

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

2023.09.20

3600

8

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

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

2023.09.22

16515

6

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

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

2023.09.22

549

3

热门下载

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

精品课程

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

共0课时 | 0人学习

Webman中文手册
Webman中文手册

共0课时 | 0人学习