★context | Package context defines the Context type, which carries deadlines, cancelation signals, and other request-scoped values across API boundaries and between processes.
一個神奇的包,在其他包源碼中到處都出現(xiàn)滔岳,又看不懂,抽一天學(xué)一下唆鸡,context包注釋翻譯為:包上下文定義了上下文類型,它跨API邊界和進(jìn)程之間傳遞截止日期灾锯、取消信號和其他請求范圍的值猾愿。
最常看到的是這個:Background() Context
若债,注釋如下:
“Background返回一個非空的上下文。它不可被Cancle拆融,無值蠢琳,也沒有deadline啊终。通常用于主函數(shù)、初始化(用于高等級傲须,在 main 或頂級請求處理中)和測試蓝牲,并作為傳入請求的頂級上下文√┓恚”
說實(shí)話我沒看懂例衍,康一下源碼:
var background = new(emptyCtx)
func Background() Context {
return background
}
我們發(fā)現(xiàn):單例,所有Background共用同一個根
而func WithValue(parent Context, key, val interface{}) Context
函數(shù)內(nèi)容為&valueCtx{parent, key, val}
所以background就相當(dāng)于是一棵繼承樹菇绵,子Context繼承父類的所有k-v對肄渗。
Context包中只有一個接口 Context
Context接口定義了一個context可以進(jìn)行的操作:
- 查詢超時時間
Deadline() (deadline time.Time, ok bool)
镇眷,Deadline返回應(yīng)該取消的工作時間咬最。當(dāng)沒有設(shè)置Deadline時,Deadline返回ok==false欠动。連續(xù)調(diào)用Deadline返回相同的結(jié)果永乌。 - Context是否結(jié)束
Done() <-chan struct{}
,通過select讀取此通道即可判斷是否完成 - Value(key interface{}) interface{}通過key查詢value具伍,會迭代父ctx
- Err() error當(dāng)Done()返回通道未關(guān)閉時返回nil翅雏,否則err非空比如超時:
context deadline exceeded
,被取消context canceled
人芽。
baidu一下吧望几,還是回到了親切的golang中文網(wǎng)社區(qū):理解 golang 中的 context(上下文) 包
Go 中的 context 包在與 API 和慢處理交互時可以派上用場,特別是在生產(chǎn)級的 Web 服務(wù)中萤厅。
理解基礎(chǔ)是Goroutine
和Channel
核心用法:context包提供的創(chuàng)建方法均是帶有第二返回值(CancelFunc類型)橄抹,它相當(dāng)于一個Hook,在子goroutine執(zhí)行過程中惕味,可以通過觸發(fā)Hook來達(dá)到控制子goroutine的目的(通常是取消楼誓,即讓其停下來)。
推薦
- context.Background 只應(yīng)用在最高等級名挥,作為所有派生 context 的根疟羹。
- context.TODO 應(yīng)用在不確定要使用什么的地方,或者當(dāng)前函數(shù)以后會更新以便使用 context禀倔。
- context 取消是建議性的(非強(qiáng)制)榄融,這些函數(shù)可能需要一些時間來清理和退出。
- context.Value 應(yīng)該很少使用救湖,它不應(yīng)該被用來傳遞可選參數(shù)剃袍。這使得 API 隱式的并且可以引起錯誤。取而代之的是捎谨,這些值應(yīng)該作為參數(shù)傳遞民效。
- 不要將 context 存儲在結(jié)構(gòu)中憔维,在函數(shù)中顯式傳遞它們,最好是作為第一個參數(shù)畏邢。
- 永遠(yuǎn)不要傳遞不存在的 context 业扒。相反,如果您不確定使用什么舒萎,使用一個 ToDo context程储。
- Context 結(jié)構(gòu)沒有取消方法,因?yàn)橹挥信缮?context 的函數(shù)才應(yīng)該取消 context臂寝。
探索
func main() {
var processTime, timeout time.Duration = 1, 2
resultChan := make(chan int)
ctx, _ := context.WithTimeout(context.Background(), timeout*time.Second)
go func(ctx context.Context, result chan int) {
time.Sleep(time.Second * processTime)
select {
case result <- 110:
fmt.Println("get result")
case <-ctx.Done():
fmt.Println("get result time out")
return
}
}(ctx, resultChan)
select {
case r := <-resultChan:
fmt.Println("get result from goroutine, value:", r)
case <-ctx.Done():
fmt.Println("timeout")
fmt.Println(ctx.Err())
}
}
當(dāng)processTime > timeout 時父子線程超時退出(通過select):
timeout
context deadline exceeded
反之當(dāng)processTime < timeout 時可以正常返回結(jié)果110:
get result
get result from goroutine, value: 110