Go RPC统一错误需服务端用*RPCError结构体封装、客户端从Response.Error解析、序列化用JSON/gob并加json tag。

在 Go 的 RPC 服务中,统一错误格式并正确透传错误信息,关键在于:服务端规范封装错误、客户端能识别并还原语义、序列化过程不丢失错误字段。Go 标准 net/rpc 默认只传字符串(err.Error()),需手动扩展。
服务端:用自定义错误结构替代裸 error
标准 error 接口无法携带码、详情、上下文等字段。定义可序列化的错误结构:
type RPCError struct {
Code int `json:"code"`
Message string `json:"message"`
Details string `json:"details,omitempty"`
}
func (e *RPCError) Error() string {
return fmt.Sprintf("[%d] %s", e.Code, e.Message)
}
// 提供常用构造方法
func NewBadRequest(msg string) *RPCError {
return &RPCError{Code: 400, Message: msg}
}
func NewInternalError(msg string) *RPCError {
return &RPCError{Code: 500, Message: msg, Details: msg}
}
在 RPC 方法中,返回 *RPCError(注意是指针,否则 JSON 编码可能失败),而非 error 接口:
- 避免直接返回
errors.New或fmt.Errorf,它们无法被客户端结构化解析 - 若必须兼容原有 error,可在 handler 中拦截并转换:
if err != nil { return &RPCError{Code: 500, Message: "server error"}, nil }
客户端:反序列化响应时主动检查错误字段
Go 的 net/rpc 不强制要求错误字段名匹配,需约定响应结构体含 Error 字段(类型为 *RPCError):
立即学习“go语言免费学习笔记(深入)”;
type Response struct {
Data interface{} `json:"data"`
Error *RPCError `json:"error"`
}
调用后检查 Response.Error 是否非空:
- 不依赖
call.Error(这是 RPC 传输层错误,如连接失败) - 业务错误一律从
Response.Error读取,并按Code分类处理 - 示例:
if resp.Error != nil { switch resp.Error.Code { case 401: handleUnauthorized() } }
序列化:选用支持结构体的编码器
标准 gob 支持结构体,但跨语言弱;JSON 更通用,需确保:
- 服务端注册时使用
jsonrpc.NewServer()(来自net/rpc/jsonrpc)或自建 HTTP+JSON 封装 - 所有字段加
json:tag,且导出(首字母大写) - 避免在
RPCError中嵌入未导出字段或函数类型
进阶:中间件式错误拦截(HTTP RPC 场景)
若基于 HTTP(如 gorilla/rpc 或自定义 handler),可在 handler 外层统一 recover 和包装:
func rpcHandler(w http.ResponseWriter, r *http.Request) {
defer func() {
if err := recover(); err != nil {
writeJSON(w, Response{
Error: NewInternalError(fmt.Sprintf("panic: %v", err)),
})
}
}()
// 正常处理...
}
- 对 panic、校验失败、DB 错误等,统一转为
*RPCError - 记录日志时保留原始 error(用于排查),返回给前端的仅是脱敏后的
Message










