go語言context包功能及操作使用詳解
Context包到底是干嘛用的？
我們會(huì)在用到很多東西的時(shí)候都看到context的影子，比如gin框架，比如grpc，這東西到底是做啥的？
大家都在用，沒幾個(gè)知道這是干嘛的，知其然而不知其所以然
原理說白了就是：
- 當(dāng)前協(xié)程取消了，可以通知所有由它創(chuàng)建的子協(xié)程退出
- 當(dāng)前協(xié)程取消了，不會(huì)影響到創(chuàng)建它的父級(jí)協(xié)程的狀態(tài)
- 擴(kuò)展了額外的功能：超時(shí)取消、定時(shí)取消、可以和子協(xié)程共享數(shù)據(jù)
context原理
這就是context包的核心原理，鏈?zhǔn)絺鬟fcontext，基于context構(gòu)造新的context
什么時(shí)候應(yīng)該使用 Context？
- 每一個(gè) RPC 調(diào)用都應(yīng)該有超時(shí)退出的能力，這是比較合理的 API 設(shè)計(jì)
- 不僅僅 是超時(shí)，你還需要有能力去結(jié)束那些不再需要操作的行為
- context.Context 是 Go 標(biāo)準(zhǔn)的解決方案
- 任何函數(shù)可能被阻塞，或者需要很長時(shí)間來完成的，都應(yīng)該有個(gè) context.Context
如何創(chuàng)建 Context？
在 RPC 開始的時(shí)候，使用 context.Background()
有些人把在 main() 里記錄一個(gè) context.Background()，然后把這個(gè)放到服務(wù)器的某個(gè)變量里，然后請(qǐng)求來了后從這個(gè)變量里繼承 context。這么做是不對(duì)的。直接每個(gè)請(qǐng)求，源自自己的 context.Background() 即可。
如果你沒有 context，卻需要調(diào)用一個(gè) context 的函數(shù)的話，用 context.TODO()
如果某步操作需要自己的超時(shí)設(shè)置的話，給它一個(gè)獨(dú)立的 sub-context（如前面的例子）
主協(xié)程通知有子協(xié)程，子協(xié)程又有多個(gè)子協(xié)程
package main
import (
"context"
"fmt"
"time"
)
func main() {
ctx, cancel := context.WithCancel(context.Background())
//緩沖通道預(yù)先放置10個(gè)消息
messages := make(chan int, 10)
defer close(messages)
for i := 0; i < 10; i++ {
messages <- i
}
//啟動(dòng)3個(gè)子協(xié)程消費(fèi)messages消息
for i := 1; i <= 3; i++ {
go child(i, ctx, messages)
}
time.Sleep(3 * time.Second) //等待子協(xié)程接收一半的消息
cancel() //結(jié)束前通知子協(xié)程
time.Sleep(2 * time.Second) //等待所有的子協(xié)程輸出
fmt.Println("主協(xié)程結(jié)束")
}
//從messages通道獲取信息，當(dāng)收到結(jié)束信號(hào)的時(shí)候不再接收
func child(i int, ctx context.Context, messages <-chan int) {
//基于父級(jí)的context建立context
newCtx, _ := context.WithCancel(ctx)
go childJob(i, "a", newCtx)
go childJob(i, "b", newCtx)
Consume:
for {
time.Sleep(1 * time.Second)
select {
case <-ctx.Done():
fmt.Printf("[%d]被主協(xié)程通知結(jié)束...\n", i)
break Consume
default:
fmt.Printf("[%d]接收消息: %d\n", i, <-messages)
}
}
}
//任務(wù)
func childJob(parent int, name string, ctx context.Context) {
for {
time.Sleep(1 * time.Second)
select {
case <-ctx.Done():
fmt.Printf("[%d-%v]被結(jié)束...\n", parent, name)
return
default:
fmt.Printf("[%d-%v]執(zhí)行\(zhòng)n", parent, name)
}
}
}
運(yùn)行結(jié)果如下
可以看到，改成context包還是順利的通過子協(xié)程退出了
主要修改了幾個(gè)地方，再ctx向下傳遞
基于上層context再構(gòu)建當(dāng)前層級(jí)的context
監(jiān)聽context的退出信號(hào)，
這就是context包的核心原理，鏈?zhǔn)絺鬟fcontext，基于context構(gòu)造新的context
context核心接口
type Context interface {
Deadline() (deadline time.Time, ok bool)
Done() <-chan struct{}
Err() error
Value(key interface{}) interface{}
}
Deadline返回綁定當(dāng)前context的任務(wù)被取消的截止時(shí)間；如果沒有設(shè)定期限，將返回ok == false。
Done 當(dāng)綁定當(dāng)前context的任務(wù)被取消時(shí)，將返回一個(gè)關(guān)閉的channel；如果當(dāng)前context不會(huì)被取消，將返回nil。
Err 如果Done返回的channel沒有關(guān)閉，將返回nil;如果Done返回的channel已經(jīng)關(guān)閉，將返回非空的值表示任務(wù)結(jié)束的原因。如果是context被取消，Err將返回Canceled；如果是context超時(shí)，Err將返回DeadlineExceeded。
Value 返回context存儲(chǔ)的鍵值對(duì)中當(dāng)前key對(duì)應(yīng)的值，如果沒有對(duì)應(yīng)的key,則返回nil。
emptyCtx結(jié)構(gòu)體
實(shí)現(xiàn)了context接口，emptyCtx沒有超時(shí)時(shí)間，不能取消，也不能存儲(chǔ)額外信息，所以emptyCtx用來做根節(jié)點(diǎn)，一般用Background和TODO來初始化emptyCtx
Backgroud
通常用于主函數(shù)，初始化以及測(cè)試，作為頂層的context
context.Background()
TODO
不確定使用什么用context的時(shí)候才會(huì)使用
valueCtx結(jié)構(gòu)體
type valueCtx struct{ Context key, val interface{} }
valueCtx利用Context的變量來表示父節(jié)點(diǎn)context，所以當(dāng)前context繼承了父context的所有信息
valueCtx還可以存儲(chǔ)鍵值。
WithValue向context添加值
可以向context添加鍵值
func WithValue(parent Context, key, val interface{}) Context {
if key == nil {
panic("nil key")
}
if !reflect.TypeOf(key).Comparable() {
panic("key is not comparable")
}
return &valueCtx{parent, key, val}
}
添加鍵值會(huì)返回創(chuàng)建一個(gè)新的valueCtx子節(jié)點(diǎn)
Value向context取值
func (c *valueCtx) Value(key interface{}) interface{} {
if c.key == key {
return c.val
}
return c.Context.Value(key)
}
可以用來獲取當(dāng)前context和所有的父節(jié)點(diǎn)存儲(chǔ)的key
如果當(dāng)前的context不存在需要的key，會(huì)沿著context鏈向上尋找key對(duì)應(yīng)的值，直到根節(jié)點(diǎn)
示例
package main
import (
"context"
"fmt"
"time"
)
func main() {
ctx := context.WithValue(context.Background(), "name1", "root1")
//第一層
go func(parent context.Context) {
ctx = context.WithValue(parent, "name2", "root2")
//第二層
go func(parent context.Context) {
ctx = context.WithValue(parent, "name3", "root3")
//第三層
go func(parent context.Context) {
//可以獲取所有的父類的值
fmt.Println(ctx.Value("name1"))
fmt.Println(ctx.Value("name2"))
fmt.Println(ctx.Value("name3"))
//不存在
fmt.Println(ctx.Value("name4"))
}(ctx)
}(ctx)
}(ctx)
time.Sleep(1 * time.Second)
fmt.Println("end")
}
運(yùn)行結(jié)果
可以看到，子context是可以獲取所有父級(jí)設(shè)置過的key
WithCancel可取消的context
用來創(chuàng)建一個(gè)可取消的context，返回一個(gè)context和一個(gè)CancelFunc，調(diào)用CancelFunc可以觸發(fā)cancel操作。
package main
import (
"context"
"fmt"
"time"
)
func main() {
ctx, cancel := context.WithCancel(context.Background())
//第一層
go func(parent context.Context) {
ctx, _ := context.WithCancel(parent)
//第二層
go func(parent context.Context) {
ctx, _ := context.WithCancel(parent)
//第三層
go func(parent context.Context) {
waitCancel(ctx, 3)
}(ctx)
waitCancel(ctx, 2)
}(ctx)
waitCancel(ctx, 1)
}(ctx)
// 主線程給的結(jié)束時(shí)間
time.Sleep(2 * time.Second)
cancel() // 調(diào)用取消context
time.Sleep(1 * time.Second)
}
func waitCancel(ctx context.Context, i int) {
for {
time.Sleep(time.Second)
select {
case <-ctx.Done():
fmt.Printf("%d end\n", i)
return
default:
fmt.Printf("%d do\n", i)
}
}
}
結(jié)果：
cancelCtx結(jié)構(gòu)體
type cancelCtx struct {
Context
mu sync.Mutex
done chan struct{}
children map[canceler]struct{}
err error
}
type canceler interface {
cancel(removeFromParent bool, err error)
Done() <-chan struct{}
}
WithDeadline-超時(shí)取消context
返回一個(gè)基于parent的可取消的context，并且過期時(shí)間deadline不晚于所設(shè)置時(shí)間d
WithTimeout-超時(shí)取消context
創(chuàng)建一個(gè)定時(shí)取消context，和WithDeadline差不多，WithTimeout是相對(duì)時(shí)間
timerCtx結(jié)構(gòu)體
timerCtx是基于cancelCtx的context精英，是一種可以定時(shí)取消的context，過期時(shí)間的deadline不晚于所設(shè)置的時(shí)間d
示例：
package main
import (
"context"
"fmt"
"time"
)
func main() {
// 設(shè)置超時(shí)時(shí)間
ctx, _ := context.WithTimeout(context.Background(), 2*time.Second)
//第一層
go func(parent context.Context) {
ctx, _ := context.WithCancel(parent)
//第二層
go func(parent context.Context) {
ctx, _ := context.WithCancel(parent)
//第三層
go func(parent context.Context) {
waitCancel(ctx, 3)
}(ctx)
waitCancel(ctx, 2)
}(ctx)
waitCancel(ctx, 1)
}(ctx)
<-ctx.Done()
// 給時(shí)間調(diào)用end
time.Sleep(time.Second)
}
func waitCancel(ctx context.Context, i int) {
for {
time.Sleep(time.Second)
select {
case <-ctx.Done():
fmt.Printf("%d end\n", i)
return
default:
fmt.Printf("%d do\n", i)
}
}
}
運(yùn)行結(jié)果：
1 do 3 do 2 do 1 end 3 end 2 end
可以看到，雖然我們沒有調(diào)用cancel方法，5秒后自動(dòng)調(diào)用了，所有的子goroutine都已經(jīng)收到停止信號(hào)
總結(jié)核心原理
- Done方法返回一個(gè)channel
- 外部通過調(diào)用<-channel監(jiān)聽cancel方法
- cancel方法會(huì)調(diào)用close(channel)
當(dāng)調(diào)用close方法的時(shí)候，所有的channel再次從通道獲取內(nèi)容，會(huì)返回零值和false
res,ok := <-done:
- 過期自動(dòng)取消，使用了time.AfterFunc方法，到時(shí)調(diào)用cancel方法
c.timer = time.AfterFunc(dur, func() {
c.cancel(true, DeadlineExceeded)
})以上就是go語言context包功能及操作使用詳解的詳細(xì)內(nèi)容，更多關(guān)于go語言context包的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！
相關(guān)文章
這篇文章主要介紹了Golang極簡入門教程（一）：基本概念,本文講解了Golang的基本知識(shí)、基礎(chǔ)語法、相關(guān)術(shù)語等,需要的朋友可以參考下2014-10-10
Go語言計(jì)算兩個(gè)經(jīng)度和緯度之間距離的方法
這篇文章主要介紹了Go語言計(jì)算兩個(gè)經(jīng)度和緯度之間距離的方法,涉及Go語言相關(guān)數(shù)學(xué)函數(shù)的使用技巧,具有一定參考借鑒價(jià)值,需要的朋友可以參考下2015-02-02
golang中http請(qǐng)求的context傳遞到異步任務(wù)的坑及解決
這篇文章主要介紹了golang中http請(qǐng)求的context傳遞到異步任務(wù)的坑及解決方案,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2024-03-03
golang?metrics各個(gè)指標(biāo)含義講解說明
這篇文章主要為大家介紹了golang?metrics各個(gè)指標(biāo)含義講解說明，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪2023-05-05
Go1.16新特性embed打包靜態(tài)資源文件實(shí)現(xiàn)
這篇文章主要為大家介紹了Go?1.16新特性embed打包靜態(tài)資源文件的實(shí)現(xiàn)示例詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪2022-07-07
Golang中時(shí)間格式化的實(shí)現(xiàn)詳解
這篇文章主要為大家詳細(xì)介紹了Go語言中進(jìn)行時(shí)間進(jìn)行格式化的相關(guān)知識(shí),文中的示例代碼講解詳細(xì),感興趣的小伙伴可以跟隨小編一起了解一下2023-09-09
單元測(cè)試是檢測(cè)你寫的一個(gè)函數(shù)是否具備安全性的一次檢測(cè)，這篇文章主要為大家詳細(xì)介紹了Golang中單元測(cè)試的具體使用，希望對(duì)大家有所幫助2023-07-07
golang自帶了testing測(cè)試包,使用該包可以進(jìn)行自動(dòng)化的單元測(cè)試,輸出結(jié)果驗(yàn)證,并且可以測(cè)試性能,下面通過示例代碼給大家講解golang testing使用示例小結(jié),感興趣的朋友一起看看吧2024-05-05
在Go語言開發(fā)中,依賴管理是一項(xiàng)非常重要的工作,Go mod作為官方的包管理工具已經(jīng)成為了Go語言依賴管理的首選方式,本文就來介紹一下go mod 依賴管理的具體使用,具有一定的參考價(jià)值,感興趣的可以了解一下2024-01-01
Go語言題解LeetCode705設(shè)計(jì)哈希集合
這篇文章主要為大家介紹了Go語言題解LeetCode705設(shè)計(jì)哈希集合，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪2022-12-12