banner
biuaxia

biuaxia

"万物皆有裂痕，那是光进来的地方。"
github
bilibili
tg_channel
首頁封存

【轉載】Go標準庫Context

114
AI 翻譯
這篇文章透過AI由簡體中文翻譯成繁體中文。查看原文
AI 生成的摘要
【轉載】Go標準庫Context介紹了在Go語言中使用Context來處理單個請求的多個goroutine之間的數據、取消信號、截止時間等操作。Context是一個接口，定義了四個方法，包括Deadline、Done、Err和Value。另外，還介紹了Background()和TODO()這兩個內置函數，以及WithCancel等With系列函數的使用。

title: 【轉載】Go 標準庫 Context
date: 2021-08-09 16:38:33
comment: false
toc: true
category:

  • Golang
    tags:
  • 轉載
  • Go
  • 標準庫
  • Context

本文轉載自：Go 標準庫 Context | 李文周的博客

在 Go http 包的 Server 中，每一個請求在都有一個對應的 goroutine 去處理。請求處理函數通常會啟動額外的 goroutine 用來訪問後端服務，比如資料庫和 RPC 服務。用來處理一個請求的 goroutine 通常需要訪問一些與請求特定的資料，比如終端用戶的身份認證資訊、驗證相關的 token、請求的截止時間。 當一個請求被取消或超時時，所有用來處理該請求的 goroutine 都應該迅速退出，然後系統才能釋放這些 goroutine 占用的資源。

為什麼需要 Context#

基本示例#

package main  

import (  
	"fmt"  
	"sync"  

	"time"  
)  

var wg sync.WaitGroup  

// 初始的例子  

func worker() {  
	for {  
		fmt.Println("worker")  
		time.Sleep(time.Second)  
	}  
	// 如何接收外部命令實現退出  
	wg.Done()  
}  

func main() {  
	wg.Add(1)  
	go worker()  
	// 如何優雅的實現結束子goroutine  
	wg.Wait()  
	fmt.Println("over")  
}

全局變數方式#

package main  

import (  
	"fmt"  
	"sync"  

	"time"  
)  

var wg sync.WaitGroup  
var exit bool  

// 全局變數方式存在的問題：  
// 1. 使用全局變數在跨包調用時不容易統一  
// 2. 如果worker中再啟動goroutine，就不太好控制了。  

func worker() {  
	for {  
		fmt.Println("worker")  
		time.Sleep(time.Second)  
		if exit {  
			break  
		}  
	}  
	wg.Done()  
}  

func main() {  
	wg.Add(1)  
	go worker()  
	time.Sleep(time.Second * 3) // sleep3秒以免程序過快退出  
	exit = true                 // 修改全局變數實現子goroutine的退出  
	wg.Wait()  
	fmt.Println("over")  
}

通道方式#

package main  

import (  
	"fmt"  
	"sync"  

	"time"  
)  

var wg sync.WaitGroup  

// 管道方式存在的問題：  
// 1. 使用全局變數在跨包調用時不容易實現規範和統一，需要維護一個共用的channel  

func worker(exitChan chan struct{}) {  
LOOP:  
	for {  
		fmt.Println("worker")  
		time.Sleep(time.Second)  
		select {  
		case <-exitChan: // 等待接收上級通知  
			break LOOP  
		default:  
		}  
	}  
	wg.Done()  
}  

func main() {  
	var exitChan = make(chan struct{})  
	wg.Add(1)  
	go worker(exitChan)  
	time.Sleep(time.Second * 3) // sleep3秒以免程序過快退出  
	exitChan <- struct{}{}      // 給子goroutine發送退出信號  
	close(exitChan)  
	wg.Wait()  
	fmt.Println("over")  
}

官方版的方案#

package main  

import (  
	"context"  
	"fmt"  
	"sync"  

	"time"  
)  

var wg sync.WaitGroup  

func worker(ctx context.Context) {  
LOOP:  
	for {  
		fmt.Println("worker")  
		time.Sleep(time.Second)  
		select {  
		case <-ctx.Done(): // 等待上級通知  
			break LOOP  
		default:  
		}  
	}  
	wg.Done()  
}  

func main() {  
	ctx, cancel := context.WithCancel(context.Background())  
	wg.Add(1)  
	go worker(ctx)  
	time.Sleep(time.Second * 3)  
	cancel() // 通知子goroutine結束  
	wg.Wait()  
	fmt.Println("over")  
}

