如何優(yōu)化Golang中重復(fù)的錯(cuò)誤處理

Golang 錯(cuò)誤處理最讓人頭疼的問題就是代碼里充斥著「if err != nil」炸宵,它們破壞了代碼的可讀性辟躏,本文收集了幾個(gè)例子,讓大家明白如何優(yōu)化此類問題土全。

讓我們看看 Errors are values 中提到的一個(gè) io.Writer 例子:

_, err = fd.Write(p0[a:b])
if err != nil {
return err
}
_, err = fd.Write(p1[c:d])
if err != nil {
return err
}
_, err = fd.Write(p2[e:f])
if err != nil {
return err
}
如上代碼乍一看無法直觀的看出其本來的意圖是什么捎琐,改進(jìn)版:

type errWriter struct {
w io.Writer
err error
}
func (ew *errWriter) write(buf []byte) {
if ew.err != nil {
return
}
_, ew.err = ew.w.Write(buf)
}
ew := &errWriter{w: fd}
ew.write(p0[a:b])
ew.write(p1[c:d])
ew.write(p2[e:f])
if ew.err != nil {
return ew.err
}
通過自定義類型 errWriter 來封裝 io.Writer,并且封裝了 error裹匙,新類型有一個(gè) write 方法瑞凑,不過其方法簽名并沒有返回 error,而是在方法內(nèi)部判斷一旦有問題就立刻返回概页,有了這些準(zhǔn)備工作籽御,我們就可以把原本穿插在業(yè)務(wù)邏輯中間的錯(cuò)誤判斷提出來放到最后來統(tǒng)一調(diào)用,從而在視覺上保證讓人可以直觀的看出代碼本來的意圖是什么。

讓我們?cè)倏纯?Eliminate error handling by eliminating errors 中提到的另一個(gè) io.Writer 例子:

type Header struct {
Key, Value string
}
type Status struct {
Code int
Reason string
}
func WriteResponse(w io.Writer, st Status, headers []Header, body io.Reader) error {
_, err := fmt.Fprintf(w, "HTTP/1.1 %d %s\r\n", st.Code, st.Reason)
if err != nil {
return err
}
for _, h := range headers {
_, err := fmt.Fprintf(w, "%s: %s\r\n", h.Key, h.Value)
if err != nil {
return err
}
}
if _, err := fmt.Fprint(w, "\r\n"); err != nil {
return err
}
_, err = io.Copy(w, body)
return err
}
第一感覺既然錯(cuò)誤是 fmt.Fprint 和 io.Copy 返回的技掏,是不是我們要重新封裝一下它們铃将?實(shí)際上真正的源頭是它們的參數(shù) io.Writer,因?yàn)橹苯诱{(diào)用 io.Writer 的 Writer 方法的話哑梳,方法簽名中有返回值 error劲阎,所以每一步 fmt.Fprint 和 io.Copy 操作都不得不進(jìn)行重復(fù)的錯(cuò)誤處理,看上去是壞味道鸠真,改進(jìn)版:

type errWriter struct {
io.Writer
err error
}
func (e *errWriter) Write(buf []byte) (int, error) {
if e.err != nil {
return 0, e.err
}
var n int
n, e.err = e.Writer.Write(buf)
return n, nil
}
func WriteResponse(w io.Writer, st Status, headers []Header, body io.Reader) error {
ew := &errWriter{Writer: w}
fmt.Fprintf(ew, "HTTP/1.1 %d %s\r\n", st.Code, st.Reason)
for _, h := range headers {
fmt.Fprintf(ew, "%s: %s\r\n", h.Key, h.Value)
}
fmt.Fprint(ew, "\r\n")
io.Copy(ew, body)
return ew.err
}
通過自定義類型 errWriter 來封裝 io.Writer悯仙,并且封裝了 error,同時(shí)重寫了 Writer 方法吠卷,雖然方法簽名中仍然有返回值 error锡垄,但是我們單獨(dú)保存了一份 error,并且在方法內(nèi)部判斷一旦有問題就立刻返回祭隔,有了這些準(zhǔn)備工作货岭,新版的 WriteResponse 不再有重復(fù)的錯(cuò)誤判斷,只需要在最后檢查一下 error 即可序攘。

類似的做法在 Golang 標(biāo)準(zhǔn)庫中屢見不鮮茴她,讓我們繼續(xù)看看 Eliminate error handling by eliminating errors 中提到的一個(gè)關(guān)于 bufio.Reader 和 bufio.Scanner 的例子:

func CountLines(r io.Reader) (int, error) {
var (
br = bufio.NewReader(r)
lines int
err error
)
for {
_, err = br.ReadString('\n')
lines++
if err != nil {
break
}
}
if err != io.EOF {
return 0, err
}
return lines, nil
}
我們構(gòu)造一個(gè) bufio.Reader寻拂,然后在一個(gè)循環(huán)中調(diào)用 ReadString 方法程奠,如果讀到文件結(jié)尾,那么 ReadString 會(huì)返回一個(gè)錯(cuò)誤(io.EOF)祭钉,為了判斷此類情況瞄沙,我們不得不在每次循環(huán)時(shí)判斷「if err != nil」,看上去這是壞味道慌核,改進(jìn)版:

func CountLines(r io.Reader) (int, error) {
sc := bufio.NewScanner(r)
lines := 0
for sc.Scan() {
lines++
}
return lines, sc.Err()
}
實(shí)際上距境,和 bufio.Reader 相比,bufio.Scanner 是一個(gè)更高階的類型垮卓,換句話簡(jiǎn)單點(diǎn)來說的話垫桂,相當(dāng)于是 bufio.Scanner 抽象了 bufio.Reader,通過把低階的 bufio.Reader 換成高階的 bufio.Scanner粟按,循環(huán)中不再需要判斷「if err != nil」诬滩,因?yàn)?Scan 方法簽名不再返回 error,而是返回 bool灭将,當(dāng)在循環(huán)里讀到了文件結(jié)尾的時(shí)候疼鸟,循環(huán)直接結(jié)束,如此一來庙曙,我們就可以統(tǒng)一在最后調(diào)用 Err 方法來判斷成功還是失敗空镜,看看 Scanner 的定義:

