[Golang] defer keyword

golang defer keyword

Golang defer keyword https://golang.org/ref/spec#Keywords

defer 的作用和執行時機

go 的 defer 語句是用來延遲執行函數的,而且延遲發生在調用函數 return 之後,比如

1
2
3
4
func a() int {
  defer b()
  return 0
}

b 的執行事發生在 return 0 之后,注意 defer 的語法,關鍵字 defer 之後是函數的調用。

defer 的重要用途一:清理釋放資源

由於 defer 的延遲特性,defer 常用在函數調用结束之后清理相關的資源,比如

1
2
f, _ := os.Open(filename)
defer f.Close()

文件資源的釋放會在函數調用結束之後借助 defer 自動執行,不需要時刻記住哪裡得資源需要釋放,打開和釋放必須相對應。

用一個例子深刻詮釋一下 defer 帶來的便利和簡潔。

代碼的主要目的是打開一個文件,然後複製內容到另一個新的文件中,沒有 defer 時這樣寫:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
func CopyFile(dstName, srcName string) (written int64, err error) {
    src, err := os.Open(srcName)
    if err != nil {
        return
    }

    dst, err := os.Create(dstName)
    if err != nil { //1
        return
    }

    written, err = io.Copy(dst, src)
    dst.Close()
    src.Close()
    return
}

代碼在 #1 處返回之后,src 文件沒有執行關閉操作,可能會導致資源不能正確釋放,改用 defer 實現:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
func CopyFile(dstName, srcName string) (written int64, err error) {
    src, err := os.Open(srcName)
    if err != nil {
        return
    }
    defer src.Close()

    dst, err := os.Create(dstName)
    if err != nil {
        return
    }
    defer dst.Close()

    return io.Copy(dst, src)
}

src 和 dst 都能即時清理和釋放,無論 return 在什麼地方執行。

鑒於 defer 的這種作用,defer 常用來釋放數據庫連結,文件打開等釋放資源的操作。

defer 的重要用途二:執行 recover

被 defer 的函數在 return 之後執行,這是時機點正好可以補獲函數拋出的 panic,因而 defer 的另一個重要用途就是執行 recover。

recover 只有在 defer 中使用才更有意義,如果在其他地方使用,由於 program 已經調用结束而提前返回而無法有效捕捉錯誤。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
package main

import (
    "fmt"
)

func main() {
    defer func() {
        if ok := recover(); ok != nil {
            fmt.Println("recover")
        }
    }()

    panic("error")

}

記住 defer 要放在 panic 執行之前。

多個 defer 的執行順序

defer 的作用就是把關鍵字之后的函數執行壓入一個線中延遲執行,多個 defer 的執行順序是後進先出 LIFO :

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

輸出順序是 321。

這個特性可以對一個 array 實現逆序操作。

被 deferred 函數的參數在 defer 時確定

這是 defer 的特點,一個函數被 defer 时,它的參數在 defer 時進行計算確定,即使 defer 之後參數發生修改,對已經 defer 的函數沒有影響,什麼意思?看例子:

1
2
3
4
5
6
func a() {
    i := 0
    defer fmt.Println(i)
    i++
    return
}

a 執行輸出的是 0 而不是 1,因為 defer 時,i 的值是 0,此時被 defer 的函數參數已經進行執行並計算並確定了。

再看一個例子:

1
2
3
4
5
6
7
8
9
10
11
12
13
func calc(index string, a, b int) int {
    ret := a + b
    fmt.Println(index, a, b, ret)
    return ret
}

func main() {
    a := 1
    b := 2
    defer calc("1", a, calc("10", a, b))
    a = 0
    return
}

執行代碼輸出

1
2
10 1 2 3 
1 1 3 4

defer 函數的參數 第三個參數在 defer 時就已經計算完成並確定,第二個參數 a 也是如此,無論之後 a 變量是否修改都不影響。

被 defer 的函數可以讀取和修改帶名稱的返回值

1
2
3
4
func c() (i int) {
    defer func() { i++ }()
    return 1
}

被 defer 的函數是在 return 之后执行,可以修改带名称的返回值,上面的函数 c 返回的是 2。

参考资料

https://blog.golang.org/defer-panic-and-recover