在 Go 中返回 nil 或自定义错误

Question

在 Go 中使用自定义 Error 类型时（使用额外字段来捕获一些详细信息），当尝试将 nil 作为此类型的值返回时，我会收到类似 cannot convert nil to type DetailedError 或 cannot use nil as type DetailedError in return argument 之类的编译错误，从代码看起来大多是这样的：

type DetailedError struct {
    x, y int
}

func (e DetailedError) Error() string {
    return fmt.Sprintf("Error occured at (%s,%s)", e.x, e.y)
}

func foo(answer, x, y int) (int, DetailedError) {
    if answer == 42 {
        return 100, nil  //!! cannot use nil as type DetailedError in return argument
    }
    return 0, DetailedError{x: x, y: y}
}

（完整的sn-p：https://play.golang.org/p/4i6bmAIbRg）

解决这个问题的惯用方法是什么？（或任何可行的方法......）

我实际上需要额外的错误字段，因为我有详细的错误消息，这些错误消息是由复杂逻辑从更简单的逻辑等构建的，如果我只是回到“字符串错误”，我基本上必须解析 将这些字符串分解成碎片并根据它们发生逻辑等等，这看起来真的很难看（我的意思是，为什么要序列化到字符串信息，你知道以后需要反序列化......）

Answer 1

不要使用DetailedError作为返回类型，始终使用error：

func foo(answer, x, y int) (int, error) {
    if answer == 42 {
        return 100, nil  //!! cannot use nil as type DetailedError in return argument
    }
    return 0, DetailedError{x: x, y: y}
}

您的DetailedError 类型满足error 接口这一事实足以完成这项工作。然后，在您的调用者中，如果您关心额外的字段，请使用类型断言：

value, err := foo(...)
if err != nil {
    if detailedErr, ok := err.(DetailedError); ok {
        // Do something with the detailed error values
    } else {
        // It's some other error type, behave accordingly
    }
}

不回DetailedError的原因：

现在看起来可能无关紧要，但将来您的代码可能会扩展以包含额外的错误检查：

func foo(answer, x, y int) (int, error) {
    cache, err := fetchFromCache(answer, x, y)
    if err != nil {
        return 0, fmt.Errorf("Failed to read cache: %s", err)
    }
    // ... 
}

其他错误类型不会是DetailedError 类型，因此您必须返回error。

此外，您的方法可能会被不知道或不关心 DetailedError 类型的其他调用者使用：

func fooWrapper(answer, x, y int) (int, error) {
    // Do something before calling foo
    result, err := foo(answer, x, y)
    if err != nil {
        return 0, err
    }
    // Do something after calling foo
    return result, nil
}

期望函数的每个调用者都理解自定义错误类型是不合理的——这正是接口，特别是 error 接口存在于 Go 中的原因。

利用这一点，不要规避它。

即使您的代码从不更改，为每个函数或用例设置新的自定义错误类型也是不可持续的，并且会使您的代码不可读且无法推理。

Answer 2

解决问题的惯用方法是返回错误接口。

如果你确实需要一个不属于错误接口的函数，你应该创建一个扩展错误接口的新接口。

type DetailedErrorInterface interface {
  error
  GetX() int //need to implement
  GetY() int //need to implement
}

然后，你必须改变你的函数来返回这个接口：

func foo(answer, x, y int) (int, DetailedErrorInterface) {
  if answer == 42 {
    return 100, nil
  }
  return 0, DetailedError{x: x, y: y}
}

Answer 3

DetailedError struct 零值不是nil 而是DetailedError{}。您可以返回error 接口而不是DetailedError

func foo(answer, x, y int) (int, error) {

或使用指针

func foo(answer, x, y int) (int, *DetailedError) {
...
//and
func (e *DetailedError) Error() string {