當子 goroutine 又開啟另外一個 goroutine 時，只需要將 ctx 傳入即可：

package main  

import (  
	"context"  
	"fmt"  
	"sync"  

	"time"  
)  

var wg sync.WaitGroup  

func worker(ctx context.Context) {  
	go worker2(ctx)  
LOOP:  
	for {  
		fmt.Println("worker")  
		time.Sleep(time.Second)  
		select {  
		case <-ctx.Done(): // 等待上級通知  
			break LOOP  
		default:  
		}  
	}  
	wg.Done()  
}  

func worker2(ctx context.Context) {  
LOOP:  
	for {  
		fmt.Println("worker2")  
		time.Sleep(time.Second)  
		select {  
		case <-ctx.Done(): // 等待上級通知  
			break LOOP  
		default:  
		}  
	}  
}  
func main() {  
	ctx, cancel := context.WithCancel(context.Background())  
	wg.Add(1)  
	go worker(ctx)  
	time.Sleep(time.Second * 3)  
	cancel() // 通知子goroutine結束  
	wg.Wait()  
	fmt.Println("over")  
}

Context 初識#

Go1.7 加入了一個新的標準庫context，它定義了Context類型，專門用來簡化 對於處理單個請求的多個 goroutine 之間與請求域的資料、取消信號、截止時間等相關操作，這些操作可能涉及多個 API 調用。

對伺服器傳入的請求應該創建上下文，而對伺服器的傳出調用應該接受上下文。它們之間的函數調用鏈必須傳遞上下文，或者可以使用WithCancel、WithDeadline、WithTimeout或WithValue創建的派生上下文。當一個上下文被取消時，它派生的所有上下文也被取消。

Context 介面#

context.Context是一個介面，該介面定義了四個需要實現的方法。具體簽名如下：

type Context interface {  
    Deadline() (deadline time.Time, ok bool)  
    Done() <-chan struct{}  
    Err() error  
    Value(key interface{}) interface{}  
}

其中：

  • Deadline方法需要返回當前Context被取消的時間，也就是完成工作的截止時間（deadline）；
  • Done方法需要返回一個Channel，這個 Channel 會在當前工作完成或者上下文被取消之後關閉，多次調用Done方法會返回同一個 Channel；
  • Err方法會返回當前Context結束的原因，它只會在Done返回的 Channel 被關閉時才會返回非空的值；
    • 如果當前Context被取消就會返回Canceled錯誤；
    • 如果當前Context超時就會返回DeadlineExceeded錯誤；
  • Value方法會從Context中返回鍵對應的值，對於同一個上下文來說，多次調用Value並傳入相同的Key會返回相同的結果，該方法僅用於傳遞跨 API 和進程間跟請求域的資料；

Background () 和 TODO ()#

Go 內置兩個函數：Background()和TODO()，這兩個函數分別返回一個實現了Context介面的background和todo。我們程式碼中最開始都是以這兩個內置的上下文物件作為最頂層的partent context，衍生出更多的子上下文物件。

Background()主要用於 main 函數、初始化以及測試程式碼中，作為 Context 這個樹結構的最頂層的 Context，也就是根 Context。

TODO()，它目前還不知道具體的使用場景，如果我們不知道該使用什麼 Context 的時候，可以使用這個。

background和todo本質上都是emptyCtx構造體類型，是一個不可取消，沒有設置截止時間，沒有攜帶任何值的 Context。

With 系列函數#

此外，context包中還定義了四個 With 系列函數。

WithCancel#

WithCancel的函數簽名如下：

func WithCancel(parent Context) (ctx Context, cancel CancelFunc)

WithCancel返回帶有新 Done 通道的父節點的副本。當調用返回的 cancel 函數或當關閉父上下文的 Done 通道時，將關閉返回上下文的 Done 通道，無論先發生什麼情況。

取消此上下文將釋放與其關聯的資源，因此程式碼應該在此上下文中運行的操作完成後立即調用 cancel。

func gen(ctx context.Context) <-chan int {  
		dst := make(chan int)  
		n := 1  
		go func() {  
			for {  
				select {  
				case <-ctx.Done():  
					return // return結束該goroutine，防止洩漏  
				case dst <- n:  
					n++  
				}  
			}  
		}()  
		return dst  
	}  
func main() {  
	ctx, cancel := context.WithCancel(context.Background())  
	defer cancel() // 當我們取完需要的整數後調用cancel  

	for n := range gen(ctx) {  
		fmt.Println(n)  
		if n == 5 {  
			break  
		}  
	}  
}

