第三十一部分：自定义错误

在上一个教程中，我们学习了如何在 Go 中表示错误以及如何处理标准库中的错误。我们还学习了如何从标准库错误中提取更多信息。

本教程介绍如何创建我们自己的自定义错误，我们可以在我们创建的函数和包中使用它们。我们还将使用标准库使用的相同技术来提供有关我们的自定义错误的更多详细信息。

使用新函数创建自定义错误

创建自定义错误的最简单方法是使用 errors 包的 New 函数。

在使用 New 函数创建自定义错误之前，让我们先了解它是如何实现的。下面提供了errors package 中 New 函数的实现。

    // Package errors implements functions to manipulate errors.
  package errors
    // New returns an error that formats as the given text.
  func New(text string) error {
      return &errorString{text}
  }
    // errorString is a trivial implementation of error.
  type errorString struct {
      s string
  }
    func (e *errorString) Error() string {
      return e.s
  }

实现非常简单。 errorString 是一个带有单个字符串字段 s 的结构类型。 第 14 行error 接口的 Error() string 方法是使用 errorString 指针接收器实现的。

New 函数在第 5 行接受一个 string 参数，使用该参数创建一个 errorString 类型的值，并返回它的地址。 因此一个新错误创建并返回了。

现在我们知道 New 函数的工作原理，让我们在自己的程序中使用它来创建自定义错误。

我们将创建一个计算圆的面积的简单程序，如果半径为负，则返回错误。

package main
import (  
    "errors"
    "fmt"
    "math"
)
func circleArea(radius float64) (float64, error) {  
    if radius < 0 {
        return 0, errors.New("Area calculation failed, radius is less than zero")
    }
    return math.Pi * radius * radius, nil
}
func main() {  
    radius := -20.0
    area, err := circleArea(radius)
    if err != nil {
        fmt.Println(err)
        return
    }
    fmt.Printf("Area of circle %0.2f", area)
}

Run in playground

在上面的程序中，在第 10 行我们检查半径是否小于零。 如果是这样，我们返回零以及相应的错误消息。 如果半径大于 0，则在第 13 行计算面积并返回 nil 值的 error。

在 main 函数中，我们在第 19 行检查错误是否为 nil。 如果它不是零，我们打印错误并返回，否则输出面积。

在这个程序中，半径小于零，因此它将输出，

Area calculation failed, radius is less than zero

使用Errorf向错误添加更多信息

上面的程序效果很好，但是如果我们输出导致错误的实际半径就不怎么 nice 了。于是fmt 软件包的 Errorf 函数派上用场的地方。此函数根据格式说明符格式化错误，并返回一个字符串作为满足错误的值。

让我们使用 Errorf 函数使程序变得更好。

package main
import (  
    "fmt"
    "math"
)
func circleArea(radius float64) (float64, error) {  
    if radius < 0 {
        return 0, fmt.Errorf("Area calculation failed, radius %0.2f is less than zero", radius)
    }
    return math.Pi * radius * radius, nil
}
func main() {  
    radius := -20.0
    area, err := circleArea(radius)
    if err != nil {
        fmt.Println(err)
        return
    }
    fmt.Printf("Area of circle %0.2f", area)
}

Run in playground

在上面的程序中，Errorf 在第 10 行打印导致错误的实际半径。 运行此程序将输出，

Area calculation failed, radius -20.00 is less than zero

使用结构类型和字段提供有关错误的更多信息

也可以使用结构类型来实现错误接口作为错误。这使我们在错误处理方面具有更大的灵活性。在我们的例子中，如果我们想访问导致错误的半径，现在唯一的方法是解析错误描述 Area calculation failed, radius -20.00 is less than zero。这样做并不合适，因为如果描述发生变化，我们的代码就会崩溃。

我们将使用前面教程“断言基础结构类型并从结构字段获取更多信息”一节中解释的标准库所遵循的策略，并使用结构字段提供对导致错误的半径的访问。我们将创建一个实现错误接口的 struct 类型，并使用它的字段提供有关错误的更多信息。

第一步是创建一个 struct 类型来表示错误。错误类型的命名约定是名称应该以文本Error 结尾。我们把struct类型命名为 areaError

type areaError struct {  
    err    string
    radius float64
}

上面的结构类型有一个字段 radius ，它存储负责错误的半径的值，err 字段存储实际的错误消息。

下一步是实现错误接口。

func (e *areaError) Error() string {  
    return fmt.Sprintf("radius %0.2f: %s", e.radius, e.err)
}

在上面的代码片段中，我们使用指针接收器 *areaError 实现错误接口的 Error() string 方法。此方法打印半径和错误描述。

让我们通过编写 main 函数和 circleArea 函数来完成程序。

package main
import (  
    "fmt"
    "math"
)
type areaError struct {  
    err    string
    radius float64
}
func (e *areaError) Error() string {  
    return fmt.Sprintf("radius %0.2f: %s", e.radius, e.err)
}
func circleArea(radius float64) (float64, error) {  
    if radius < 0 {
        return 0, &areaError{"radius is negative", radius}
    }
    return math.Pi * radius * radius, nil
}
func main() {  
    radius := -20.0
    area, err := circleArea(radius)
    if err != nil {
        if err, ok := err.(*areaError); ok {
            fmt.Printf("Radius %0.2f is less than zero", err.radius)
            return
        }
        fmt.Println(err)
        return
    }
    fmt.Printf("Area of rectangle1 %0.2f", area)
}

Run in playground