type Scanner struct {
r io.Reader // The reader provided by the client.
split SplitFunc // The function to split the tokens.
maxTokenSize int // Maximum size of a token; modified by tests.
token []byte // Last token returned by split.
buf []byte // Buffer used as argument to split.
start int // First non-processed byte in buf.
end int // End of data in buf.
err error // Sticky error.
empties int // Count of successive empty tokens.
scanCalled bool // Scan has been called; buffer is in use.
done bool // Scan has finished.
}
可見 Scanner 封裝了 io.Reader,并且封裝了 error,和我們之前討論的做法一致吴攒。有一點(diǎn)說明一下张抄,實(shí)際上查看 Scan 源代碼的話,你會(huì)發(fā)現(xiàn)它不是通過 err 來判斷是否結(jié)束的洼怔,而是通過 done 來判斷是否結(jié)束欣鳖,這是因?yàn)?Scan 只有遇到文件結(jié)束的錯(cuò)誤才退出,其它錯(cuò)誤會(huì)繼續(xù)執(zhí)行茴厉,當(dāng)然泽台,這只是具體的細(xì)節(jié)問題,不影響我們的結(jié)論矾缓。

通過對(duì)以上幾個(gè)例子的分析怀酷,我們可以得出優(yōu)化重復(fù)錯(cuò)誤處理的大概套路:通過創(chuàng)建新的類型來封裝原本干臟活累活的舊類型,同時(shí)在新類型中封裝 error嗜闻,新舊類型的方法簽名可以保持兼容蜕依,也可以不兼容,這個(gè)不是關(guān)鍵的琉雳,視客觀情況而定样眠,至于具體的邏輯實(shí)現(xiàn),先判斷有沒有 error翠肘,如果有就直接退出檐束,如果沒有就繼續(xù)執(zhí)行,并且在執(zhí)行過程中保存可能出現(xiàn)的 error 以便后面操作使用束倍,最后通過統(tǒng)一調(diào)用新類型的 error 來完成錯(cuò)誤處理被丧。提醒一下,此方案的缺點(diǎn)是要到最后才能知道有沒有錯(cuò)誤绪妹,好在如此的控制粒度在多數(shù)時(shí)候并無大礙甥桂。

