讲师中心 微信公众号
AI工具推荐 视频效率加速

如何为Golang错误添加错误码_Golang错误码设计与使用方法

夏杰吖_7142

夏杰吖_7142

发布时间:2026-01-15 11:34:51

|

239人浏览过

|

来源于php中文网

原创

Go语言需扩展error接口以支持结构化错误码,推荐定义含Code()方法的整型码结构体,确保实现Error()和Unwrap()以便errors.Is/As正确识别,并分层设计码值、避免动态拼接,统一在日志与gRPC中透传。

如何为golang错误添加错误码_golang错误码设计与使用方法

Go 语言原生的 error 接口不带错误码,直接用字符串描述错误(如 errors.New("not found"))无法结构化识别问题类型。要支持错误分类、日志聚合、前端提示映射或 RPC 错误透传,必须自己扩展错误类型——核心是让错误值携带可比较的错误码,并保持与标准库兼容。

定义带错误码的自定义错误类型

最常用方式是定义一个结构体,嵌入 error 字段或实现 Error() 方法,同时暴露 Code() 方法返回整型或字符串码。推荐用整型码(如 HTTP 状态码风格),便于数值比较和 switch 判断。

type CodeError struct {
    code int
    msg  string
}

func (e *CodeError) Error() string { return e.msg }
func (e *CodeError) Code() int     { return e.code }

var (
    ErrNotFound = &CodeError{code: 404, msg: "resource not found"}
    ErrInvalid  = &CodeError{code: 400, msg: "invalid parameter"}
)

注意:不要用指针接收者定义 Code() 时返回值为 int,否则 fmt.Printf("%v", err) 可能 panic(未实现 error 接口)。确保结构体显式实现 error 接口(即有 Error() string 方法)。

用 errors.Is / errors.As 判断带码错误

Go 1.13+ 的 errors.Is 和 errors.As 支持自定义错误的链式判断。但前提是你的错误类型实现了 Unwrap() error(用于包装)或正确响应 Is(target error) bool。

立即学习“go语言免费学习笔记(深入)”;

Git Factory
Git Factory

为每个编码任务配置并管理独立的 Git worktree,支持并行分支和清晰的 PR 工作流,避免合并冲突。

下载
  • 若只做简单错误码判断,无需包装,可直接在 Is 中比对指针:errors.Is(err, ErrNotFound)
  • 若需从包装错误中提取原始码(例如 fmt.Errorf("failed: %w", ErrNotFound)),则必须实现 Unwrap() error:
func (e *CodeError) Unwrap() error { return nil } // 表示无下层错误
// 或包装时返回被包装错误:
func WrapCode(err error, code int, msg string) error {
    return &wrappedCodeError{
        code: code,
        msg:  msg,
        err:  err,
    }
}
type wrappedCodeError struct {
    code int
    msg  string
    err  error
}
func (e *wrappedCodeError) Error() string { return e.msg }
func (e *wrappedCodeError) Code() int     { return e.code }
func (e *wrappedCodeError) Unwrap() error { return e.err }

此时 errors.As(err, &target) 才能成功把底层 *CodeError 提取出来。

避免在错误码中混用业务状态和系统错误

错误码不是 HTTP 状态码的简单复刻。常见误区是把所有“失败”都塞进 Code(),比如数据库连接失败返回 500、用户未登录也返回 500,导致上层无法区分是重试还是跳转登录页。

  • 建议分层设计:定义公共错误码常量集(如 CodeDBConnection = 1001)、业务错误码(如 CodeUserNotActive = 2001)
  • HTTP 层再做一次映射:不是所有 CodeDBConnection 都返回 500,某些场景可降级为 404 或 429
  • 禁止在 Code() 返回值里动态拼接数字(如 return 400 + id),这破坏可枚举性和日志分析能力

日志与 gRPC 场景下的错误码透传

日志中仅打印 err.Error() 会丢失码信息;gRPC 的 status.Code 要求明确映射。关键是在日志打点和 RPC 响应前,先提取并结构化错误码。

// 日志示例(使用 zap)
if ce, ok := errors.Cause(err).(*CodeError); ok {
    logger.Error("operation failed", zap.Int("code", ce.Code()), zap.String("msg", ce.Error()))
} else {
    logger.Error("unknown error", zap.Error(err))
}

// gRPC server 示例
func (s *Service) Do(ctx context.Context, req *pb.Request) (*pb.Response, error) {
    err := s.biz.Do(req)
    if err != nil {
        if ce, ok := err.(*CodeError); ok {
            return nil, status.Error(codes.Code(ce.Code()), ce.Error())
        }
        return nil, status.Error(codes.Internal, err.Error())
    }
    return &pb.Response{}, nil
}

注意 errors.Cause 来自 github.com/pkg/errors,Go 1.20+ 更推荐用 errors.Unwrap 循环获取最底层错误,但需小心无限循环(包装层数过多或循环引用)。

错误码真正起作用的地方不在定义那一刻,而在所有调用方一致检查 err.(interface{ Code() int }) 或用 errors.As 提取的那一刻。漏掉一处类型断言,整个码体系就断了。

热门AI工具

更多
WorkBuddy

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

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

DeepSeek

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

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

豆包大模型

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

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

Laper
Laper Hot

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

相关专题

更多
golang如何定义变量
golang如何定义变量

golang定义变量的方法:1、声明变量并赋予初始值“var age int =值”;2、声明变量但不赋初始值“var age int”;3、使用短变量声明“age :=值”等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

519

2024.02.23

golang有哪些数据转换方法
golang有哪些数据转换方法

golang数据转换方法:1、类型转换操作符;2、类型断言;3、字符串和数字之间的转换;4、JSON序列化和反序列化;5、使用标准库进行数据转换;6、使用第三方库进行数据转换;7、自定义数据转换函数。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

596

2024.02.23

golang常用库有哪些
golang常用库有哪些

golang常用库有:1、标准库;2、字符串处理库;3、网络库;4、加密库;5、压缩库;6、xml和json解析库;7、日期和时间库;8、数据库操作库;9、文件操作库;10、图像处理库。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

1116

2024.02.23

golang和python的区别是什么
golang和python的区别是什么

golang和python的区别是:1、golang是一种编译型语言,而python是一种解释型语言;2、golang天生支持并发编程,而python对并发与并行的支持相对较弱等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

771

2024.03.05

golang是免费的吗
golang是免费的吗

golang是免费的。golang是google开发的一种静态强类型、编译型、并发型,并具有垃圾回收功能的开源编程语言,采用bsd开源协议。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

1666

2024.05.21

golang结构体相关大全
golang结构体相关大全

本专题整合了golang结构体相关大全,想了解更多内容,请阅读专题下面的文章。

4654

2025.06.09

golang相关判断方法
golang相关判断方法

本专题整合了golang相关判断方法,想了解更详细的相关内容,请阅读下面的文章。

2134

2025.06.10

golang数组使用方法
golang数组使用方法

本专题整合了golang数组用法,想了解更多的相关内容,请阅读专题下面的文章。

4026

2025.06.17

OpenJDK JVM参数怎么调优
OpenJDK JVM参数怎么调优

Java应用运行缓慢,如何调整JVM参数?本专题介绍OpenJDK JVM性能调优的基本流程,涵盖性能指标确认、运行数据采集、内存配置和垃圾回收分析,帮助你先定位瓶颈,再通过对照测试验证效果,避免直接套用参数而影响应用稳定性。

20

2026.10.16

热门下载

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

精品课程

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

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