上面的示例程式碼中，gen函數在單獨的 goroutine 中生成整數並將它們發送到返回的通道。 gen 的調用者在使用生成的整數之後需要取消上下文，以免gen啟動的內部 goroutine 發生洩漏。

WithDeadline#

WithDeadline的函數簽名如下：

func WithDeadline(parent Context, deadline time.Time) (Context, CancelFunc)

返回父上下文的副本，並將 deadline 調整為不遲於 d。如果父上下文的 deadline 已經早於 d，則 WithDeadline (parent, d) 在語義上等同於父上下文。當截止日過期時，當調用返回的 cancel 函數時，或者當父上下文的 Done 通道關閉時，返回上下文的 Done 通道將被關閉，以最先發生的情況為準。

取消此上下文將釋放與其關聯的資源，因此程式碼應該在此上下文中運行的操作完成後立即調用 cancel。

func main() {  
	d := time.Now().Add(50 * time.Millisecond)  
	ctx, cancel := context.WithDeadline(context.Background(), d)  

	// 儘管ctx會過期，但在任何情況下調用它的cancel函數都是很好的實踐。  
	// 如果不這樣做，可能會使上下文及其父類存活的時間超過必要的時間。  
	defer cancel()  

	select {  
	case <-time.After(1 * time.Second):  
		fmt.Println("overslept")  
	case <-ctx.Done():  
		fmt.Println(ctx.Err())  
	}  
}

上面的程式碼中，定義了一個 50 毫秒之後過期的 deadline，然後我們調用context.WithDeadline(context.Background(), d)得到一個上下文（ctx）和一個取消函數（cancel），然後使用一個 select 讓主程序陷入等待：等待 1 秒後打印overslept退出或者等待 ctx 過期後退出。

在上面的示例程式碼中，因為 ctx 50 毫秒後就會過期，所以ctx.Done()會先接收到 context 到期通知，並且會打印 ctx.Err () 的內容。

WithTimeout#

WithTimeout的函數簽名如下：

func WithTimeout(parent Context, timeout time.Duration) (Context, CancelFunc)

WithTimeout返回WithDeadline(parent, time.Now().Add(timeout))。

取消此上下文將釋放與其相關的資源，因此程式碼應該在此上下文中運行的操作完成後立即調用 cancel，通常用於資料庫或者網路連接的超時控制。具體示例如下：

package main  

import (  
	"context"  
	"fmt"  
	"sync"  

	"time"  
)  

// context.WithTimeout  

var wg sync.WaitGroup  

func worker(ctx context.Context) {  
LOOP:  
	for {  
		fmt.Println("db connecting ...")  
		time.Sleep(time.Millisecond * 10) // 假設正常連接資料庫耗時10毫秒  
		select {  
		case <-ctx.Done(): // 50毫秒後自動調用  
			break LOOP  
		default:  
		}  
	}  
	fmt.Println("worker done!")  
	wg.Done()  
}  

func main() {  
	// 設置一個50毫秒的超時  
	ctx, cancel := context.WithTimeout(context.Background(), time.Millisecond*50)  
	wg.Add(1)  
	go worker(ctx)  
	time.Sleep(time.Second * 5)  
	cancel() // 通知子goroutine結束  
	wg.Wait()  
	fmt.Println("over")  
}

WithValue#

WithValue函數能夠將請求作用域的資料與 Context 物件建立關係。聲明如下：

func WithValue(parent Context, key, val interface{}) Context

WithValue返回父節點的副本，其中與 key 關聯的值為 val。

僅對 API 和進程間傳遞請求域的資料使用上下文值，而不是使用它來傳遞可選參數給函數。

所提供的鍵必須是可比較的，並且不應該是string類型或任何其他內置類型，以避免使用上下文在包之間發生衝突。WithValue的用戶應該為鍵定義自己的類型。為了避免在分配給 interface {} 時進行分配，上下文鍵通常具有具體類型struct{}。或者，導出的上下文關鍵變數的靜態類型應該是指針或介面。

package main  

import (  
	"context"  
	"fmt"  
	"sync"  

	"time"  
)  

// context.WithValue  

type TraceCode string  

var wg sync.WaitGroup  

