正确使用errors.Is()来进行错误类型检查

本文探讨了在 Go 语言中使用 `errors.Is()` 进行错误类型检查时遇到的问题。当使用 `errors.Is()` 检查错误时，只有没有参数或带有值接收器的错误实现才能被找到。这意味着可包装的错误实现必须具有值接收器才能通过 `errors.Is()` 被找到。本文提供了使用 `errors.as` 代替 `errors.Is` 来检测和获取此类错误值的方法，并讨论了 `errors.as` 和 `errors.Is` 在指针处理方面的区别。

我正在检查 go v1.13 go v1.14 中的错误跟踪。为什么使用 errors.is() 只能找到不带参数或带值接收器的错误实现？这意味着能够包装的错误实现必须有一个值接收器，以便能够通过 errors.is() 找到。

package main

import (
    "fmt"
    "errors"
)

type someAtomicError struct {}
func (e *someAtomicError) Error() string { return "Hi!" }
func checkAtomicError() {
    e := &someAtomicError{}
    e2 := fmt.Errorf("whoa!: %w", e)
    e2IsE := errors.Is(e2, &someAtomicError{})
    fmt.Println("atomic error trace ---\t\t", e2, "\t\t--- is traceable: ", e2IsE)
}


type someWrapperError struct {
    Msg string
    Err error
}
func (e someWrapperError) Error() string { return fmt.Sprintf("%s: %v", e.Msg, e.Err) }
func (e someWrapperError) Unwrap() error { return e.Err }
func checkWrapperError() {
    e := someWrapperError{"Hi!", nil}
    e2 := fmt.Errorf("whoa!: %w", e)
    e2IsE := errors.Is(e2, someWrapperError{"Hi!", nil})
    fmt.Println("wrapper error trace ---\t\t", e2, "\t--- is traceable: ", e2IsE)
}


type somePointerWrapperError struct {
    Msg string
    Err error
}
func (e *somePointerWrapperError) Error() string { return fmt.Sprintf("%s: %v", e.Msg, e.Err) }
func (e *somePointerWrapperError) Unwrap() error { return e.Err }
func checkPointerWrapperError() {
    e := &somePointerWrapperError{"Hi!", nil}
    e2 := fmt.Errorf("whoa!: %w", e)
    e2IsE := errors.Is(e2, &somePointerWrapperError{"Hi!", nil})
    fmt.Println("pointer wrapper error trace ---\t", e2, "\t--- is traceable: ", e2IsE)
}


func main() {
    checkAtomicError()
    checkWrapperError() 
    checkPointerWrapperError()
}

//atomic error trace ---         whoa!: Hi!         --- is traceable:  true
//wrapper error trace ---        whoa!: Hi!: <nil>  --- is traceable:  true
//pointer wrapper error trace ---    whoa!: Hi!: <nil>  --- is traceable:  false

https://play.golang.org/p/-hsukz-gii2

参数中的任何差异（包括包装的错误参数 err）似乎都会导致无法使用 errors.is() 找到该类型。

解决方案

当您尝试通过 errors.is 查找另一个错误时出现 false 的原因是，虽然这两个错误可能具有相同的字段值，但它们是两个不同的内存指针：

e  := &somepointerwrappererror{"hi!", nil}
e2 := &somepointerwrappererror{"hi!", nil} // e2 != e

ew := fmt.errorf("whoa!: %w", e)

errors.is(ew, e)  // true
errors.is(ew, e2) // false - because `ew` wraps `e` not `e2`

那么如何检测这种“类型”的错误并获取其值：使用 errors.as 代替：

e := &somepointerwrappererror{"hi!", nil}
e2 := fmt.errorf("whoa!: %w", e)

var ev *somepointerwrappererror

if errors.as(e2, &ev) {
    fmt.printf("%#v\n", ev) // &somepointerwrappererror{msg:"hi!", err:error(nil)}
}

https://play.golang.org/p/CttKThLasXD

远程相关，但也许它对某人有帮助：我花了一些时间才意识到 errors.as(...) 实际上需要一个指向目标的双指针，而 errors.is (...) 不会：

var _ error = (*CustomError)(nil) // ensure CustomError implements error

type CustomError struct {
    msg string
}

func (e CustomError) Error() string {
    return e.msg
}

func main() {
    err := &CustomError{"Hello, world!"} // Methods return pointers to errors, allowing them to be nil
    
    var eval *CustomError

    as := errors.As(err, &eval) // yes, that's **CustomError
    asFaulty := errors.As(err, eval) // no compile error, so it wrongly seems okay
    is := errors.Is(err, eval) // that's just *CustomError

    fmt.Printf("as: %t, asFaulty: %t, is: %t", as, asFaulty, is) // as: true, asFaulty: false, is: true
}

好了，本文到此结束，带大家了解了《正确使用errors.Is()来进行错误类型检查》，希望本文对你有所帮助！关注golang学习网公众号，给大家分享更多Golang知识！