Go?錯誤處理實踐總結(jié)示例
最近在對極客時間毛劍老師的 Go 進(jìn)階訓(xùn)練營進(jìn)行重溫和學(xué)習(xí)匯總,這是一門比較偏向于工程化以及原理層面的的課程,涵蓋的知識點(diǎn)非常多,因此決定開一個系列來進(jìn)行記錄,也便于自己總結(jié)查閱。
Go 錯誤處理機(jī)制
Go 內(nèi)置 errors
Go 語言中的error
就是普通的一個接口,表示值
// http://golang.org/pkg/builtin/#error // error 接口的定義 type error interface { Error() string } // http://golang.org/pkg/errors/error.go // errors 構(gòu)建 error 對象 type errorString struct { s string } func (e *errorString) Error() string { return e.s }
基礎(chǔ)庫中有大量自定義的error
,如Error: EOF
,而errors.New()
返回的是內(nèi)部errorString
對象的指針。
Error 與 Exception
不同于 Java、C++ 等語言,Go 處理異常的邏輯是不引入 exception,而是采取多參數(shù)返回,因此可以在函數(shù)中帶入 error interface 對象來交給調(diào)用者來進(jìn)行處理。
func handle() (int, error) { return 1, nil } func main() { i, err := handle() if err != nil { return } // 其他處理邏輯 }
需要注意的是,Go 中有 panic 的機(jī)制,可以和 recovery 搭配實現(xiàn)類似于try...exception...
的效果,但是 Go 中的 panic 并不等同于 exception,exception 一般是交由調(diào)用者來進(jìn)行處理,而 Go panic 則是針對真正異常的情況(如索引越界、棧溢出、不可恢復(fù)的環(huán)境問題等),意味著代碼不能繼續(xù)運(yùn)行,而不能假設(shè)調(diào)用者會來解決 panic。
Go 的多返回值來支持調(diào)用者進(jìn)行錯誤處理的方式給予了開發(fā)者很大的靈活性,有如下優(yōu)勢
- 簡單
- Plan for failure, not success
- 沒有隱藏的控制流
- 完全交給開發(fā)者來控制 error
- error 是值,因此有很大的靈活性進(jìn)行處理
Go 錯誤處理最佳實踐
panic
panic 只用于真正異常的情況,如
- 在程序啟動的時候,如果有強(qiáng)依賴的服務(wù)出現(xiàn)故障時 panic 退出
- 在程序啟動的時候,如果發(fā)現(xiàn)有配置明顯不符合要求, 可以 panic 退出(防御編程)
- 在程序入口處,例如 gin 中間件需要使用 recovery 預(yù)防 panic 程序退出
因為 panic 會導(dǎo)致程序直接退出,而如果使用 recovery 進(jìn)行處理的話性能不好且不可控。因此,其他情況下只要不是不可恢復(fù)的程序錯誤,都不應(yīng)該直接 panic 應(yīng)該返回 error,從而交給開發(fā)者。
error
一般我們在開發(fā)中會使用github.com/pkg/errors
處理應(yīng)用錯誤,但需要注意的是,在公共庫當(dāng)中,我們一般不使用。
在通過多返回值來判斷錯誤時,error
應(yīng)該是函數(shù)的最后一個返回值,而當(dāng)error
不是nil
時,其他返回值均應(yīng)該為不可用狀態(tài),不應(yīng)該對它們進(jìn)行額外處理,錯誤處理的時候也應(yīng)該先判斷錯誤,當(dāng)if err != nil
時及時返回錯誤,從而避免過多的代碼嵌套。
// 錯誤示例 func f() error { ans, err := someFunc() if err == nil { // 其他邏輯 } return err } // 正確示例 func f() error { ans, err := someFunc() if err != nil { return err } // 其他邏輯 return nil }
當(dāng)程序出現(xiàn)錯誤時,一般使用errors.New
或errors.Errorf
返回錯誤值
func someFunc() error { res := anotherFunc() if res != true { errors.Errorf("結(jié)果錯誤,已嘗試 %d 次", count) } // 其他邏輯 return nil }
而如果是調(diào)用其他函數(shù)出現(xiàn)問題,則應(yīng)該直接返回,如果需要攜帶額外信息,則使用errors.WithMessage
。
func someFunc() error { res, err := anotherFunc() if err != nil { return errors.WithMessage(err, "other information") } }
如果是調(diào)用其他庫(標(biāo)準(zhǔn)庫、企業(yè)公共庫、開源第三方庫等)獲取到錯誤時,請使用errors.Wrap
添加堆棧信息。只需要在錯誤第一次出現(xiàn)時使用,且在基礎(chǔ)庫和被大量引用的第三方庫編寫時一般不使用,避免堆棧信息重復(fù)。
func f() error { err := json.Unmashal(&a, data) if err != nil { return errors.Wrap(err, "other information") } // 其他邏輯 return nil }
當(dāng)需要對錯誤進(jìn)行判斷時,需要采用errors.Is
進(jìn)行比較
func f() error { err := A() if errors.Is(err, io.EOF){ return nil } // 其他邏輯 return nil }
而對錯誤類型進(jìn)行判斷時則使用errors.As
進(jìn)行賦值
func f() error { err := A() var errA errorA if errors.As(err, &errA){ // ... } // 其他邏輯 return nil }
對于業(yè)務(wù)中的錯誤(如輸入錯誤等),最好在統(tǒng)一的一個地方建立自己的錯誤字典,其中應(yīng)該包含錯誤代碼并且可以在日志中作為獨(dú)立字段打印,也需要有清晰的文檔。
我們常常用日志來輔助我們進(jìn)行錯誤處理,不需要進(jìn)行返回、被忽略的錯誤必須輸出日志,但禁止每個出錯的地方都打日志。而如果同一個地方不停地報錯,最好是打印一次錯誤詳情并打印出現(xiàn)次數(shù)。
總結(jié)
以上就是對 Go 錯誤處理和最佳實踐的一些總結(jié),后續(xù)也會對錯誤類型、錯誤包裝以及常見的使用中遇到的坑等進(jìn)行總結(jié)。
參考golanggorm錯誤處理事務(wù)以及日志用法示例
更多關(guān)于Go 錯誤處理的資料請關(guān)注本站其它相關(guān)文章!
版權(quán)聲明:本站文章來源標(biāo)注為YINGSOO的內(nèi)容版權(quán)均為本站所有,歡迎引用、轉(zhuǎn)載,請保持原文完整并注明來源及原文鏈接。禁止復(fù)制或仿造本網(wǎng)站,禁止在非www.sddonglingsh.com所屬的服務(wù)器上建立鏡像,否則將依法追究法律責(zé)任。本站部分內(nèi)容來源于網(wǎng)友推薦、互聯(lián)網(wǎng)收集整理而來,僅供學(xué)習(xí)參考,不代表本站立場,如有內(nèi)容涉嫌侵權(quán),請聯(lián)系alex-e#qq.com處理。