go语言的defer语句

举报
风吹稻花香 发表于 2021/06/05 01:28:52 2021/06/05
【摘要】 go语言defer语句的用法 参考:https://www.jianshu.com/p/5b0b36f398a2 defer的语法 defer后面必须是函数调用语句,不能是其他语句,否则编译器会出错。 package main import "log" func foo(n int) int { defer n++ //defer log.Println("n=", ...

go语言defer语句的用法

参考:https://www.jianshu.com/p/5b0b36f398a2

defer的语法

defer后面必须是函数调用语句,不能是其他语句,否则编译器会出错。


  
  1. package main
  2. import "log"
  3. func foo(n int) int {
  4. defer n++
  5. //defer log.Println("n=", n)
  6. return n
  7. }

这个例子中defer后面使用的是n++指令,不是一个函数调用语句,编译器就报错:


  
  1. # command-line-arguments
  2. ./main.go:6: expression in defer must be function call
  3. ./main.go:6: syntax error: unexpected ++ at end of statement

defer的基本功能

defer后面的函数在defer语句所在的函数执行结束的时候会被调用;我们查看一下汇编吗,看看defer是在什么时候被执行的:
定义两个函数foo1和foo2,功能和代码都是一样,只是其中一个包含defer语句,另一个没有。


  
  1. func foo1(i int) int {
  2. i = 100
  3. i = 200
  4. return i
  5. }
  6. func foo2(i int) int {
  7. i = 100
  8. defer foo()
  9. i = 200
  10. return i
  11. }

这是foo1的汇编代码:


  
  1. func foo1(i int) int {
  2. 44d660: 48 c7 44 24 10 00 00 movq $0x0,0x10(%rsp)
  3. 44d667: 00 00
  4. i = 100
  5. 44d669: 48 c7 44 24 08 64 00 movq $0x64,0x8(%rsp)
  6. 44d670: 00 00
  7. i = 200
  8. 44d672: 48 c7 44 24 08 c8 00 movq $0xc8,0x8(%rsp)
  9. 44d679: 00 00
  10. return i
  11. 44d67b: 48 c7 44 24 10 c8 00 movq $0xc8,0x10(%rsp)
  12. 44d682: 00 00
  13. 44d684: c3 retq
  14. ...
  15. }

再看foo2的汇编代码:


  
  1. func foo2(i int) int {
  2. 44d690: 64 48 8b 0c 25 f8 ff mov %fs:0xfffffffffffffff8,%rcx
  3. 44d697: ff ff
  4. 44d699: 48 3b 61 10 cmp 0x10(%rcx),%rsp
  5. 44d69d: 76 70 jbe 44d70f <main.foo2+0x7f>
  6. 44d69f: 48 83 ec 18 sub $0x18,%rsp
  7. 44d6a3: 48 89 6c 24 10 mov %rbp,0x10(%rsp)
  8. 44d6a8: 48 8d 6c 24 10 lea 0x10(%rsp),%rbp
  9. 44d6ad: 48 c7 44 24 28 00 00 movq $0x0,0x28(%rsp)
  10. 44d6b4: 00 00
  11. i = 100
  12. 44d6b6: 48 c7 44 24 20 64 00 movq $0x64,0x20(%rsp)
  13. 44d6bd: 00 00
  14. defer foo()
  15. 44d6bf: c7 04 24 00 00 00 00 movl $0x0,(%rsp)
  16. 44d6c6: 48 8d 05 93 fb 01 00 lea 0x1fb93(%rip),%rax # 46d260 <go.func.*+0x41>
  17. 44d6cd: 48 89 44 24 08 mov %rax,0x8(%rsp)
  18. 44d6d2: e8 e9 3e fd ff callq 4215c0 <runtime.deferproc>
  19. 44d6d7: 85 c0 test %eax,%eax
  20. 44d6d9: 75 24 jne 44d6ff <main.foo2+0x6f>
  21. 44d6db: eb 00 jmp 44d6dd <main.foo2+0x4d>
  22. i = 200
  23. 44d6dd: 48 c7 44 24 20 c8 00 movq $0xc8,0x20(%rsp)
  24. 44d6e4: 00 00
  25. return i
  26. 44d6e6: 48 c7 44 24 28 c8 00 movq $0xc8,0x28(%rsp)
  27. 44d6ed: 00 00
  28. 44d6ef: 90 nop
  29. 44d6f0: e8 6b 48 fd ff callq 421f60 <runtime.deferreturn>
  30. 44d6f5: 48 8b 6c 24 10 mov 0x10(%rsp),%rbp
  31. 44d6fa: 48 83 c4 18 add $0x18,%rsp
  32. 44d6fe: c3 retq
  33. ...
  34. }

