深入了解golang中的defer关键字

文章目录

1. 1. defer会在函数返回之前执行
2. 2. defer可以放在函数中任意位置
3. 3. 可以同时设置多个defer函数，执行顺序为FILO
   1. 3.1. 多个defer函数是如何实现FILO？
4. 4. defer函数的传入参数在定义时就已经明确
5. 5. 可以修改函数中的命名返回值
6. 6. 多用于文件资源关闭，数据库等连接关闭
7. 7. 和recover一起处理panic
8. 8. 参考资料

golang中的defer关键字是用来声明一个延迟函数，一般称这个函数为defer函数，该函数会在defer语句所在的函数返回之前会执行。通过defer关键字，我们可以修改函数命名返回值，进行资源释放等操作，总的来说defer函数有如下特点和功能：

• 函数返回之前执行
• 可以放在函数中任意位置
• 可以同时设置多个defer函数，多个defer函数执行遵循FILO顺序
• defer函数的传入参数在定义时就已经明确
• 可以修改函数中的命名返回值
• 用于文件资源，锁资源、数据库连接等释放和关闭
• 和recover一起处理panic

本文将介绍defer上面的几个特性，如果想深入了解defer底层实现机制，可以阅读笔者写的《深入Go语言之旅 - 基础篇 - defer函数》。

defer会在函数返回之前执行

当程序执行一个函数时候，会将函数的上下文（输入参数，返回值，输出参数等信息）作为栈帧放在程序内存的栈中，当函数执行完成之后，设置返回值并返回，此函数才真正完成执行。

defer语句函数会在函数返回之前执行，下面程序将会依次输出B A：

func main() {
    defer fmt.Println("A")
    fmt.Println("B")
}

defer可以放在函数中任意位置

func main() {
    fmt.Println("A")
    defer fmt.Println("B")
    fmt.Println("C")
}

上面程序将会依次输出A C B

注意：

1. defer语句一定要在函数return语句之前，这样才能生效。下面程序将会只输出A

func main() {
    fmt.Println("A")
    return 
    fmt.Println("B")
}

2. 此在调用os.Exit时候，defer不会执行。下面程序只会输出B

func main() {
    defer fmt.Println("A")
    fmt.Println("B")
    os.Exit(0)
}

3. panic后的defer也不会执行。

func main() {
	defer fmt.Println("A")
	panic("it is panic") // panic后面的任何语句都不会执行
    defer fmt.Println("B")
}

上面程序将会输出类似下面的内容：

A
panic: it is panic

goroutine 1 [running]:
main.main()
	/tmp/sandbox3995833797/prog.go:9 +0x73

可以同时设置多个defer函数，执行顺序为FILO

可以设置多个defer函数，多个defer函数执行遵循FILO顺序，下面程序将依次输出B D C A

func main() {
    defer fmt.Println("A")
    fmt.Println("B")
    defer fmt.Println("C")
    fmt.Println("D")
}

我们来看下多个defer嵌套情况：

func main() {
    fmt.Println("A")
    defer func() {
       fmt.Println("B")
       defer fmt.Println("C")
       fmt.Println("D")
    }()
    
    defer fmt.Println("E")
    fmt.Println("F")
}

上面程序将依次输出： A F E B D C

多个defer函数是如何实现FILO？

defer语句内部实现形式是一个结构体:

# 位于/usr/lib/go/src/runtime/runtime2.go#784
type _defer struct {
    ...
	sp      uintptr // 函数栈指针,sp是stack pointor单词首字母缩写
	pc      uintptr //程序计数器, pc是program counter单词首字母缩写
	fn      *funcval // 函数地址，执行defer函数
	_panic  *_panic // 指向最近一次panic
	link    *_defer // 指向下一个_defer结构
	...
}

defer内部实现是一个链表，链表元素类型是_defer结构体，其中的link字段指向下一个_defer地址，当定义一个defer语句时候，系统内部会将defer函数转换成_defer结构体，并放在链表头部，最后执行时候，系统会从链表头部开始依次执行，这也就是多个defer的执行顺序是First In Last out的原因。

如果想详细了解defer实现机制，可以阅读笔者写的《深入Go语言之旅 - 基础篇 - defer函数》。

defer函数的传入参数在定义时就已经明确

1. defer函数的传入参数在定义时就已经明确，不论传入的参数是变量、表达式、函数语句，都会先计算出计算出实参结果，再随defer语句入栈

func main() {
  i := 1
  defer fmt.Println(i)
  i++
  return
}

上面程序输出1，而不是2

注意：

当defer类似闭包使用时候，访问的总是循环中最后一个值

func main() {
    for i:=0; i<5; i++ {
        defer func() {
           fmt.Println(i) 
        }()
    }
}

上面程序会连续输出5个5。至于为什么会这样，可以阅读《深入Go语言之旅 - 基础篇 - 闭包》。

解决办法可将值传入闭包函数中：

func main() {
    for i:=0; i<5; i++ {
        defer func(i int) {
           fmt.Println(i) 
        }(i)
    }
}

此时依次输出4 3 2 10

可以修改函数中的命名返回值

func main() {
    fmt.Println(test())
}

func test() (i int) {
    defer func() {
        i++
    }()
    return 100
}

上面程序会输出101，这是因为执行return 100时候，会将100复制返回变量i，之后执行defer函数时,i值会加1，此时i值变成101，最后函数test才会真正执行完成，所以最终打印输出为101

注意匿名返回值的情况, 下面程序输出的1，而不是101。

当执行test函数时候，系统会生成一个临时变量作为返回值变量，当执行到return ret时候，会将ret值复制给这个临时变量，此后defer函数对ret变量进行任何都和这个变量无关了，所以test函数最后返回值是1

func main() {
    fmt.Println(test())
}

func test() int {
    ret := 1                         
    defer func() {
        ret += 100           
    }()               
    return ret                  
} 

我们来看下返回值是匿名指针类型的情况：

func main() {
    fmt.Println(*(test()))
}

func test() *int {
    ret := 1                         
    defer func() {                        
        ret += 100           
    }()               
    return &ret                  
} 

上面程序将输出101。

多用于文件资源关闭，数据库等连接关闭

处理资源释放回收

通过defer我们可以简洁优雅处理资源回收问题，避免复杂的代码逻辑情况下，遗漏忽视相关的资源回收问题。

我们看下下面的代码，目的是复制文件内容到一个新文件

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 {
        return
    }

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

上面代码是有bug的。当dstName文件创建失败的时候，直接返回了，却没有对scrName文件资源进行关闭回收。

通过defer我们可以保证始终能够正确的关闭资源, 并且处理逻辑简单优雅。

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

和recover一起处理panic

recover用户捕获panic异常，panic用于抛出异常。recover需要放在defer语句中，否则无法捕获到一次

下面这个例子将会捕获到panic， 并且输出panic信息：

func main() {
    defer func() {
        if r := recover(); r != nil {
            fmt.Println(r)
        }
    }()
    panic("it is panic")
}

多个恐慌同时发生时候，只会捕获第一个恐慌：

func main() {
    defer func() {
        if r := recover(); r != nil {
            fmt.Println(r)
        }
    }()
    panic("it is panic")
    panic("it is another panic") // 此处的语句根本不会执行
}

参考资料

• Defer, Panic, and Recover
• 5 More Gotchas of Defer in Go
• 深入了解defer
• 《深入Go语言之旅 - 基础篇 - defer函数》