go語言context包功能及操作使用詳解
Context包到底是干嘛用的？
我們會在用到很多東西的時候都看到context的影子，比如gin框架，比如grpc，這東西到底是做啥的？
大家都在用，沒幾個知道這是干嘛的，知其然而不知其所以然
原理說白了就是：
- 當前協(xié)程取消了，可以通知所有由它創(chuàng)建的子協(xié)程退出
- 當前協(xié)程取消了，不會影響到創(chuàng)建它的父級協(xié)程的狀態(tài)
- 擴展了額外的功能：超時取消、定時取消、可以和子協(xié)程共享數(shù)據(jù)
context原理
這就是context包的核心原理，鏈式傳遞context，基于context構造新的context
什么時候應該使用 Context？
- 每一個 RPC 調用都應該有超時退出的能力，這是比較合理的 API 設計
- 不僅僅 是超時，你還需要有能力去結束那些不再需要操作的行為
- context.Context 是 Go 標準的解決方案
- 任何函數(shù)可能被阻塞，或者需要很長時間來完成的，都應該有個 context.Context
如何創(chuàng)建 Context？
在 RPC 開始的時候，使用 context.Background()
有些人把在 main() 里記錄一個 context.Background()，然后把這個放到服務器的某個變量里，然后請求來了后從這個變量里繼承 context。這么做是不對的。直接每個請求，源自自己的 context.Background() 即可。
如果你沒有 context，卻需要調用一個 context 的函數(shù)的話，用 context.TODO()
如果某步操作需要自己的超時設置的話，給它一個獨立的 sub-context（如前面的例子）
主協(xié)程通知有子協(xié)程，子協(xié)程又有多個子協(xié)程
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() //結束前通知子協(xié)程
time.Sleep(2 * time.Second) //等待所有的子協(xié)程輸出
fmt.Println("主協(xié)程結束")
}
//從messages通道獲取信息，當收到結束信號的時候不再接收
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é)程通知結束...\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]被結束...\n", parent, name)
return
default:
fmt.Printf("[%d-%v]執(zhí)行\(zhòng)n", parent, name)
}
}
}
運行結果如下
可以看到，改成context包還是順利的通過子協(xié)程退出了
主要修改了幾個地方，再ctx向下傳遞
基于上層context再構建當前層級的context
監(jiān)聽context的退出信號，
這就是context包的核心原理，鏈式傳遞context，基于context構造新的context
context核心接口
type Context interface {
Deadline() (deadline time.Time, ok bool)
Done() <-chan struct{}
Err() error
Value(key interface{}) interface{}
}
Deadline返回綁定當前context的任務被取消的截止時間；如果沒有設定期限，將返回ok == false。
Done 當綁定當前context的任務被取消時，將返回一個關閉的channel；如果當前context不會被取消，將返回nil。
Err 如果Done返回的channel沒有關閉，將返回nil;如果Done返回的channel已經(jīng)關閉，將返回非空的值表示任務結束的原因。如果是context被取消，Err將返回Canceled；如果是context超時，Err將返回DeadlineExceeded。
Value 返回context存儲的鍵值對中當前key對應的值，如果沒有對應的key,則返回nil。
emptyCtx結構體
實現(xiàn)了context接口，emptyCtx沒有超時時間，不能取消，也不能存儲額外信息，所以emptyCtx用來做根節(jié)點，一般用Background和TODO來初始化emptyCtx
Backgroud
通常用于主函數(shù)，初始化以及測試，作為頂層的context
context.Background()
TODO
不確定使用什么用context的時候才會使用
valueCtx結構體
type valueCtx struct{ Context key, val interface{} }
valueCtx利用Context的變量來表示父節(jié)點context，所以當前context繼承了父context的所有信息
valueCtx還可以存儲鍵值。
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}
}
添加鍵值會返回創(chuàng)建一個新的valueCtx子節(jié)點
Value向context取值
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é)點
示例
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")
}
運行結果
可以看到，子context是可以獲取所有父級設置過的key
WithCancel可取消的context
用來創(chuàng)建一個可取消的context，返回一個context和一個CancelFunc，調用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)
// 主線程給的結束時間
time.Sleep(2 * time.Second)
cancel() // 調用取消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)
}
}
}
結果：
cancelCtx結構體
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-超時取消context
返回一個基于parent的可取消的context，并且過期時間deadline不晚于所設置時間d
WithTimeout-超時取消context
創(chuàng)建一個定時取消context，和WithDeadline差不多，WithTimeout是相對時間
timerCtx結構體
timerCtx是基于cancelCtx的context精英，是一種可以定時取消的context，過期時間的deadline不晚于所設置的時間d
示例：
package main
import (
"context"
"fmt"
"time"
)
func main() {
// 設置超時時間
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()
// 給時間調用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)
}
}
}
運行結果：
1 do 3 do 2 do 1 end 3 end 2 end
可以看到，雖然我們沒有調用cancel方法，5秒后自動調用了，所有的子goroutine都已經(jīng)收到停止信號
總結核心原理
- Done方法返回一個channel
- 外部通過調用<-channel監(jiān)聽cancel方法
- cancel方法會調用close(channel)
當調用close方法的時候，所有的channel再次從通道獲取內容，會返回零值和false
res,ok := <-done:
- 過期自動取消，使用了time.AfterFunc方法，到時調用cancel方法
c.timer = time.AfterFunc(dur, func() {
c.cancel(true, DeadlineExceeded)
})以上就是go語言context包功能及操作使用詳解的詳細內容，更多關于go語言context包的資料請關注腳本之家其它相關文章！
相關文章
這篇文章主要介紹了Go語言實現(xiàn)順序存儲的線性表的方法,實例分析了Go語言實現(xiàn)線性表的定義、插入、刪除元素等的使用技巧,具有一定參考借鑒價值,需要的朋友可以參考下2015-03-03
本文給大家分享的是Golang使用zlib壓縮和解壓縮字符串的方法和示例，有需要的小伙伴可以參考下2017-02-02
go get 從指定源上面下載或者更新指定的代碼和依賴，并對他們進行編譯和安裝，但go get功能比較差，所以下面這篇文章主要給大家介紹了關于利用dep代替go get獲取私有庫的相關資料，需要的朋友可以參考借鑒，下面來一起看看吧。2017-11-11
這篇文章主要介紹了go判斷文件夾是否存在,并創(chuàng)建的實例，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2020-12-12
在Go的日常開發(fā)中,Context上下文對象無處不在,這篇文章小編就來帶大家深入了解一下上下文context的理解與使用,文中的示例代碼講解詳細,需要的可以參考下2023-10-10
這篇文章主要為大家介紹了Go語言Goroutinue和管道效率使用詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪2022-09-09
這篇文章主要為大家介紹了Go應用正確的CPU核數(shù)分析，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪2023-06-06
這篇文章主要介紹了線上問題排查之golang使用json進行對象copy，文章圍繞golang使用json進行對象copy的內存溢出問題排查展開詳細內容需要的小伙伴可以參考一下2022-06-06
這篇文章主要介紹了一文秒懂Go 編寫命令行工具的代碼,本文給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下2021-01-01
今天小編就為大家分享一篇關于在go中使用omitempty的代碼實例，小編覺得內容挺不錯的，現(xiàn)在分享給大家，具有很好的參考價值，需要的朋友一起跟隨小編來看看吧2019-04-04