Golang自定义网络协议Codec接口实现

酷晨姑娘_3261

酷晨姑娘_3261

2026-05-21

635人浏览

原创

Go 的 rpc.Codec 接口必须同时实现 ReadRequestHeader 和 WriteRequestHeader,因为 RPC 调用严格依赖“头-体”分离的二阶段流程:先通过 header 获取服务名、方法名等元信息,再据此解析 body;缺一则在 server.ServeCodec 或 client.Go 中触发 panic。

为什么 Go 的 rpc.Codec 接口必须同时实现 ReadRequestHeader 和 WriteRequestHeader

因为 rpc 协议栈在一次调用中严格依赖“头-体”分离的二阶段解析:先读/写请求头(含服务名、方法名、序列化类型等元信息),再根据头里的指示去读/写具体参数体。如果只实现其中一个,server.servecodec 或 client.go 会在内部调用时 panic,错误通常是 nil pointer dereference 或 invalid memory address —— 实际是未实现方法返回了 nil 或未初始化的 error。

实操建议:

  • ReadRequestHeader 必须从连接中准确读取固定长度或带长度前缀的 header 字节,并反序列化到 *rpc.Request;不要在这里读 body
  • WriteRequestHeader 要确保写入的 header 格式与对端 ReadRequestHeader 解析逻辑完全一致,包括字节序、字段顺序、空字符串/零值编码方式
  • 两个方法共用的底层 io.ReadWriter 需要加锁(如用 sync.Mutex 包裹),否则并发调用时会出现读写错位

如何让自定义 Codec 支持非 JSON 序列化(比如 Protocol Buffers)

Go 标准 rpc 包不绑定序列化格式,关键在于把 body 的编解码逻辑从 header 处理中剥离,并在 ReadRequestBody/WriteRequestBody 中交由 protobuf 的 proto.Marshal/proto.Unmarshal 处理。

常见错误现象:客户端发的是 proto.Message,但服务端收到后 panic 报 cannot unmarshal into *struct{} —— 这是因为你没在 ReadRequestBody 里显式构造目标类型的指针实例。

实操建议:

  • ReadRequestBody 的参数 body interface{} 是一个地址(如 &MyReq{}),需用 reflect.New(reflect.TypeOf(body).Elem().Elem()).Interface() 动态创建对应 proto struct 的指针(注意双重 Elem():因传入的是 *T,而 T 本身是 proto.Message)
  • 避免在 Codec 内部硬编码 proto 文件路径或 proto.Register,应由业务层提前注册 proto.Message 类型
  • 若需兼容老 JSON RPC 客户端,可在 header 中增加 Content-Type 字段(如 "application/x-protobuf"),并在 ReadRequestBody 中分支处理

ServerCodec 和 ClientCodec 能复用同一套实现吗

可以,但必须满足:读写逻辑完全对称,且 header/body 的边界划分在两端一致。标准库中的 jsonrpc.NewClientCodec 和 jsonrpc.NewServerCodec 就是同一结构体的不同构造函数。

Golang Uber Dig
Golang Uber Dig

使用 uber-go/dig 在 Golang 中实现依赖注入——基于反射容器,提供 Provide/Invoke、dig.In/dig.Out 参数与结果对象,支持命名依赖等

下载

容易踩的坑:

  • 误以为只要实现了 rpc.Codec 接口就能直接传给 rpc.NewClient —— 实际上 rpc.NewClient 只接受 rpc.ClientCodec,它额外要求实现 Close() 方法;同理服务端需要 rpc.ServerCodec(含 Close() 和 Ready())
  • 在 WriteRequestHeader 中写了 header 却忘了 flush(尤其用 bufio.Writer 时),导致客户端卡在 ReadRequestHeader 死等
  • 同一个 Codec 实例被多个 goroutine 复用时,内部缓冲区(如 bytes.Buffer)未重置,造成 body 数据污染

为什么 ReadRequestBody 有时读不到完整数据,但 WriteRequestBody 却正常

根本原因在于 TCP 是流式协议,而你的 ReadRequestBody 没做长度帧界定。标准 jsonrpc 用换行符分隔,gob 自带长度前缀,但自定义 codec 若直接 io.ReadFull(conn, buf),就会因网络延迟或分包导致读不满。

实操建议:

  • 在 header 中预留 4 字节 body length 字段(binary.BigEndian.PutUint32),ReadRequestBody 先读这 4 字节,再循环 io.ReadFull 直到读满指定长度
  • 避免用 bufio.Scanner 处理 body,它默认 64KB 缓冲上限,大消息直接报 scanner over maximum capacity
  • 测试时用 net.Pipe() 替代真实 TCP 连接,可精确控制写入节奏,快速复现分包问题

header 的设计粒度和 body 的帧定界方式,才是自定义 Codec 稳定性的真正分水岭,不是序列化格式本身。

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

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

2238

7

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

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

2023.09.20

3600

8

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

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

2023.09.22

16615

6

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

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

2023.09.22

549

3

热门下载

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

精品课程

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