Golang 語言中 Context 的使用方式

大家好，我是 frank。
歡迎大家點擊上方藍色文字「Golang 語言開發棧」關注公衆號。
設爲星標，第一時間接收推送文章。

介紹

在 Golang 語言併發編程中，經常會遇到監控 goroutine 運行結束的場景，通常我們會想到使用 WaitGroup 和 chan + select，其中 WaitGroup 用於監控一組 goroutine 是否全部運行結束，chan + select 用於監控一個 goroutine 是否運行結束（取消一個 goroutine）。

如果我們需要監控多個 goroutine 是否運行結束（取消多個 goroutine），通常會使用 context，當然使用 context 也可以用於監控一個 goroutine 是否運行結束（取消一個 goroutine）。我們在之前的文章已經介紹過 Golang 語言標準庫 Context，未閱讀的讀者朋友們可以按需翻閱。本文我們主要介紹 Context 的一些使用方式。

取消一個 goroutine

使用 context 取消一個 goroutine，比較類似於使用 chan + select 的方式取消一個 goroutine。

示例代碼：

func main () {
 ctx, cancel := context.WithCancel(context.Background())
 go func(ctx context.Context) {
  for {
   select {
    case <-ctx.Done():
     fmt.Println("goroutine 已停止")
     return
   default:
    fmt.Println("goroutine 正在運行")
    time.Sleep(time.Second)
   }
  }
 }(ctx)
 time.Sleep(time.Second \* 5)
 cancel()
 time.Sleep(time.Second \* 5)
 fmt.Println("main goroutine 已結束")
}

閱讀上面這段代碼，我們首先使用 context.Background() 創建一個 context 樹的根節點，然後使用 context.WithCancel() 創建一個可取消的子 context 類型的變量 ctx，作爲參數傳遞給子 goroutine，用作跟蹤子 goroutine。

然後在子 goroutine 中，使用 for select 監控 <-ctx.Done() 判斷子 goroutine 是否運行結束。

最後使用 context.WithCancel() 返回的第二個值 CancelFunc 類型的 cancel 變量給子 goroutine 發送取消指令。

取消多個 goroutine

接下來，我們再來看一個使用 context 停止多個 goroutine 的示例。

func main () {
 ctx, cancel := context.WithCancel(context.Background())
  // 停止多個 goroutine
 go worker(ctx, "節點一")
 go worker(ctx, "節點二")
 go worker(ctx, "節點三")
 time.Sleep(time.Second \* 5)
 cancel()
 time.Sleep(time.Second \* 5)
 fmt.Println("main goroutine 已結束")
}

func worker (ctx context.Context, node string) {
 for {
  select {
   case <-ctx.Done():
    fmt.Println(node, "goroutine 已停止")
    return
  default:
   fmt.Println(node, "goroutine 正在運行")
   time.Sleep(time.Second)
  }
 }
}

閱讀上面這段代碼，我們使用 go 關鍵字啓動三個 worker goroutine，和上個示例一樣，首先創建一個 context 樹的根節點，使用第一個返回值 context 類型的子 ctx 跟蹤每一個 worker goroutine，在 worker 中使用 for seclect 監控 <-ctx.Done() 判斷子 goroutine 是否運行結束，最後通過調用第二個返回值 CancelFunc 類型的 cancel 給子 goroutine 發送取消指令，此時所有子 context 都會接收到取消指令，goroutine 結束運行。

上下文信息傳遞

我們在前面的示例中使用 WithCancel 函數，用作取消 context，除此之外，可用作取消 Context 的函數還有 WithDeadline 函數和 WithTimeout 函數，分別用於定時取消和超時取消，限於篇幅，本文不再贅述，感興趣的讀者可以查閱官方標準庫文檔。除了上述三個函數外，還有一個 WithValue 函數，它是用作上下文信息傳遞的一個函數。

在 Golang 語言中，Context 包還有一個重要的作用，就是用作上下文信息傳遞，接下來我們介紹一下如何使用 WithValue 函數傳遞上下文信息。

示例代碼：

func main () {
 ctx, cancel := context.WithCancel(context.Background())
 // 傳遞上下文信息
 ctxValue := context.WithValue(ctx, "uid", 1)
 go func(ctx context.Context) {
  for {
   select {
    case <-ctx.Done():
     fmt.Println(ctx.Value("uid"), "goroutine 已停止")
     return
   default:
    fmt.Println("goroutine 正在運行")
    time.Sleep(time.Second)
   }
  }
 }(ctxValue)
 time.Sleep(time.Second \* 5)
 cancel()
 time.Sleep(time.Second \* 5)
 fmt.Println("main goroutine 已結束")
}

閱讀上面這段代碼，我們使用 WithValue 函數給子 goroutine 傳遞上下文信息 uid。WithValue 函數接收三個參數，分別是 parent context，key 和 value。返回值是一個 context，我們可以在子 goroutine 中調用 Value 方法獲取傳遞的上下文信息。

總結

本文我們簡述了監控 goroutine 的幾種方式，分別是 WaitGroup，chan + select 和 context。重點介紹了 context 的一些使用方式，分別是取消一個 goroutine，取消多個 goroutine 和傳遞上下文信息。關於定時取消和超時取消，感興趣的讀者可以參閱官方標準庫文檔。

參考資料：
https://golang.org/pkg/context/
https://blog.golang.org/context
https://blog.wu-boy.com/2020/08/three-ways-to-manage-concurrency-in-go/
https://gobyexample.com/context

本文由 Readfog 進行 AMP 轉碼，版權歸原作者所有。

猜你喜歡