Go RPC错误处理需结构化:gRPC用status.Status返回标准码,net/rpc需自定义RPCError并映射HTTP状态码,客户端统一解析code而非字符串,兼顾日志traceID与用户友好性。

在 Go 的 RPC 调用中,错误处理不能只依赖 error 类型的字符串描述,而应明确返回结构化的错误对象和 HTTP 状态码(尤其在 gRPC-HTTP/1.1 代理、RESTful 封装或自定义 RPC 框架中)。Go 标准库 net/rpc 本身不内置状态码,需自行设计;而 gRPC 则通过 status.Status 统一表达错误语义。下面分场景说明如何正确传递错误信息。
使用 gRPC:通过 status.Status 返回错误码和详情
gRPC 原生支持标准错误码(如 codes.NotFound、codes.InvalidArgument),客户端可精准识别并做差异化处理。
- 服务端返回错误时,用
status.Errorf构造带 code 和 message 的错误:
// server.go
import "google.golang.org/grpc/status"
import "google.golang.org/grpc/codes"
func (s *MyService) GetUser(ctx context.Context, req *pb.GetUserRequest) (*pb.User, error) {
if req.Id == 0 {
return nil, status.Errorf(codes.InvalidArgument, "user ID cannot be zero")
}
user, err := s.store.FindByID(req.Id)
if err != nil {
return nil, status.Errorf(codes.NotFound, "user not found: %v", err)
}
return user, nil
}
- 客户端解析错误时,用
status.FromError提取 code 和 message:
// client.go
resp, err := client.GetUser(ctx, &pb.GetUserRequest{Id: 123})
if err != nil {
st, ok := status.FromError(err)
if ok {
switch st.Code() {
case codes.NotFound:
log.Printf("user missing — show 404 page")
case codes.InvalidArgument:
log.Printf("client input invalid — reject silently")
}
}
}
立即学习“go语言免费学习笔记(深入)”;
基于 net/rpc:自定义错误响应结构 + HTTP 状态映射
标准 net/rpc 只返回 error 接口,无法直接传状态码。常见做法是将错误封装为 JSON 响应体,并在 HTTP 层(如用 http.ServeMux 包装 RPC)注入状态码。
- 定义统一错误响应结构:
type RPCError struct {
Code int // HTTP status code, e.g., 400, 404, 500
Message string
Details map[string]any
}
func (e *RPCError) Error() string { return e.Message }
- 在 RPC 方法中返回该结构,由 HTTP handler 解包并设置状态码:
// handler wrapper
func rpcHandler(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Content-Type", "application/json")
err := rpcServer.ServeHTTP(w, r)
if err != nil {
if rpcErr, ok := err.(*RPCError); ok {
w.WriteHeader(rpcErr.Code)
json.NewEncoder(w).Encode(rpcErr)
return
}
w.WriteHeader(http.StatusInternalServerError)
json.NewEncoder(w).Encode(&RPCError{
Code: http.StatusInternalServerError,
Message: "internal server error",
})
}
}
客户端统一错误解析:避免硬编码字符串判断
无论后端用 gRPC 还是 HTTP+RPC,客户端都不应靠 strings.Contains(err.Error(), "not found") 判断错误类型——易出错且难维护。
- 对 gRPC 客户端:始终用
status.FromError+st.Code() - 对 HTTP-RPC 客户端:解码响应 body 为
*RPCError,再 switch Code 字段 - 可封装通用错误工具函数:
func IsNotFound(err error) bool {
if st, ok := status.FromError(err); ok {
return st.Code() == codes.NotFound
}
if rpcErr, ok := err.(*RPCError); ok {
return rpcErr.Code == http.StatusNotFound
}
return false
}
补充建议:错误日志与调试友好性
生产环境中,错误对象应包含可追溯的 trace ID 或 request ID,便于关联日志;同时避免向客户端暴露敏感细节(如数据库错误、路径、内部堆栈)。
- 服务端记录完整错误(含 stacktrace)到日志系统,但返回给客户端的
Message应简洁、用户友好 - 使用
grpc-zap或grpc-go/otel自动注入 traceID 到 gRPC 错误元数据(status.WithDetails) - 对
net/rpc,可在RPCError.Details中附加"request_id": "abc123",不暴露原始 error










