Go语言错误处理

错误类型

error

在Go语言中，error 是一个内置的接口类型，用于表示错误。

type error interface {
    Error() string
}

任何实现了 Error() 方法的类型都被认为是一个错误类型。这种设计使得错误处理灵活且可扩展。

示例：

func DoSomething() error {
    // 发生错误，返回一个 error
    return errors.New("发生了一个错误")
}

创建错误

为了提供更多的上下文信息，通常需要创建自定义错误类型。

使用 errors.New

errors 包提供了 New 函数，可以创建一个基本的错误。

import "errors"

err := errors.New("这是一个错误")

使用 fmt.Errorf

fmt 包的 Errorf 函数允许使用格式化字符串创建错误。

import "fmt"

err := fmt.Errorf("操作失败：%s", reason)

自定义错误类型

可以创建一个结构体，实现 error 接口。

type MyError struct {
    Code    int
    Message string
}

func (e *MyError) Error() string {
    return fmt.Sprintf("错误代码 %d: %s", e.Code, e.Message)
}

使用自定义错误：

func DoSomething() error {
    return &MyError{Code: 404, Message: "资源未找到"}
}

错误的包装与解包

Go 1.13 引入了错误包装机制，允许将上下文信息添加到错误中，同时保留原始错误。

错误包装

使用 fmt.Errorf 的 %w 动词来包装错误。

err := fmt.Errorf("操作失败: %w", originalErr)

错误解包

使用 errors 包的 Unwrap、Is 和 As 函数来处理被包装的错误。

• errors.Unwrap()：获取被包装的原始错误。

  unwrappedErr := errors.Unwrap(err)

• errors.Is()：判断错误链中是否存在特定的错误。

  if errors.Is(err, os.ErrNotExist) {
      // 处理文件不存在的情况
  }

• errors.As()：判断错误链中是否存在特定类型的错误，并获取它。

  var myErr *MyError
  if errors.As(err, &myErr) {
      fmt.Println(myErr.Code)
  }

错误处理的原则

及早返回错误

当函数执行过程中发生错误，应立即返回，不要继续执行。

func ReadFile(path string) ([]byte, error) {
    data, err := ioutil.ReadFile(path)
    if err != nil {
        return nil, err // 及早返回错误
    }
    // 继续处理数据
    return data, nil
}

不要吞掉错误

不要忽略错误，或者简单地打印错误消息而不返回。

// 不推荐的做法
if err != nil {
    fmt.Println("发生错误")
    // 继续执行，可能导致未知行为
}

检查所有可能的错误

对于返回错误的函数调用，应始终检查并处理错误。

// 错误的做法
data, _ := ioutil.ReadFile("config.json")

// 正确的做法
data, err := ioutil.ReadFile("config.json")
if err != nil {
    return err
}

提供上下文信息

在返回错误时，添加有用的上下文信息，方便调试和定位问题。

if err != nil {
    return fmt.Errorf("读取配置文件失败: %w", err)
}

静态分析

使用 go vet、golint 等工具，检查项目中未处理的错误。

go vet ./...