Golang關(guān)鍵字defer的用法詳解

更新時(shí)間：2023年05月05日 10:10:21 作者：本生來(lái)滑稽

defer是Go里面的一個(gè)關(guān)鍵字，用在方法或函數(shù)前面，作為方法或函數(shù)的延遲調(diào)用。這篇文章主要為大家介紹了defer的簡(jiǎn)單使用，需要的可以參考一下

1. defer的簡(jiǎn)單介紹與使用場(chǎng)景

defer是Go里面的一個(gè)關(guān)鍵字，用在方法或函數(shù)前面，作為方法或函數(shù)的延遲調(diào)用。它主要用于以下兩個(gè)場(chǎng)景：

優(yōu)雅釋放資源，比如一些網(wǎng)絡(luò)連接、數(shù)據(jù)庫(kù)連接以及文件資源的釋放。
與recover配合處理panic異常

場(chǎng)景一：復(fù)制文件

func CopyFile(dstFile, srcFile string) (wr int64, err error) { 
    src, err := os.Open(srcFile)     
    if err != nil {         
        return     
    }      
    dst, err := os.Create(dstFile)     
    if err != nil {         
        return    
    }      
    wr, err = io.Copy(dst, src)     
    dst.Close()     
    src.Close()     
    return 
}

這樣的代碼是有問(wèn)題的，當(dāng)?shù)?行執(zhí)行失敗的時(shí)候程序返回但沒(méi)有關(guān)閉前面成功打開(kāi)的src，資源沒(méi)有正確關(guān)閉，正確代碼如下：

（在成功打開(kāi)資源，沒(méi)返回err的情況下，都可以使用defer進(jìn)行優(yōu)雅的關(guān)閉資源）

func CopyFile(dstFile, srcFile string) (wr int64, err error) {
    src, err := os.Open(srcFile)
    if err != nil {
        return
    }
    defer src.Close()
    dst, err := os.Create(dstFile)
    if err != nil {
        return
    }
    defer dst.Close()
    wr, err = io.Copy(dst, src)  
    return err
}

場(chǎng)景二：處理異常panic

package main
import "fmt"
func main() {
   defer func() {
      if r := recover(); r != nil {
         fmt.Println(r)
      }
   }()
   a := 1
   b := 0
   fmt.Println("result:", a/b)   
}

運(yùn)行結(jié)果：

runtime error: integer divide by zero

程序沒(méi)有輸出result, 會(huì)拋出panic, 因?yàn)椴荒軐?duì)除數(shù)為0的數(shù)做除法，我們使用defer在程序發(fā)生panic的時(shí)候捕獲異常。go中是用panic拋異常，recover捕獲異常，異常會(huì)在下一篇go文章進(jìn)行分析。

通過(guò)這兩個(gè)使用場(chǎng)景我們也可以看到defer后面跟著的函數(shù)被調(diào)用的時(shí)間：

函數(shù)return的時(shí)候
當(dāng)前協(xié)程發(fā)生panic的時(shí)候

說(shuō)到延遲函數(shù)被調(diào)用的時(shí)機(jī)，這時(shí)順便說(shuō)一下多個(gè)延遲函數(shù)被調(diào)用時(shí)候的執(zhí)行順序問(wèn)題。官方對(duì)defer的解釋中寫到每次defer語(yǔ)句執(zhí)行的時(shí)候，會(huì)把函數(shù)“壓棧”，同時(shí)函數(shù)參數(shù)會(huì)被拷貝下來(lái)

這兩點(diǎn)很重要：

一是說(shuō)明當(dāng)一個(gè)函數(shù)中有多個(gè)defer的時(shí)候，執(zhí)行順序是LIFO先進(jìn)后出

二是說(shuō)明延遲函數(shù)的參數(shù)在defer語(yǔ)句出現(xiàn)時(shí)就已經(jīng)確定下來(lái)了

這段代碼是用來(lái)補(bǔ)充這二點(diǎn)的：看一下能否看懂執(zhí)行結(jié)果，能的話就直接跳到第二部分

func deferRun1() {
   var num = 1
   numptr := &num
   defer fmt.Println("defer run 1: \n", numptr, num, *numptr) // 0xc000022088 1 1
   defer func() {
      fmt.Println("defer run 2 : \n", numptr, num, *numptr) // 0xc000116028 2 2
   }()
   defer func(num int, numptr *int) {
      fmt.Println("defer run 3: \n", numptr, num, *numptr) //0xc000116028 1 2
   }(num, numptr)
   num = 2
   fmt.Println(numptr, num, *numptr) // 0xc000116028 2 2
   return
}

