Go Context庫(kù) 使用基本示例

更新時(shí)間：2024年09月18日 11:41:37 作者：knoci

在Go的http包中,每個(gè)請(qǐng)求由獨(dú)立的goroutine處理,這些goroutine可能需要訪問(wèn)請(qǐng)求特定的數(shù)據(jù)或啟動(dòng)其他服務(wù),Context在Go語(yǔ)言中提供了一種方式來(lái)傳遞請(qǐng)求域的數(shù)據(jù)、取消信號(hào)和截止時(shí)間,本文介紹Go Context庫(kù) 使用基本示例,感興趣的朋友跟隨小編一起看看吧

為什么需要Context

在 Go http包的Server中，每一個(gè)請(qǐng)求在都有一個(gè)對(duì)應(yīng)的 goroutine 去處理。請(qǐng)求處理函數(shù)通常會(huì)啟動(dòng)額外的 goroutine 用來(lái)訪問(wèn)后端服務(wù)，比如數(shù)據(jù)庫(kù)和RPC服務(wù)。

用來(lái)處理一個(gè)請(qǐng)求的 goroutine 通常需要訪問(wèn)一些與請(qǐng)求特定的數(shù)據(jù)，比如終端用戶(hù)的身份認(rèn)證信息、驗(yàn)證相關(guān)的token、請(qǐng)求的截止時(shí)間。

當(dāng)一個(gè)請(qǐng)求被取消或超時(shí)時(shí)，所有用來(lái)處理該請(qǐng)求的 goroutine 都應(yīng)該迅速退出，然后系統(tǒng)才能釋放這些 goroutine 占用的資源。

基本示例

在 Go 語(yǔ)言中，sync.WaitGroup 是一個(gè)用于控制多個(gè)協(xié)程（goroutine）的同步工具，它允許主協(xié)程等待多個(gè)并發(fā)協(xié)程完成工作。WaitGroup 通過(guò)計(jì)數(shù)器來(lái)跟蹤多個(gè)協(xié)程的完成狀態(tài)，每個(gè)協(xié)程在開(kāi)始執(zhí)行前調(diào)用 WaitGroup 的 Add 方法增加計(jì)數(shù)，執(zhí)行完成后調(diào)用 Done 方法減少計(jì)數(shù)。當(dāng)計(jì)數(shù)器歸零時(shí)，表示所有協(xié)程都已完成，主協(xié)程可以繼續(xù)執(zhí)行。

主要方法

Add(delta int)：增加 WaitGroup 的計(jì)數(shù)器，通常在啟動(dòng)協(xié)程之前調(diào)用。delta 可以是任何整數(shù)，通常用于跟蹤需要等待的協(xié)程數(shù)量。
Done()：減少 WaitGroup 的計(jì)數(shù)器，通常在協(xié)程完成工作后調(diào)用。
Wait()：阻塞調(diào)用 Wait 的協(xié)程，直到 WaitGroup 的計(jì)數(shù)器歸零。

package main
import (
	"fmt"
	"sync"
	"time"
)
var wg sync.WaitGroup
// 初始的例子
func worker() {
	for {
		fmt.Println("worker")
		time.Sleep(time.Second)
	}
	// 如何接收外部命令實(shí)現(xiàn)退出
	wg.Done()
}
func main() {
	wg.Add(1)
	go worker()
	// 如何優(yōu)雅的實(shí)現(xiàn)結(jié)束子goroutine
	wg.Wait()
	fmt.Println("over")
}

全局變量方式

        全局變量方式存在的問(wèn)題：
                1. 使用全局變量在跨包調(diào)用時(shí)不容易統(tǒng)一
                2. 如果worker中再啟動(dòng)goroutine，就不太好控制了。

package main
import (
	"fmt"
	"sync"
	"time"
)
var wg sync.WaitGroup
var exit bool
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秒以免程序過(guò)快退出
	exit = true                 // 修改全局變量實(shí)現(xiàn)子goroutine的退出
	wg.Wait()
	fmt.Println("over")
}

通道方式

管道方式存在的問(wèn)題：
1. 使用全局變量在跨包調(diào)用時(shí)不容易實(shí)現(xiàn)規(guī)范和統(tǒng)一，需要維護(hù)一個(gè)共用的channel

