Go语言中关键字defer允许我们推迟到函数返回之前(或任意位置执行return语句之后)一刻才执行某个语句或函数(为什么要在返回之后才执行这些语句?因为return语句同样可以包含一些操作,而不是单纯地返回某个值)。
关键字defer的用法类似于面向对象编程语言Java和C#的finally语句块,它一般用于释放某些已分配的资源。典型的例子就是对一个互斥解锁,或者关闭一个文件。
多个延迟执行语句的处理顺序
当有多个defer行为被注册时,它们会以逆序执行(类似栈,即后进先出),下面的代码是将一系列的数值打印语句按顺序延迟处理,如下所示:
packagemainimport("fmt")funcmain(){fmt.Println("deferbegin")//将defer放入延迟调用栈deferfmt.Println(1)deferfmt.Println(2)//最后一个放入,位于栈顶,最先调用deferfmt.Println(3)fmt.Println("deferend")}
代码输出如下:
deferbegin
deferend
3
2
1
结果分析如下:
代码的延迟顺序与最终的执行顺序是反向的。
延迟调用是在defer所在函数结束时进行,函数结束可以是正常返回时,也可以是发生宕机时。
使用延迟执行语句在函数退出时释放资源
处理业务或逻辑中涉及成对的操作是一件比较烦琐的事情,比如打开和关闭文件、接收请求和回复请求、加锁和解锁等。在这些操作中,最容易忽略的就是在每个函数退出处正确地释放和关闭资源。
defer语句正好是在函数退出时执行的语句,所以使用defer能非常方便地处理资源释放问题。
1)使用延迟并发解锁
在下面的例子中会在函数中并发使用map,为防止竞态问题,使用sync.Mutex进行加锁,参见下面代码:
var(//一个演示用的映射valueByKey=make(map[string]int)//保证使用映射时的并发安全的互斥锁valueByKeyGuardsync.Mutex)//根据键读取值funcreadValue(keystring)int{//对共享资源加锁valueByKeyGuard.Lock()//取值v:=valueByKey[key]//对共享资源解锁valueByKeyGuard.Unlock()//返回值returnv}
代码说明如下:
第3行,实例化一个map,键是string类型,值为int。
第5行,map默认不是并发安全的,准备一个sync.Mutex互斥量保护map的访问。
第9行,readValue()函数给定一个键,从map中获得值后返回,该函数会在并发环境中使用,需要保证并发安全。
第11行,使用互斥量加锁。
第13行,从map中获取值。
第15行,使用互斥量解锁。
第17行,返回获取到的map值。
使用defer语句对上面的语句进行简化,参考下面的代码。
funcreadValue(keystring)int{valueByKeyGuard.Lock()//defer后面的语句不会马上调用,而是延迟到函数结束时调用defervalueByKeyGuard.Unlock()returnvalueByKey[key]}
加粗部分为对比前面代码而修改和添加的代码,代码说明如下:
第6行在互斥量加锁后,使用defer语句添加解锁,该语句不会马上执行,而是等readValue()返回时才会被执行。
第8行,从map查询值并返回的过程中,与不使用互斥量的写法一样,对比上面的代码,这种写法更简单。
2)使用延迟释放文件句柄
文件的操作需要经过打开文件、获取和操作文件资源、关闭资源几个过程,如果在操作完毕后不关闭文件资源,进程将一直无法释放文件资源。在下面的例子中将实现根据文件名获取文件大小的函数,函数中需要打开文件、获取文件大小和关闭文件等操作。由于每一步系统操作都需要进行错误处理,而每一步处理都会造成一次可能的退出,因此就需要在退出时释放资源,而我们需要密切关注在函数退出处正确地释放文件资源。参考下面的代码:
//根据文件名查询其大小funcfileSize(filenamestring)int64{//根据文件名打开文件,返回文件句柄和错误f,err:=os.Open(filename)//如果打开时发生错误,返回文件大小为0iferr!=nil{return0}//取文件状态信息info,err:=f.Stat()//如果获取信息时发生错误,关闭文件并返回文件大小为0iferr!=nil{f.Close()return0}//取文件大小size:=info.Size()//关闭文件f.Close()//返回文件大小returnsize}
代码说明如下:
第2行,定义获取文件大小的函数,返回值是64位的文件大小值。
第5行,使用os包提供的函数Open(),根据给定的文件名打开一个文件,并返回操作文件用的句柄和操作错误。
第8行,如果打开的过程中发生错误,如文件没找到、文件被占用等,将返回文件大小为0。
第13行,此时文件句柄f可以正常使用,使用f的方法Stat()来获取文件的信息,获取信息时,可能也会发生错误。
第16~19行对错误进行处理,此时文件是正常打开的,为了释放资源,必须要调用f的Close()方法来关闭文件,否则会发生资源泄露。
第22行,获取文件大小。
第25行,关闭文件、释放资源。
第28行,返回获取到的文件大小。
在上面的例子中加粗部分是对文件的关闭操作。下面使用defer对代码进行简化,代码如下:
funcfileSize(filenamestring)int64{f,err:=os.Open(filename)iferr!=nil{return0}//延迟调用Close,此时Close不会被调用deferf.Close()info,err:=f.Stat()iferr!=nil{//defer机制触发,调用Close关闭文件return0}size:=info.Size()//defer机制触发,调用Close关闭文件returnsize}
代码中加粗部分为对比前面代码而修改的部分,代码说明如下:
第10行,在文件正常打开后,使用defer,将f.Close()延迟调用。注意,不能将这一句代码放在第4行空行处,一旦文件打开错误,f将为空,在延迟语句触发时,将触发宕机错误。
第16行和第22行,defer后的语句(f.Close())将会在函数返回前被调用,自动释放资源。