go - Go 有标准的 Err 变量吗？

Question

刚开始使用 Golang。我认为声明一个错误变量并在您的错误结构中使用它来确定出了什么问题是惯用的，就像在 strconv.go 中所做的那样。 .在那里，声明了 ErrRange 和 ErrSyntax，并且在适当的时候，对它们的引用在它们返回时存储在 NumError 结构中。我认为原因是因为可以将对存储在 NumError 中的错误的引用地址与 ErrRange 和 ErrSyntax 变量进行比较确定返回了哪种类型的错误。

是否存在“标准”的此类声明错误类型？例如，在 Java 中，您有类似 java.lang.IllegalArgumentException 的东西。例如，是否可以在我自己的代码中使用 ErrArgument 或 ErrUnsupportedOperation 而不是创建每次都表示相同内容的新错误变量？

Answer 1

包作者有几种常见的惯用方法来返回错误。

1. 固定错误变量，通常命名为Err…

   var (
           ErrSomethingBad = errors.New("some string")
           ErrKindFoo      = errors.New("foo happened")
   )
   

2. 错误类型，通常命名为…Error

   type SomeError struct {
        // extra information, whatever might be useful to callers
        // (or for making a nice message in `Error()`)
        ExtraInfo int
   }
   type OtherError string
   
   func (e SomeError) Error() string { /* … */ }
   func (e OtherError) Error() string {
           return fmt.Sprintf("failure doing something with %q", string(e))
   }
   

   使用 Go 1.13 及更高版本，您可能还想实现一个 Unwrap() error 方法以与 errors.Unwrap 一起使用.

3. 根据需要临时设置 errors.New 值。

   func SomepackageFunction() error {
           return errors.New("not implemented")
   }
   

4. 使用标准包中定义的错误。通常限于一个小集合，如io.EOF；在大多数情况下，最好通过上面的方法 1 创建您自己的。

   func SomeFunc() error {
           return io.EOF
   }
   

   请注意，有时在实现接口(interface)时(例如将 Read 方法变成 io.Reader)， 最好使用匹配错误(或接口(interface)规范“要求”)。

5. 制作一个类似net.Error的界面:

   type Error interface {
       error
       Timeout() bool   // Is the error a timeout?
       Temporary() bool // Is the error temporary?
   }
   

6. 使用 Go 1.13 或更高版本，返回具有简单上下文的现有错误(对于更复杂的上下文，使用带有 Unwrap() 方法的自定义错误类型):

   func SomepackageFunction() error {
       err := somethingThatCanFail()
       if err != nil {
               return fmt.Errorf("some context: %w", err)
       }
   }
   

   注意新的(Go 1.13)格式化动词 %w，它包装了提供的错误，以便调用者可以使用 errors.Unwrap 或 获取它错误。是。

通常您会混合使用所有这些方式。

如果您认为您的包的任何用户永远想要测试特定错误，则首选第一个、第二个和第五个。他们允许这样的事情:

err := somepkg.Function()
if err == somepkg.ErrSomethingBad {
        // …
}
// or for an error type, something like:
if e, ok := err.(somepkg.SomeError); ok && e.ExtraInfo > 42 {
        // use the fields/methods of `e` if needed
}

对于 Go 1.13 或更高版本，上面的内容可以改写为:

err := somepkg.Function()
if errors.Is(err, somepkg.ErrSomethingBad) {
        // …
}
// or for an error type, something like:
var someErr somepkg.SomeError
if errors.As(err, &someErr) && someErr.ExtraInfo > 42 {
        // use the fields/methods of `someErr` if needed
}

不同之处在于错误将根据需要展开。

第五种方式(只是第二种方式的扩展)允许像这样检查行为/类型的错误(或使用 Go 1.13 的 errors.As):

if e, ok := err.(net.Error); ok && e.Timeout() {
        // it's a timeout, sleep and retry
}

第三种方式的问题是它没有为包的用户留下任何理智的方式来测试它。 (测试 err.Error() 返回的字符串的内容不是一个好主意)。但是，对于您不希望任何人想要测试的错误，这很好。

进一步阅读:

• Effective Go on errors
• Go 博客 Error handling and Go
• 戴夫·切尼 Inspecting Errors
• 彼得 bool 贡 Programming with errors