Golang error 的突圍
寫過 C 的同學知道，C 語言中常常返回整數錯誤碼（errno）來表示函式處理出錯，通常用 -1 來表示錯誤，用 0 表示正確。
而在 Go 中，我們使用 error 型別來表示錯誤，不過它不再是一個整數型別，是一個介面型別：
type error interface {
Error() string
}
複製程式碼它表示那些能用一個字串就能說清的錯誤。
我們最常用的就是 errors.New() 函式，非常簡單：
// src/errors/errors.go
func New(text string) error {
return &errorString{text}
}
type 使用 New 函式創建出來的 error 型別實際上是 errors 包裡未匯出的 errorString 型別，它包含唯一的一個欄位 s，並且實現了唯一的方法：Error() string。
通常這就夠了，它能反映當時“出錯了”，但是有些時候我們需要更加具體的資訊，例如：
func Sqrt(f float64) (float64,error) {
if f < 0 {
return 當呼叫者發現出錯的時候，只知道傳入了一個負數進來，並不清楚到底傳的是什麼值。在 Go 裡：
It is the error implementation's responsibility to summarize the context.
它要求返回這個錯誤的函式要給出具體的“上下文”資訊，也就是說，在 Sqrt 函式裡，要給出這個負數到底是什麼。
所以，如果發現 f 小於 0，應該這樣返回錯誤：
if f < 0 {
return 這就用到了 fmt.Errorf 函式，它先將字串格式化，再呼叫 errors.New 函式來建立錯誤。
當我們想知道錯誤型別，並且列印錯誤的時候，直接列印 error：
fmt.Println(err)
複製程式碼或者：
fmt.Println(err.Error)
複製程式碼fmt 包會自動呼叫 err.Error() 函式來列印字串。
通常，我們將 error 放到函式返回值的最後一個，沒什麼好說的，大家都這樣做，約定俗成。
參考資料【Tony Bai】這篇文章提到，構造 error 的時候，要求傳入的字串首字母小寫，結尾不帶標點符號，這是因為我們經常會這樣使用返回的 error：
... err := errors.New("error example")
fmt.Printf("The returned error is %s.\n",err)
複製程式碼error 的困局
In Go,error handling is important. The language's design and conventions encourage you to explicitly check for errors where they occur (as distinct from the convention in other languages of throwing exceptions and sometimes catching them).
在 Go 語言中，錯誤處理是非常重要的。它從語言層面要求我們需要明確地處理遇到的錯誤。而不是像其他語言，類如 Java，使用 try-catch- finally 這種“把戲”。
這就造成程式碼裡 “error” 滿天飛，顯得非常冗長拖沓。
而為了程式碼健壯性考慮，對於函式返回的每一個錯誤，我們都不能忽略它。因為出錯的同時，很可能會返回一個 nil 型別的物件。如果不對錯誤進行判斷，那下一行對 nil 物件的操作百分之百會引發一個 panic。
這樣，Go 語言中詬病最多的就是它的錯誤處理方式似乎回到了上古 C 語言時代。
rr := doStuff1()
if err != nil {
//handle error...
}
err = doStuff2()
if err != nil {
//handle error...
}
err = doStuff3()
if err != nil {
//handle error...
}
複製程式碼Go authors 之一的 Russ Cox 對於這種觀點進行過駁斥：當初選擇返回值這種錯誤處理機制而不是 try-catch，主要是考慮前者適用於大型軟體，後者更適合小程式。
在參考資料【Go FAQ】裡也提到，try-catch 會讓程式碼變得非常混亂，程式設計師會傾向將一些常見的錯誤，例如，failing to open a file，也拋到異常裡，這會讓錯誤處理更加冗長繁瑣且易出錯。
而 Go 語言的多返回值使得返回錯誤異常簡單。對於真正的異常，Go 提供 panic-recover 機制，也使得程式碼看起來非常簡潔。
當然 Russ Cox 也承認 Go 的錯誤處理機制對於開發人員的確有一定的心智負擔。
參考資料【Go 語言的錯誤處理機制是一個優秀的設計嗎？】是知乎上的一個回答，闡述了 Go 對待錯誤和異常的不同處理方式，前者使用 error，後者使用 panic，這樣的處理比較 Java 那種錯誤異常一鍋端的做法更有優勢。
【如何優雅的在Golang中進行錯誤處理】對於在業務上如何處理 error，給出了一些很好的示例。
嘗試破局
這部分的內容主要來自 Dave cheney GoCon 2016 的演講，參考資料可以直達原文。
經常聽到 Go 有很多“箴言”，說得很順口，但理解起來並不是太容易，因為它們大部分都是有故事的。例如，我們常說：
Don't communicating by sharing memory,share memory by communicating.
文中還列舉了很多，都很有意思：
下面我們講三條關於 error 的“箴言”。
Errors are just values
Errors are just values 的實際意思是隻要實現了 Error 介面的型別都可以認為是 Error，重要的是要理解這些“箴言”背後的道理。
作者把處理 error 的方式分為三種：
- Sentinel errors
- Error Types
- Opaque errors
我們來挨個說。首先 Sentinel errors，Sentinel 來自計算機中常用的詞彙，中文意思是“哨兵”。以前在學習快排的時候，會有一個“哨兵”，其他元素都要和“哨兵”進行比較，它劃出了一條界限。
這裡 Sentinel errors 實際想說的是這裡有一個錯誤，暗示處理流程不能再進行下去了，必須要在這裡停下，這也是一條界限。而這些錯誤，往往是提前約定好的。
例如，io 包裡的 io.EOF，表示“檔案結束”錯誤。但是這種方式處理起來，不太靈活：
func main() {
r := bytes.NewReader([]byte("0123456789"))
_,err := r.Read(make([]byte,10))
if err == io.EOF {
log.Fatal("read failed:",err)
}
}
複製程式碼必須要判斷 err 是否和約定好的錯誤 io.EOF 相等。
再來一個例子，當我想返回 err 並且加上一些上下文資訊時，就麻煩了：
func main() {
err := readfile(“.bashrc”)
if strings.Contains(error.Error(),"not found") {
// handle error
}
}
func readfile(path string) error {
err := openfile(path)
if err != nil {
return fmt.Errorf(“cannot open file: %v",err)
}
// ……
}
複製程式碼在 readfile 函式裡判斷 err 不為空，則用 fmt.Errorf 在 err 前加上具體的 file 資訊，返回給呼叫者。返回的 err 其實還是一個字串。
造成的後果時，呼叫者不得不用字串匹配的方式判斷底層函式 readfile 是不是出現了某種錯誤。當你必須要這樣才能判斷某種錯誤時，程式碼的“壞味道”就出現了。
順帶說一句，err.Error() 方法是給程式設計師而非程式碼設計的，也就是說，當我們呼叫 Error 方法時，結果要寫到檔案或是打印出來，是給程式設計師看的。在程式碼裡，我們不能根據 err.Error() 來做一些判斷，就像上面的 main 函式裡做的那樣，不好。
Sentinel errors 最大的問題在於它在定義 error 和使用 error 的包之間建立了依賴關係。比如要想判斷 err == io.EOF 就得引入 io 包，當然這是標準庫的包，還 Ok。如果很多使用者自定義的包都定義了錯誤，那我就要引入很多包，來判斷各種錯誤。麻煩來了，這容易引起迴圈引用的問題。
因此，我們應該儘量避免 Sentinel errors，僅管標準庫中有一些包這樣用，但建議還是別模仿。
第二種就是 Error Types，它指的是實現了 error 介面的那些型別。它的一個重要的好處是，型別中除了 error 外，還可以附帶其他欄位，從而提供額外的資訊，例如出錯的行數等。
標準庫有一個非常好的例子：
// PathError records an error and the operation and file path that caused it.
type PathError struct {
Op string
Path string
Err error
}
複製程式碼PathError 額外記錄了出錯時的檔案路徑和操作型別。
通常，使用這樣的 error 型別，外層呼叫者需要使用型別斷言來判斷錯誤：
// underlyingError returns the underlying error for known os error types.
func underlyingError(err error) error {
switch err := err.(type) {
case *PathError:
return err.Err
case *LinkError:
return err.Err
case *SyscallError:
return err.Err
}
return err
}
複製程式碼但是這又不可避免地在定義錯誤和使用錯誤的包之間形成依賴關係，又回到了前面的問題。
即使 Error types 比 Sentinel errors 好一些，因為它能承載更多的上下文資訊，但是它仍然存在引入包依賴的問題。因此，也是不推薦的。至少，不要把 Error types 作為一個匯出型別。
最後一種，Opaque errors。翻譯一下，就是“黑盒 errors”，因為你能知道錯誤發生了，但是不能看到它內部到底是什麼。
譬如下面這段虛擬碼：
func fn() error {
x,err := bar.Foo()
if err != nil {
return err
}
// use x
return nil
}
複製程式碼作為呼叫者，呼叫完 Foo 函式後，只用知道 Foo 是正常工作還是出了問題。也就是說你只需要判斷 err 是否為空，如果不為空，就直接返回錯誤。否則，繼續後面的正常流程，不需要知道 err 到底是什麼。
這就是處理 Opaque errors 這種型別錯誤的策略。
當然，在某些情況下，這樣做並不夠用。例如，在一個網路請求中，需要呼叫者判斷返回的錯誤型別，以此來決定是否重試。這種情況下，作者給出了一種方法：
In this case rather than asserting the error is a specific type or value,we can assert that the error implements a particular behaviour.
就是說，不去判斷錯誤的型別到底是什麼，而是去判斷錯誤是否具有某種行為，或者說實現了某個介面。
來個例子：
type temporary interface {
Temporary() bool
}
func IsTemporary(err error) bool {
te,ok := err.(temporary)
return ok && te.Temporary()
}
複製程式碼拿到網路請求返回的 error 後，呼叫 IsTemporary 函式，如果返回 true，那就重試。
這麼做的好處是在進行網路請求的包裡，不需要 import 引用定義錯誤的包。
handle not just check errors
這一節要說第二句箴言：“Don't just check errors,handle them gracefully”。
func AuthenticateRequest(r *Request) error {
err := authenticate(r.User)
if err != nil {
return err
}
return nil
}
複製程式碼上面這個例子中的程式碼是有問題的，直接優化成一句就可以了：
func AuthenticateRequest(r *Request) error {
return authenticate(r.User)
}
複製程式碼還有其他的問題，在函式呼叫鏈的最頂層，我們得到的錯誤可能是：No such file or directory。
這個錯誤反饋的資訊太少了，不知道檔名、路徑、行號等等。
嘗試改進一下，增加一點上下文：
func AuthenticateRequest(r *Request) error {
err := authenticate(r.User)
if err != nil {
return fmt.Errorf("authenticate failed: %v",err)
}
return nil
}
複製程式碼這種做法實際上是先錯誤轉換成字串，再拼接另一個字串，最後，再通過 fmt.Errorf 轉換成錯誤。這樣做破壞了相等性檢測，即我們無法判斷錯誤是否是一種預先定義好的錯誤了。
應對方案是使用第三方庫：github.com/pkg/errors。提供了友好的介面：
// Wrap annotates cause with a message.
func Wrap(cause error,message string) error
// Cause unwraps an annotated error.
func Cause(err error) error
複製程式碼通過 Wrap 可以將一個錯誤，加上一個字串，“包裝”成一個新的錯誤；通過 Cause 則可以進行相反的操作，將裡層的錯誤還原。
有了這兩個函式，就方便很多：
func ReadFile(path string) ([]byte,error) {
f,err := os.Open(path)
if err != nil {
return nil,errors.Wrap(err,"open failed")
}
defer f.Close()
buf,err := ioutil.ReadAll(f)
if err != nil {
return nil,"read failed")
}
return buf,nil
}
複製程式碼這是一個讀檔案的函式，先嚐試開啟檔案，如果出錯，則返回一個附加上了 “open failed” 的錯誤資訊；之後，嘗試讀檔案，如果出錯，則返回一個附加上了 “read failed” 的錯誤。
當在外層呼叫 ReadFile 函式時：
func main() {
_,err := ReadConfig()
if err != nil {
fmt.Println(err)
os.Exit(1)
}
}
func ReadConfig() ([]byte,error) {
home := os.Getenv("HOME")
config,err := ReadFile(filepath.Join(home,".settings.xml"))
return config,"could not read config")
}
複製程式碼這樣我們在 main 函式裡就能打印出這樣一個錯誤資訊：
could not read config: open failed: open /Users/dfc/.settings.xml: no such file or directory
複製程式碼它是有層次的，非常清晰。而如果我們用 pkg/errors 庫提供的列印函式：
func main() {
_,err := ReadConfig()
if err != nil {
errors.Print(err)
os.Exit(1)
}
}
複製程式碼能得到更有層次、更詳細的錯誤：
readfile.go:27: could not read config
readfile.go:14: open failed
open /Users/dfc/.settings.xml: no such file or directory
複製程式碼上面講的是 Wrap 函式，接下來看一下 “Cause” 函式，以前面提到的 temporary 介面為例：
type temporary interface {
Temporary() bool
}
// IsTemporary returns true if err is temporary.
func IsTemporary(err error) bool {
te,ok := errors.Cause(err).(temporary)
return ok && te.Temporary()
}
複製程式碼判斷之前先使用 Cause 取出錯誤，做斷言，最後，遞迴地呼叫 Temporary 函式。如果錯誤沒實現 temporary 介面，就會斷言失敗，返回 false。
Only handle errors once
什麼叫“處理”錯誤：
Handling an error means inspecting the error value,and making a decision.
意思是查看了一下錯誤，並且做出一個決定。
例如，如果不做任何決定，相當於忽略了錯誤：
func Write(w io.Writer,buf []byte) {
w.Write(buf)
w.Write(buf)
}
複製程式碼w.Write(buf) 會返回兩個結果，一個表示寫成功的位元組數，一個是 error，上面的例子中沒有對這兩個返回值做任何處理。
下面這個例子卻又處理了兩次錯誤：
func Write(w io.Writer,buf []byte) error {
_,err := w.Write(buf)
if err != nil {
// annotated error goes to log file
log.Println("unable to write:",err)
// unannotated error returned to caller
return err
return err
}
return nil
}
複製程式碼第一次處理是將錯誤寫進了日誌，第二次處理則是將錯誤返回給上層呼叫者。而呼叫者也可能將錯誤寫進日誌或是繼續返回給上層。
這樣一來，日誌檔案中會有很多重複的錯誤描述，並且在最上層呼叫者（如 main 函式）看來，它拿到的錯誤卻還是最底層函式返回的 error，沒有任何上下文資訊。
使用第三方的 error 包就可以比較完美的解決問題：
func Write(w io.Write,buf []byte) error {
_,err := w.Write(buf)
return errors.Wrap(err,"write failed")
}
複製程式碼返回的錯誤，對於人和機器而言，都是友好的。
小結
這一部分主要講了處理 error 的一些原則，引入了第三方的 errors 包，使得錯誤處理變得更加優雅。
作者最後給出了一些結論：
- errors 就像對外提供的 API 一樣，需要認真對待。
- 將 errors 看成黑盒，判斷它的行為，而不是型別。
- 儘量不要使用 sentinel errors。
- 使用第三方的錯誤包來包裹 error（errors.Wrap），使得它更好用。
- 使用 errors.Cause 來獲取底層的錯誤。
胎死腹中的 try 提案
之前已經出現用 “check & handle” 關鍵字和 “try 內建函式”改進錯誤處理流程的提案，目前 try 內建函式的提案已經被官方提前拒絕，原因是社群裡一邊倒地反對聲音。
關於這兩個提案的具體內容見參考資料【check & handle】和【try 提案】。
go 1.13 的改進
有一些 Go 語言失敗的嘗試，比如 Go 1.5 引入的 vendor 和 internal 來管理包，最後被濫用而引發了很多問題。因此 Go 1.13 直接拋棄了 GOPATH 和 vendor 特性，改用 module 來管理包。
柴大在《Go 語言十年而立，Go2 蓄勢待發》一文中表示：
比如最近 Go 語言之父之一 Robert Griesemer 提交的通過 try 內建函式來簡化錯誤處理就被否決了。失敗的嘗試是一個好的現象，它表示 Go 語言依然在一些新興領域的嘗試 —— Go 語言依然處於活躍期。
今年 9 月 3 號，Go 釋出 1.13 版本，除了 module 特性轉正之外，還改進了數字字面量。比較重要的還有 defer 效能提升 30%，將更多的物件從堆上移動到棧上以提升效能，等等。
還有一個重大的改進發生在 errors 標準庫中。errors 庫增加了 Is/As/Unwrap三個函式，這將用於支援錯誤的再次包裝和識別處理，為 Go 2 中新的錯誤處理改進提前做準備。
1.13 支援了 error 包裹（wrapping）：
An error e can wrap another error w by providing an Unwrap method that returns w. Both e and w are available to programs,allowing e to provide additional context to w or to reinterpret it while still allowing programs to make decisions based on w.
為了支援 wrapping，fmt.Errorf 增加了 %w 的格式，並且在 error 包增加了三個函式：errors.Unwrap，errors.Is，errors.As。
fmt.Errorf
使用 fmt.Errorf 加上 %w 格式符來生成一個巢狀的 error，它並沒有像 pkg/errors 那樣使用一個 Wrap 函式來巢狀 error，非常簡潔。
Unwrap
func Unwrap(err error) error
複製程式碼將巢狀的 error 解析出來，多層巢狀需要呼叫 Unwrap 函式多次，才能獲取最裡層的 error。
原始碼如下：
func Unwrap(err error) error {
// 判斷是否實現了 Unwrap 方法
u,ok := err.(interface {
Unwrap() error
})
// 如果不是，返回 nil
if !ok {
return nil
}
// 呼叫 Unwrap 方法返回被巢狀的 error
return u.Unwrap()
}
複製程式碼對 err 進行斷言，看它是否實現了 Unwrap 方法，如果是，呼叫它的 Unwrap 方法。否則，返回 nil。
Is
func Is(err,target error) bool
複製程式碼判斷 err 是否和 target 是同一型別，或者 err 巢狀的 error 有沒有和 target 是同一型別的，如果是，則返回 true。
原始碼如下：
func Is(err,target error) bool {
if target == nil {
return err == target
}
isComparable := reflectlite.TypeOf(target).Comparable()
// 無限迴圈，比較 err 以及巢狀的 error
for {
if isComparable && err == target {
return true
}
// 呼叫 error 的 Is 方法，這裡可以自定義實現
if x,ok := err.(interface{ Is(error) bool }); ok && x.Is(target) {
return true
}
// 返回被巢狀的下一層的 error
if err = Unwrap(err); err == nil {
return false
}
}
}
複製程式碼通過一個無限迴圈，使用 Unwrap 不斷地將 err 裡層巢狀的 error 解開，再看被解開的 error 是否實現了 Is 方法，並且呼叫它的 Is 方法，當兩者都返回 true 的時候，整個函式返回 true。
As
func As(err error,target interface{}) bool
複製程式碼從 err 錯誤鏈裡找到和 target 相等的並且設定 target 所指向的變數。
原始碼如下：
func As(err error,target interface{}) bool {
// target 不能為 nil
if target == nil {
panic("errors: target cannot be nil")
}
val := reflectlite.ValueOf(target)
typ := val.Type()
// target 必須是一個非空指標
if typ.Kind() != reflectlite.Ptr || val.IsNil() {
panic("errors: target must be a non-nil pointer")
}
// 保證 target 是一個介面型別或者實現了 Error 介面
if e := typ.Elem(); e.Kind() != reflectlite.Interface && !e.Implements(errorType) {
panic("errors: *target must be interface or implement error")
}
targetType := typ.Elem()
for err != nil {
// 使用反射判斷是否可被賦值，如果可以就賦值並且返回true
if reflectlite.TypeOf(err).AssignableTo(targetType) {
val.Elem().Set(reflectlite.ValueOf(err))
return true
}
// 呼叫 error 自定義的 As 方法，實現自己的型別斷言程式碼
if x,ok := err.(interface{ As(interface{}) bool }); ok && x.As(target) {
return true
}
// 不斷地 Unwrap，一層層的獲取巢狀的 error
err = Unwrap(err)
}
return false
}
複製程式碼返回 true 的條件是錯誤鏈裡的 err 能被賦值到 target 所指向的變數；或者 err 實現的 As(interface{}) bool 方法返回 true。
前者，會將 err 賦給 target 所指向的變數；後者，由 As 函式提供這個功能。
如果 target 不是一個指向“實現了 error 介面的型別或者其它介面型別”的非空的指標的時候，函式會 panic。
這一部分的內容，飛雪無情大佬的文章【飛雪無情 分析 1.13 錯誤】寫得比較好，推薦閱讀。
總結
Go 語言使用 error 和 panic 處理錯誤和異常是一個非常好的做法，比較清晰。至於是使用 error 還是 panic，看具體的業務場景。
當然，Go 中的 error 過於簡單，以至於無法記錄太多的上下文資訊，對於錯誤包裹也沒有比較好的辦法。當然，這些可以通過第三方庫來解決。官方也在新發布的 go 1.13 中對這一塊作出了改進，相信在 Go 2 裡會有更進一步的優化。
本文還列舉了一些處理 error 的示例，例如不要兩次處理一個錯誤，判斷錯誤的行為而不是型別等等。
參考資料裡列舉了很多錯誤處理相關的示例，這篇文章作為一個引子。
參考資料
【Go 2 錯誤提案】go.googlesource.com/proposal/+/…
【check & handle】go.googlesource.com/proposal/+/…
【錯誤討論的 issue】github.com/golang/go/i…
【error value 的 FAQ】github.com/golang/go/w…
【error 包】golang.org/pkg/errors/
【飛雪無情的部落格 錯誤處理】www.flysnow.org/2019/01/01/…
【飛雪無情 分析 1.13 錯誤】www.flysnow.org/2019/09/06/…
【Tony Bai Go語言錯誤處理】tonybai.com/2015/10/30/…
【Go 官方 error 使用教程】blog.golang.org/error-handl…
【Go FAQ】golang.org/doc/faq#exc…
【ethancai 錯誤處理】ethancai.github.io/2017/12/29/…
【Dave cheney GoCon 2016 演講】dave.cheney.net/paste/gocon…
【Morsing's Blog Effective error handling in Go】morsmachine.dk/error-handl…
【如何優雅的在Golang中進行錯誤處理】www.ituring.com.cn/article/508…
【Go 2 錯誤處理提案：try 還是 check？】toutiao.io/posts/uh9qo…
【try 提案】github.com/golang/go/i…
【否決 try 提案】github.com/golang/go/i…
【Go 語言的錯誤處理機制是一個優秀的設計嗎？】www.zhihu.com/question/27…