讲师中心 微信公众号

工具推荐

视频效率加速
立刻MV
立刻MV

低成本歌曲 MV、视频生成

剧云
剧云

中文短剧剧本制作平台

AniShort
AniShort

AI短剧协同制作平台

SoundView
SoundView

字幕擦除翻译、配音口型同步

Kratos框架怎么自定义统一错误码规范

雨杰吖_5568

雨杰吖_5568

发布时间:2026-11-19 08:29:06

|

907人浏览过

|

来源于php中文网

原创

必须在 .proto 中定义 ErrorReason 枚举并为每项显式标注 (errors.code),所有业务错误须用 errors.Xxx() 封装返回,否则 HTTP 状态码、gRPC Code、Swagger 文档及 errors.Is() 判断全部失效。

kratos框架怎么自定义统一错误码规范

必须在服务对应的 .proto 文件中定义 ErrorReason 枚举,每个值显式绑定 (errors.code),且所有业务错误必须通过 errors.Xxx() 封装返回——否则 HTTP 状态码、gRPC Code、Swagger 文档、跨服务 errors.Is() 判断全部失效。

错误码必须定义在 .proto 里,不能 runtime 拼凑

Kratos 不接受 errors.New("user not found") 或 fmt.Errorf("invalid token: %s", t) 这类运行时构造的错误。这类错误会被 transport 层 fallback 到 500 Internal Server Error,丢失语义和状态码控制。

  • ErrorReason 枚举需与 service 同级声明,命名非强制但强烈推荐为 ErrorReason
  • 每个枚举项必须加 (errors.code) = NNN 注解,例如:USER_NOT_FOUND = 0 [(errors.code) = 404];
  • 未加注解的项默认走 (errors.default_code) = 500,但不可依赖——它会让前端无法按状态码分支处理
  • 生成代码后,会产出类型安全的错误变量,如 helloworld.ErrUserNotFound

返回错误必须用 errors.Xxx() 封装,不是直接 return

handler 里不能直接 return errors.New(...),而要调用 Kratos 提供的封装函数,把底层 error 转成 proto 中定义的 enum 实例。

Kratos框架 2.8.2
Kratos框架 2.8.2

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

下载
  • 函数签名是 errors.BadRequest(errReason, "描述"),第一个参数是 .proto 中定义的枚举值(如 helloworld.USER_NOT_FOUND),第二个是 human-readable 描述
  • 这样返回后,HTTP 层自动设 Status: 404,gRPC 层设 Code: NotFound,message 字段含你传的描述
  • errors.New 和 errors.WithMessage 只能用于内部包装,比如数据库层报错后加 context,但最终仍需用 errors.NotFound(...) 封装再向上抛
  • 手动在 middleware 里调 w.WriteHeader(404) 会覆盖框架自动提取的 status,导致文档与实际响应不一致

验证是否生效:看 curl 响应头 + errors.Is() 匹配

最直接的验证方式是调用接口并检查原始响应,而不是只看 JSON body。

  • 执行 curl -v http://localhost:8000/v1/user/999,确认响应头中 Status: 404 Not Found 与 proto 中 (errors.code) = 404 一致
  • 在另一个服务或单元测试中,用 errors.Is(err, helloworld.ErrUserNotFound) 判断类型,而非字符串匹配 strings.Contains(err.Error(), "not found")
  • 如果始终返回 500,优先检查:.proto 是否漏了 (errors.code);返回 error 是否来自 errors.Xxx();errors.Xxx() 第一个参数是否拼写正确(大小写、包路径)

最容易被忽略的是:错误码的语义一致性依赖于团队对 ErrorReason 枚举的共同维护——一旦某个枚举值被多个服务复用(如 INVALID_ARGUMENT),它的 (errors.code) 就必须统一,否则跨服务调用时 errors.Is() 会因包路径不同而失败。这不是框架限制,而是契约约定。

热门AI工具

更多
讯飞智文

一款面向学习和办公场景的AI文档创作工具,可辅助生成PPT与Word文档,提高资料整理和内容制作效率。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

相关专题

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

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

246

2026.02.24

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

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

153

2026.02.24

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

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

697

2026.02.24

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

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

238

2026.02.24

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

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

537

2026.02.24

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

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

228

2026.02.24

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

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

604

2026.02.26

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

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

265

2026.02.26

GoFrame框架Web开发与路由中间件
GoFrame框架Web开发与路由中间件

本专题聚焦GoFrame框架的Web开发,拆解路由注册与匹配规则、请求参数获取、参数校验与中间件执行顺序,说明统一响应、JWT鉴权、文件上传与接口文档生成的落地方式,并补充优雅重启与测试实践。

0

2026.11.17

热门下载

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

精品课程

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

共0课时 | 0人学习

Kratos框架快速入门
Kratos框架快速入门

共0课时 | 0人学习

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

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn