defer有什麼用呢

2023-05-14 21:00:43

1. 簡介

本文將從一個資源回收問題引入,引出defer關鍵字,並對其進行基本介紹。接著,將詳細介紹在資源回收、攔截和處理panic等相關場景下defer的使用。

進一步,介紹defer的執行順序,以及在註冊defer函數時,其引數的求值時機等相關特性。最後,重點講解defer的注意點,如在defer中函數中需要儘量避免引起panic,以及儘量避免在defer中使用閉包。

通過本文的閱讀,讀者將對Go語言中的defer有更深入的瞭解,並且能夠更加有效地使用這個關鍵字。

2. 問題引入

開發過程中,函數可能會開啟檔案、建立網路連線或者其他需要手動關閉的資源。當函數在處理過程中發生錯誤時,我們需要手動釋放這些資源。而如果有多處需要進行錯誤處理,手動釋放資源將是一個不小的心智負擔。同時,如果我們遺漏了資源的釋放,就會導致資源洩漏的問題。這種問題可能會導致系統效能下降、程式執行異常或者系統崩潰等。

以下是一個範例程式碼,其中函數開啟了一個檔案,讀取其中的內容並返回:

func ReadFile(filename string) ([]byte, error) {
    f, err := os.Open(filename)
    if err != nil {
        return nil, err
    }

    var content []byte
    _, err = f.Read(content)
    if err != nil {
        // 出現錯誤,此時呼叫Close釋放資源
        f.Close()
        return nil, err
    }
    // 正常處理結束,也需要呼叫Close釋放資源
    f.Close()
    return content, nil
}

在上面的程式碼中,我們使用了 os.Open 函數開啟一個檔案,並在函數返回之前使用 f.Close() 函數手動關閉檔案。同時,在出現錯誤時,我們也呼叫了f.Close()方法手動關閉了資源。

但是,我們設想一下,如果函數中不僅僅只開啟了一個檔案,而是同時開啟了檔案,網路連線,資料庫連線等資源,同時假設函數中需要錯誤處理的地方有5處,此時在錯誤處理中,來實現對資源的回收是非常大的心智負擔,而且一旦在某個錯誤處理中,忘記對資源的回收,那就代表著資源的洩漏,將會帶來一系列的問題。而且,如果在函數執行過程中發生了panic,此時將不會執行錯誤處理常式,會直接退出,函數開啟的檔案可能將不會被關閉。

綜上所述,我們這裡遇到的問題,在於函數處理過程中,會開啟一些資源,在函數退出時需要正確釋放資源。而釋放資源的方式,如果是在每一個錯誤處理處來對資源進行釋放,此時對於開發人員是一個不小的負擔;同時對於函數執行過程中發生panic的情況,也無法正常釋放資源。

那有什麼方式,能夠簡潔高效得釋放資源,無需在函數的多個錯誤處理處都執行一次資源的回收;同時也能夠處理panic可能導致資源洩漏的問題嗎? 其實還真有,Go中的defer關鍵字便非常適合在該場景中使用,下面我先來了解了解defer

3. defer對問題的解決

3.1 defer基本介紹

Go語言中,我們可以在函數體中使用 defer 關鍵字,來延遲函數或方法的執行。defer 延遲的函數或方法,會在當前函數執行結束時執行,無論函數是正常返回還是異常返回。也就是說,無論在函數中的哪個位置,只要使用了 defer 延遲執行了某個函數或方法,那麼這個函數或方法的執行都會被推遲到當前函數執行結束時再執行。

defer 語句的語法很簡單,它只需要在需要延遲執行的語句前加上 defer 關鍵字即可。defer 語句支援執行函數呼叫和方法呼叫,也可以在語句中使用函數引數和方法引數等。下面是一個 defer 語句的範例:

func demo() {
    defer fmt.Println("deferred")
    fmt.Println("hello")
}

在上面的範例中,我們使用了 defer 關鍵字,延遲了 fmt.Println("deferred") 的執行。當函數執行到 defer 語句時,這個語句並不會立即執行,而是被壓入一個棧中,等到函數執行結束時,再按照後進先出的順序依次執行這些被延遲的語句。在這個範例中,fmt.Println("hello") 會先被執行,然後是被延遲的 fmt.Println("deferred")。因此,輸出的結果是:

