Kratos框架怎么自定义统一错误处理

夏萱小哥_5930

夏萱小哥_5930

2026-10-13

266人浏览

原创

kratos 错误处理由 protobuf 注解驱动,须在 .proto 中用 (errors.code) 定义 errorreason 枚举;业务层调用 errors.new(int32(pb.enum), msg) 构造错误;手动设状态码或裸 error 会绕过框架,导致日志、监控、文档、grpc 状态码失效。

kratos框架怎么自定义统一错误处理

Kratos 的错误处理不是靠中间件“兜底”,而是由 Protobuf 定义驱动、框架自动注入的。直接写 http.Error 或手动 w.WriteHeader 会绕过整个错误体系,导致日志、监控、Swagger 文档、gRPC 状态码全部失效。

Protobuf 中定义 ErrorReason 枚举是前提

必须在 .proto 文件里声明带 (errors.code) 注解的枚举,Kratos 才能识别并生成对应错误码逻辑:

  • ErrorReason 枚举需 import "errors/errors.proto"
  • 每个枚举值必须显式标注 (errors.code) = NNN,例如 USER_NOT_FOUND = 0 [(errors.code) = 404];
  • 不加注解的枚举值会被忽略,框架不会为其生成 HTTP 状态码或 gRPC Status
  • 如果没定义 ErrorReason,errors.New 抛出的 error 默认映射为 500,且无 reason 字段

errors.New + ErrorReason 枚举值才是标准用法

业务层不要自己拼 JSON 或设状态码,而是用 Kratos 提供的 errors 包构造错误:

Kratos框架 2.8.2
Kratos框架 2.8.2

Kratos框架 2.8.2 源码包下载,针对 Watch Resolver goroutine 测试及指标、日志默认值问题进行修正。

下载
  • 调用 errors.New(int, string) 时,第一个参数必须是 ErrorReason 枚举的整数值(不是字符串名)
  • 例如:返回 USER_NOT_FOUND,应写 errors.New(int32(pb.USER_NOT_FOUND), "user not found"),而不是 "USER_NOT_FOUND"
  • 该 error 会被 transport 层自动转成含 code、reason、message、metadata 的标准响应体
  • HTTP 响应头 Status 和 gRPC Status.Code 全部由框架根据 (errors.code) 注解推导,无需手动设置

自定义错误格式需改 transport/http/server.go 的 errorEncoder

默认响应结构是 {"code":404,"reason":"USER_NOT_FOUND","message":"..."}。如需改成 {"err_code":...,"err_msg":...} 这类字段名,不能动业务代码,而要重写 encoder:

  • 找到项目中初始化 HTTP server 的地方(通常是 cmd/xxx/main.go)
  • 在 http.Server 配置里传入自定义 errorEncoder 函数
  • 函数签名必须是 func(ctx context.Context, err error, w http.ResponseWriter)
  • 内部仍需调用 errors.FromError(err) 解析原始错误,再按需序列化
  • 注意:改了 errorEncoder 不影响 gRPC 的错误编码,gRPC 走的是另一套 grpc.Server 的 errorCodec

中间件里捕获 panic 或未知 error 时务必用 errors.New 包装

有些场景(如 biz 层 panic、第三方库返回裸 error)无法走标准枚举路径,这时中间件兜底要谨慎:

  • 不要直接 return nil, err —— 框架可能无法识别裸 error,降级为 500 且无 reason
  • 推荐统一 fallback 到一个兜底枚举值,比如 UNKNOWN_ERROR = 999 [(errors.code) = 500]
  • 然后包装: errors.New(int32(pb.UNKNOWN_ERROR), fmt.Sprintf("panic: %v", recover()))
  • 避免在中间件里手动写 w.WriteHeader(500) + json.Marshal,否则会和 transport 冲突,造成重复写 body

最易被忽略的一点:Protobuf 枚举值变更后,必须重新运行 kratos proto client 或 protoc 生成 Go 代码,否则 pb.USER_NOT_FOUND 常量不会更新,运行时传错数字会导致错误码映射完全错乱。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

kratos框架

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
Golang 入门学习路线:从零基础到上手开发
Golang 入门学习路线:从零基础到上手开发