package main
import (
	"fmt"
	"sync"
	"time"
)
var wg sync.WaitGroup
func worker(exitChan chan struct{}) {
LOOP:
	for {
		fmt.Println("worker")
		time.Sleep(time.Second)
		select {
		case <-exitChan: // 等待接收上級(jí)通知
			break LOOP
		default:
		}
	}
	wg.Done()
}
func main() {
	var exitChan = make(chan struct{})
	wg.Add(1)
	go worker(exitChan)
	time.Sleep(time.Second * 3) // sleep3秒以免程序過(guò)快退出
	exitChan <- struct{}{}      // 給子goroutine發(fā)送退出信號(hào)
	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(): // 等待上級(jí)通知
			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結(jié)束
	wg.Wait()
	fmt.Println("over")
}

當(dāng)子goroutine又開(kāi)啟另外一個(gè)goroutine時(shí)，只需要將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(): // 等待上級(jí)通知
			break LOOP
		default:
		}
	}
	wg.Done()
}
func worker2(ctx context.Context) {
LOOP:
	for {
		fmt.Println("worker2")
		time.Sleep(time.Second)
		select {
		case <-ctx.Done(): // 等待上級(jí)通知
			break LOOP
		default:
		}
	}
}
func main() {
	ctx, cancel := context.WithCancel(context.Background())
	wg.Add(1)
	go worker(ctx)
	time.Sleep(time.Second * 3)
	cancel() // 通知子goroutine結(jié)束
	wg.Wait()
	fmt.Println("over")
}

Context初識(shí)

Go1.7加入了一個(gè)新的標(biāo)準(zhǔn)庫(kù)context，它定義了Context類(lèi)型，專(zhuān)門(mén)用來(lái)簡(jiǎn)化對(duì)于處理單個(gè)請(qǐng)求的多個(gè) goroutine 之間與請(qǐng)求域的數(shù)據(jù)、取消信號(hào)、截止時(shí)間等相關(guān)操作，這些操作可能涉及多個(gè) API 調(diào)用。

對(duì)服務(wù)器傳入的請(qǐng)求應(yīng)該創(chuàng)建上下文，而對(duì)服務(wù)器的傳出調(diào)用應(yīng)該接受上下文。它們之間的函數(shù)調(diào)用鏈必須傳遞上下文，或者可以使用WithCancel、WithDeadline、WithTimeout或WithValue創(chuàng)建的派生上下文。當(dāng)一個(gè)上下文被取消時(shí)，它派生的所有上下文也被取消。

Context接口

context.Context是一個(gè)接口，該接口定義了四個(gè)需要實(shí)現(xiàn)的方法。具體簽名如下：

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

其中：

Deadline方法需要返回當(dāng)前Context被取消的時(shí)間，也就是完成工作的截止時(shí)間（deadline）；
Done方法需要返回一個(gè)Channel，這個(gè)Channel會(huì)在當(dāng)前工作完成或者上下文被取消之后關(guān)閉，多次調(diào)用Done方法會(huì)返回同一個(gè)Channel；
Err方法會(huì)返回當(dāng)前Context結(jié)束的原因，它只會(huì)在Done返回的Channel被關(guān)閉時(shí)才會(huì)返回非空的值；
- 如果當(dāng)前Context被取消就會(huì)返回Canceled錯(cuò)誤；
- 如果當(dāng)前Context超時(shí)就會(huì)返回DeadlineExceeded錯(cuò)誤；
Value方法會(huì)從Context中返回鍵對(duì)應(yīng)的值，對(duì)于同一個(gè)上下文來(lái)說(shuō)，多次調(diào)用Value 并傳入相同的Key會(huì)返回相同的結(jié)果，該方法僅用于傳遞跨API和進(jìn)程間跟請(qǐng)求域的數(shù)據(jù)；

Background()和TODO()

Go內(nèi)置兩個(gè)函數(shù)：Background()和TODO()，這兩個(gè)函數(shù)分別返回一個(gè)實(shí)現(xiàn)了Context接口的background和todo。我們代碼中最開(kāi)始都是以這兩個(gè)內(nèi)置的上下文對(duì)象作為最頂層的partent context，衍生出更多的子上下文對(duì)象。

Background()主要用于main函數(shù)、初始化以及測(cè)試代碼中，作為Context這個(gè)樹(shù)結(jié)構(gòu)的最頂層的Context，也就是根Context。

