在 golang 中使用 customerror 类型可以优雅地处理函数中的错误，为您提供：自定义错误消息以提供更多详细信息。错误分类以将错误分组到类别中。错误堆栈跟踪以帮助追踪错误的根源。

如何通过 Golang 的 CustomError 类型优雅地处理函数中的错误

简介

在 Golang 中处理错误至关重要，它可以帮助你写出健壮且可维护的代码。使用标准的 error 类型 zwar 有效，但有时你需要更丰富的错误信息，例如：

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

• 自定义错误消息： 提供有关错误的更具体信息。
• 错误分类： 将错误分组到不同的类别中，以便于处理和记录。
• 错误堆栈跟踪： 帮助追踪错误的根源。

Golang 中的 CustomError 类型可以满足这些需求，因为它提供了比标准 error 类型更高级的功能。

创建 CustomError 类型

Golang Uber Dig

使用 uber-go/dig 在 Golang 中实现依赖注入——基于反射容器，提供 Provide/Invoke、dig.In/dig.Out 参数与结果对象，支持命名依赖等

下载

创建一个新的 error 类型很容易，只需要实现 error 接口即可：

import (
  "fmt"
)

// CustomError 代表一个自定义错误类型
type CustomError struct {
  Message string
  Category string
  StackTrace []uintptr
}

// Error() 实现 error 接口，返回错误信息
func (ce CustomError) Error() string {
  return fmt.Sprintf("Error: %s", ce.Message)
}

使用 CustomError 类型

现在你可以使用新的 CustomError 类型来处理你的函数中的错误。以下是如何使用它的步骤：

1. 创建 CustomError 实例： 根据错误情况创建 CustomError 的实例，提供自定义错误消息、类别和堆栈跟踪。
2. 返回 CustomError： 在你的函数中返回 CustomError 实例，而不是标准的 error 值。
3. 检查 CustomError： 在调用函数的地方，使用 errors.Is() 或 errors.As() 函数来检查错误类型是否与你的 CustomError 类型匹配。
4. 获取自定义信息： 一旦你确定错误类型是 CustomError，你可以通过类型转换访问自定义错误消息、类别和堆栈跟踪。

实战案例

考虑以下函数，它打开一个文件并对其进行读取：

func readFile(filename string) (string, error) {
  data, err := ioutil.ReadFile(filename)
  if err != nil {
    return "", err
  }

  return string(data), nil
}

使用 CustomError 类型，此函数可以提供更丰富的错误信息：

import (
  "fmt"
  "io/ioutil"

  "errors"
)

// FileError 代表读取文件时可能发生的错误的自定义错误
type FileError struct {
  Message string
  Category string
  StackTrace []uintptr
}

// Error() 实现 error 接口，返回错误信息
func (fe FileError) Error() string {
  return fmt.Sprintf("Error: %s", fe.Message)
}

func readFile(filename string) (string, error) {
  data, err := ioutil.ReadFile(filename)
  if err != nil {
    // 创建 FileError 实例并返回
    return "", FileError{
      Message: fmt.Sprintf("Failed to read file: %s", filename),
      Category: "File Read Error",
      StackTrace: errors.Callers(1),
    }
  }

  return string(data), nil
}

现在，当调用 readFile 函数并发生错误时，你可以使用 errors.Is() 或 errors.As() 检查错误是否属于 FileError 类型，并访问自定义错误信息、类别和堆栈跟踪：

data, err := readFile("non-existent.txt")

// 检查错误是否属于 FileError 类型
if errors.Is(err, FileError{}) {
  // 类型转换以访问自定义错误信息和类别
  fileError := err.(FileError)
  fmt.Println("File Read Error:", fileError.Message)
  fmt.Println("Category:", fileError.Category)
  fmt.Println("StackTrace:", fileError.StackTrace)
} else {
  fmt.Println("Unknown error:", err)
}