Go中defer使用场景及注意事项

目录
  • 1. 简介
    • 1.1 使用场景
    • 1.2 注意事项
  • 2. defer 数据结构
  • 3. 执行机制
    • 3.1 栈上分配
    • 3.2 开放编码
  • 4. 参考

1. 简介

defer 会在当前函数返回前执行传入的函数,它会经常被用于关闭文件描述符、关闭数据库连接以及解锁资源。

理解这句话主要在三个方面:

  • 当前函数
  • 返回前执行,当然函数可能没有返回值
  • 传入的函数,即 defer 关键值后面跟的是一个函数,包括普通函数如(fmt.Println), 也可以是匿名函数 func()

1.1 使用场景

使用 defer 的最常见场景是在函数调用结束后完成一些收尾工作,例如在 defer 中回滚数据库的事务:

func createPost(db *gorm.DB) error {
    tx := db.Begin()
    // 用来回滚数据库事件
    defer tx.Rollback()

    if err := tx.Create(&Post{Author: "Draveness"}).Error; err != nil {
        return err
    }

    return tx.Commit().Error
}

在使用数据库事务时,我们可以使用上面的代码在创建事务后就立刻调用 Rollback 保证事务一定会回滚。哪怕事务真的执行成功了,那么调用 tx.Commit() 之后再执行 tx.Rollback() 也不会影响已经提交的事务。

1.2 注意事项

使用defer时会遇到两个常见问题,这里会介绍具体的场景并分析这两个现象背后的设计原理:

defer 关键字的调用时机以及多次调用 defer 时执行顺序是如何确定的defer 关键字使用传值的方式传递参数时会进行预计算,导致不符合预期的结果

作用域

向 defer 关键字传入的函数会在函数返回之前运行。

假设我们在 for 循环中多次调用 defer 关键字:

package main

import "fmt"

func main() {
	for i := 0; i < 5; i++ {
	    // FILO, 先进后出, 先出现的关键字defer会被压入栈底,会最后取出执行
		defer fmt.Println(i)
	}
}
 

#运行

$ go run main.go

4

3

2

1

0

运行上述代码会倒序执行传入 defer 关键字的所有表达式,因为最后一次调用 defer 时传入了 fmt.Println(4),所以这段代码会优先打印 4。我们可以通过下面这个简单例子强化对 defer 执行时机的理解:

package main

import "fmt"

func main() {
    // 代码块
	{
		defer fmt.Println("defer runs")
		fmt.Println("block ends")
	}

	fmt.Println("main ends")
}

# 输出

$ go run main.go

block ends

main ends

defer runs

从上述代码的输出我们会发现,defer 传入的函数不是在退出代码块的作用域时执行的,它只会在当前函数和方法返回之前被调用。

预计算参数

Go 语言中所有的函数调用都是传值的.

虽然 defer 是关键字,但是也继承了这个特性。假设我们想要计算 main 函数运行的时间,可能会写出以下的代码:

package main

import (
	"fmt"
	"time"
)

func main() {
	startedAt := time.Now()
	// 这里误以为:startedAt是在time.Sleep之后才会将参数传递给defer所在语句的函数中
	defer fmt.Println(time.Since(startedAt))

	time.Sleep(time.Second)
}

# 输出

$ go run main.go

0s

上述代码的运行结果并不符合我们的预期,这个现象背后的原因是什么呢?

经过分析(或者使用debug方式),我们会发现:

调用 defer 关键字会立刻拷贝函数中引用的外部参数

所以 time.Since(startedAt) 的结果不是在 main 函数退出之前计算的,而是在 defer 关键字调用时计算的,最终导致上述代码输出 0s。

想要解决这个问题的方法非常简单,我们只需要向 defer 关键字传入匿名函数:

package main

import (
	"fmt"
	"time"
)

func main() {
	startedAt := time.Now()
    // 使用匿名函数,传递的是函数的指针
	defer func() {
		fmt.Println(time.Since(startedAt))
	}()

	time.Sleep(time.Second)
}

#输出

$ go run main.go

$ 1.0056135s

2. defer 数据结构

defer 关键字在 Go 语言源代码中对应的数据结构:

type _defer struct {
	siz       int32
	started   bool
	openDefer bool
	sp        uintptr
	pc        uintptr
	fn        *funcval
	_panic    *_panic
	link      *_defer
}

简单介绍一下 runtime._defer 结构体中的几个字段:

  • siz 是参数和结果的内存大小;
  • sp 和 pc 分别代表栈指针和调用方的程序计数器;
  • fn 是 defer 关键字中传入的函数;
  • _panic 是触发延迟调用的结构体,可能为空;
  • openDefer 表示当前 defer 是否经过开放编码的优化;

除了上述的这些字段之外,runtime._defer 中还包含一些垃圾回收机制使用的字段, 这里不做过多的说明

