17370845950

如何在Golang中实现自定义错误类型_定义结构体和Error方法

在 Go 中实现自定义错误类型,核心是定义一个结构体,并为它实现 Error() 方法(签名必须是 func() string)。Go 的 error 接口非常简洁,只包含这一个方法,因此只要你的类型实现了它,就自动满足 error 接口。

定义带字段的错误结构体

常见做法是定义一个结构体,内嵌必要信息(如错误码、消息、时间、上下文等),便于调试和分类处理。

例如:

type MyError struct {
    Code    int
    Message string
    File    string
    Line    int
}

func (e *MyError) Error() string {
    return fmt.Sprintf("[%d] %s at %s:%d", e.Code, e.Message, e.File, e.Line)
}

这样创建错误时可以携带丰富上下文:

err := &MyError{
    Code:    4001,
    Message: "invalid user ID",
    File:    "user.go",
    Line:    23,
}
log.Println(err.Error()) // [4001] invalid user ID at user.go:23

让错误支持 fmt.Errorf 包装(可选但推荐)

如果希望自定义错误能被 fmt.Errorf("wrap: %w", err) 正确包装(即支持错误链),需额外实现 Unwrap() error 方法:

type MyError struct {
    Code    int
    Message string
    Cause   error // 可选:用于嵌套原始错误
}

func (e *MyError) Error() string {
    if e.Cause != nil {
        return fmt.Sprintf("%s: %v", e.Message, e.Cause)
    }
    return e.Message
}

func (e *MyError) Unwrap() error {
    return e.Cause
}

之后就能用标准方式包装和检查:

original := errors.New("network timeout")
err := &MyError{Code: 500, Message: "service unavailable", Cause: original}
wrapped := fmt.Errorf("backend failed: %w", err)

fmt.Println(errors.Is(wrapped, original)) // true
fmt.Println(errors.Unwrap(wrapped))         // &MyError{...}

提供便捷构造函数(提高可用性)

避免每次手动 new 结构体,封装工厂函数更符合 Go 习惯:

func NewMyError(code int, format string, args ...interface{}) error {
    return &MyError{
        Code:    code,
        Message: fmt.Sprintf(format, args...),
    }
}

// 使用
err := NewMyError(404, "user %s not found", userID)

区分临时性错误(Temporary)或超时错误(Timeout)

某些场景(如 net 包)会检查错误是否实现了 Temporary() boolTimeout() bool。若需兼容这些逻辑,可选择性实现:

func (e *MyError) Temporary() bool {
    return e.Code == 408 || e.Code == 429 || e.Code >= 500 && e.Code < 600
}

func (e *MyError) Timeout() bool {
    return e.Code == 408
}

这样 net/http 客户端或重试库就能根据返回值做智能判断。