grpc注册自定义codec需在初始化阶段调用grpc.registercodec,且客户端和服务端必须一致;codec实现marshal、unmarshal、name三方法;调用时用grpc.forcecodec指定,仅支持unary rpc。

gRPC 如何注册自定义编解码器(Codec)
gRPC 默认只认 proto 和 json,想用私有二进制格式,必须显式注册自己的 Codec 实现,否则调用直接 panic 或报 encoding not registered 错误。
关键不是“写一个编解码器”,而是“让 gRPC 在 dial 和 server 启动时能发现它”。注册必须在初始化阶段完成,且需两端一致:
-
grpc.RegisterCodec必须在任何grpc.Dial或grpc.NewServer调用前执行,晚了就无效 - 客户端和服务端都要注册同一个
Codec实例(或行为完全一致的实例),否则解码失败 - 注册名(
codec.Name()返回值)要和你在grpc.CallOption中指定的编码名严格匹配,比如用"mybin",那所有地方都得是这个字符串,大小写敏感
实现 Codec 接口的三个必填方法
gRPC v1.60+ 的 Codec 接口只有三个方法:Marshal、Unmarshal、Name。别试图加日志、缓冲池或上下文透传——这些逻辑得收在你自己的序列化函数里,接口本身不提供扩展点。
常见翻车点:
-
Marshal返回nil, err时,gRPC 会直接终止请求,不会重试;错误信息不会透传给对方,只在本地日志可见 -
Unmarshal如果对非法输入不做校验(比如长度不足、magic 字节不对),可能 panic 或读越界;建议开头就做len(data) 检查 -
Name返回空字符串或含斜杠/空格,会导致grpc.Codec注册失败,启动时静默忽略(无报错),但后续调用全走默认 codec
示例骨架:
type MyBinCodec struct{}
func (MyBinCodec) Name() string { return "mybin" }
func (MyBinCodec) Marshal(v interface{}) ([]byte, error) {
// 你自己的二进制序列化逻辑,比如 binary.Write 到 bytes.Buffer
}
func (MyBinCodec) Unmarshal(data []byte, v interface{}) error {
// 你自己的二进制反序列化逻辑,注意 type assert 和边界检查
}
如何在 RPC 调用中指定用你的编解码器
不是全局切换,默认所有 RPC 还是走 proto。必须在每次调用时显式指定,靠 grpc.CallOption 里的 grpc.UseCompressor 不行——那是给压缩用的;真正起作用的是 grpc.ForceCodec。
使用场景有限:仅适用于 unary RPC(client.Method(ctx, req)),streaming 不支持(gRPC stream 的 codec 是绑定在 stream 创建时的,无法 per-message 切换)。
- 客户端调用时加选项:
client.MyMethod(ctx, req, grpc.ForceCodec(&MyBinCodec{})) - 服务端无需额外配置,只要注册过该 codec,收到对应
content-type: application/grpc+mybin就会自动路由过去 - 如果服务端没注册,会返回
status code 13 (Internal),错误信息类似encoding mybin is not supported
私有二进制格式下 metadata 和错误传播的限制
用了自定义 codec,就等于绕过了 proto 的 wire 协议层,gRPC 的很多基础设施不再生效。最实际的影响是:
-
status.Status不再自动编码进 trailer;你得自己在二进制 payload 里预留 error 字段,或者靠约定返回固定结构体(比如struct{ Code int; Msg string }) -
metadata.MD仍可正常传递(它走 header,独立于 message 编码),但如果你在Marshal里把 metadata 混进 body,gRPC 不会帮你拆——header 和 body 是分离传输的 - 流控、超时、取消信号这些基于 HTTP/2 frame 的机制照常工作,但业务层感知不到 codec 级别的失败(比如解包失败发生在
Unmarshal,此时 response stream 已关闭,error 只能记日志)
换句话说:你能控制 payload 长什么样,但控制不了 gRPC runtime 怎么调度这个 payload。别指望靠改 codec 实现加密或签名——那些该放在 transport 层或 middleware 做。










