Kratos 通过 protoc-gen-go-http 插件自动映射 gRPC error 为 HTTP 状态码,依赖 google.api.http option、errors.Coder 接口及 kratos.api.common.ErrorCode 枚举;需确保 common.proto 正确导入、错误用标准封装、避免 Status 字段与 error 混用,并执行 make api 更新生成代码。

gRPC error 转 HTTP 状态码靠 protoc-gen-go-http 自动映射
Kratos 不是靠中间件或手动 switch 语句做状态码转换,而是由 protoc-gen-go-http 插件在生成 HTTP handler 时,根据 google.api.http option 和错误返回约定,自动把 gRPC error 映射为对应 HTTP 状态码与响应体。前提是你的 proto 中定义了 Status 字段(如 kratos.api.common.Status),且 service 方法返回 error 时,error 实现了 Kratos 的 errors.Coder 接口。
常见错误现象:HTTP 接口返回 500,但 gRPC 调用返回的是 INVALID_ARGUMENT;或者 HTTP 响应 body 是空 JSON,没带 code/message 字段。
- 确认
api/common/common.proto已存在,package严格为kratos.api.common,且被业务 proto 正确import - 检查
internal/biz/xxx.go中返回的 error 是否用了errors.BadRequest、errors.NotFound等标准封装,而不是裸写errors.New("xxx") -
protoc-gen-go-http会识别errors.Code()返回值:400→HTTP 400,404→HTTP 404,500→HTTP 500,其他未覆盖 code 默认 fallback 到 500
HTTP 响应体结构不一致?别混用 Status 字段和 error 返回
同一个 RPC 方法,gRPC 客户端收 error,HTTP 客户端收 JSON body。如果在 HelloReply 里定义了 kratos.api.common.Status status = 2,又同时在 service 层 return error,就会冲突——protoc-gen-go-http 优先用 error 映射,忽略 reply 中的 status 字段。
正确做法只选其一:
- 想走标准错误映射:reply message 里**不要放**
Status字段,所有错误都通过return nil, errors.BadRequest(...)抛出 - 想自定义响应体结构(比如必须带
stat和data):reply message 里保留Status或自定义字段,service 层统一return &pb.HelloReply{Status: &common.Status{Code: 400, Message: "xxx"}}, nil,并禁用 error 映射(需改写 handler 模板或手动覆盖生成代码) - 混合用极易出错:例如
return &pb.HelloReply{Status: ...}, errors.NotFound(),结果 HTTP 返回 404 + 空 body,因为 error 优先级更高
service.Register() 失败导致 HTTP 错误映射完全不生效
看似是 HTTP 状态码映射问题,实则是 gRPC server 根本没起来:service.Register() 报 rpc error: code = Unavailable,说明 grpc.Server 实例为 nil 或未传入 kratos.New() 参数列表。
后果很直接:protoc-gen-go-http 生成的 HTTP handler 依赖 gRPC service 的反射信息来提取 method、error 映射规则。gRPC server 缺失 → handler 初始化失败 → 所有 HTTP 路由注册为空 → curl 返回 404 或 panic。
- 检查
internal/server/grpc.go是否调用了grpc.NewServer(),且返回值非 nil - 确认
kratos.New(kratos.Server(httpSrv, grpcSrv))中grpcSrv确实是那个*grpc.Server实例,不是漏传、错传或变量名拼错 - 纯 HTTP 项目可直接删掉
service.Register()调用——它只对 gRPC 有效,删了反而避免误导性错误
自定义错误码没出现在 HTTP 响应里?检查 ErrorCode enum 定义位置
protoc-gen-go-http 只认 kratos.api.common.ErrorCode 枚举里的值,且要求该 enum 必须定义在 api/common/common.proto 中。如果你在 api/greeter/greeter.proto 里另写了一个 enum ErrorCode,哪怕字段名和值完全一样,也不会被映射。
典型表现:gRPC 返回 NOT_FOUND,HTTP 却返回 500 而非 404;或日志里出现 unknown error code: 404。
- 必须把
enum ErrorCode放进api/common/common.proto,且 package 为kratos.api.common - 业务 proto 中只能
import "api/common/common.proto",然后在 error 字段里引用kratos.api.common.ErrorCode - 修改后务必重新运行
make api,否则生成的 Go 代码仍用旧 enum,映射逻辑失效
最常被忽略的一点:错误码映射不是“写完 enum 就自动生效”,它依赖生成代码中硬编码的 switch 分支。一旦你改了 common.proto 但跳过 make api,服务跑的还是旧映射逻辑——连重启都救不了,必须重新生成并编译。


