TODO()，它目前還不知道具體的使用場(chǎng)景，如果我們不知道該使用什么Context的時(shí)候，可以使用這個(gè)。

background和todo本質(zhì)上都是emptyCtx結(jié)構(gòu)體類(lèi)型，是一個(gè)不可取消，沒(méi)有設(shè)置截止時(shí)間，沒(méi)有攜帶任何值的Context。

With系列函數(shù)

此外，context包中還定義了四個(gè)With系列函數(shù)。

WithCancel

WithCancel的函數(shù)簽名如下：

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

WithCancel返回帶有新Done通道的父節(jié)點(diǎn)的副本。當(dāng)調(diào)用返回的cancel函數(shù)或當(dāng)關(guān)閉父上下文的Done通道時(shí)，將關(guān)閉副本上下文的Done通道，無(wú)論先發(fā)生什么情況。

取消此上下文將釋放與其關(guān)聯(lián)的資源，因此代碼應(yīng)該在此上下文中運(yùn)行的操作完成后立即調(diào)用cancel。

func gen(ctx context.Context) <-chan int {
	dst := make(chan int)
	n := 1
	go func() {
		for {
			select {
			    case <-ctx.Done():
				    return // return結(jié)束該goroutine，防止泄露
			    case dst <- n:
				    n++
			}
		}
	}()
	return dst
}
func main() {
	ctx, cancel := context.WithCancel(context.Background())
	defer cancel() // 當(dāng)我們?nèi)⊥晷枰恼麛?shù)后調(diào)用cancel
	for n := range gen(ctx) {
		fmt.Println(n)
		if n == 5 {
			break
		}
	}
}

上面的示例代碼中，gen函數(shù)在單獨(dú)的goroutine中生成整數(shù)并將它們發(fā)送到返回的通道。 gen的調(diào)用者在使用生成的整數(shù)之后需要取消上下文，以免gen啟動(dòng)的內(nèi)部goroutine發(fā)生泄漏。

WithDeadline

WithDeadline的函數(shù)簽名如下：

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

返回父上下文的副本，并將deadline調(diào)整為不遲于d。如果父上下文的deadline已經(jīng)早于d，則WithDeadline(parent, d)在語(yǔ)義上等同于父上下文。當(dāng)截止日過(guò)期時(shí)，當(dāng)調(diào)用返回的cancel函數(shù)時(shí)，或者當(dāng)父上下文的Done通道關(guān)閉時(shí)，返回上下文的Done通道將被關(guān)閉，以最先發(fā)生的情況為準(zhǔn)。

取消此上下文將釋放與其關(guān)聯(lián)的資源，因此代碼應(yīng)該在此上下文中運(yùn)行的操作完成后立即調(diào)用cancel。

func main() {
	d := time.Now().Add(50 * time.Millisecond)
	ctx, cancel := context.WithDeadline(context.Background(), d)
	// 盡管ctx會(huì)過(guò)期，但在任何情況下調(diào)用它的cancel函數(shù)都是很好的實(shí)踐。
	// 如果不這樣做，可能會(huì)使上下文及其父類(lèi)存活的時(shí)間超過(guò)必要的時(shí)間。
	defer cancel()
	select {
	case <-time.After(1 * time.Second):
		fmt.Println("overslept")
	case <-ctx.Done():
		fmt.Println(ctx.Err())
	}
}

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

在上面的示例代碼中，因?yàn)閏tx 50毫秒后就會(huì)過(guò)期，所以ctx.Done()會(huì)先接收到context到期通知，并且會(huì)打印ctx.Err()的內(nèi)容。

WithTimeout

WithTimeout的函數(shù)簽名如下：

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

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

取消此上下文將釋放與其相關(guān)的資源，因此代碼應(yīng)該在此上下文中運(yùn)行的操作完成后立即調(diào)用cancel，通常用于數(shù)據(jù)庫(kù)或者網(wǎng)絡(luò)連接的超時(shí)控制。具體示例如下：

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) // 假設(shè)正常連接數(shù)據(jù)庫(kù)耗時(shí)10毫秒
		select {
		case <-ctx.Done(): // 50毫秒后自動(dòng)調(diào)用
			break LOOP
		default:
		}
	}
	fmt.Println("worker done!")
	wg.Done()
}
func main() {
	// 設(shè)置一個(gè)50毫秒的超時(shí)
	ctx, cancel := context.WithTimeout(context.Background(), time.Millisecond*50)
	wg.Add(1)
	go worker(ctx)
	time.Sleep(time.Second * 5)
	cancel() // 通知子goroutine結(jié)束
	wg.Wait()
	fmt.Println("over")
}