func worker(ctx context.Context) {  
	key := TraceCode("TRACE_CODE")  
	traceCode, ok := ctx.Value(key).(string) // 在子goroutine中獲取trace code  
	if !ok {  
		fmt.Println("invalid trace code")  
	}  
LOOP:  
	for {  
		fmt.Printf("worker, trace code:%s\n", traceCode)  
		time.Sleep(time.Millisecond * 10) // 假設正常連接資料庫耗時10毫秒  
		select {  
		case <-ctx.Done(): // 50毫秒後自動調用  
			break LOOP  
		default:  
		}  
	}  
	fmt.Println("worker done!")  
	wg.Done()  
}  

func main() {  
	// 設置一個50毫秒的超時  
	ctx, cancel := context.WithTimeout(context.Background(), time.Millisecond*50)  
	// 在系統的入口中設置trace code傳遞給後續啟動的goroutine實現日誌資料聚合  
	ctx = context.WithValue(ctx, TraceCode("TRACE_CODE"), "12512312234")  
	wg.Add(1)  
	go worker(ctx)  
	time.Sleep(time.Second * 5)  
	cancel() // 通知子goroutine結束  
	wg.Wait()  
	fmt.Println("over")  
}

使用 Context 的注意事項#

  • 推薦以參數的方式顯示傳遞 Context
  • 以 Context 作為參數的函數方法，應該把 Context 作為第一個參數。
  • 給一個函數方法傳遞 Context 的時候，不要傳遞 nil，如果不知道傳遞什麼，就使用 context.TODO ()
  • Context 的 Value 相關方法應該傳遞請求域的必要資料，不應該用於傳遞可選參數
  • Context 是執行緒安全的，可以放心的在多個 goroutine 中傳遞

客戶端超時取消示例#

調用服務端 API 時如何在客戶端實現超時控制？

server 端#

// context_timeout/server/main.go  
package main  

import (  
	"fmt"  
	"math/rand"  
	"net/http"  

	"time"  
)  

// server端，隨機出現慢響應  

func indexHandler(w http.ResponseWriter, r *http.Request) {  
	number := rand.Intn(2)  
	if number == 0 {  
		time.Sleep(time.Second * 10) // 耗時10秒的慢響應  
		fmt.Fprintf(w, "slow response")  
		return  
	}  
	fmt.Fprint(w, "quick response")  
}  

func main() {  
	http.HandleFunc("/", indexHandler)  
	err := http.ListenAndServe(":8000", nil)  
	if err != nil {  
		panic(err)  
	}  
}

client 端#

// context_timeout/client/main.go  
package main  

import (  
	"context"  
	"fmt"  
	"io/ioutil"  
	"net/http"  
	"sync"  
	"time"  
)  

// 客戶端  

type respData struct {  
	resp *http.Response  
	err  error  
}  

func doCall(ctx context.Context) {  
	transport := http.Transport{  
	   // 請求頻繁可定義全局的client物件並啟用長鏈接  
	   // 請求不頻繁使用短鏈接  
	   DisableKeepAlives: true,  	
	}  
	client := http.Client{  
		Transport: &transport,  
	}  

	respChan := make(chan *respData, 1)  
	req, err := http.NewRequest("GET", "http://127.0.0.1:8000/", nil)  
	if err != nil {  
		fmt.Printf("new requestg failed, err:%v\n", err)  
		return  
	}  
	req = req.WithContext(ctx) // 使用帶超時的ctx創建一個新的client request  
	var wg sync.WaitGroup  
	wg.Add(1)  
	defer wg.Wait()  
	go func() {  
		resp, err := client.Do(req)  
		fmt.Printf("client.do resp:%v, err:%v\n", resp, err)  
		rd := &respData{  
			resp: resp,  
			err:  err,  
		}  
		respChan <- rd  
		wg.Done()  
	}()  

	select {  
	case <-ctx.Done():  
		//transport.CancelRequest(req)  
		fmt.Println("call api timeout")  
	case result := <-respChan:  
		fmt.Println("call server api success")  
		if result.err != nil {  
			fmt.Printf("call server api failed, err:%v\n", result.err)  
			return  
		}  
		defer result.resp.Body.Close()  
		data, _ := ioutil.ReadAll(result.resp.Body)  
		fmt.Printf("resp:%v\n", string(data))  
	}  
}  

func main() {  
	// 定義一個100毫秒的超時  
	ctx, cancel := context.WithTimeout(context.Background(), time.Millisecond*100)  
	defer cancel() // 調用cancel釋放子goroutine資源  
	doCall(ctx)  
}
載入中......
此文章數據所有權由區塊鏈加密技術和智能合約保障僅歸創作者所有。