Go 语言中的错误处理与其他语言不太一样,它把错误当成一种值来处理,更强调判断错误、处理错误,而不是一股脑的 catch 捕获异常。

Error接口和错误处理

Error 接口

Go 语言中把错误当成一种特殊的值来处理,不支持其他语言中使用try/catch捕获异常的方式。

Error 接口

Go 语言中使用一个名为 error 接口来表示错误类型。

  1. type error interface {
  2. Error() string
  3. }

error 接口只包含一个方法——Error,这个函数需要返回一个描述错误信息的字符串。

当一个函数或方法需要返回错误时,我们通常是把错误作为最后一个返回值。例如下面标准库 os 中打开文件的函数。

  1. func Open(name string) (*File, error) {
  2. return OpenFile(name, O_RDONLY, 0)
  3. }

由于 error 是一个接口类型,默认零值为nil。所以我们通常将调用函数返回的错误与nil进行比较,以此来判断函数是否返回错误。例如你会经常看到类似下面的错误判断代码。

  1. file, err := os.Open("./xx.go")
  2. if err != nil {
  3. fmt.Println("打开文件失败,err:", err)
  4. return
  5. }

注意

当我们使用fmt包打印错误时会自动调用 error 类型的 Error 方法,也就是会打印出错误的描述信息。

创建错误

我们可以根据需求自定义 error,最简单的方式是使用errors 包提供的New函数创建一个错误。

errors.New

函数签名如下,

  1. func New(text string) error

它接收一个字符串参数返回包含该字符串的错误。我们可以在函数返回时快速创建一个错误。

  1. func queryById(id int64) (*Info, error) {
  2. if id <= 0 {
  3. return nil, errors.New("无效的id")
  4. }
  5. // ...
  6. }

或者用来定义一个错误变量,例如标准库io.EOF错误定义如下。

  1. var EOF = errors.New("EOF")

fmt.Errorf

当我们需要传入格式化的错误描述信息时,使用fmt.Errorf是个更好的选择。

  1. fmt.Errorf("查询数据库失败,err:%v", err)

但是上面的方式会丢失原有的错误类型,只拿到错误描述的文本信息。

为了不丢失函数调用的错误链,使用fmt.Errorf时搭配使用特殊的格式化动词%w,可以实现基于已有的错误再包装得到一个新的错误。

  1. fmt.Errorf("查询数据库失败,err:%w", err)

对于这种二次包装的错误,errors包中提供了以下三个方法。

  1. func Unwrap(err error) error // 获得err包含下一层错误
  2. func Is(err, target error) bool // 判断err是否包含target
  3. func As(err error, target interface{}) bool // 判断err是否为target类型

错误结构体类型

此外我们还可以自己定义结构体类型,实现`error接口。

  1. // OpError 自定义结构体类型
  2. type OpError struct {
  3. Op string
  4. }
  5. // Error OpError 类型实现error接口
  6. func (e *OpError) Error() string {
  7. return fmt.Sprintf("无权执行%s操作", e.Op)
  8. }