WithValue

WithValue函數(shù)能夠?qū)⒄?qǐng)求作用域的數(shù)據(jù)與 Context 對(duì)象建立關(guān)系。聲明如下：

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

WithValue返回父節(jié)點(diǎn)的副本，其中與key關(guān)聯(lián)的值為val。

僅對(duì)API和進(jìn)程間傳遞請(qǐng)求域的數(shù)據(jù)使用上下文值，而不是使用它來(lái)傳遞可選參數(shù)給函數(shù)。

所提供的鍵必須是可比較的，并且不應(yīng)該是string類(lèi)型或任何其他內(nèi)置類(lèi)型，以避免使用上下文在包之間發(fā)生沖突。WithValue的用戶(hù)應(yīng)該為鍵定義自己的類(lèi)型。為了避免在分配給interface{}時(shí)進(jìn)行分配，上下文鍵通常具有具體類(lèi)型struct{}?；蛘?，導(dǎo)出的上下文關(guān)鍵變量的靜態(tài)類(lèi)型應(yīng)該是指針或接口。

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) // 假設(shè)正常連接數(shù)據(jù)庫(kù)耗時(shí)10毫秒
		select {
		case <-ctx.Done(): // 50毫秒后自動(dòng)調(diào)用
			break LOOP
		default:
		}
	}
	fmt.Println("worker done!")
	wg.Done()
}
func main() {
	// 設(shè)置一個(gè)50毫秒的超時(shí)
	ctx, cancel := context.WithTimeout(context.Background(), time.Millisecond*50)
	// 在系統(tǒng)的入口中設(shè)置trace code傳遞給后續(xù)啟動(dòng)的goroutine實(shí)現(xiàn)日志數(shù)據(jù)聚合
	ctx = context.WithValue(ctx, TraceCode("TRACE_CODE"), "12512312234")
	wg.Add(1)
	go worker(ctx)
	time.Sleep(time.Second * 5)
	cancel() // 通知子goroutine結(jié)束
	wg.Wait()
	fmt.Println("over")
}

使用Context的注意事項(xiàng)

推薦以參數(shù)的方式顯示傳遞Context
以Context作為參數(shù)的函數(shù)方法，應(yīng)該把Context作為第一個(gè)參數(shù)。
給一個(gè)函數(shù)方法傳遞Context的時(shí)候，不要傳遞nil，如果不知道傳遞什么，就使用
context.TODO()Context的Value相關(guān)方法應(yīng)該傳遞請(qǐng)求域的必要數(shù)據(jù)，不應(yīng)該用于傳遞可選參數(shù)
Context是線程安全的，可以放心的在多個(gè)goroutine中傳遞

客戶(hù)端超時(shí)取消示例

調(diào)用服務(wù)端API時(shí)如何在客戶(hù)端實(shí)現(xiàn)超時(shí)控制？

server端

// context_timeout/server/main.go
package main
import (
	"fmt"
	"math/rand"
	"net/http"
	"time"
)
// server端，隨機(jī)出現(xiàn)慢響應(yīng)
func indexHandler(w http.ResponseWriter, r *http.Request) {
	number := rand.Intn(2)
	if number == 0 {
		time.Sleep(time.Second * 10) // 耗時(shí)10秒的慢響應(yīng)
		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"
)
// 客戶(hù)端
type respData struct {
	resp *http.Response
	err  error
}
func doCall(ctx context.Context) {
	transport := http.Transport{
	   // 請(qǐng)求頻繁可定義全局的client對(duì)象并啟用長(zhǎng)鏈接
	   // 請(qǐng)求不頻繁使用短鏈接
	   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) // 使用帶超時(shí)的ctx創(chuàng)建一個(gè)新的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() {
	// 定義一個(gè)100毫秒的超時(shí)
	ctx, cancel := context.WithTimeout(context.Background(), time.Millisecond*100)
	defer cancel() // 調(diào)用cancel釋放子goroutine資源
	doCall(ctx)
}

到此這篇關(guān)于 Go Context庫(kù) 使用的文章就介紹到這了,更多相關(guān) Go Context庫(kù) 使用內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: