Golang defer 关键字实现原理

1. Golang defer 关键字实现原理

1.1. 作用

defer 用于资源的释放, 会在函数返回之前进行调用。

如果有多个 defer 表达式, 调用顺序类似于栈, 越后面的 defer 表达式越先被调用。

defer 是在 return 之前执行的。这个在官方文档中是明确说明了的。要使用 defer 时不踩坑, 最重要的一点就是要明白, return xxx 这一条语句并不是一条原子指令!

函数返回的过程是这样的: 先给返回值赋值, 然后调用 defer 表达式, 最后才是返回到调用函数中。

defer 表达式可能会在设置函数返回值之后, 在返回到调用函数之前, 修改返回值, 使最终的函数返回值与你想象的不一致。

其实使用 defer 时, 用一个简单的转换规则改写一下, 就不会迷糊了。改写规则是将 return 语句拆成两句写, return xxx 会被改写成:

1. 返回值 = xxx
2. 调用 defer 函数
3. 空的 return

defer 确实是在 return 之前调用的。但表现形式上却可能不像。本质原因是 return xxx 语句并不是一条原子指令, defer 被插入到了赋值 与 ret 之间, 因此可能有机会改变最终的返回值。

// 先来看看几个例子。
// 例 1: 
func f1() (result int) {
	defer func() {
		result++
	}()
	return 0
}

// 例 2: 
func f2() (r int) {
	t := 5
	defer func() {
		t = t + 5
	}()
	return t
}

// 例 3: 
func f3() (r int) {
	defer func(r int) {
		r = r + 5
	}(r)
	return 1
}

func main() {
	a := f1()
	b := f2()
	c := f3()

	fmt.Printf("a = %d, b = %d, c = %d\n", a, b, c) // a = 1, b = 5, c = 1
}

1.2. defer 的实现

defer 关键字的实现跟 go 关键字很类似, 不同的是它调用的是 runtime.deferproc 而不是 runtime.newproc。在 defer 出现的地方, 插入了指令 call runtime.deferproc, 然后在函数返回之前的地方, 插入指令 call runtime.deferreturn。

普通的函数返回时, 汇编代码类似:

add xx SP
return

如果其中包含了 defer 语句, 则汇编代码是:

call runtime.deferreturn, 
add xx SP
return

goroutine 的控制结构中, 有一张表记录 defer, 调用 runtime.deferproc 时会将需要 defer 的表达式记录在表中, 而在调用 runtime.deferreturn 的时候, 则会依次从 defer 表中出栈并执行。