首頁 > 軟體

詳解Golang中Context的三個常見應用場景

2022-12-29 14:00:21

超時取消

假設我們希望HTTP請求在給定時間內完成,超時自動取消。

首先定義超時上下文,設定時間返回取消函數(一旦超時用於清理資源)。呼叫取消函數取消後續操作,刪除子上下文對父的參照。

    ctx, cancel := context.WithTimeout(context.Background(), time.Millisecond*80)
    defer cancel()
    req = req.WithContext(ctx)

還可以通過特定時間進行設定:

/ The context will be cancelled after 3 seconds
// If it needs to be cancelled earlier, the `cancel` function can
// be used, like before
ctx, cancel := context.WithTimeout(ctx, 3*time.Second)

​​​​​​​// Setting a context deadline is similar to setting a timeout, except
// you specify a time when you want the context to cancel, rather than a duration.
// Here, the context will be cancelled on 2022-11-10 23:00:00
ctx, cancel := context.WithDeadline(ctx, time.Date(2022, time.November, 10, 23, 0, 0, 0, time.UTC))

完整範例如下:

func main() {
    //定義請求
	req, err := http.NewRequest(http.MethodGet, "https://www.baidu.com", nil)
	if err != nil {
		log.Fatal(err)
	}

    // 定義上下文
	ctx, cancel := context.WithTimeout(context.Background(), time.Millisecond*80)
	defer cancel()
	req = req.WithContext(ctx)

    // 執行請求
	c := &http.Client{}
	res, err := c.Do(req)
	if err != nil {
		log.Fatal(err)
	}
	defer res.Body.Close()

    // 輸出紀錄檔
	out, err := io.ReadAll(res.Body)
	if err != nil {
		log.Fatal(err)
	}
	log.Println(string(out))
}

超時輸出結果:

2022/12/27 14:36:00 Get "https://www.baidu.com": context deadline exceeded

我們可以調大超時時間,則能正常看到輸出結果。

取消後續操作

有時請求被取消後,需要阻止系統繼續做後續比必要的工作。請看下面使用者發起的http請求,應用程式接收請求後查詢資料庫並返回查詢結果:

正常流程如下:

但如果使用者端取消了請求,如果沒有取消,應用服務和資料庫仍然繼續工作,然後結果卻不能反饋給使用者端。理想狀況為所有下游過程停止,如圖所示:

考慮有兩個相關操作的情況,“相關”的意思是如果一個失敗了,另一個即使完成也沒有意義了。如果已經知道前一個操作失敗了,則希望取消所有相關的操作。請看範例:

func operation1(ctx context.Context) error {
	// 假設該操作因某種原因而失敗
	// 下面模擬業務執行一定時間
	time.Sleep(100 * time.Millisecond)
	return errors.New("failed")
}

func operation2(ctx context.Context) {
	// 該方法要麼正常執行完成
	// 要麼取消,不再繼續執行
	select {
	case <-time.After(500 * time.Millisecond):
		fmt.Println("done")
	case <-ctx.Done():
		fmt.Println("halted operation2")
	}
}

func main() {
	// 建立上下文
	ctx := context.Background()

	// 基於上下文建立需求上下文
	ctx, cancel := context.WithCancel(ctx)

	// 在不同協程中執行兩個操作
	go func() {
		err := operation1(ctx)
		// 如果該方法返回錯誤,則取消該上下文中的後續操作
		if err != nil {
			cancel()
		}
	}()

	// 實用相同上下文執行操作2
	operation2(ctx)
}

由於我們設定操作2執行時間較長,而操作1很快就報錯,因此輸出結果為操作2被取消:

halted operation2

上下文傳值

我們可以實用上下文變數在不同協程中傳遞值。

假設一個操作需要呼叫函數多次,其中用於標識的公共ID需要被 紀錄檔記錄,請看範例:

// 定義key,用於儲存上下文值的鍵
const keyID = "id"

func main() {
    // 定義上下文值
	rand.Seed(time.Now().Unix())
	ctx := context.WithValue(context.Background(), keyID, rand.Int())
	operation1(ctx)
}

func operation1(ctx context.Context) {
	// do some work

	// we can get the value from the context by passing in the key
	log.Println("operation1 for id:", ctx.Value(keyID), " completed")
	operation2(ctx)
}

func operation2(ctx context.Context) {
	// do some work

	// this way, the same ID is passed from one function call to the next
	log.Println("operation2 for id:", ctx.Value(keyID), " completed")
}

這裡在main函數中建立上下文,並採用鍵值對方式儲存id值,從而後續函數呼叫時可以從上下文中獲取該值。如圖所示:

使用context變數在不同操作中傳遞資訊非常有用,主要原因包括:

  • 執行緒安全: 一旦設定了上下文鍵,就不能修改它的值,可以使用context.WithValue方法可以設定新的值
  • 通用方法: 在Go的官方庫和應用程式中大量使用上下文傳遞資料,我們當然最好也使用這種模式

到此這篇關於詳解Golang中Context的三個常見應用場景的文章就介紹到這了,更多相關Golang Context內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com!


IT145.com E-mail:sddin#qq.com