如何使用Golang的error接口_Golang自定义error接口与实现方法

go 的 Error 接口仅含 Error() String 方法，任何实现该方法的类型即为 error；标准库 errors.New 返回私有结构体 errors.errorString；自定义 error 需实现该方法，推荐用指针接收者 Struct 携带上下文字段，并可选实现 Unwrap() 以支持 errors.Is/As 和 fmt.Errorf(“%w”) 包装。

Go 的 error 接口到底长什么样

Go 的 error 接口非常简单，就一个方法：Error() string。任何实现了这个方法的类型，自动就是 error 类型。它不是抽象类，也不是需要显式继承的东西，纯粹靠结构满足——这正是 Go “鸭子类型”的体现。

标准库里的 errors.New("xxx") 返回的是一个内置的私有结构体（errors.errorString），它只存一个字符串，Error() 方法就直接返回它。

所以自定义 error 的核心就一条：写个类型，实现 Error() string 方法。

用 struct 实现带字段的 error（最常用）

当错误需要携带上下文（比如失败的 ID、http 状态码、重试次数），用 struct 最自然。注意别漏了导出字段（首字母大写），否则外部包无法访问。

立即学习“go语言免费学习笔记（深入）”；

type ValidationError struct {     Field   string     Value   interface{}     Message string }  func (e *ValidationError) Error() string {     return e.Message }  // 使用 err := &ValidationError{     Field:   "email",     Value:   "invalid@",     Message: "email format invalid", } fmt.Println(err.Error()) // email format invalid

• 建议用指针接收者（func (e *ValidationError) Error()），避免复制大结构体；但哪怕值接收者也合法，只要方法存在
• 不要在 Error() 里 panic 或调用可能出错的函数——它必须是纯、快、稳的
• 如果要支持 fmt.Errorf 包装（Go 1.13+），记得嵌入 Unwrap() error 方法并返回底层 error

用 errors.Is 和 errors.As 判断自定义 error 类型

直接用 == 或 reflect.DeepEqual 判断 error 是反模式。Go 1.13 引入了 errors.Is（判断是否为同一错误值或其包装链中存在）和 errors.As（尝试把 error 转成具体类型）。

if errors.Is(err, io.EOF) { ... } var ve *ValidationError if errors.As(err, &ve) {     log.Printf("validation failed on field %s", ve.Field) }

• errors.As 第二个参数必须是指向目标类型的指针变量（&ve），不是类型字面量
• 如果你的自定义 error 没实现 Unwrap() error，它就不会被 errors.Is/errors.As 向下穿透；若需支持包装（如用 fmt.Errorf("failed: %w", err)），必须手动加 Unwrap 方法
• 多个嵌套包装时，errors.As 会逐层查找，不只看顶层

什么时候该用 fmt.Errorf(“%w”) 而不是拼接字符串

用 %w 是为了保留原始 error 的类型和值信息，让上层能用 errors.As 或 errors.Is 做精准判断。纯字符串拼接（"failed: " + err.Error()）会丢失所有类型信息，变成一个普通 errors.errorString。

// ✅ 保留原始 error 的可判定性 return fmt.Errorf("processing user %d failed: %w", userID, err)  // ❌ 变成无意义字符串，下游无法识别是不是 io.EOF 或 ValidationError return fmt.Errorf("processing user %d failed: %s", userID, err.Error())

• %w 只能用一次，且必须是最后一个动词（%w 后不能再跟其他格式化动词）
• 被包装的 error 如果本身是 nil，fmt.Errorf(... %w) 结果也是 nil —— 这是安全的，不用额外判空
• 如果原始 error 已经带堆栈（比如用 github.com/pkg/errors），%w 不会自动继承堆栈；Go 标准库目前不提供原生堆栈捕获，需借助 runtime/debug.Stack() 或第三方库

自定义 error 看似简单，真正难的是设计它的字段粒度、是否支持包装、要不要带堆栈、以及上下游如何一致使用 errors.As 做类型断言——这些细节一旦定错，排查链路就会断裂。