context.Context類型
context.Context類型(以下簡稱Context類型)是在Go 1.7發(fā)布時(shí)才被加入到標(biāo)準(zhǔn)庫的。而后,標(biāo)準(zhǔn)庫中的很多其他代碼包都為了支持它而進(jìn)行了擴(kuò)展墓怀,包括:os/exec包因俐、net包、database/sql包秤涩,以及runtime/pprof包和runtime/trace包,等等司抱。
Context類型之所以受到了標(biāo)準(zhǔn)庫中眾多代碼包的積極支持筐眷,主要是因?yàn)樗且环N非常通用的同步工具。它的值不但可以被任意地?cái)U(kuò)散习柠,而且還可以被用來傳遞額外的信息和信號(hào)匀谣。
更具體地說照棋,Context類型可以提供一類代表上下文的值。此類值是并發(fā)安全的武翎,也就是說它可以被傳播給多個(gè)goroutine烈炭。
由于Context類型實(shí)際上是一個(gè)接口類型,而context包中實(shí)現(xiàn)該接口的所有私有類型宝恶,都是基于某個(gè)數(shù)據(jù)類型的指針類型符隙,所以,如此傳播并不會(huì)影響該類型值的功能和安全垫毙。
context 的作用
1.通過context膏执,我們可以方便地對(duì)同一個(gè)請(qǐng)求所產(chǎn)生地goroutine進(jìn)行約束管理,可以設(shè)定超時(shí)露久、deadline更米,甚至是取消這個(gè)請(qǐng)求相關(guān)的所有g(shù)oroutine。形象地說毫痕,假如一個(gè)請(qǐng)求過來征峦,需要A去做事情,而A讓B去做一些事情消请,B讓C去做一些事情栏笆,A、B臊泰、C是三個(gè)有關(guān)聯(lián)的goroutine蛉加,那么問題來了:假如在A、B缸逃、C還在處理事情的時(shí)候請(qǐng)求被取消了针饥,那么該如何優(yōu)雅地同時(shí)關(guān)閉goroutine A、B需频、C呢丁眼?這個(gè)時(shí)候就輪到context包上場了。
2.在golang中的創(chuàng)建一個(gè)新的線程并不會(huì)返回像c語言類似的pid所有我們不能從外部殺死某個(gè)線程昭殉,所有我就得讓它自己結(jié)束之前我們用channel+select的方式苞七,來解決這個(gè)問題但是有些場景實(shí)現(xiàn)起來比較麻煩,例如由一個(gè)請(qǐng)求衍生出多個(gè)線程并且之間需要滿足一定的約束關(guān)系挪丢,以實(shí)現(xiàn)一些諸如:
有效期蹂风,中止線程樹,傳遞請(qǐng)求全局變量之類的功能
context 接口定義
type Context interface {
Deadline() (deadline time.Time, ok bool)
Done() <-chan struct{}
Err() error
Value(key interface{}) interface{}
}
1.Deadline方法是獲取設(shè)置的截止時(shí)間的意思乾蓬,第一個(gè)返回式是截止時(shí)間惠啄,到了這個(gè)時(shí)間點(diǎn),Context會(huì)自動(dòng)發(fā)起取消請(qǐng)求;第二個(gè)返回值ok==false時(shí)表示沒有設(shè)置截止時(shí)間礁阁,如果需要取消的話巧号,需要調(diào)用取消函數(shù)進(jìn)行取消。
2.Done方法返回一個(gè)只讀的chan姥闭,類型為struct{}丹鸿,我們?cè)趃oroutine中歧杏,如果該方法返回的chan可以讀取泛豪,則意味著parent context已經(jīng)發(fā)起了取消請(qǐng)求,我們通過Done方法收到這個(gè)信號(hào)后哟绊,就應(yīng)該做清理操作铜跑,然后退出goroutine门怪,釋放資源。之后锅纺,Err 方法會(huì)返回一個(gè)錯(cuò)誤掷空,告知為什么 Context 被取消。
3.Err方法返回取消的錯(cuò)誤原因囤锉,因?yàn)槭裁碈ontext被取消坦弟。
4.Value方法獲取該Context上綁定的值,是一個(gè)鍵值對(duì)官地,所以要通過一個(gè)Key才可以獲取對(duì)應(yīng)的值酿傍,這個(gè)值一般是線程安全的。
創(chuàng)建 context
一個(gè)是Background驱入,主要用于main函數(shù)赤炒、初始化以及測試代碼中,作為Context這個(gè)樹結(jié)構(gòu)的最頂層的Context亏较,也就是根Context莺褒,它不能被取消。
一個(gè)是TODO宴杀,如果我們不知道該使用什么Context的時(shí)候癣朗,可以使用這個(gè)。
兩個(gè)實(shí)現(xiàn)方式代碼是一樣的旺罢,不同的是,靜態(tài)分析工具可以使用它來驗(yàn)證 context 是否正確傳遞
var (
background = new(emptyCtx)
todo = new(emptyCtx)
)
func Background() Context {
return background
}
func TODO() Context {
return todo
}
四個(gè)重要的函數(shù)
1.context.WithCancel(parent Context) (ctx Context, cancel CancelFunc)
返回派生 context 和取消函數(shù)绢记。只有創(chuàng)建它的函數(shù)才能調(diào)用取消函數(shù)來取消此 context扁达。如果您愿意,可以傳遞取消函數(shù)蠢熄,但是跪解,強(qiáng)烈建議不要這樣做。這可能導(dǎo)致取消函數(shù)的調(diào)用者沒有意識(shí)到取消 context 的下游影響签孔。
ctx, cancel := context.WithCancel(context.Background())
2.context.WithDeadline(parent Context, d time.Time) (ctx Context, cancel CancelFunc)
此函數(shù)返回其父項(xiàng)的派生 context叉讥,當(dāng)截止日期超過或取消函數(shù)被調(diào)用時(shí)窘行,該 context 將被取消。例如图仓,您可以創(chuàng)建一個(gè)將在以后的某個(gè)時(shí)間自動(dòng)取消的 context罐盔,并在子函數(shù)中傳遞它。當(dāng)因?yàn)榻刂谷掌诤谋M而取消該 context 時(shí)救崔,獲此 context 的所有函數(shù)都會(huì)收到通知去停止運(yùn)行并返回惶看。
ctx, cancel := context.WithDeadline(context.Background(), time.Now().Add(2 * time.Second))
3.context.WithTimeout(parent Context, timeout time.Duration) (ctx Context, cancel CancelFunc)
此函數(shù)類似于 context.WithDeadline。不同之處在于它將持續(xù)時(shí)間作為參數(shù)輸入而不是時(shí)間對(duì)象六孵。此函數(shù)返回派生 context纬黎,如果調(diào)用取消函數(shù)或超出超時(shí)持續(xù)時(shí)間,則會(huì)取消該派生 context劫窒。
ctx, cancel := context.WithTimeout(context.Background(), 2 * time.Second)
4.context.WithValue(parent Context, key, val interface{}) (ctx Context, cancel CancelFunc)
此函數(shù)接收 context 并返回派生 context本今,其中值 val 與 key 關(guān)聯(lián),并通過 context 樹與 context 一起傳遞主巍。這意味著一旦獲得帶有值的 context诈泼,從中派生的任何 context 都會(huì)獲得此值。
示例:
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 方法執(zhí)行完后煤禽,結(jié)束 ctx 相關(guān)的 goroutine
for n := range gen(ctx) {
logger.Info(n)
if n == 5 {
break
}
}
}
func ContextTest03() {
// 自動(dòng)取消(定時(shí)取消)
timeout := 3 * time.Second
ctx, _ := context.WithTimeout(context.Background(), timeout)
logger.Info(Add(ctx), ctx.Err())
}
func ContextTest04() {
// 手動(dòng)取消
ctx, cancel := context.WithCancel(context.Background())
go func() {
time.Sleep(2 * time.Second)
cancel() // 在調(diào)用處主動(dòng)取消
}()
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
}
知識(shí)擴(kuò)展
問題1:“可撤銷的”在context包中代表著什么铐达?“撤銷”一個(gè)Context值又意味著什么?
我相信很多初識(shí)context包的Go程序開發(fā)者檬果,都會(huì)有這樣的疑問瓮孙。確實(shí),“可撤銷的”(cancelable)這個(gè)詞在這里是比較抽象的选脊,很容易讓人迷惑杭抠。我這里再來解釋一下。
這需要從Context類型的聲明講起恳啥。這個(gè)接口中有兩個(gè)方法與“撤銷”息息相關(guān)偏灿。Done方法會(huì)返回一個(gè)元素類型為struct{}的接收通道。不過钝的,這個(gè)接收通道的用途并不是傳遞元素值翁垂,而是讓調(diào)用方去感知“撤銷”當(dāng)前Context值的那個(gè)信號(hào)。
一旦當(dāng)前的Context值被撤銷硝桩,這里的接收通道就會(huì)被立即關(guān)閉沿猜。我們都知道,對(duì)于一個(gè)未包含任何元素值的通道來說碗脊,它的關(guān)閉會(huì)使任何針對(duì)它的接收操作立即結(jié)束啼肩。
正因?yàn)槿绱耍赾oordinateWithContext函數(shù)中,基于調(diào)用表達(dá)式cxt.Done()的接收操作祈坠,才能夠起到感知撤銷信號(hào)的作用害碾。
除了讓Context值的使用方感知到撤銷信號(hào),讓它們得到“撤銷”的具體原因赦拘,有時(shí)也是很有必要的慌随。后者即是Context類型的Err方法的作用。該方法的結(jié)果是error類型的另绩,并且其值只可能等于context.Canceled變量的值儒陨,或者context.DeadlineExceeded變量的值。
前者用于表示手動(dòng)撤銷笋籽,而后者則代表:由于我們給定的過期時(shí)間已到蹦漠,而導(dǎo)致的撤銷。
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’
}
你可能已經(jīng)感覺到了车海,對(duì)于Context值來說笛园,“撤銷”這個(gè)詞如果當(dāng)名詞講,指的其實(shí)就是被用來表達(dá)“撤銷”狀態(tài)的信號(hào)侍芝;如果當(dāng)動(dòng)詞講研铆,指的就是對(duì)撤銷信號(hào)的傳達(dá);而“可撤銷的”指的則是具有傳達(dá)這種撤銷信號(hào)的能力州叠。
我在前面講過棵红,當(dāng)我們通過調(diào)用context.WithCancel函數(shù)產(chǎn)生一個(gè)可撤銷的Context值時(shí),還會(huì)獲得一個(gè)用于觸發(fā)撤銷信號(hào)的函數(shù)咧栗。
通過調(diào)用這個(gè)函數(shù)逆甜,我們就可以觸發(fā)針對(duì)這個(gè)Context值的撤銷信號(hào)。一旦觸發(fā)致板,撤銷信號(hào)就會(huì)立即被傳達(dá)給這個(gè)Context值交煞,并由它的Done方法的結(jié)果值(一個(gè)接收通道)表達(dá)出來。
撤銷函數(shù)只負(fù)責(zé)觸發(fā)信號(hào)斟或,而對(duì)應(yīng)的可撤銷的Context值也只負(fù)責(zé)傳達(dá)信號(hào)素征,它們都不會(huì)去管后邊具體的“撤銷”操作。實(shí)際上萝挤,我們的代碼可以在感知到撤銷信號(hào)之后御毅,進(jìn)行任意的操作,Context值對(duì)此并沒有任何的約束平斩。
最后亚享,若再深究的話,這里的“撤銷”最原始的含義其實(shí)就是绘面,終止程序針對(duì)某種請(qǐng)求(比如HTTP請(qǐng)求)的響應(yīng),或者取消對(duì)某種指令(比如SQL指令)的處理。這也是Go語言團(tuán)隊(duì)在創(chuàng)建context代碼包揭璃,和Context類型時(shí)的初衷晚凿。
如果我們?nèi)ゲ榭磏et包和database/sql包的API和源碼的話,就可以了解它們?cè)谶@方面的典型應(yīng)用瘦馍。
問題2:撤銷信號(hào)是如何在上下文樹中傳播的歼秽?
我在前面講了,context包中包含了四個(gè)用于繁衍Context值的函數(shù)情组。其中的WithCancel燥筷、WithDeadline和WithTimeout都是被用來基于給定的Context值產(chǎn)生可撤銷的子值的。
context包的WithCancel函數(shù)在被調(diào)用后會(huì)產(chǎn)生兩個(gè)結(jié)果值院崇。第一個(gè)結(jié)果值就是那個(gè)可撤銷的Context值肆氓,而第二個(gè)結(jié)果值則是用于觸發(fā)撤銷信號(hào)的函數(shù)。
在撤銷函數(shù)被調(diào)用之后底瓣,對(duì)應(yīng)的Context值會(huì)先關(guān)閉它內(nèi)部的接收通道谢揪,也就是它的Done方法會(huì)返回的那個(gè)通道。
然后捐凭,它會(huì)向它的所有子值(或者說子節(jié)點(diǎn))傳達(dá)撤銷信號(hào)拨扶。這些子值會(huì)如法炮制,把撤銷信號(hào)繼續(xù)傳播下去茁肠。最后患民,這個(gè)Context值會(huì)斷開它與其父值之間的關(guān)聯(lián)。
我們通過調(diào)用context包的WithDeadline函數(shù)或者WithTimeout函數(shù)生成的Context值也是可撤銷的垦梆。它們不但可以被手動(dòng)撤銷匹颤,還會(huì)依據(jù)在生成時(shí)被給定的過期時(shí)間,自動(dòng)地進(jìn)行定時(shí)撤銷奶赔。這里定時(shí)撤銷的功能是借助它們內(nèi)部的計(jì)時(shí)器來實(shí)現(xiàn)的惋嚎。
當(dāng)過期時(shí)間到達(dá)時(shí),這兩種Context值的行為與Context值被手動(dòng)撤銷時(shí)的行為是幾乎一致的站刑,只不過前者會(huì)在最后停止并釋放掉其內(nèi)部的計(jì)時(shí)器另伍。
最后要注意,通過調(diào)用context.WithValue函數(shù)得到的Context值是不可撤銷的绞旅。撤銷信號(hào)在被傳播時(shí)摆尝,若遇到它們則會(huì)直接跨過,并試圖將信號(hào)直接傳給它們的子值因悲。
問題 3:怎樣通過Context值攜帶數(shù)據(jù)堕汞?怎樣從中獲取數(shù)據(jù)?
既然談到了context包的WithValue函數(shù)晃琳,我們就來說說Context值攜帶數(shù)據(jù)的方式讯检。
WithValue函數(shù)在產(chǎn)生新的Context值(以下簡稱含數(shù)據(jù)的Context值)的時(shí)候需要三個(gè)參數(shù)琐鲁,即:父值、鍵和值人灼。與“字典對(duì)于鍵的約束”類似围段,這里鍵的類型必須是可判等的。
原因很簡單投放,當(dāng)我們從中獲取數(shù)據(jù)的時(shí)候奈泪,它需要根據(jù)給定的鍵來查找對(duì)應(yīng)的值。不過灸芳,這種Context值并不是用字典來存儲(chǔ)鍵和值的涝桅,后兩者只是被簡單地存儲(chǔ)在前者的相應(yīng)字段中而已。
Context類型的Value方法就是被用來獲取數(shù)據(jù)的烙样。在我們調(diào)用含數(shù)據(jù)的Context值的Value方法時(shí)冯遂,它會(huì)先判斷給定的鍵,是否與當(dāng)前值中存儲(chǔ)的鍵相等误阻,如果相等就把該值中存儲(chǔ)的值直接返回债蜜,否則就到其父值中繼續(xù)查找。
如果其父值中仍然未存儲(chǔ)相等的鍵究反,那么該方法就會(huì)沿著上下文根節(jié)點(diǎn)的方向一路查找下去寻定。
注意,除了含數(shù)據(jù)的Context值以外精耐,其他幾種Context值都是無法攜帶數(shù)據(jù)的狼速。因此,Context值的Value方法在沿路查找的時(shí)候卦停,會(huì)直接跨過那幾種值向胡。
如果我們調(diào)用的Value方法的所屬值本身就是不含數(shù)據(jù)的,那么實(shí)際調(diào)用的就將會(huì)是其父輩或祖輩的Value方法惊完。這是由于這幾種Context值的實(shí)際類型僵芹,都屬于結(jié)構(gòu)體類型,并且它們都是通過“將其父值嵌入到自身”小槐,來表達(dá)父子關(guān)系的拇派。
最后,提醒一下凿跳,Context接口并沒有提供改變數(shù)據(jù)的方法件豌。因此,在通常情況下控嗜,我們只能通過在上下文樹中添加含數(shù)據(jù)的Context值來存儲(chǔ)新的數(shù)據(jù)茧彤,或者通過撤銷此種值的父值丟棄掉相應(yīng)的數(shù)據(jù)。如果你存儲(chǔ)在這里的數(shù)據(jù)可以從外部改變疆栏,那么必須自行保證安全曾掂。