3. 执行机制

堆分配、栈分配和开放编码是处理 defer 关键字的三种方法。

  • 早期的 Go 语言会在堆上分配, 不过性能较差
  • Go 语言在 1.13 中引入栈上分配的结构体,减少了 30% 的额外开销
  • 在1.14 中引入了基于开放编码的 defer,使得该关键字的额外开销可以忽略不计

堆上分配暂时不做过多的说明

3.1 栈上分配

在 1.13 中对 defer 关键字进行了优化,当该关键字在函数体中最多执行一次时,会将结构体分配到栈上并调用。

除了分配位置的不同,栈上分配和堆上分配的 runtime._defer 并没有本质的不同,而该方法可以适用于绝大多数的场景,与堆上分配的 runtime._defer 相比,该方法可以将 defer 关键字的额外开销降低 ~30%。

3.2 开放编码

在 1.14 中通过开放编码(Open Coded)实现 defer 关键字,该设计使用代码内联优化 defer 关键的额外开销并引入函数数据 funcdata 管理 panic 的调用3,该优化可以将 defer 的调用开销从 1.13 版本的~35ns 降低至 ~6ns 左右:

然而开放编码作为一种优化 defer 关键字的方法,它不是在所有的场景下都会开启的,开放编码只会在满足以下的条件时启用:

  • 函数的 defer 数量小于或等于8个;
  • 函数的 defer 关键字不能再循环中执行
  • 函数的 return 语句 与 defer 语句个数的成绩小于或者等于15个。

4. 参考

https://draveness.me/golang/docs/part2-foundation/ch05-keyword/golang-defer/

到此这篇关于Go中defer使用注意事项的文章就介绍到这了,更多相关Go中defer使用内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们!

(0)

