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 が処理を行います。リクエスト処理関数は通常、データベースや RPC サービスなどのバックエンドサービスにアクセスするために追加の goroutine を起動します。リクエストを処理する goroutine は、通常、エンドユーザーの認証情報、検証関連のトークン、リクエストの締切時間など、リクエスト特有のデータにアクセスする必要があります。リクエストがキャンセルされたりタイムアウトした場合、リクエストを処理するために使用されるすべての 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) // プログラムが早く終了しないように3秒スリープ
exit = true // グローバル変数を変更して子goroutineを終了させる
wg.Wait()
fmt.Println("over")
}
チャネル方式#
package main
import (
"fmt"
"sync"
"time"
)
var wg sync.WaitGroup
// チャネル方式の問題点:
// 1. グローバル変数を使用すると、パッケージ間での規範と統一が難しく、共用のチャネルを維持する必要がある
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) // プログラムが早く終了しないように3秒スリープ
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 間でリクエストスコープのデータ、キャンセル信号、締切時間などの関連操作を簡素化するために特化しています。
サーバーに渡されるリクエストはコンテキストを作成する必要があり、サーバーからの呼び出しはコンテキストを受け取る必要があります。これらの間の関数呼び出しチェーンはコンテキストを渡さなければならず、またはWithCancel
、WithDeadline
、WithTimeout
、またはWithValue
で作成された派生コンテキストを使用できます。コンテキストがキャンセルされると、それに派生するすべてのコンテキストもキャンセルされます。
Context インターフェース#
context.Context
はインターフェースであり、4 つの実装が必要なメソッドを定義しています。具体的なシグネチャは次のとおりです:
type Context interface {
Deadline() (deadline time.Time, ok bool)
Done() <-chan struct{}
Err() error
Value(key interface{}) interface{}
}
ここで:
Deadline
メソッドは、現在のContext
がキャンセルされる時間、つまり作業の締切時間を返す必要があります;Done
メソッドは、現在の作業が完了するか、コンテキストがキャンセルされた後に閉じられるChannel
を返す必要があります。Done
メソッドを複数回呼び出すと、同じチャネルが返されます;Err
メソッドは、現在のContext
が終了する理由を返します。これは、Done
が返すチャネルが閉じられたときにのみ非空の値を返します;- 現在の
Context
がキャンセルされた場合はCanceled
エラーが返されます; - 現在の
Context
がタイムアウトした場合はDeadlineExceeded
エラーが返されます;
- 現在の
Value
メソッドは、Context
からキーに対応する値を返します。同じコンテキストに対して、同じキーを渡してValue
を複数回呼び出すと、同じ結果が返されます。このメソッドは、API 間やプロセス間でリクエストスコープのデータを渡すためのものです;
Background () と TODO ()#
Go には 2 つの組み込み関数があります:Background()
とTODO()
。これらの関数は、それぞれContext
インターフェースを実装したbackground
とtodo
を返します。私たちのコードでは、最初はこれらの 2 つの組み込みコンテキストオブジェクトを最上位のparent context
として使用し、さらに多くの子コンテキストオブジェクトを派生させます。
Background()
は主に main 関数、初期化、およびテストコードで使用され、Context のツリー構造の最上位の Context、つまりルート Context として機能します。
TODO()
は、まだ具体的な使用シーンが不明な場合に使用されます。どのコンテキストを使用すべきかわからない場合は、これを使用できます。
background
とtodo
は本質的にemptyCtx
構造体タイプであり、キャンセルできず、締切時間が設定されておらず、値を持たない Context です。
With シリーズ関数#
さらに、context
パッケージには 4 つの 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 // この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)
親コンテキストのコピーを返し、締切を d より遅くならないように調整します。親コンテキストの締切がすでに 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 ミリ秒後に期限切れになる締切を定義し、context.WithDeadline(context.Background(), d)
を呼び出してコンテキスト(ctx)とキャンセル関数(cancel)を取得します。その後、select を使用してメインプログラムを待機させます:1 秒後にoverslept
を印刷して終了するか、ctx が期限切れになるのを待ちます。
上記の例では、ctx は 50 ミリ秒後に期限切れになるため、ctx.Done()
が最初にコンテキストの期限切れ通知を受け取り、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
は親ノードのコピーを返し、キーに関連付けられた値を val に設定します。
API やプロセス間でリクエストスコープのデータを渡すためにのみコンテキスト値を使用し、関数にオプションのパラメータを渡すために使用しないでください。
提供されたキーは比較可能でなければならず、string
型や他の組み込み型であってはならず、パッケージ間での衝突を避ける必要があります。WithValue
のユーザーはキーの独自の型を定義する必要があります。コンテキストキーは通常、具体的な型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("無効な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 を呼び出す際に、クライアントでタイムアウト制御を実現する方法は?
サーバー側#
// context_timeout/server/main.go
package main
import (
"fmt"
"math/rand"
"net/http"
"time"
)
// サーバー側、ランダムに遅延応答
func indexHandler(w http.ResponseWriter, r *http.Request) {
number := rand.Intn(2)
if number == 0 {
time.Sleep(time.Second * 10) // 10秒の遅延応答
fmt.Fprintf(w, "遅延応答")
return
}
fmt.Fprint(w, "迅速な応答")
}
func main() {
http.HandleFunc("/", indexHandler)
err := http.ListenAndServe(":8000", nil)
if err != nil {
panic(err)
}
}
クライアント側#
// 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("新しいリクエストの作成に失敗しました, err:%v\n", err)
return
}
req = req.WithContext(ctx) // タイムアウト付きのctxを使用して新しいclientリクエストを作成
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("API呼び出しタイムアウト")
case result := <-respChan:
fmt.Println("サーバーAPI呼び出し成功")
if result.err != nil {
fmt.Printf("サーバーAPI呼び出しに失敗しました, 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)
}