hello
deferred

3.2 defer對上述問題的解決

通過上述描述,我們瞭解defer函數能夠在函數或方法結束前延遲執行,而且無論函數是正常返回還是發生了panicdefer函數都會被執行。

這個特性非常適合用於資源的釋放,例如開啟的檔案、建立的網路連線、申請的記憶體等等。我們可以在函數或方法中使用defer來延遲釋放這些資源,從而避免因為忘記釋放而導致的問題,同時也能夠在發生異常時正確地釋放資源,讓程式碼更加健壯。下面我們使用defer對上面ReadFile函數進行改進,具體做法是在函數中使用defer關鍵字,將f.Close()操作延遲到函數結束時執行,程式碼如下:

func ReadFile(filename string) ([]byte, error) {
    f, err := os.Open(filename)
    if err != nil {
        return nil, err
    }
    // 獲取到一個資源,便註冊資源釋放函數
    defer f.Close()

    var content []byte
    _, err = f.Read(content)
    if err != nil {
        return nil, err
    }

    return content, nil
}

在之前的實現中,無論是正常結束還是出現錯誤,都需要呼叫f.Close()釋放資源。而現在只需要通過defer關鍵字註冊f.Close()函數即可,這樣的程式碼更簡潔,更容易維護,並且不會出現資源洩露的問題。

4.defer其他常見用途

defer語句除了用於在函數中釋放資源外,還有其他一些場景的用途,如攔截和處理panic,用於函數結束時列印紀錄檔等內容,下面將仔細對其進行說明。

4.1 攔截和處理panic

使用defer語句可以在程式出現panic時,及時進行資源回收和錯誤處理,避免程式因未處理的panic而直接崩潰。具體來說,可以通過在函數開頭使用defer語句註冊一個函數來捕獲panic。當發生panic時,程式會先執行defer語句註冊的函數,再進行panic的傳遞。

例如下面的程式碼中,函數中使用了defer來捕獲panic,並在發生panic時進行了錯誤處理和資源回收:

func someFunction() {
    defer func() {
        if r := recover(); r != nil {
            log.Println("Recovered from panic:", r)
            // 進行錯誤處理或者資源回收
        }
    }()
    // 函數程式碼
    // 可能會出現panic的程式碼
}

使用defer語句攔截和處理panic的好處是,在出現panic時,程式不會立即崩潰,而是可以通過defer語句進行錯誤處理和資源回收,保證程式的正常執行和資料的安全性。同時,這種方式也使得程式碼更加簡潔易讀,提高了程式碼的可維護性和可讀性。

4.2 實現函數執行時間的計算

在效能測試和優化過程中,我們通常需要知道某個函數或程式碼段的執行時間。這個時候可以使用defer記錄函數執行開始和結束的時間戳,然後計算兩者之差,即可得到函數的執行時間。如下:

func foo() {
    defer func() {
        fmt.Println("foo execution time:", time.Since(start))
    }()
    start := time.Now()
    // 函數執行邏輯
}

在上述程式碼中,我們使用time.Now()函數獲取當前時間戳,並將其儲存在start變數中。然後,在函數執行結束時,我們在defer語句中定義一個匿名函數,用來計算函數執行時間並輸出。在匿名函數中,我們呼叫time.Since(start)函數來獲取當前時間戳與start變數之間的時間差,並將其輸出。這樣可以幫助我們快速發現程式中耗時較長的程式碼段,進而進行優化。

總的來說,defer的場景用途還是比較廣泛的,可以在需要在函數執行結束後執行某些操作的場景下使用。

5. defer相關特性

5.1 defer的執行順序

當函數中有多個defer語句時,它們的執行順序是後進先出的,也就是說最後一個defer語句會最先執行,倒數第二個defer語句會在最後一個defer語句執行完後執行,以此類推。

例如,下面的程式碼中有三個defer語句:

func main() {
    defer fmt.Println("Third")
    defer fmt.Println("Second")
    defer fmt.Println("First")
    fmt.Println("Hello, defer!")
}