通过比较很容易看出foo2有两处需要注意,第一处是defer foo()语句的翻译,这个翻译我没有细看懂,我猜是准备foo的函数参数(如果有),然后保存这些参数值和foo的地址,注册到系统(runtime.deferproc);另一处是return指令的翻译,return指令的执行分三步,第一步拷贝return值到返回值内存地址,第二步会调用runtime.deferreturn去执行前面注册的defer函数,第三部再执行ret汇编指令。

有两个常见的defer语句应用场景是:

  • file对象打开后的自动关闭

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

在打开输入文件输出文件后,不管后面的代码流程如何影响,这两个文件能够被自动关闭。

  • mutex对象锁住后的自动释放

  
  1. func foo(...) {
  2. mu.Lock()
  3. defer mu.Unlock()
  4. // code logic
  5. }

确保mu锁能够在函数foo退出之后自动释放。

注意0:如何让defer函数在宿主函数的执行中间执行

我们注意到defer函数的执行是在defer指令所在函数的运行结束之后,那么如何才能在所在函数的中间就释放呢,比如前面例子,在foo入口锁住了lock,而如果foo后半段的代码运行时间比较长,而此时又不需要继续保持住锁,该怎么办呢?


  
  1. func foo() {
  2. mu.Lock();
  3. defer mu.Unlock();
  4. object, ok := map[key];
  5. if (!ok) {
  6. return
  7. }
  8. // time-consuming operating with object
  9. ...
  10. }

我们希望能在time-consuming operation 之前就释放锁,而不是等到整个foo返回。这有两个办法,一个是根据逻辑,把foo拆分两部分,前半部分需要锁,后半部分不需要锁;另一个办法是使用匿名函数:


  
  1. package main
  2. import "log"
  3. import "time"
  4. import "sync"
  5. var mu sync.Mutex
  6. func lock() {
  7. mu.Lock()
  8. log.Printf("lock")
  9. }
  10. func unlock() {
  11. mu.Unlock()
  12. log.Printf("unlock")
  13. }
  14. func foo() int {
  15. lock()
  16. func() {
  17. log.Printf("entry inner")
  18. defer unlock()
  19. log.Printf("exit inner")
  20. }()
  21. time.Sleep(1 * time.Second)
  22. log.Printf("return")
  23. return 0;
  24. }
  25. func main() {
  26. r := foo()
  27. log.Println("r=",r)
  28. }

运行结果:


  
  1. $ ./main
  2. 2017/09/30 22:18:58 lock
  3. 2017/09/30 22:18:58 inner
  4. 2017/09/30 22:18:58 unlock
  5. 2017/09/30 22:18:59 return
  6. 2017/09/30 22:18:59 r= 0

从日志我们可以看出mu锁在sleep语句之前已经被释放了,而不是需要等到foo函数结束的时候才释放。

注意1:多个defer的执行顺序

如果函数里面有多条defer指令,他们的执行顺序是反序,即后定义的defer先执行。


  
  1. package main
  2. import "log"
  3. import "time"
  4. func foo(n int) int {
  5. defer log.Println("1111")
  6. time.Sleep(1 * time.Second)
  7. defer log.Println("2222")
  8. time.Sleep(1 * time.Second)
  9. defer log.Println("3333")
  10. time.Sleep(1 * time.Second)
  11. return n
  12. }
  13. func main() {
  14. var i int = 100
  15. foo(i)
  16. }

运行结果如下,可以看出他们的调用顺序:


  
  1. 2017/09/30 19:22:03 3333
  2. 2017/09/30 19:22:03 2222
  3. 2017/09/30 19:22:03 1111

注意2:defer函数参数的计算时间点