原文鏈接:https://huoding.com/2019/04/11/728

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市邮旷,隨后出現(xiàn)的幾起案子黄选,更是在濱河造成了極大的恐慌,老刑警劉巖婶肩,帶你破解...
    沈念sama閱讀 217,084評(píng)論 6 503
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件办陷,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡狡孔,警方通過查閱死者的電腦和手機(jī)懂诗,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,623評(píng)論 3 392
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來苗膝,“玉大人殃恒,你說我怎么就攤上這事植旧。” “怎么了离唐?”我有些...
    開封第一講書人閱讀 163,450評(píng)論 0 353
  • 文/不壞的土叔 我叫張陵病附,是天一觀的道長(zhǎng)。 經(jīng)常有香客問我亥鬓,道長(zhǎng)完沪,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,322評(píng)論 1 293
  • 正文 為了忘掉前任嵌戈,我火速辦了婚禮覆积,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘熟呛。我一直安慰自己宽档,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,370評(píng)論 6 390
  • 文/花漫 我一把揭開白布庵朝。 她就那樣靜靜地躺著吗冤,像睡著了一般。 火紅的嫁衣襯著肌膚如雪九府。 梳的紋絲不亂的頭發(fā)上椎瘟,一...
    開封第一講書人閱讀 51,274評(píng)論 1 300
  • 那天,我揣著相機(jī)與錄音侄旬,去河邊找鬼肺蔚。 笑死,一個(gè)胖子當(dāng)著我的面吹牛勾怒,可吹牛的內(nèi)容都是我干的婆排。 我是一名探鬼主播声旺,決...
    沈念sama閱讀 40,126評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼笔链,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來了腮猖?” 一聲冷哼從身側(cè)響起鉴扫,我...
    開封第一講書人閱讀 38,980評(píng)論 0 275
  • 序言:老撾萬榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎澈缺,沒想到半個(gè)月后坪创,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,414評(píng)論 1 313
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡姐赡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,599評(píng)論 3 334
  • 正文 我和宋清朗相戀三年莱预,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片项滑。...
    茶點(diǎn)故事閱讀 39,773評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡依沮,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情危喉,我是刑警寧澤宋渔,帶...
    沈念sama閱讀 35,470評(píng)論 5 344
  • 正文 年R本政府宣布,位于F島的核電站辜限,受9級(jí)特大地震影響皇拣,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜薄嫡,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,080評(píng)論 3 327
  • 文/蒙蒙 一氧急、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧毫深,春花似錦态蒂、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,713評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至鸳址,卻和暖如春瘩蚪,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背稿黍。 一陣腳步聲響...
    開封第一講書人閱讀 32,852評(píng)論 1 269
  • 我被黑心中介騙來泰國(guó)打工疹瘦, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人巡球。 一個(gè)月前我還...
    沈念sama閱讀 47,865評(píng)論 2 370
  • 正文 我出身青樓言沐,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親酣栈。 傳聞我的和親對(duì)象是個(gè)殘疾皇子险胰,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,689評(píng)論 2 354

推薦閱讀更多精彩內(nèi)容

  • Lua 5.1 參考手冊(cè) by Roberto Ierusalimschy, Luiz Henrique de F...
    蘇黎九歌閱讀 13,791評(píng)論 0 38
  • 一、數(shù)據(jù)類型轉(zhuǎn)換 https://studygolang.com/articles/10838 package m...
    蓓蓓的萬能男友閱讀 1,079評(píng)論 0 1
  • 談到docker源碼矿筝,其實(shí)網(wǎng)上有很多的源碼的分析的文章起便,也看過一些大牛寫的docker源碼解讀的文章,收獲很大窖维。我...
    跨界師閱讀 1,323評(píng)論 2 3
  • fmt格式化字符串 格式:%[旗標(biāo)][寬度][.精度][arg索引]動(dòng)詞旗標(biāo)有以下幾種:+: 對(duì)于數(shù)值類型總是輸出...
    皮皮v閱讀 1,096評(píng)論 0 3
  • “叮鈴鈴……”第一節(jié)語文課下課了榆综,同學(xué)們聚在一起嘰嘰喳喳地談?wù)撟约荷盏哪且惶臁P∏嗟靡庋笱蟮卣f:“我上個(gè)星期過了...
    八歲的可愛淘閱讀 308評(píng)論 0 0