當函數返回時,它們按照後進先出的順序執行,所以輸出結果是:

Hello, World!
First
Second
Third

5.2 註冊defer函數時,其引數的求值時機

在註冊defer函數時,如果defer函數傳入的引數是變數,那麼變數的求值順序與普通函數呼叫一樣,是在函數引數傳遞之前進行的。例如,假設有如下程式碼:

func foo() {
    a := 1
    defer func(x int) {
        fmt.Println("x in defer:", x)
    }(a)
    a = 2
    fmt.Println("a before end of function:", a)
}

在這個例子中,變數a在defer函數中被作為引數傳遞,defer語句中的匿名函數會捕獲a的值,並在函數執行結束時列印該值。foo函數執行的結果如下:

a before end of function:2
x in defer:1

因此,可以看出在defer語句中傳入的變數是在註冊defer函數時進行求值的,而不是在函數執行結束時。

6. defer注意點

6.1 在defer中儘量避免執行可能引起panic的操作

在使用defer語句時,應當儘量避免在其中引起panic。因為當在defer語句中發生panic時,當前defer函數中後續的語句將無法得到執行,可能無法釋放已經申請的資源。此時,程式可能會因為資源洩漏等問題而崩潰或產生其他不可預期的後果。舉個例子,假設有如下程式碼:

func main() {
    defer func() {
       if r := recover(); r != nil {
          fmt.Println("Recovered in defer:", r)
       }
    }()
    fmt.Println("Start")
    defer fmt.Println("First Defer")
    defer func() {
       fmt.Println("Second Defer")
       panic("oops")
       fmt.Println("資源回收")
    }()
    fmt.Println("End")
}

這段程式碼中,我們在第三個defer語句中引發了panic,這時會觸發panic機制,第三個defer後續的程式碼將不會被執行,最後程式會輸出如下結果:

Start
End
Second Defer
First Defer
Recovered in defer: oops

可以看到,第三個defer語句中,由於panic導致了fmt.Println("資源回收")語句無法被執行。因此,在編寫程式碼時,我們應該儘量避免在defer中引起panic,如果不可避免有panic可能性的出現,此時應該對其進行處理,以確保程式的穩定性和可靠性。

6.2 儘量避免在defer中使用閉包

這裡先簡單介紹下閉包,在 Go 中,閉包是一個函數值(function value),它參照了函數體之外的變數。這個被參照的變數會被「捕獲」到閉包中,即使這個變數在閉包被建立之後發生了變化,閉包中也能存取到變化後的值。

defer中使用閉包可能會導致一些意想不到的問題。因為閉包參照了外部變數,而在defer函數執行時,這些變數的值可能已經被修改或者不再存在,從而導致出現不可預期的行為。

舉個例子,假設有一個defer函數使用了閉包來記錄當前時間戳和某個變數的值:

func foo() {
    i := 0
    defer func() {
        fmt.Printf("i: %d, timestamp: %d\n", i, time.Now().UnixNano())
    }()
    i++
}

在這個例子中,我們使用了閉包來捕獲了變數i和當前時間戳,並在defer函數中輸出它們的值。然而,由於defer函數的執行時機是在函數返回之後,我們無法確定變數i的值是否已經被修改了。因此,這個例子可能輸出的結果是不穩定的,無法得到預期的結果。

因此,儘量避免在defer中使用閉包,可以避免一些潛在的問題。如果必須要使用閉包,那麼要格外小心,確保在defer函數執行時閉包參照的變數值仍然是符合預期的。

7. 總結

在本文中,我們從一個資源回收的問題引出了defer,介紹了defer的基本用法以及在資源回收、攔截和處理panic等場景中的使用。我們還討論了defer的一些特性,如執行順序以及註冊defer函數時,引數的求值時機。最後,我們提醒了在使用defer時需要注意的一些問題,如儘量避免在defer中引起panic和避免在defer中使用閉包。

總的來說,defer是Go語言中一個非常方便和強大的語法特性,在某些場景下可以幫助我們更好地實現某些功能。但是,在使用defer時需要注意一些問題,避免引起不必要的麻煩。掌握defer的使用技巧,可以讓我們的程式碼更加健壯、清晰和易於維護。