package main

import (
	"errors"
	"fmt"
)

func main() {
	err := errors.New("這是 errors.New() 創(chuàng)建的錯誤")
	fmt.Printf("err 錯誤類型：%T，錯誤為：%v\n", err, err)
}

/* 輸出
err 錯誤類型：*errors.errorString，錯誤為：這是 errors.New() 創(chuàng)建的錯誤
*/

這段代碼唯一讓人困惑的地方可能就是錯誤類型了，但沒關(guān)系。只要看一下源碼，就瞬間迎刃而解。

源碼如下：

// src/errors/errors.go

// New returns an error that formats as the given text.
// Each call to New returns a distinct error value even if the text is identical.
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 是一個結(jié)構(gòu)體，實現(xiàn)了 Error() 方法，New 函數(shù)直接返回 errorString 指針。

這種用法很簡單，但不實用。假如我還想返回程序的上下文信息，它就沒轍了。

下面看第二種方式。

fmt.Errorf()

還是先看一個例子：

package main
import (
	"database/sql"
	"fmt"
)
func foo() error {
	return sql.ErrNoRows
}
func bar() error {
	return foo()
}
func main() {
	err := bar()
	if err == sql.ErrNoRows {
		fmt.Printf("data not found, %+v\n", err)
		return
	}
	if err != nil {
		fmt.Println("Unknown error")
	}
}
/* 輸出
data not found, sql: no rows in result set
*/

這個例子輸出了我們想要的結(jié)果，但是還不夠。

一般情況下，我們會通過使用 fmt.Errorf() 函數(shù)，附加上我們想添加的文本信息，使返回內(nèi)容更明確，處理起來更靈活。

所以，foo() 函數(shù)會改成下面這樣：

func foo() error {
   return fmt.Errorf("foo err, %v", sql.ErrNoRows)
}

這時問題就出現(xiàn)了，經(jīng)過 fmt.Errorf() 的封裝，原始 error 類型發(fā)生了改變，這就導(dǎo)致 err == sql.ErrNoRows 不再成立，返回信息變成了 Unknown error。

如果想根據(jù)返回的 error 類型做不同處理，就無法實現(xiàn)了。

因此，Go 1.13 為我們提供了 wrapError 來處理這個問題。

Wrap Error

看一個例子：

package main
import (
	"fmt"
)
type myError struct{}
func (e myError) Error() string {
	return "Error happended"
}
func main() {
	e1 := myError{}
	e2 := fmt.Errorf("E2: %w", e1)
	e3 := fmt.Errorf("E3: %w", e2)
	fmt.Println(e2)
	fmt.Println(e3)
}
/* output
E2: Error happended
E3: E2: Error happended
*/

乍一看好像好沒什么區(qū)別，但背后的實現(xiàn)原理卻并不相同。

Go 擴展了 fmt.Errorf() 函數(shù)，增加了一個 %w 標識符來創(chuàng)建 wrapError。

// src/fmt/errors.go

func Errorf(format string, a ...interface{}) error {
	p := newPrinter()
	p.wrapErrs = true
	p.doPrintf(format, a)
	s := string(p.buf)
	var err error
	if p.wrappedErr == nil {
		err = errors.New(s)
	} else {
		err = &wrapError{s, p.wrappedErr}
	}
	p.free()
	return err
}

當使用 w% 時，函數(shù)會返回 &wrapError{s, p.wrappedErr}，wrapError 結(jié)構(gòu)體定義如下：

// src/fmt/errors.go
type wrapError struct {
	msg string
	err error
}
func (e *wrapError) Error() string {
	return e.msg
}
func (e *wrapError) Unwrap() error {
	return e.err
}

實現(xiàn)了 Error() 方法，說明它是一個 error，而 Unwrap() 方法是為了獲取被封裝的 error。

// src/errors/wrap.go

func Unwrap(err error) error {
	u, ok := err.(interface {
		Unwrap() error
	})
	if !ok {
		return nil
	}
	return u.Unwrap()
}

它們之間的關(guān)系是這樣的：

因此，我們可以使用 w% 將上文中的程序進行改造，使其內(nèi)容輸出更豐富。

如下：

package main
import (
	"database/sql"
	"errors"
	"fmt"
)
func bar() error {
	if err := foo(); err != nil {
		return fmt.Errorf("bar failed: %w", foo())
	}
	return nil
}
func foo() error {
	return fmt.Errorf("foo failed: %w", sql.ErrNoRows)
}
func main() {
	err := bar()
	if errors.Is(err, sql.ErrNoRows) {
		fmt.Printf("data not found,  %+v\n", err)
		return
	}
	if err != nil {
		fmt.Println("Unknown error")
	}
}
/* output
data not found,  bar failed: foo failed: sql: no rows in result set
*/

終于有了讓人滿意的輸出結(jié)果，每個函數(shù)都增加了必要的上下文信息，而且也符合對錯誤類型的判斷。

errors.Is() 函數(shù)用來判斷 err 以及其封裝的 error 鏈中是否包含目標類型。這也就解決了上文提出的無法判斷錯誤類型的問題。