【GO】错误包errors介绍和使用事项

当我们在开发 Go 语言程序时，错误处理是必不可少的一部分。Go 语言内置了 error 类型和 errors 包，提供了一系列的函数来帮助我们处理错误。

在本文中，我们将介绍 errors.Is、errors.As、errors.New 和 fmt.Errorf 这四个与错误处理相关的函数。

errors.Is

errors.Is 函数可以用来判断一个错误是否与另一个错误相等。它的函数原型为：

func Is(err, target error) bool

其中 err 是需要被判断的错误，target 是目标错误。如果 err 是 target 的一个实例，那么 errors.Is 函数返回 true，否则返回 false。

使用 errors.Is 函数的示例代码：

package main

import (
    "errors"
    "fmt"
)

func main() {
    err := errors.New("something went wrong")
    if errors.Is(err, errors.New("something went wrong")) {
        fmt.Println("err is equal to the target error")
    } else {
        fmt.Println("err is not equal to the target error")
    }
}

在上面的示例中，我们使用 errors.New 函数创建了一个错误对象 err，然后使用 errors.Is 函数将 err 和另一个相同字符串信息的错误对象进行比较，输出了 “err is equal to the target error”。

errors.As

errors.As 函数可以用来将一个错误转换为另一个类型的错误。它的函数原型为：

func As(err error, target interface{}) bool

其中 err 是需要被转换的错误，target 是转换后的目标类型。如果 err 可以被转换为 target 类型，那么 errors.As 函数返回 true，并将转换后的结果存储在 target 中，否则返回 false。

注意：errors.As 无法判断 errors.New 的错误

使用 errors.As 函数的示例代码：

package main

import (
    "errors"
    "fmt"
)

type MyError struct {
    Code int
    Msg  string
}

func main() {
    err := &MyError{Code: 123, Msg: "something went wrong"}
    var target *MyError
    if errors.As(err, &target) {
        fmt.Println(target)
    } else {
        fmt.Println("err is not of type *MyError")
    }
}

在上面的示例中，我们定义了一个自定义类型 MyError，并使用 errors.As 函数将一个 *MyError 类型的错误转换为 target 变量。由于 err 和 target 类型相同，因此转换成功并输出了 MyError 结构体的内容。

errors.New

errors.New 函数可以用来创建一个简单的错误对象。它的函数原型为：

func New(text string) error

其中 text 是错误的字符串信息。errors.New 函数会返回一个新的错误对象，这个对象的 Error() 方法返回 text。

使用 errors.New 函数的示例代码：

package main

import (
    "errors"
    "fmt"
)

func main() {
    err := errors.New("something went wrong")
    fmt.Println(err)
}

在上面的示例中，我们使用 errors.New 函数创建了一个错误对象 err，并将其打印输出。

fmt.Errorf

fmt.Errorf 函数可以用来创建一个带格式化的错误对象。它的函数原型为：

func Errorf(format string, a ...interface{}) error

其中 format 是错误信息的格式化字符串，a… 是可变参数，用来填充格式化字符串中的占位符。fmt.Errorf 函数会返回一个新的错误对象，这个对象的 Error() 方法返回经过格式化后的字符串。

使用 fmt.Errorf 函数的示例代码：

package main

import (
    "fmt"
)

func main() {
    err := fmt.Errorf("something went wrong: %s", "file not found")
    fmt.Println(err)
}

在上面的示例中，我们使用 fmt.Errorf 函数创建了一个错误对象 err，并将其打印输出。

fmt.Errorf 函数和 errors.Is 搭配使用的示例代码：

package main

import (
    "errors"
    "fmt"
)
var ErrOne = errors.New("something went wrong")

func main() {
    err := fmt.Errorf("something went wrong: %w", ErrOne)
    if errors.Is(err, ErrOne) {
        fmt.Println("err is of type MyError")
    } else {
        fmt.Println("err is not of type MyError")
    }
}

总结

在 Go 语言中，错误处理是一个非常重要的方面。errors.Is、errors.As、errors.New 和 fmt.Errorf 这四个函数是我们处理错误的有力工具。errors.Is 可以用来比较两个错误是否相等，errors.As 可以将一个错误转换为另一个类型的错误，errors.New 可以创建一个简单的错误对象，fmt.Errorf 可以创建一个带格式化的错误对象。在编写 Go 语言程序时，我们可以根据具体的场景和需求选择合适的函数来处理错误。