0

0

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

P粉602998670

P粉602998670

发布时间: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.Iserrors.As 支持自定义错误的链式判断。但前提是你的错误类型实现了 Unwrap() error(用于包装)或正确响应 Is(target error) bool

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

  • 若只做简单错误码判断,无需包装,可直接在 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 提取的那一刻。漏掉一处类型断言,整个码体系就断了。

相关专题

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

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

178

2024.02.23

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

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

226

2024.02.23

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

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

337

2024.02.23

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

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

208

2024.03.05

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

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

389

2024.05.21

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

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

195

2025.06.09

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

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

191

2025.06.10

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

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

192

2025.06.17

Golang gRPC 服务开发与Protobuf实战
Golang gRPC 服务开发与Protobuf实战

本专题系统讲解 Golang 在 gRPC 服务开发中的完整实践,涵盖 Protobuf 定义与代码生成、gRPC 服务端与客户端实现、流式 RPC(Unary/Server/Client/Bidirectional)、错误处理、拦截器、中间件以及与 HTTP/REST 的对接方案。通过实际案例,帮助学习者掌握 使用 Go 构建高性能、强类型、可扩展的 RPC 服务体系,适用于微服务与内部系统通信场景。

6

2026.01.15

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Node.js 教程
Node.js 教程

共57课时 | 8.6万人学习

CSS3 教程
CSS3 教程

共18课时 | 4.5万人学习

Vue 教程
Vue 教程

共42课时 | 6.5万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号