Golang错误定义与公共错误声明方法

本篇文章给大家分享《Golang错误变量定义与公共错误声明模式》，覆盖了Golang的常见基础知识，其实一个语言的全部知识点一篇文章是不可能说完的，但希望通过这些问题，让读者对自己的掌握程度有一定的认识(B 数)，从而弥补自己的不足，更好的掌握它。

Go中通过var声明公共错误变量，如ErrNotFound，使用fmt.Errorf配合%w包装错误以保留原错误链，支持errors.Is和errors.As判断，自定义错误类型可携带状态码等信息，遵循Err开头、小写描述、复用变量等最佳实践，提升代码可读性和错误处理一致性。

在Go语言中，错误处理是通过返回值显式处理的，因此定义清晰、可复用的错误变量非常重要。为了提升代码可读性和一致性，Go社区形成了一套公共错误声明的模式。

使用 var 声明公共错误

最常见的方式是在包级别使用 var 块声明错误变量，配合 errors.New 初始化。这些错误通常表示函数可能返回的特定失败情况。

var (
    ErrNotFound          = errors.New("resource not found")
    ErrInvalidArgument   = errors.New("invalid argument provided")
    ErrUnauthorized      = errors.New("unauthorized access")
    ErrTimeout           = errors.New("operation timed out")
)

这种方式让错误在整个包甚至其他包中都能被引用，调用方可以使用 errors.Is 进行判断。

使用 fmt.Errorf 配合 %w 实现包装错误

当需要附加上下文但又保留原始错误类型时，应使用 fmt.Errorf 并配合 %w 动词进行错误包装。

if err := readFile(); err != nil {
    return fmt.Errorf("failed to read config: %w", err)
}

这样既保留了底层错误链，又能提供更丰富的上下文信息，同时支持 errors.Is 和 errors.As 的匹配。

自定义错误类型以携带更多信息

对于需要携带额外数据（如状态码、时间戳）的场景，可以定义实现 error 接口的结构体。

type AppError struct {
    Code    int
    Message string
    Err     error
}

func (e *AppError) Error() string {
    return fmt.Sprintf("[%d] %s: %v", e.Code, e.Message, e.Err)
}

func (e *AppError) Unwrap() error {
    return e.Err
}

这种模式适合构建分层应用中的错误体系，便于中间件统一处理和日志记录。

错误定义的最佳实践

遵循以下建议能让错误系统更清晰可靠：

• 错误变量名以 Err 开头，符合Go命名惯例
• 使用小写英文描述，避免包含句号
• 尽量复用已定义的错误变量而非每次新建
• 公开的错误应文档化其用途和触发条件
• 私有错误可用小写 errXXX 命名

基本上就这些。Go的错误机制虽简单，但通过合理定义和组织错误变量，能构建出健壮且易于调试的程序。关键在于保持一致性，并善用标准库提供的工具。

文中关于的知识介绍，希望对你的学习有所帮助！若是受益匪浅，那就动动鼠标收藏这篇《Golang错误定义与公共错误声明方法》文章吧，也可关注golang学习网公众号了解相关技术文章。