defer函数的参数是在defer语句出现的位置做计算的,而不是在函数运行的时候做计算的,即所在函数结束的时候计算的。


  
  1. package main
  2. import "log"
  3. func foo(n int) int {
  4. log.Println("n1=", n)
  5. defer log.Println("n=", n)
  6. n += 100
  7. log.Println("n2=", n)
  8. return n
  9. }
  10. func main() {
  11. var i int = 100
  12. foo(i)
  13. }

其运行结果是:


  
  1. 2017/09/30 19:25:10 n1= 100
  2. 2017/09/30 19:25:10 n2= 200
  3. 2017/09/30 19:25:10 n= 100

可以看到defer函数的位置时n的值为100,尽管在函数foo结束的时候n的值已经是200了,但是defer语句本身所处的位置时刻,即foo函数入口时n为100,所以最终defer函数打印出来的n值为100。

注意3:如何在defer语句里面使用多条语句

前面我们提到defer后面只能是一条函数调用指令;而实际情况下经常会需要逻辑运行,会有分支,条件,而不是简单的一个log.Print指令;那怎么处理这种情况呢,我们可以把这些逻辑指令一起定义成一个函数,然后再调用这些函数就行了,命名函数或者匿名函数都可以,下面是一个匿名函数的例子:


  
  1. package main
  2. import "log"
  3. import _ "time"
  4. func foo(n int) int {
  5. log.Println("n1=", n)
  6. defer func() {
  7. n += 100
  8. log.Println("n=", n)
  9. }()
  10. n += 100
  11. log.Println("n2=", n)
  12. return n
  13. }
  14. func main() {
  15. var i int = 100
  16. foo(i)
  17. }

运行结果:


  
  1. 2017/09/30 19:30:58 n1= 100
  2. 2017/09/30 19:30:58 n2= 200
  3. 2017/09/30 19:30:58 n= 300

眼尖的同学会发现其中的问题;为什么n打印出来是300呢,不是明明说好defer函数的参数值在它出现时候计算,而不是在运行的时候计算的吗,n应该打印出200才对啊?
同学,仔细看一下原文:defer函数的参数在defer语句出现的位置计算,不是在defer函数运行的时刻计算;人家明明说的很清楚,defer函数的参数,请问这里n是参数吗,不是哎,这里引用的是宿主函数的局部变量,而不是参数;所以它拿到的是运行时刻的值。

这就引发出下一个注意事项。

注意4:defer函数会影响宿主函数的返回值


  
  1. package main
  2. import "log"
  3. func foo1(i *int) int {
  4. *i += 100
  5. defer func() { *i += 200 }()
  6. log.Printf("i=%d", *i)
  7. return *i
  8. }
  9. func foo2(i *int) (r int) {
  10. *i += 100
  11. defer func() { r += 200 }()
  12. log.Printf("i=%d", *i)
  13. return *i
  14. }
  15. func main() {
  16. var i, r int
  17. i,r = 0,0
  18. r = foo1(&i)
  19. log.Printf("i=%d, r=%d\n", i, r)
  20. i,r = 0,0
  21. r = foo2(&i)
  22. log.Printf("i=%d, r=%d\n", i, r)
  23. }

运行结果为:


  
  1. $ go build main.go && ./main
  2. 2017/09/30 20:01:00 i=100
  3. 2017/09/30 20:01:00 i=300, r=100
  4. 2017/09/30 20:01:00 i=100
  5. 2017/09/30 20:01:00 i=100, r=300

这个例子其实有一点拗口的。
foo1 return指令前(i==100, ret==0),return指令后(i==100, ret=100),然后调用defer函数后(i==300,r==100),defer函数增加了i;main函数收到(i==300, r==100)
foo2 return指令前(i==100, ret==0),return指令后(i==100, ret=100),然后调用defer函数后(i==100,r==300),defer函数增加了ret;main函数收到(i==100, r==300)

文章来源: blog.csdn.net,作者:网奇,版权归原作者所有,如需转载,请联系作者。

原文链接:blog.csdn.net/jacke121/article/details/88419028

【版权声明】本文为华为云社区用户转载文章,如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱: cloudbbs@huaweicloud.com
  • 点赞
  • 收藏
  • 关注作者

评论(0

0/1000
抱歉,系统识别当前为高风险访问,暂不支持该操作

全部回复

上滑加载中

设置昵称

在此一键设置昵称,即可参与社区互动!

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。