Golang 入门路线涵盖从零到上手的核心路径:首先打牢基础语法与切片等底层机制;随后攻克 Go 的灵魂——接口设计与 Goroutine 并发模型;接着通过 Gin 框架与 GORM 深入 Web 开发实战;最后在微服务与云原生工具开发中进阶,旨在培养具备高性能并发处理能力的后端工程师。

2026.02.24

206

7

Golang 疑难杂症解决指南:常见问题排查与优化
Golang 疑难杂症解决指南:常见问题排查与优化

《Golang 疑难杂症解决指南》聚焦开发过程中常见却棘手的问题,从并发模型、内存管理、性能瓶颈到工程化实践逐步拆解。通过真实案例与调试思路,帮助开发者定位问题根因,建立系统化排查方法。不只给出答案,更强调分析路径与工具使用,让你在复杂 Go 项目中具备持续解决问题的能力。

2026.02.24

113

7

Golang 运行与部署实战:从本地到云端
Golang 运行与部署实战:从本地到云端

《Golang 运行与部署实战》围绕 Go 应用从开发完成到稳定上线的完整流程展开,系统讲解编译构建、环境配置、日志与配置管理、容器化部署以及常见运维问题处理。结合真实项目场景,拆解自动化构建与持续部署思路,帮助开发者建立可靠的发布流程,提升服务稳定性与可维护性。

2026.02.24

657

10

Golang 面试题精选:高频问题与解答
Golang 面试题精选:高频问题与解答

Golang 面试题精选》系统整理企业常见 Go 技术面试问题,覆盖语言基础、并发模型、内存与调度机制、网络编程、工程实践与性能优化等核心知识点。每道题不仅给出答案,还拆解背后的设计原理与考察思路,帮助读者建立完整知识结构,在面试与实际开发中都能更从容应对复杂问题。

2026.02.24

218

7

Golang 性能优化专题:提升应用效率
Golang 性能优化专题:提升应用效率

《Golang 性能优化专题》聚焦 Go 应用在高并发与大规模服务中的性能问题,从 profiling、内存分配、Goroutine 调度、GC 机制到 I/O 与锁竞争逐层分析。结合真实案例讲解定位瓶颈的方法与优化策略,帮助开发者建立系统化性能调优思维,在保证代码可维护性的同时显著提升服务吞吐与稳定性。

2026.02.24

457

7

Golang 生态工具与框架:扩展开发能力
Golang 生态工具与框架:扩展开发能力

《Golang 生态工具与框架》系统梳理 Go 语言在实际工程中的主流工具链与框架选型思路,涵盖 Web 框架、RPC 通信、依赖管理、测试工具、代码生成与项目结构设计等内容。通过真实项目场景解析不同工具的适用边界与组合方式,帮助开发者构建高效、可维护的 Go 工程体系,并提升团队协作与交付效率。

2026.02.24

208

7

Golang 并发编程专题:掌握多核时代的核心技能
Golang 并发编程专题:掌握多核时代的核心技能

《Golang 并发编程专题:掌握多核时代的核心技能》系统讲解 Go 在并发领域的设计哲学与实践方法,深入剖析 goroutine、channel、调度模型与并发安全机制,结合真实场景与性能思维,帮助开发者构建高吞吐、低延迟、可扩展的并发程序,全面提升多核时代的工程能力。

2026.02.26

564

7

Golang Web 开发路线:构建高效后端服务
Golang Web 开发路线:构建高效后端服务

《Golang Web 开发路线:构建高效后端服务》围绕 Go 在后端领域的工程实践,系统讲解 Web 框架选型、路由设计、中间件机制、数据库访问与接口规范,结合高并发与可维护性思维,逐步构建稳定、高性能、易扩展的后端服务体系,帮助开发者形成完整的 Go Web 架构能力。

2026.02.26

225

7

Golang 实际项目案例:从需求到上线
Golang 实际项目案例:从需求到上线

《Golang 实际项目案例:从需求到上线》以真实业务场景为主线,完整覆盖需求分析、架构设计、模块拆分、编码实现、性能优化与部署上线全过程,强调工程规范与实践决策,帮助开发者打通从技术实现到系统交付的关键路径,提升独立完成 Go 项目的综合能力。

2026.02.26

62

7

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Kratos框架快速入门
Kratos框架快速入门

共0课时 | 0人学习

Kratos框架v3文档
Kratos框架v3文档

共0课时 | 0人学习