Golang自定义网络协议Codec接口实现技巧指南

千宇同学_5012

千宇同学_5012

2026-05-21

981人浏览

原创

直接用conn.write(struct)失败因write只接受[]byte且go无隐式转换;真正可用的codec必须同时实现序列化与分帧(如长度前缀),并统一处理压缩、错误传播及跨语言兼容性。

golang自定义网络协议codec接口实现技巧指南

为什么直接用 conn.Write(struct) 一定失败

因为 net.Conn 的 Write 方法只接受 []byte,而 Go struct 没有隐式转换能力。编译器会直接报错:cannot use myStruct (type MyStruct) as type []byte。

常见错误包括:

  • 用 fmt.Sprintf("%v", s) 拼字符串再转 []byte → 字段顺序、nil 值、time.Time 格式全不可控
  • 用 json.Marshal(s) 后直接 Write() → 解决了序列化,但没解决 TCP 粘包,接收方无法判断消息边界
  • 把 gob.Encoder 直接套在 conn 上 → gob 是流式编码,不自带长度头,多请求会互相污染

真正能上线的 Codec,必须同时处理两件事:序列化 + 分帧(framing),缺一不可。

ReadRequestHeader 和 WriteRequest 怎么配合长度前缀

标准 rpc.ServerCodec 要求你实现 ReadRequestHeader、ReadRequestBody、WriteResponse 等方法。关键在于:长度前缀不能只加在 body 上,而要覆盖整个逻辑消息单元(含 header + body),否则 header 读取逻辑会错位。

推荐做法是把「header」理解为 RPC 协议层的元数据(如 method name、seq id、compress flag),不是 TCP 层的 length prefix —— length prefix 是传输层的事,应封装在 WriteRequest 底层,对上层 Codec 透明:

Golang Naming
Golang Naming

Go(Golang)命名规范 — 包括包、构造函数、结构体、接口、常量、枚举、错误、布尔值、接收器、getter/setter、函数等。

下载
  • WriteRequest 内部:先 json.Marshal(req) 得到 payload,再 binary.BigEndian.PutUint32(header[:], uint32(len(payload))),最后 conn.Write(append(header[:], payload...))
  • ReadRequestHeader 不负责读 length prefix,它只从已解帧的 payload 中解析 method、seq 等字段(比如用 json.Unmarshal 到一个临时 struct{Method string; Seq uint64})
  • 真正的分帧逻辑(读 4 字节 length,再读 length 字节 payload)应抽成独立函数,如 readFrame(conn net.Conn) ([]byte, error),被 ReadRequestHeader 和 ReadRequestBody 共用

别在 ReadRequestHeader 里做 io.ReadFull(conn, ...) —— 这会让后续 ReadRequestBody 无数据可读,或触发重复读取。

选 json 还是 protobuf?别只看体积

线上翻车往往不是因为性能差,而是因为语义模糊或演进失控:

  • json:字段名大小写敏感(json:"user_id" vs json:"userId")、time.Time 默认序列化为 RFC3339 字符串(服务端用 int64 存,客户端却收到字符串)、nil slice 和空 slice 在反序列化后行为不一致
  • gob:Go 专属,跨语言等于零;Go 版本升级可能破坏兼容性(如 1.19+ 对未导出字段编码行为变更);抓包看到的是乱码,无法快速验证 payload
  • protobuf:需要定义 .proto 文件,但带来强 schema 控制、明确的字段编号、向后兼容保障(新增字段默认忽略)、多语言支持;只要不用 oneof 或嵌套过深,性能不输 json

如果你的 RPC 要长期维护、或未来可能接入 Python/JS 客户端,protobuf 不是“更优选项”,而是“唯一合理选项”。json 只适合内部调试或临时脚本。

ServerCodec 必须处理压缩与错误传播

压缩不是锦上添花,而是 Codec 的责任边界之一。如果你在 WriteRequest 里用了 gzip.Writer,就必须保证:

  • 每次调用后显式 Flush(),否则数据滞留在缓冲区,连接超时断开
  • 压缩只作用于 payload(即序列化后的字节),不能包含 length prefix —— 否则接收方先读 4 字节,发现不是真实长度,后续全乱
  • ReadRequestHeader 失败时,必须返回具体错误(如 io.ErrUnexpectedEOF),不能吞掉或返回 nil;否则 rpc.Server 会静默关闭连接,日志里只显示 connection reset by peer
  • 如果协议支持 compress flag,ReadRequestBody 必须根据 flag 动态选择 gzip.NewReader 或直通解码,且解压失败要透传错误,不能 fallback 到原始字节

最容易被忽略的一点:WriteResponse 也得走同样压缩路径。否则客户端收到的响应没压缩,而请求压缩了,协议就失衡——尤其当服务端返回大数组时,带宽浪费立刻显现。

golang免费学习笔记(深入):立即使用
在学习笔记中,你将探索golang的核心概念和高级技巧!

相关文章

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

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

下载

相关标签:

golang

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

相关专题

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

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

2023.06.20

3149

3

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

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

2023.07.25

2308

9

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

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

2023.08.02

1240

5

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

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

2023.08.09

1198

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

1356

5

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

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

2023.09.20

2138

7

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

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

2023.09.20

3460

8

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

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

2023.09.22

15695

6

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

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

2023.09.22

549

3

热门下载

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

精品课程

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