Go 語(yǔ)言怎么優(yōu)化重復(fù)的 if err != nil 樣板代碼?
1.介紹
Go 語(yǔ)言的錯(cuò)誤處理在社區(qū)中一直被部分 Go 開(kāi)發(fā)者詬病,其中重復(fù)的 if err != nil 樣板代碼是最令 Go 開(kāi)發(fā)者難以忍受的,嚴(yán)重降低代碼的可讀性。
針對(duì)這個(gè)社區(qū)爭(zhēng)論非常激烈的話題,筆者介紹兩種優(yōu)化重復(fù)的 if err != nil 樣板代碼的方式。
2.封裝錯(cuò)誤檢查函數(shù)
錯(cuò)誤檢查函數(shù)示例代碼:
func CheckErrors (err error) {
if err != nil {
// do something
}
}
調(diào)用錯(cuò)誤檢查函數(shù)示例代碼:
err := SomeMethod()
CheckErrors(err)
閱讀上面這段代碼,封裝一個(gè)錯(cuò)誤檢查的函數(shù),代碼中需要處理錯(cuò)誤的地方,直接調(diào)用該函數(shù)。
這種方式,雖然在視覺(jué)上提升了代碼的可讀性,但是在需要特殊處理錯(cuò)誤的場(chǎng)景也有局限性,比如需要使用額外的信息完善錯(cuò)誤時(shí),該方式并不適用此類(lèi)場(chǎng)景。
3.結(jié)構(gòu)體中定義錯(cuò)誤信息字段
我們可以在結(jié)構(gòu)體中定義錯(cuò)誤信息字段,將結(jié)構(gòu)體的方法與錯(cuò)誤信息綁定在一起。
示例代碼:
type Writer struct {
err error
buf []byte
n int
wr io.Writer
}
func (b *Writer) Flush() error {
if b.err != nil {
return b.err
}
// ...
return nil
}
閱讀 Go 標(biāo)準(zhǔn)庫(kù) bufio 的代碼片段,我們可以發(fā)現(xiàn)在 Writer 結(jié)構(gòu)體中定義一個(gè) err 字段,將錯(cuò)誤信息封裝在結(jié)構(gòu)體中。
在 Writer 結(jié)構(gòu)體的方法的開(kāi)頭先判斷 err 字段是否為 nil,如果 err 字段的值不是 nil,則直接返回 err,從而減少 if err != nil 樣板代碼的重復(fù)出現(xiàn)。
4.總結(jié)
本文我們介紹怎么優(yōu)化 Go 語(yǔ)言中重復(fù)的 if err != nil 樣板代碼的兩種方式,筆者推薦使用第二種方式,因?yàn)榈谝环N方式雖然簡(jiǎn)單,但是在一些特定場(chǎng)景并不適合。
通過(guò)在結(jié)構(gòu)體中定義錯(cuò)誤信息的字段,將結(jié)構(gòu)體的方法和錯(cuò)誤信息綁定在一起的優(yōu)化方式,相比較第一種方式更加優(yōu)雅。
參考資料:
https://www.reddit.com/r/golang/comments/6v07ij/copypasting_if_err_nil_return_err_everywhere/
https://www.reddit.com/r/golang/comments/649o0c/syncx_go_library_that_extends_standard_sync/
https://go.dev/blog/errors-are-values
https://pkg.go.dev/golang.org/x/sync/errgroup
https://pkg.go.dev/github.com/facebookgo/stackerr#section-readme