詳解Go語言的context包從放棄到入門
一、Context包到底是干嘛用的
我們會在用到很多東西的時候都看到context的影子,比如gin框架,比如grpc,這東西到底是做啥的?
大家都在用,沒幾個知道這是干嘛的,知其然而不知其所以然,
誰都在CRUD,誰都覺得if else就完了,有代碼能copy我也行,原理啥啥不懂不重要,反正就是一把梭
原理說白了就是:
- 當前協(xié)程取消了,可以通知所有由它創(chuàng)建的子協(xié)程退出
- 當前協(xié)程取消了,不會影響到創(chuàng)建它的父級協(xié)程的狀態(tài)
- 擴展了額外的功能:超時取消、定時取消、可以給子協(xié)程共享數(shù)據(jù)
二、主協(xié)程退出通知子協(xié)程示例演示
主協(xié)程通知子協(xié)程退出
如下代碼展示了,通過一個叫done的channel通道達到了這樣的效果
package main import ( "fmt" "time" ) func main() { done := make(chan string) //緩沖通道預先放置10個消息 messages := make(chan int, 10) defer close(messages) for i := 0; i < 10; i++ { messages <- i } //啟動3個子協(xié)程消費messages消息 for i := 1; i <= 3; i++ { go child(i, done, messages) } time.Sleep(3 * time.Second) //等待子協(xié)程接收一半的消息 close(done) //結(jié)束前通知子協(xié)程 time.Sleep(2 * time.Second) //等待所有的子協(xié)程輸出 fmt.Println("主協(xié)程結(jié)束") } //從messages通道獲取信息,當收到結(jié)束信號的時候不再接收 func child(i int, done <-chan string, messages <-chan int) { Consume: for { time.Sleep(1 * time.Second) select { case <-done: fmt.Printf("[%d]被主協(xié)程通知結(jié)束...\n", i) break Consume default: fmt.Printf("[%d]接收消息: %d\n", i, <-messages) } } }
運行結(jié)束如下
這里,我們用一個channel的關閉做到了通知所有的消費到一半的子協(xié)程退出。
問題來了,如果子協(xié)程又要啟動它的子協(xié)程,這可咋整?
主協(xié)程通知有子協(xié)程,子協(xié)程又有多個子協(xié)程
這是可哲學問題,我們還是得建立一個叫done的channel來監(jiān)測
下面演示一下這種操作,再在每個child方法里啟動多個job,如下
全量代碼貼出來
package main import ( "fmt" "time" ) func main() { done := make(chan string) //緩沖通道預先放置10個消息 messages := make(chan int, 10) defer close(messages) for i := 0; i < 10; i++ { messages <- i } //啟動3個子協(xié)程消費messages消息 for i := 1; i <= 3; i++ { go child(i, done, messages) } time.Sleep(3 * time.Second) //等待子協(xié)程接收一半的消息 close(done) //結(jié)束前通知子協(xié)程 time.Sleep(2 * time.Second) //等待所有的子協(xié)程輸出 fmt.Println("主協(xié)程結(jié)束") } //從messages通道獲取信息,當收到結(jié)束信號的時候不再接收 func child(i int, done <-chan string, messages <-chan int) { newDone := make(chan string) defer close(newDone) go childJob(i, "a", newDone) go childJob(i, "b", newDone) Consume: for { time.Sleep(1 * time.Second) select { case <-done: fmt.Printf("[%d]被主協(xié)程通知結(jié)束...\n", i) break Consume default: fmt.Printf("[%d]接收消息: %d\n", i, <-messages) } } } //任務 func childJob(parent int, name string, done <-chan string) { for { time.Sleep(1 * time.Second) select { case <-done: fmt.Printf("[%d-%v]被結(jié)束...\n", parent, name) return default: fmt.Printf("[%d-%v]執(zhí)行\(zhòng)n", parent, name) } } }
運行結(jié)果如下
問題來了,如果job里再啟動自己的goroutine,這樣沒完沒了的建立done的通道有點惡心,這時候context包就來了!
我們先把上面的代碼改成context包的方式
package main import ( "context" "fmt" "time" ) func main() { ctx, cancel := context.WithCancel(context.Background()) //緩沖通道預先放置10個消息 messages := make(chan int, 10) defer close(messages) for i := 0; i < 10; i++ { messages <- i } //啟動3個子協(xié)程消費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通道獲取信息,當收到結(jié)束信號的時候不再接收 func child(i int, ctx context.Context, messages <-chan int) { //基于父級的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) } } } //任務 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) } } }
運行結(jié)果如下
可以看到,改成context包還是順利的通過子協(xié)程退出了
主要修改了幾個地方,再ctx向下傳遞
基于上層context再構(gòu)建當前層級的context
監(jiān)聽context的退出信號,
這就是context包的核心原理,鏈式傳遞context,基于context構(gòu)造新的context
三、Context包的核心接口和方法
更多資料可以查看:Go 語言設計與實現(xiàn)
context接口
context是一個接口,主要包含以下4個方法
- Deadline
返回當前context任務被取消的時間,沒有設定返回ok返回false
- Done
當綁定當前的context任務被取消時,將返回一個關閉的channel
- Err
Done返回的channel沒有關閉,返回nil;
Done返回的channel已經(jīng)關閉,返回非空值表示任務結(jié)束的原因;
context被取消,返回Canceled。
context超時,DeadlineExceeded
- Value
返回context
存儲的鍵
emptyCtx結(jié)構(gòu)體
實現(xiàn)了context接口,emptyCtx沒有超時時間,不能取消,也不能存儲額外信息,所以emptyCtx用來做根節(jié)點,一般用Background和TODO來初始化emptyCtx
Backgroud
通常用于主函數(shù),初始化以及測試,作為頂層的context
TODO
不確定使用什么用context的時候才會使用
valueCtx結(jié)構(gòu)體
type valueCtx struct{ Context key, val interface{} }
valueCtx利用Context的變量來表示父節(jié)點context,所以當前context繼承了父context的所有信息
valueCtx還可以存儲鍵值。
Value
func (c *valueCtx) Value(key interface{}) interface{} { if c.key == key { return c.val } return c.Context.Value(key) }
可以用來獲取當前context和所有的父節(jié)點存儲的key
如果當前的context不存在需要的key,會沿著context鏈向上尋找key對應的值,直到根節(jié)點
WithValue
可以向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} }
添加鍵值會返回創(chuàng)建一個新的valueCtx子節(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{} }
和valueCtx類似,有一個context做為父節(jié)點,
變量done表示一個channel,用來表示傳遞關閉;
children表示一個map,存儲了當前context節(jié)點為下的子節(jié)點
err用來存儲錯誤信息表示任務結(jié)束的原因
WithCancel
用來創(chuàng)建一個可取消的context,返回一個context和一個CancelFunc,調(diào)用CancelFunc可以觸發(fā)cancel操作。
timerCtx結(jié)構(gòu)體
timerCtx是基于cancelCtx的context精英,是一種可以定時取消的context,過期時間的deadline不晚于所設置的時間d
WithDeadline
返回一個基于parent的可取消的context,并且過期時間deadline不晚于所設置時間d
WithTimeout
創(chuàng)建一個定時取消context,和WithDeadline差不多,WithTimeout是相對時間
四、總結(jié)核心原理
- Done方法返回一個channel
- 外部通過調(diào)用<-channel監(jiān)聽cancel方法
- cancel方法會調(diào)用close(channel)
當調(diào)用close方法的時間,所有的channel再次從通道獲取內(nèi)容,會返回零值和false
res,ok := <-done:
- 過期自動取消,使用了time.AfterFunc方法,到時調(diào)用cancel方法
c.timer = time.AfterFunc(dur, func() { c.cancel(true, DeadlineExceeded) })
授人以漁不如授人以漁,知其然也知其所以然,讓我們共同構(gòu)建美麗新世界,讓人與自然更加和諧,就是這樣,giao~
到此這篇關于Go語言的context包從放棄到入門的文章就介紹到這了,更多相關Go語言context包入門內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家!
相關文章
Go 通過結(jié)構(gòu)struct實現(xiàn)接口interface的問題
這篇文章主要介紹了Go 通過結(jié)構(gòu)struct實現(xiàn)接口interface的問題,本文通過示例代碼給大家介紹的非常詳細,對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下2021-10-10Go語言調(diào)用Shell與可執(zhí)行文件的實現(xiàn)
這篇文章主要介紹了Go語言調(diào)用Shell與可執(zhí)行文件的實現(xiàn),文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧2020-10-10詳解Golang time包中的結(jié)構(gòu)體time.Time
在日常開發(fā)過程中,會頻繁遇到對時間進行操作的場景,使用 Golang 中的 time 包可以很方便地實現(xiàn)對時間的相關操作,本文先講解一下 time 包中的結(jié)構(gòu)體 time.Time,需要的朋友可以參考下2023-07-07解決golang sync.Wait()不執(zhí)行的問題
這篇文章主要介紹了解決golang sync.Wait()不執(zhí)行的問題,具有很好的參考價值,希望對大家有所幫助。一起跟隨小編過來看看吧2020-12-12go實現(xiàn)一個內(nèi)存緩存系統(tǒng)的示例代碼
本文主要介紹了go實現(xiàn)一個內(nèi)存緩存系統(tǒng)的示例代碼,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧2024-10-10Go?Web開發(fā)之Gin多服務配置及優(yōu)雅關閉平滑重啟實現(xiàn)方法
這篇文章主要為大家介紹了Go?Web開發(fā)之Gin多服務配置及優(yōu)雅關閉平滑重啟實現(xiàn)方法詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪2024-01-01Go實現(xiàn)替換(覆蓋)文件某一行內(nèi)容的示例代碼
本文主要介紹了Go實現(xiàn)替換(覆蓋)文件某一行內(nèi)容的示例代碼,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧2022-07-07