理解 Go defer

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

三月沙 wechat
扫描关注 wecatch 的公众号