Go中defer使用場景及注意事項
1. 簡介
defer 會在當(dāng)前函數(shù)返回前執(zhí)行傳入的函數(shù),它會經(jīng)常被用于關(guān)閉文件描述符、關(guān)閉數(shù)據(jù)庫連接以及解鎖資源。
理解這句話主要在三個方面:
- 當(dāng)前函數(shù)
- 返回前執(zhí)行,當(dāng)然函數(shù)可能沒有返回值
- 傳入的函數(shù),即 defer 關(guān)鍵值后面跟的是一個函數(shù),包括普通函數(shù)如(fmt.Println), 也可以是匿名函數(shù) func()
1.1 使用場景
使用 defer 的最常見場景是在函數(shù)調(diào)用結(jié)束后完成一些收尾工作,例如在 defer 中回滾數(shù)據(jù)庫的事務(wù):
func createPost(db *gorm.DB) error {
tx := db.Begin()
// 用來回滾數(shù)據(jù)庫事件
defer tx.Rollback()
if err := tx.Create(&Post{Author: "Draveness"}).Error; err != nil {
return err
}
return tx.Commit().Error
}
在使用數(shù)據(jù)庫事務(wù)時,我們可以使用上面的代碼在創(chuàng)建事務(wù)后就立刻調(diào)用 Rollback 保證事務(wù)一定會回滾。哪怕事務(wù)真的執(zhí)行成功了,那么調(diào)用 tx.Commit() 之后再執(zhí)行 tx.Rollback() 也不會影響已經(jīng)提交的事務(wù)。
1.2 注意事項
使用defer時會遇到兩個常見問題,這里會介紹具體的場景并分析這兩個現(xiàn)象背后的設(shè)計原理:
defer 關(guān)鍵字的調(diào)用時機(jī)以及多次調(diào)用 defer 時執(zhí)行順序是如何確定的defer 關(guān)鍵字使用傳值的方式傳遞參數(shù)時會進(jìn)行預(yù)計算,導(dǎo)致不符合預(yù)期的結(jié)果
作用域
向 defer 關(guān)鍵字傳入的函數(shù)會在函數(shù)返回之前運行。
假設(shè)我們在 for 循環(huán)中多次調(diào)用 defer 關(guān)鍵字:
package main
import "fmt"
func main() {
for i := 0; i < 5; i++ {
// FILO, 先進(jìn)后出, 先出現(xiàn)的關(guān)鍵字defer會被壓入棧底,會最后取出執(zhí)行
defer fmt.Println(i)
}
}
#運行
$ go run main.go
4
3
2
1
0
運行上述代碼會倒序執(zhí)行傳入 defer 關(guān)鍵字的所有表達(dá)式,因為最后一次調(diào)用 defer 時傳入了 fmt.Println(4),所以這段代碼會優(yōu)先打印 4。我們可以通過下面這個簡單例子強(qiáng)化對 defer 執(zhí)行時機(jī)的理解:
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
從上述代碼的輸出我們會發(fā)現(xiàn),defer 傳入的函數(shù)不是在退出代碼塊的作用域時執(zhí)行的,它只會在當(dāng)前函數(shù)和方法返回之前被調(diào)用。
預(yù)計算參數(shù)
Go 語言中所有的函數(shù)調(diào)用都是傳值的.
雖然 defer 是關(guān)鍵字,但是也繼承了這個特性。假設(shè)我們想要計算 main 函數(shù)運行的時間,可能會寫出以下的代碼:
package main
import (
"fmt"
"time"
)
func main() {
startedAt := time.Now()
// 這里誤以為:startedAt是在time.Sleep之后才會將參數(shù)傳遞給defer所在語句的函數(shù)中
defer fmt.Println(time.Since(startedAt))
time.Sleep(time.Second)
}
# 輸出
$ go run main.go
0s
上述代碼的運行結(jié)果并不符合我們的預(yù)期,這個現(xiàn)象背后的原因是什么呢?
經(jīng)過分析(或者使用debug方式),我們會發(fā)現(xiàn):
調(diào)用 defer 關(guān)鍵字會立刻拷貝函數(shù)中引用的外部參數(shù)
所以 time.Since(startedAt) 的結(jié)果不是在 main 函數(shù)退出之前計算的,而是在 defer 關(guān)鍵字調(diào)用時計算的,最終導(dǎo)致上述代碼輸出 0s。
想要解決這個問題的方法非常簡單,我們只需要向 defer 關(guān)鍵字傳入匿名函數(shù):
package main
import (
"fmt"
"time"
)
func main() {
startedAt := time.Now()
// 使用匿名函數(shù),傳遞的是函數(shù)的指針
defer func() {
fmt.Println(time.Since(startedAt))
}()
time.Sleep(time.Second)
}
#輸出
$ go run main.go
$ 1.0056135s
2. defer 數(shù)據(jù)結(jié)構(gòu)
defer 關(guān)鍵字在 Go 語言源代碼中對應(yīng)的數(shù)據(jù)結(jié)構(gòu):
type _defer struct {
siz int32
startedbool
openDefer bool
sp uintptr
pc uintptr
fn *funcval
_panic *_panic
link*_defer
}
簡單介紹一下 runtime._defer 結(jié)構(gòu)體中的幾個字段:
- siz 是參數(shù)和結(jié)果的內(nèi)存大??;
- sp 和 pc 分別代表棧指針和調(diào)用方的程序計數(shù)器;
- fn 是 defer 關(guān)鍵字中傳入的函數(shù);
- _panic 是觸發(fā)延遲調(diào)用的結(jié)構(gòu)體,可能為空;
- openDefer 表示當(dāng)前 defer 是否經(jīng)過開放編碼的優(yōu)化;
除了上述的這些字段之外,runtime._defer 中還包含一些垃圾回收機(jī)制使用的字段, 這里不做過多的說明
3. 執(zhí)行機(jī)制
堆分配、棧分配和開放編碼是處理 defer 關(guān)鍵字的三種方法。
- 早期的 Go 語言會在堆上分配, 不過性能較差
- Go 語言在 1.13 中引入棧上分配的結(jié)構(gòu)體,減少了 30% 的額外開銷
- 在1.14 中引入了基于開放編碼的 defer,使得該關(guān)鍵字的額外開銷可以忽略不計
堆上分配暫時不做過多的說明
3.1 棧上分配
在 1.13 中對 defer 關(guān)鍵字進(jìn)行了優(yōu)化,當(dāng)該關(guān)鍵字在函數(shù)體中最多執(zhí)行一次時,會將結(jié)構(gòu)體分配到棧上并調(diào)用。
除了分配位置的不同,棧上分配和堆上分配的 runtime._defer 并沒有本質(zhì)的不同,而該方法可以適用于絕大多數(shù)的場景,與堆上分配的 runtime._defer 相比,該方法可以將 defer 關(guān)鍵字的額外開銷降低 ~30%。
3.2 開放編碼
在 1.14 中通過開放編碼(Open Coded)實現(xiàn) defer 關(guān)鍵字,該設(shè)計使用代碼內(nèi)聯(lián)優(yōu)化 defer 關(guān)鍵的額外開銷并引入函數(shù)數(shù)據(jù) funcdata 管理 panic 的調(diào)用3,該優(yōu)化可以將 defer 的調(diào)用開銷從 1.13 版本的~35ns 降低至 ~6ns 左右:
然而開放編碼作為一種優(yōu)化 defer 關(guān)鍵字的方法,它不是在所有的場景下都會開啟的,開放編碼只會在滿足以下的條件時啟用:
- 函數(shù)的 defer 數(shù)量小于或等于8個;
- 函數(shù)的 defer 關(guān)鍵字不能再循環(huán)中執(zhí)行
- 函數(shù)的 return 語句 與 defer 語句個數(shù)的成績小于或者等于15個。
4. 參考
https://draveness.me/golang/docs/part2-foundation/ch05-keyword/golang-defer/
到此這篇關(guān)于Go中defer使用注意事項的文章就介紹到這了,更多相關(guān)Go中defer使用內(nèi)容請搜索本站以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持本站!
版權(quán)聲明:本站文章來源標(biāo)注為YINGSOO的內(nèi)容版權(quán)均為本站所有,歡迎引用、轉(zhuǎn)載,請保持原文完整并注明來源及原文鏈接。禁止復(fù)制或仿造本網(wǎng)站,禁止在非maisonbaluchon.cn所屬的服務(wù)器上建立鏡像,否則將依法追究法律責(zé)任。本站部分內(nèi)容來源于網(wǎng)友推薦、互聯(lián)網(wǎng)收集整理而來,僅供學(xué)習(xí)參考,不代表本站立場,如有內(nèi)容涉嫌侵權(quán),請聯(lián)系alex-e#qq.com處理。
關(guān)注官方微信