在上面的程序中，第 17 行 circleArea 用于计算圆的面积。 此函数首先检查半径是否小于零，如果是，则使用导致错误的半径和相应的错误消息创建类型 areaError 的值，然后在 19 行返回它的地址以及 0 作为 area。 **因此，我们提供了关于错误的更多信息，在本例中，使用自定义错误结构的字段提供了导致错误的半径。**

如果半径不是负数，则此函数在第 21 行计算并返回该 area 以及 nil 错误。

main 函数的第 26 行，我们试图找到半径为 -20 的圆的 area 。 由于半径小于零，因此将返回错误。

在 27 行中我们检查错误是否为 nil，在下一行中我们断言它为 *areaError。 如果错误是 ***areaError 类型，我们使用 err.radius** 获取导致错误的半径，打印自定义错误消息并从程序返回。

如果断言失败，我们只需打印错误并返回。 如果没有错误，将打印该 area。

程序将输出

Radius -20.00 is less than zero

现在让我们使用上一篇教程中描述的第二种策略，并使用定制错误类型的方法来提供有关错误的更多信息。

使用有关结构类型的方法提供有关错误的更多信息

在本节中，我们将编写一个计算矩形面积的程序。如果长度或宽度小于零，此程序将打印错误。

第一步是创建一个结构来表示错误。

type areaError struct {  
    err    string //error description
    length float64 //length which caused the error
    width  float64 //width which caused the error
}

上面的错误结构类型包含一个错误描述字段以及导致错误的长度和宽度。

现在我们已经有了错误类型，让我们实现错误接口并在错误类型上添加几个方法来提供关于错误的更多信息。

func (e *areaError) Error() string {  
    return e.err
}
func (e *areaError) lengthNegative() bool {  
    return e.length < 0
}
func (e *areaError) widthNegative() bool {  
    return e.width < 0
}

在上面的代码片段中，我们从 Error() string 方法返回错误的描述。 当 length 小于零时，lengthNegative() bool 方法返回 true，而当 width 小于零时，widthNegative() bool 方法返回 true。 **这两种方法提供了有关错误的更多信息，在这种情况下，它们表示面积计算是否因为长度为负或宽度为负而失败。 因此，我们使用 struct error 类型的方法来提供有关错误的更多信息。**

下一步是编写计算面积函数。

func rectArea(length, width float64) (float64, error) {  
    err := ""
    if length < 0 {
        err += "length is less than zero"
    }
    if width < 0 {
        if err == "" {
            err = "width is less than zero"
        } else {
            err += ", width is less than zero"
        }
    }
    if err != "" {
        return 0, &areaError{err, length, width}
    }
    return length * width, nil
}

上面的 rectArea 函数检查长度或宽度是否小于零，如果是，则返回一条错误消息，否则返回以为 nil 的错误值和矩形面积。

让我们通过创建主函数来完成这个程序。

func main() {  
    length, width := -5.0, -9.0
    area, err := rectArea(length, width)
    if err != nil {
        if err, ok := err.(*areaError); ok {
            if err.lengthNegative() {
                fmt.Printf("error: length %0.2f is less than zero\n", err.length)
            }
            if err.widthNegative() {
                fmt.Printf("error: width %0.2f is less than zero\n", err.width)
            }
            return
        }
        fmt.Println(err)
        return
    }
    fmt.Println("area of rect", area)
}

在main函数中，我们在第 4 行检查错误是否为 nil。 如果它不是 nil，我们断言它在下一行输入 *areaError。 然后使用 lengthNegative() 和 widthNegative() 方法，检查错误是否是因为长度为负或宽度为负。 我们打印相应的错误消息并从程序返回。 因此，我们使用错误结构类型的方法来提供有关错误的更多信息。

如果没有错误，矩形的面积将被打印出来。

这是完整的程序供你参考。

package main
import "fmt"
type areaError struct {  
    err    string  //error description
    length float64 //length which caused the error
    width  float64 //width which caused the error
}
func (e *areaError) Error() string {  
    return e.err
}
func (e *areaError) lengthNegative() bool {  
    return e.length < 0
}
func (e *areaError) widthNegative() bool {  
    return e.width < 0
}
func rectArea(length, width float64) (float64, error) {  
    err := ""
    if length < 0 {
        err += "length is less than zero"
    }
    if width < 0 {
        if err == "" {
            err = "width is less than zero"
        } else {
            err += ", width is less than zero"
        }
    }
    if err != "" {
        return 0, &areaError{err, length, width}
    }
    return length * width, nil
}
func main() {  
    length, width := -5.0, -9.0
    area, err := rectArea(length, width)
    if err != nil {
        if err, ok := err.(*areaError); ok {
            if err.lengthNegative() {
                fmt.Printf("error: length %0.2f is less than zero\n", err.length)
            }
            if err.widthNegative() {
                fmt.Printf("error: width %0.2f is less than zero\n", err.width)
            }
            return
        }
    }
    fmt.Println("area of rect", area)
}

Run in playground

这个程序将打印输出

error: length -5.00 is less than zero  
error: width -9.00 is less than zero

我们已经看到了 error handling 教程中描述的三种方法中的两种方法的示例，以提供关于错误的更多信息。

第三种使用 direct comparison 的方法非常简单。我将把它作为一个练习留给你，让你了解如何使用这个策略来提供关于自定义错误的更多信息。

本教程到此结束。

下面简要回顾一下我们在本教程中学习的内容

• 使用新的函数创建自定义错误

• 使用errorf向错误添加更多信息

• 使用结构类型提供关于错误的更多信息

• 使用结构类型的方法提供关于错误的更多信息

原文链接

https://golangbot.com/custom-errors/