Golang中巧用defer進行錯誤處理

問題引入

毫無疑問,錯誤處理是程序的重要組成部分,有效且優雅的處理錯誤是大多數程序員的追求。很多程序員都有C/C++的編程背景,Golang的程序員也不例外,他們處理錯誤有意無意的帶著C/C++的烙印。

我們看看下面的例子,就有一種似曾相識的趕腳,代碼如下:

func deferDemo() error {
    err := createResource1()
    if err != nil {
        return ERR_CREATE_RESOURCE1_FAILED
    }
    err = createResource2()
    if err != nil {
        destroyResource1()
        return ERR_CREATE_RESOURCE2_FAILED
    }

    err = createResource3()
    if err != nil {
        destroyResource1()
        destroyResource2()
        return ERR_CREATE_RESOURCE3_FAILED
    }

    err = createResource4()
    if err != nil {
        destroyResource1()
        destroyResource2()
        destroyResource3()
        return ERR_CREATE_RESOURCE4_FAILED
    }
    return nil
}

從代碼的實現中可以看出:在一個函數中,當創建新資源失敗時,則要清理所有前面已經創建成功的資源,這使得函數中有了重復代碼的壞味道,比如destroyResource1函數調用了3次,destroyResource2函數調用了2次。

重構一:一個defer + 多個flag

Golang提供了一個很好用的關鍵字defer,當包含defer的函數執行完畢時(不管是通過return的正常結束,還是由于panic導致的異常結束),defer語句才被調用。
考慮到這一點,我們嘗試將所有資源在defer語句中統一清理。由于函數返回時,不知道是否需要清理以及清理那些資源,所以要增加多個flag。
重構后的代碼如下所示:

func deferDemo() error {
    flag := false
    flag1 := false
    flag2 := false
    flag3 := false

    defer func() {
        if !flag {
            if flag3 {
                 destroyResource3()
            }
            if flag2 {
                 destroyResource2()
            }
            if flag1 {
             destroyResource1()
            }
        }
    }()

    err := createResource1()
    if err != nil {
        return ERR_CREATE_RESOURCE1_FAILED
    }
    flag1 = true

    err = createResource2()
    if err != nil {
        return ERR_CREATE_RESOURCE2_FAILED
    }
    flag2 = true

    err = createResource3()
    if err != nil {
        return ERR_CREATE_RESOURCE3_FAILED
    }
    flag3 = true

    err = createResource4()
    if err != nil {
        return ERR_CREATE_RESOURCE4_FAILED
    }
    flag = true
    return nil
}

從重構后的代碼可以看出,雖然消除了重復,但是引入了太多的flag:

  1. flag表示函數是否執行成功,即flag為true時表示函數執行成功,否則表示函數執行失敗;在defer語句中,只有flag為false時才需要統一清理資源
  2. flagi表示第i個資源是否創建成功,即flagi為true時表示第i個資源創建成功,否則表示第i個資源創建失敗;在defer語句中,只有flagi為true時才需要清理第i個資源

顯然,這不是我們想要的

重構二:多個defer

看過linux源碼的同學都知道,在內核代碼中,很多地方都通過goto語句來集中處理錯誤,非常優雅。
我們用這種方法將重構前的代碼用C語言寫一下,代碼如下所示:

ErrCode deferDemo()
{
   ErrCode err = createResource1();
   if (err != ERR_SUCC)
   {
       goto err_1;
   }

   err = createResource2();
   if (err != ERR_SUCC)
   {
       goto err_2;
   }

   err = createResource3();
   if (err != ERR_SUCC)
   {
       goto err_3;
   }

   err = createResource4();
   if (err != ERR_SUCC)
   {
       goto err_4;
   }

   return ERR_SUCC;

   err_4:
       destroyResource3();
   err_3:
       destroyResource2();
   err_2:
       destroyResource1();
   err_1:
       return ERR_FAIL;
}

沒有重復,沒有flag,錯誤處理也很優雅,感覺很爽,那以前在C/C++編碼規范中禁止使用goto語句的規則確實有點過,呵呵...

從重構后的C代碼中可以看出,create操作和destroy操作的順序類似入棧和出棧的順序:

  1. 伴隨著create操作,destroy操作逐個入棧,順序為1,2,3
  2. 出棧時是destroy操作,順序為3,2,1

于是我們又想到了defer語句:當Golang的代碼執行時,如果遇到defer語句,則壓入堆棧,當函數返回時,會按照后進先出的順序調用defer語句
我們看一個例子,代碼如下所示:

func main() {
    defer fmt.Println(1)
    defer fmt.Println(2)
    defer fmt.Println(3)
}

運行后,日志如下所示:

3
2
1

然而,有堆棧特性還不夠,因為伴隨著create操作,destroy操作入棧是有條件的:

  1. 如果create操作失敗,則直接返回,那么defer語句沒有執行,導致destroy操作沒有入棧
  2. 如果create操作成功,則defer語句得到執行,destroy操作完成入棧

可見,destroy操作的入棧條件是create操作成功,但是destroy操作并不是一定執行,只有當某個create操作失敗("err != nil")時,前面入棧的destory操作才需要執行,所以err的值也需要入棧。然而,destroy操作入棧時"err == nil" ,于是問題就變成:當err的值在后面變成非nil時,應該同步修改堆棧中的err值,即堆棧中傳遞的是引用或指針而不是值。

當err的引用或指針和destroy操作都需要入棧時,defer后面必須是一個閉包調用。我們知道,對于閉包的參數是值傳遞,而對于外部變量卻是引用傳遞。為了簡單優雅起見,我們將err不通過參數的指針傳遞,而通過外部變量的引用傳遞。

我們根據這個結論重構一下代碼,如下所示:

func deferDemo() error {
    err := createResource1()
    if err != nil {
        return ERR_CREATE_RESOURCE1_FAILED
    }
    defer func() {
        if err != nil {
            destroyResource1()
        }
    }()

    err = createResource2()
    if err != nil {
        return ERR_CREATE_RESOURCE2_FAILED
    }
    defer func() {
        if err != nil {
            destroyResource2()
        }
    }()

    err = createResource3()
    if err != nil {
        return ERR_CREATE_RESOURCE3_FAILED
    }
    defer func() {
        if err != nil {
            destroyResource3()
        }
    }()

    err = createResource4()
    if err != nil {
        return ERR_CREATE_RESOURCE4_FAILED
    }
    return nil
}

本次重構消除了代碼的壞味道,不由的感嘆一句:”升級了,我的哥!“

小結

本文通過巧用defer,有效且優雅的處理了錯誤,該技巧應該被所有的Golang程序員掌握并大量使用。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 230,431評論 6 544
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,637評論 3 429
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 178,555評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,900評論 1 318
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,629評論 6 412
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,976評論 1 328
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,976評論 3 448
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 43,139評論 0 290
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,686評論 1 336
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,411評論 3 358
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,641評論 1 374
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 39,129評論 5 364
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,820評論 3 350
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,233評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,567評論 1 295
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,362評論 3 400
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,604評論 2 380

推薦閱讀更多精彩內容