context.Context類型
context.Context類型(以下簡稱Context類型)是在Go 1.7發布時才被加入到標準庫的。而后,標準庫中的很多其他代碼包都為了支持它而進行了擴展,包括:os/exec包、net包、database/sql包,以及runtime/pprof包和runtime/trace包,等等。
Context類型之所以受到了標準庫中眾多代碼包的積極支持,主要是因為它是一種非常通用的同步工具。它的值不但可以被任意地擴散,而且還可以被用來傳遞額外的信息和信號。
更具體地說,Context類型可以提供一類代表上下文的值。此類值是并發安全的,也就是說它可以被傳播給多個goroutine。
由于Context類型實際上是一個接口類型,而context包中實現該接口的所有私有類型,都是基于某個數據類型的指針類型,所以,如此傳播并不會影響該類型值的功能和安全。
context 的作用
1.通過context,我們可以方便地對同一個請求所產生地goroutine進行約束管理,可以設定超時、deadline,甚至是取消這個請求相關的所有goroutine。形象地說,假如一個請求過來,需要A去做事情,而A讓B去做一些事情,B讓C去做一些事情,A、B、C是三個有關聯的goroutine,那么問題來了:假如在A、B、C還在處理事情的時候請求被取消了,那么該如何優雅地同時關閉goroutine A、B、C呢?這個時候就輪到context包上場了。
2.在golang中的創建一個新的線程并不會返回像c語言類似的pid所有我們不能從外部殺死某個線程,所有我就得讓它自己結束之前我們用channel+select的方式,來解決這個問題但是有些場景實現起來比較麻煩,例如由一個請求衍生出多個線程并且之間需要滿足一定的約束關系,以實現一些諸如:
有效期,中止線程樹,傳遞請求全局變量之類的功能
context 接口定義
type Context interface {
Deadline() (deadline time.Time, ok bool)
Done() <-chan struct{}
Err() error
Value(key interface{}) interface{}
}
1.Deadline方法是獲取設置的截止時間的意思,第一個返回式是截止時間,到了這個時間點,Context會自動發起取消請求;第二個返回值ok==false時表示沒有設置截止時間,如果需要取消的話,需要調用取消函數進行取消。
2.Done方法返回一個只讀的chan,類型為struct{},我們在goroutine中,如果該方法返回的chan可以讀取,則意味著parent context已經發起了取消請求,我們通過Done方法收到這個信號后,就應該做清理操作,然后退出goroutine,釋放資源。之后,Err 方法會返回一個錯誤,告知為什么 Context 被取消。
3.Err方法返回取消的錯誤原因,因為什么Context被取消。
4.Value方法獲取該Context上綁定的值,是一個鍵值對,所以要通過一個Key才可以獲取對應的值,這個值一般是線程安全的。
創建 context
一個是Background,主要用于main函數、初始化以及測試代碼中,作為Context這個樹結構的最頂層的Context,也就是根Context,它不能被取消。
一個是TODO,如果我們不知道該使用什么Context的時候,可以使用這個。
兩個實現方式代碼是一樣的,不同的是,靜態分析工具可以使用它來驗證 context 是否正確傳遞
var (
background = new(emptyCtx)
todo = new(emptyCtx)
)
func Background() Context {
return background
}
func TODO() Context {
return todo
}
四個重要的函數
1.context.WithCancel(parent Context) (ctx Context, cancel CancelFunc)
返回派生 context 和取消函數。只有創建它的函數才能調用取消函數來取消此 context。如果您愿意,可以傳遞取消函數,但是,強烈建議不要這樣做。這可能導致取消函數的調用者沒有意識到取消 context 的下游影響。
ctx, cancel := context.WithCancel(context.Background())
2.context.WithDeadline(parent Context, d time.Time) (ctx Context, cancel CancelFunc)
此函數返回其父項的派生 context,當截止日期超過或取消函數被調用時,該 context 將被取消。例如,您可以創建一個將在以后的某個時間自動取消的 context,并在子函數中傳遞它。當因為截止日期耗盡而取消該 context 時,獲此 context 的所有函數都會收到通知去停止運行并返回。
ctx, cancel := context.WithDeadline(context.Background(), time.Now().Add(2 * time.Second))
3.context.WithTimeout(parent Context, timeout time.Duration) (ctx Context, cancel CancelFunc)
此函數類似于 context.WithDeadline。不同之處在于它將持續時間作為參數輸入而不是時間對象。此函數返回派生 context,如果調用取消函數或超出超時持續時間,則會取消該派生 context。
ctx, cancel := context.WithTimeout(context.Background(), 2 * time.Second)
4.context.WithValue(parent Context, key, val interface{}) (ctx Context, cancel CancelFunc)
此函數接收 context 并返回派生 context,其中值 val 與 key 關聯,并通過 context 樹與 context 一起傳遞。這意味著一旦獲得帶有值的 context,從中派生的任何 context 都會獲得此值。
示例:
func ContextTest01() {
logger.Info("start")
ctx, cancelFunc := context.WithCancel(context.Background())
go func() {
logger.Info("go 1")
cancelFunc()
}()
<-ctx.Done()
logger.Info("end")
logger.Info("end", ctx.Err())
}
func ContextTest02() {
fmt.Println("start")
gen := func(ctx context.Context) <-chan int {
dst := make(chan int)
n := 1
go func() {
for {
select {
case <-ctx.Done():
logger.Info("end")
return // returning not to leak the goroutine
case dst <- n:
n++
}
}
}()
return dst
}
ctx, cancel := context.WithCancel(context.Background())
defer cancel() // main 方法執行完后,結束 ctx 相關的 goroutine
for n := range gen(ctx) {
logger.Info(n)
if n == 5 {
break
}
}
}
func ContextTest03() {
// 自動取消(定時取消)
timeout := 3 * time.Second
ctx, _ := context.WithTimeout(context.Background(), timeout)
logger.Info(Add(ctx), ctx.Err())
}
func ContextTest04() {
// 手動取消
ctx, cancel := context.WithCancel(context.Background())
go func() {
time.Sleep(2 * time.Second)
cancel() // 在調用處主動取消
}()
logger.Info(Add(ctx), ctx.Err())
}
func Cdd(ctx context.Context) int {
logger.Info(ctx.Value("K_C"))
<-ctx.Done()
return -3
}
func Bdd(ctx context.Context) int {
logger.Info(ctx.Value("K_A"))
logger.Info(ctx.Value("K_B"))
ctxc := context.WithValue(ctx, "K_C", "I am GO")
go logger.Info(Cdd(ctxc), ctxc.Err())
<-ctxc.Done()
return -2
}
func Add(ctx context.Context) int {
ctxa := context.WithValue(ctx, "K_A", "HELLO")
ctxb := context.WithValue(ctxa, "K_B", "WORLD")
go logger.Info(Bdd(ctxb), ctxb.Err())
<-ctxb.Done()
return -1
}
知識擴展
問題1:“可撤銷的”在context包中代表著什么?“撤銷”一個Context值又意味著什么?
我相信很多初識context包的Go程序開發者,都會有這樣的疑問。確實,“可撤銷的”(cancelable)這個詞在這里是比較抽象的,很容易讓人迷惑。我這里再來解釋一下。
這需要從Context類型的聲明講起。這個接口中有兩個方法與“撤銷”息息相關。Done方法會返回一個元素類型為struct{}的接收通道。不過,這個接收通道的用途并不是傳遞元素值,而是讓調用方去感知“撤銷”當前Context值的那個信號。
一旦當前的Context值被撤銷,這里的接收通道就會被立即關閉。我們都知道,對于一個未包含任何元素值的通道來說,它的關閉會使任何針對它的接收操作立即結束。
正因為如此,在coordinateWithContext函數中,基于調用表達式cxt.Done()的接收操作,才能夠起到感知撤銷信號的作用。
除了讓Context值的使用方感知到撤銷信號,讓它們得到“撤銷”的具體原因,有時也是很有必要的。后者即是Context類型的Err方法的作用。該方法的結果是error類型的,并且其值只可能等于context.Canceled變量的值,或者context.DeadlineExceeded變量的值。
前者用于表示手動撤銷,而后者則代表:由于我們給定的過期時間已到,而導致的撤銷。
func ContextTest01() {
logger.Info("start")
ctx, cancelFunc := context.WithCancel(context.Background())
go func() {
logger.Info("go 1")
cancelFunc()
}()
<-ctx.Done()
logger.Info("end")
logger.Info("end", ctx.Err())
// 最后輸出 ‘end context canceled’
}
你可能已經感覺到了,對于Context值來說,“撤銷”這個詞如果當名詞講,指的其實就是被用來表達“撤銷”狀態的信號;如果當動詞講,指的就是對撤銷信號的傳達;而“可撤銷的”指的則是具有傳達這種撤銷信號的能力。
我在前面講過,當我們通過調用context.WithCancel函數產生一個可撤銷的Context值時,還會獲得一個用于觸發撤銷信號的函數。
通過調用這個函數,我們就可以觸發針對這個Context值的撤銷信號。一旦觸發,撤銷信號就會立即被傳達給這個Context值,并由它的Done方法的結果值(一個接收通道)表達出來。
撤銷函數只負責觸發信號,而對應的可撤銷的Context值也只負責傳達信號,它們都不會去管后邊具體的“撤銷”操作。實際上,我們的代碼可以在感知到撤銷信號之后,進行任意的操作,Context值對此并沒有任何的約束。
最后,若再深究的話,這里的“撤銷”最原始的含義其實就是,終止程序針對某種請求(比如HTTP請求)的響應,或者取消對某種指令(比如SQL指令)的處理。這也是Go語言團隊在創建context代碼包,和Context類型時的初衷。
如果我們去查看net包和database/sql包的API和源碼的話,就可以了解它們在這方面的典型應用。
問題2:撤銷信號是如何在上下文樹中傳播的?
我在前面講了,context包中包含了四個用于繁衍Context值的函數。其中的WithCancel、WithDeadline和WithTimeout都是被用來基于給定的Context值產生可撤銷的子值的。
context包的WithCancel函數在被調用后會產生兩個結果值。第一個結果值就是那個可撤銷的Context值,而第二個結果值則是用于觸發撤銷信號的函數。
在撤銷函數被調用之后,對應的Context值會先關閉它內部的接收通道,也就是它的Done方法會返回的那個通道。
然后,它會向它的所有子值(或者說子節點)傳達撤銷信號。這些子值會如法炮制,把撤銷信號繼續傳播下去。最后,這個Context值會斷開它與其父值之間的關聯。
我們通過調用context包的WithDeadline函數或者WithTimeout函數生成的Context值也是可撤銷的。它們不但可以被手動撤銷,還會依據在生成時被給定的過期時間,自動地進行定時撤銷。這里定時撤銷的功能是借助它們內部的計時器來實現的。
當過期時間到達時,這兩種Context值的行為與Context值被手動撤銷時的行為是幾乎一致的,只不過前者會在最后停止并釋放掉其內部的計時器。
最后要注意,通過調用context.WithValue函數得到的Context值是不可撤銷的。撤銷信號在被傳播時,若遇到它們則會直接跨過,并試圖將信號直接傳給它們的子值。
問題 3:怎樣通過Context值攜帶數據?怎樣從中獲取數據?
既然談到了context包的WithValue函數,我們就來說說Context值攜帶數據的方式。
WithValue函數在產生新的Context值(以下簡稱含數據的Context值)的時候需要三個參數,即:父值、鍵和值。與“字典對于鍵的約束”類似,這里鍵的類型必須是可判等的。
原因很簡單,當我們從中獲取數據的時候,它需要根據給定的鍵來查找對應的值。不過,這種Context值并不是用字典來存儲鍵和值的,后兩者只是被簡單地存儲在前者的相應字段中而已。
Context類型的Value方法就是被用來獲取數據的。在我們調用含數據的Context值的Value方法時,它會先判斷給定的鍵,是否與當前值中存儲的鍵相等,如果相等就把該值中存儲的值直接返回,否則就到其父值中繼續查找。
如果其父值中仍然未存儲相等的鍵,那么該方法就會沿著上下文根節點的方向一路查找下去。
注意,除了含數據的Context值以外,其他幾種Context值都是無法攜帶數據的。因此,Context值的Value方法在沿路查找的時候,會直接跨過那幾種值。
如果我們調用的Value方法的所屬值本身就是不含數據的,那么實際調用的就將會是其父輩或祖輩的Value方法。這是由于這幾種Context值的實際類型,都屬于結構體類型,并且它們都是通過“將其父值嵌入到自身”,來表達父子關系的。
最后,提醒一下,Context接口并沒有提供改變數據的方法。因此,在通常情況下,我們只能通過在上下文樹中添加含數據的Context值來存儲新的數據,或者通過撤銷此種值的父值丟棄掉相應的數據。如果你存儲在這里的數據可以從外部改變,那么必須自行保證安全。