Go Error 嵌套到底是怎么實(shí)現(xiàn)的?
Go Error 的設(shè)計(jì)哲學(xué)是 「Errors Are Values」。
這句話應(yīng)該怎么理解呢?翻譯起來(lái)挺難的。不過(guò)從源碼的角度來(lái)看,好像更容易理解其背后的含義。
Go Error 源碼很簡(jiǎn)單,寥寥幾行:
//?src/builtin/builtin.go
type?error?interface?{
?Error()?string
}
error 是一個(gè)接口類型,只需要實(shí)現(xiàn) Error() 方法即可。在 Error() 方法中,就可以返回自定義結(jié)構(gòu)體的任意內(nèi)容。
下面首先說(shuō)說(shuō)如何創(chuàng)建 error。
創(chuàng)建 Error
創(chuàng)建 error 有兩種方式,分別是:
errors.New();fmt.Errorf()。
errors.New()
errors.New() 的使用延續(xù)了 Go 的一貫風(fēng)格,New 一下就可以了。
舉一個(gè)例子:
package?main
import?(
?"errors"
?"fmt"
)
func?main()?{
?err?:=?errors.New("這是?errors.New()?創(chuàng)建的錯(cuò)誤")
?fmt.Printf("err 錯(cuò)誤類型:%T,錯(cuò)誤為:%v\n",?err,?err)
}
/*?輸出
err 錯(cuò)誤類型:*errors.errorString,錯(cuò)誤為:這是 errors.New()?創(chuàng)建的錯(cuò)誤
*/
這段代碼唯一讓人困惑的地方可能就是錯(cuò)誤類型了,但沒(méi)關(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 是一個(gè)結(jié)構(gòu)體,實(shí)現(xiàn)了 Error() 方法,New 函數(shù)直接返回 errorString 指針。
這種用法很簡(jiǎn)單,但不實(shí)用。假如我還想返回程序的上下文信息,它就沒(méi)轍了。
下面看第二種方式。
fmt.Errorf()
還是先看一個(gè)例子:
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
*/
這個(gè)例子輸出了我們想要的結(jié)果,但是還不夠。
一般情況下,我們會(huì)通過(guò)使用 fmt.Errorf() 函數(shù),附加上我們想添加的文本信息,使返回內(nèi)容更明確,處理起來(lái)更靈活。
所以,foo() 函數(shù)會(huì)改成下面這樣:
func?foo()?error?{
???return?fmt.Errorf("foo?err,?%v",?sql.ErrNoRows)
}
這時(shí)問(wèn)題就出現(xiàn)了,經(jīng)過(guò) fmt.Errorf() 的封裝,原始 error 類型發(fā)生了改變,這就導(dǎo)致 err == sql.ErrNoRows 不再成立,返回信息變成了 Unknown error。
如果想根據(jù)返回的 error 類型做不同處理,就無(wú)法實(shí)現(xiàn)了。
因此,Go 1.13 為我們提供了 wrapError 來(lái)處理這個(gè)問(wèn)題。
Wrap Error
看一個(gè)例子:
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
*/
乍一看好像好沒(méi)什么區(qū)別,但背后的實(shí)現(xiàn)原理卻并不相同。
Go 擴(kuò)展了 fmt.Errorf() 函數(shù),增加了一個(gè) %w 標(biāo)識(shí)符來(lái)創(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
}
當(dāng)使用 w% 時(shí),函數(shù)會(huì)返回 &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
}
實(shí)現(xiàn)了 Error() 方法,說(shuō)明它是一個(gè) 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% 將上文中的程序進(jìn)行改造,使其內(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é)果,每個(gè)函數(shù)都增加了必要的上下文信息,而且也符合對(duì)錯(cuò)誤類型的判斷。
errors.Is() 函數(shù)用來(lái)判斷 err 以及其封裝的 error 鏈中是否包含目標(biāo)類型。這也就解決了上文提出的無(wú)法判斷錯(cuò)誤類型的問(wèn)題。
后記
其實(shí),Go 目前對(duì) Error 的處理方式也是充滿爭(zhēng)議的。不過(guò),官方團(tuán)隊(duì)正在積極和社區(qū)交流,提出改進(jìn)方法。相信在不久的將來(lái),一定會(huì)找到更好的解決方案。
現(xiàn)階段來(lái)說(shuō),大部分團(tuán)隊(duì)可能會(huì)選擇 github.com/pkg/errors 包來(lái)進(jìn)行錯(cuò)誤處理。如果感興趣的話,可以學(xué)學(xué)看。
好了,本文就到這里吧。關(guān)注我,帶你通過(guò)問(wèn)題讀 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