相关推荐

  • golang中defer的使用规则详解

    前言 在golang当中,defer代码块会在函数调用链表中增加一个函数调用.这个函数调用不是普通的函数调用,而是会在函数正常返回,也就是return之后添加一个函数调用.因此,defer通常用来释放函数内部变量. 为了更好的学习defer的行为,我们首先来看下面一段代码: func CopyFile(dstName, srcName string) (written int64, err error) { src, err := os.Open(srcName) if err != nil {

  • Go使用defer函数要注意的几个点

    概述 defer 函数大家肯定都用过,它在声明时不会立刻去执行,而是在函数 return 后去执行的. 它的主要应用场景有异常处理.记录日志.清理数据.释放资源 等等. 这篇文章不是分享 defer 的应用场景,而是分享使用 defer 需要注意的点. 咱们先从一道题开始,一起来感受下 ... func calc(index string, a, b int) int { ret := a + b fmt.Println(index, a, b, ret) return ret } func m

  • 总结Go语言中defer的使用和注意要点

    前言 defer是golang语言中的关键字,用于资源的释放,会在函数返回之前进行调用. 一般采用如下模式: f,err := os.Open(filename) if err != nil { panic(err) } defer f.Close() 如果有多个defer表达式,调用顺序类似于栈,越后面的defer表达式越先被调用. 延时调用函数的语法如下: defer func_name(param-list) 当一个函数调用前有关键字 defer 时, 那么这个函数的执行会推迟到包含这个

  • 聊聊golang的defer的使用

    序 本文主要研究一下golang的defer defer return先赋值(对于命名返回值),然后执行defer,最后函数返回 defer函数调用的执行顺序与它们分别所属的defer语句的执行顺序相反 defer后面的表达式可以是func或者是method的调用,如果defer的函数为nil,则会panic 实例 实例1 // f returns 42 func f() (result int) { defer func() { // result is accessed after it w

  • Golang学习笔记之延迟函数(defer)的使用小结

    golang的defer优雅又简洁, 是golang的亮点之一.defer在声明时不会立即执行,而是在函数return后,再按照先进后出的原则依次执行每个defer,一般用于释放资源.清理数据.记录日志.异常处理等. 关键字defer于注册延迟调用.这些调用直到 ret 前才被执行,通常用于释放资源或错误处理. 一.当defer被声明时,其参数就会被实时解析 func a() { i := 0 defer fmt.Println(i) //输出0,因为i此时就是0 i++ defer fmt.P

  • Go中defer使用场景及注意事项

    目录 1. 简介 1.1 使用场景 1.2 注意事项 2. defer 数据结构 3. 执行机制 3.1 栈上分配 3.2 开放编码 4. 参考 1. 简介 defer 会在当前函数返回前执行传入的函数,它会经常被用于关闭文件描述符.关闭数据库连接以及解锁资源. 理解这句话主要在三个方面: 当前函数 返回前执行,当然函数可能没有返回值 传入的函数,即 defer 关键值后面跟的是一个函数,包括普通函数如(fmt.Println), 也可以是匿名函数 func() 1.1 使用场景 使用 defe

  • swift中defer的实际应用小结

    看看苹果官方的介绍 用 defer 语句在即将离开当前代码块时执行一系列语句.该语句让你能执行一些必要的清理工作,不管是以何种方式离开当前代码块的--无论是由于抛出错误而离开,或是由于诸如 return.break 的语句.例如,你可以用 defer 语句来确保文件描述符得以关闭,以及手动分配的内存得以释放. defer 语句将代码的执行延迟到当前的作用域退出之前.该语句由 defer 关键字和要被延迟执行的语句组成.延迟执行的语句不能包含任何控制转移语句,例如 break.return 语句,

  • 浅谈Java中GuavaCache返回Null的注意事项

    Guava在实际的Java后端项目中应用的场景还是比较多的,比如限流,缓存,容器操作之类的,有挺多实用的工具类,这里记录一下,在使用GuavaCache,返回null的一个问题 I. 常见使用姿势 @Test public void testGuava() { LoadingCache<String, String> cache = CacheBuilder.newBuilder().build(new CacheLoader<String, String>() { @Overri

  • golang中defer的关键特性示例详解

    前言 大家都知道golang的defer关键字,它可以在函数返回前执行一些操作,最常用的就是打开一个资源(例如一个文件.数据库连接等)时就用defer延迟关闭改资源,以免引起内存泄漏.本文主要给大家介绍了关于golang中defer的关键特性,分享出来供大家参考学习,下面话不多说,来一起看看详细的介绍: 一.defer 的作用和执行时机 go 的 defer 语句是用来延迟执行函数的,而且延迟发生在调用函数 return 之后,比如 func a() int { defer b() return

  • php中array_unshift()修改数组key注意事项分析

    本文实例分析了php中array_unshift()修改数组key注意事项.分享给大家供大家参考,具体如下: 众所周知,array_unshift()用来在数组的开头添加元素,但今天突然发现如果数组的键值是数字类型的(或能转成数字类型的),array_unshift()会修改所有键为数字的元素的Key,真是坑啊 实例: $a=array(111=>"dddddddddddd","112"=>array("one"=>"

  • ThinkPHP中处理表单中的注意事项

    本文实例讲述了ThinkPHP中处理表单中的注意事项.分享给大家供大家参考.具体分析如下: ThinkPHP中在表单提交数据中,有以下问题需要加以注意: 1.直接通过url访问模块中的某一个方法,这样很不安全.可以使用下面来限制 复制代码 代码如下: $this->isPost();//判断是不是以post方式访问方法. 在3.1.3中使用常量 IS_POST 来判断. 2.处理错误方法: _404('提示错误','跳转[注意在开启调试模式下不会跳转]',''); 方法 halt(); 查询:

  • 关于Javascript中defer和async的区别总结

    首先来看看这三句话: <script src="script.js"></script> 没有 defer 或 async,浏览器会立即加载并执行指定的脚本,"立即"指的是在渲染该 script 标签之下的文档元素之前,也就是说不等待后续载入的文档元素,读到就加载并执行. <script async src="script.js"></script> 有 async,加载和渲染后续文档元素的过程将和

  • 浅谈c语言中转义字符的用法及注意事项

    c语言中的转义字符: \a 响铃符 \b 退格 \f 换页符 \n 换行符 \r 回车符(回到该行的首位置) \v 纵向制表符 \\ 反斜杠 \? 问号(?经vs10测试可以直接打印) \"(\') 双引号(单引号) \ooo 八进制数(ooo表示一个用8进制数表示出来的对应ANSII代码对应出字符,用此方法可以表示出所有ASCII字符.不过测试发现打不出%号,存疑!) \xhh 十六进制数(功能同八进制数,用hh表示一个十六进制数,如\x20表示空格) 注:使用转义字符的退格符,换行符,回车符

  • 基于开发中使用UEditor编辑器的注意事项详解

    最近在一个刚结束的一个项目中使用到了UEditor编辑器,下面总结一下遇到的问题以及使用时需要注意的地方: 1. 使用UEditor插件需要先对其进行路径配置: 在ueditor.config.js文件中 配置 ueditor.config.js文件相对Ueditor文件夹的位置: 2. UEditor的图片上传功能: 此功能需将插件部署至服务器时才可生效: 3. UEditor报错"Cannot set property 'innerHTML' of undefined": 错误的原

  • java中Lambda常用场景代码实例

    本文实例为大家分享了java中Lambda常用场景的具体代码,供大家参考,具体内容如下 public class test18 { /** * lambda表达式的常用场景 */ @Test public void test() { List<String> list_one = new ArrayList<>(); list_one.add("NIKE"); list_one.add("Addidas"); /** * 用在匿名内部类里简写

随机推荐