Go Error 的設計哲學是 「Errors Are Values」。

這句話應該怎么理解呢?翻譯起來挺難的。不過從源碼的角度來看，好像更容易理解其背后的含義。

Go Error 源碼很簡單，寥寥幾行：

// src/builtin/builtin.go 
 
type error interface { 
 Error() string 
} 

error 是一個接口類型，只需要實現(xiàn) Error() 方法即可。在 Error() 方法中，就可以返回自定義結構體的任意內容。

下面首先說說如何創(chuàng)建 error。

創(chuàng)建 Error

創(chuàng)建 error 有兩種方式，分別是：

• errors.New();
• fmt.Errorf()。

errors.New()

errors.New() 的使用延續(xù)了 Go 的一貫風格，New 一下就可以了。

舉一個例子：

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)建的錯誤 
*/ 

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

源碼如下：

// 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 是一個結構體，實現(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 
*/ 

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

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

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

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

這時問題就出現(xiàn)了，經(jīng)過 fmt.Errorf() 的封裝，原始 error 類型發(fā)生了改變，這就導致 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 結構體定義如下：

// 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() 
} 

它們之間的關系是這樣的：

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

如下：

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 
*/ 

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

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

后記

其實，Go 目前對 Error 的處理方式也是充滿爭議的。不過，官方團隊正在積極和社區(qū)交流，提出改進方法。相信在不久的將來，一定會找到更好的解決方案。

現(xiàn)階段來說，大部分團隊可能會選擇 github.com/pkg/errors 包來進行錯誤處理。如果感興趣的話，可以學學看。

好了，本文就到這里吧。關注我，帶你通過問題讀 Go 源碼。

源碼地址：https://github.com/yongxinz/gopher

參考文章：

https://chasecs.github.io/posts/the-philosophy-of-go-error-handling/

https://medium.com/@dche423/golang-error-handling-best-practice-cn-42982bd72672

https://www.flysnow.org/2019/09/06/go1.13-error-wrapping.html