對(duì)于第一個(gè)defer，傳入的num和*numptr都是一個(gè)具體的值，所以程序return完之后結(jié)果會(huì)是1,1

對(duì)于第二個(gè)defer, 沒(méi)有傳入?yún)?shù)，結(jié)果會(huì)和最后的num和numptr地址對(duì)應(yīng)的內(nèi)容相同

對(duì)于第三個(gè)defer, 傳入的參數(shù)num是固定的值，而numptr是固定的地址，后面地址對(duì)應(yīng)的內(nèi)容被修改了，所以結(jié)果是1,2

同時(shí)，執(zhí)行順序會(huì)是第三個(gè)defer先執(zhí)行，然后是第二個(gè)...第一個(gè)

2. defer在return執(zhí)行的時(shí)機(jī)

第一小節(jié)上面說(shuō)了有一種情況延遲函數(shù)的執(zhí)行是在return的時(shí)候，再具體一點(diǎn)就是在return的時(shí)候，defer操作帶來(lái)了什么結(jié)果呢？

一句話解決這個(gè)問(wèn)題就是：函數(shù)return不是一個(gè)原子操作，需要經(jīng)過(guò)以下三步：

設(shè)置返回值
執(zhí)行defer
將結(jié)果返回

一定要牢記在心中，分析的時(shí)候也要嚴(yán)格按照這三步來(lái)，否則極容易掉坑！

下面把需要注意的情況列舉出來(lái)：

情況一：延遲函數(shù)參數(shù)早已固定下來(lái)（第一小節(jié)提到的重要的一點(diǎn)）

func main() {
   deferRun()
   deferRun2()
}
func deferRun() {
   var num = 1
   defer fmt.Printf("num is %d\n", num)
   num = 2
   return
}
func deferRun2() {
   var arr = [4]int{1, 2, 3, 4}
   defer printArr(&arr)
   arr[0] = 100
   return
}
func printArr(arr *[4]int) {
   for i := range arr {
      fmt.Println(arr[i])
   }
}

運(yùn)行結(jié)果為 num is 1 以及 100,2,3,4

道理很簡(jiǎn)單：延遲函數(shù)的參數(shù)在defer出現(xiàn)的時(shí)候就固定了，對(duì)于deferRun，傳的參數(shù)是num的值，而對(duì)于deferRun，傳的參數(shù)是arr的地址，地址不變，但是地址對(duì)應(yīng)的內(nèi)容被修改，所以輸出被改變。

情況二： 嚴(yán)格把握三步走，繞開(kāi) “匿名” 小坑，分析看注釋

func main() {
   res1 := deferRun()
   fmt.Println(res1)
   res2 := deferRun2()
   fmt.Println(res2)
   res3 := deferRun3()
   fmt.Println(res3)
   res4 := deferRun4()
   fmt.Println(res4)
}
// return 2 
func deferRun() (res int) {
   num := 1
   defer func() {
      res++
   }()
   return num   //1.返回值參數(shù)res賦值為num即1  //2.執(zhí)行defer語(yǔ)句，res++  //3. 結(jié)果返回2
}
// return 1
func deferRun2() int {   // 注意這里返回值是匿名的，我們可以在心里為這個(gè)匿名的返回值取名為res
   var num int
   defer func() {
      num++
   }()
   return 1  //1.匿名返回值參數(shù)(res)賦值為1  //2.執(zhí)行defer語(yǔ)句，num++,加了個(gè)寂寞 //3.結(jié)果返回1
}
//return 1
func deferRun3() int {
   num := 1
   defer func() {
      num++
   }()
   return num  //1.匿名(res)賦值為num即1  //2.執(zhí)行defer語(yǔ)句，num++,加了個(gè)寂寞，num為2，res依舊為1 
              //3.結(jié)果返回1
}
//return 2
func deferRun4() (res int) {
   num := 1
   defer func() {
      res++
   }()
   return num //1.返回值參數(shù)res賦值為1  //2.執(zhí)行defer語(yǔ)句，res++ //3.結(jié)果返回2
}