Golang巧用defer進(jìn)行錯(cuò)誤處理的方法

本文主要跟大家介紹了Golang巧用defer進(jìn)行錯(cuò)誤處理的相關(guān)內(nèi)容，分享出來(lái)供大家參考學(xué)習(xí)，下面來(lái)看看詳細(xì)的介紹：

問(wèn)題引入

毫無(wú)疑問(wèn)，錯(cuò)誤處理是程序的重要組成部分，有效且優(yōu)雅的處理錯(cuò)誤是大多數(shù)程序員的追求。很多程序員都有C/C++的編程背景，Golang的程序員也不例外，他們處理錯(cuò)誤有意無(wú)意的帶著C/C++的烙印。

我們看看下面的例子，就有一種似曾相識(shí)的趕腳，代碼如下：

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
}

從代碼的實(shí)現(xiàn)中可以看出：在一個(gè)函數(shù)中，當(dāng)創(chuàng)建新資源失敗時(shí)，則要清理所有前面已經(jīng)創(chuàng)建成功的資源，這使得函數(shù)中有了重復(fù)代碼的壞味道，比如destroyResource1函數(shù)調(diào)用了3次，destroyResource2函數(shù)調(diào)用了2次。

重構(gòu)一：一個(gè)defer + 多個(gè)flag

Golang提供了一個(gè)很好用的關(guān)鍵字defer，當(dāng)包含defer的函數(shù)執(zhí)行完畢時(shí)（不管是通過(guò)return的正常結(jié)束，還是由于panic導(dǎo)致的異常結(jié)束），defer語(yǔ)句才被調(diào)用。

考慮到這一點(diǎn)，我們嘗試將所有資源在defer語(yǔ)句中統(tǒng)一清理。由于函數(shù)返回時(shí)，不知道是否需要清理以及清理那些資源，所以要增加多個(gè)flag。

重構(gòu)后的代碼如下所示：

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
}

從重構(gòu)后的代碼可以看出，雖然消除了重復(fù)，但是引入了太多的flag：

• flag表示函數(shù)是否執(zhí)行成功，即flag為true時(shí)表示函數(shù)執(zhí)行成功，否則表示函數(shù)執(zhí)行失?。辉赿efer語(yǔ)句中，只有flag為false時(shí)才需要統(tǒng)一清理資源
• flagi表示第i個(gè)資源是否創(chuàng)建成功，即flagi為true時(shí)表示第i個(gè)資源創(chuàng)建成功，否則表示第i個(gè)資源創(chuàng)建失??；在defer語(yǔ)句中，只有flagi為true時(shí)才需要清理第i個(gè)資源
  

顯然，這不是我們想要的

重構(gòu)二：多個(gè)defer

看過(guò)linux源碼的同學(xué)都知道，在內(nèi)核代碼中，很多地方都通過(guò)goto語(yǔ)句來(lái)集中處理錯(cuò)誤，非常優(yōu)雅。

我們用這種方法將重構(gòu)前的代碼用C語(yǔ)言寫(xiě)一下，代碼如下所示：

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;
}

沒(méi)有重復(fù)，沒(méi)有flag，錯(cuò)誤處理也很優(yōu)雅，感覺(jué)很爽，那以前在C/C++編碼規(guī)范中禁止使用goto語(yǔ)句的規(guī)則確實(shí)有點(diǎn)過(guò)，呵呵...

從重構(gòu)后的C代碼中可以看出，create操作和destroy操作的順序類(lèi)似入棧和出棧的順序：

• 伴隨著create操作，destroy操作逐個(gè)入棧，順序?yàn)?，2，3
• 出棧時(shí)是destroy操作，順序?yàn)?，2，1
  

于是我們又想到了defer語(yǔ)句：當(dāng)Golang的代碼執(zhí)行時(shí)，如果遇到defer語(yǔ)句，則壓入堆棧，當(dāng)函數(shù)返回時(shí)，會(huì)按照后進(jìn)先出的順序調(diào)用defer語(yǔ)句。

我們看一個(gè)例子，代碼如下所示：

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

運(yùn)行后，日志如下所示：

3
2
1

然而，有堆棧特性還不夠，因?yàn)榘殡S著create操作，destroy操作入棧是有條件的：

• 如果create操作失敗，則直接返回，那么defer語(yǔ)句沒(méi)有執(zhí)行，導(dǎo)致destroy操作沒(méi)有入棧
• 如果create操作成功，則defer語(yǔ)句得到執(zhí)行，destroy操作完成入棧
  

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

當(dāng)err的引用或指針和destroy操作都需要入棧時(shí)，defer后面必須是一個(gè)閉包調(diào)用。我們知道，對(duì)于閉包的參數(shù)是值傳遞，而對(duì)于外部變量卻是引用傳遞。為了簡(jiǎn)單優(yōu)雅起見(jiàn)，我們將err不通過(guò)參數(shù)的指針傳遞，而通過(guò)外部變量的引用傳遞。

我們根據(jù)這個(gè)結(jié)論重構(gòu)一下代碼，如下所示：

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
}

本次重構(gòu)消除了代碼的壞味道，不由的感嘆一句：”升級(jí)了，我的哥！“

總結(jié)

本文通過(guò)巧用defer，有效且優(yōu)雅的處理了錯(cuò)誤，該技巧應(yīng)該被所有的Golang程序員掌握并大量使用。

好了，以上就是這篇文章的全部?jī)?nèi)容了，希望本文的內(nèi)容對(duì)大家的學(xué)習(xí)或者工作能帶來(lái)一定的幫助，如果有疑問(wèn)大家可以留言交流，謝謝大家對(duì)腳本之家的支持。