17370845950

如何使用Golang自定义错误类型_定义结构体实现Error接口
Go中自定义错误最规范方式是定义结构体并实现Error()方法;可携带字段如Field、Code、Cause等,并支持错误链Unwrap,指针接收者避免拷贝且需返回可读字符串。

在 Go 语言中,自定义错误类型最常用、最规范的方式是定义一个结构体,并让其实现 Error() 方法(即满足 error 接口)。这种方式比简单用 fmt.Errorf 更具表现力,能携带上下文、状态码、原始错误等信息,便于错误分类、日志记录和上层处理。

定义结构体并实现 error 接口

Go 的 error 接口非常简单:

type error interface {
  Error() string
}

只要结构体实现了 Error() string 方法,它就是合法的错误类型。例如:

type ValidationError struct {
  Field string
  Value interface{}
  Reason string
}

func (e *ValidationError) Error() string {
  return fmt.Sprintf("validation failed on field %q: %v (%s)", e.Field, e.Value, e.Reason)
}

注意:方法接收者建议用指针(*ValidationError),避免拷贝;同时确保返回有意义、可读的字符串。

携带额外字段与错误链支持

真实项目中,错误往往需要携带更多信息,比如 HTTP 状态码、错误码、原始错误(cause)、时间戳等。还可以结合 Go 1.13+ 的错误链特性(Unwrap):

type ApiError struct {
  Code int
  Message string
  Cause error
func (e *ApiError) Error() string {
  return fmt.Sprintf("API error %d: %s", e.Code, e.Message)
}

// 支持 errors.Is / errors.As 判断
func (e *ApiError) Unwrap() error { return e.Cause }

这样就能用 errors.Is(err, someTargetErr)errors.As(err, &target) 进行语义化错误匹配。

提供构造函数和快捷方法

避免直接 new 结构体,推荐封装构造函数,统一错误创建逻辑:

func NewValidationError(field string, value interface{}, reason string) error {
  return &ValidationError{Field: field, Value: value, Reason: reason}
}

func NewBadRequestError(msg string) error {
  return &ApiError{Code: 400, Message: msg}
}

还可为常用场景添加方法,如:

func (e *ApiError) IsClientError() bool { return e.Code >= 400 && e.Code func (e *ApiError) StatusCode() int { return e.Code }

在业务中使用与判断

抛出时直接返回自定义错误实例;捕获时可用类型断言或 errors.As 提取:

if err != nil {
  if ve, ok := err.(*ValidationError); ok {
    log.Printf("Validation error on %s: %v", ve.Field, ve.Value)
  } else if errors.Is(err, io.EOF) {
    // 处理标准错误
  }
}

更推荐用 errors.As,它能穿透错误包装链:

var ve *ValidationError
if errors.As(err, &ve) {
  log.Printf("Found validation error: %s", ve.Error())
}