02. 上下文-context
2.1 什么是context
Context是由Golang官方开发的并发控制包，一方面可以用于当请求超时或者被取消时，通知goroutine停止工作，另一方面可以用于在goroutine之间传递请求范围内的值。
2.2 为什么需要context
在并发编程中，通常会启动多个goroutine来处理任务，这些goroutine可能需要共享一些状态信息或者需要在某些条件下停止工作。Context提供了一种机制，可以让我们在不同的goroutine之间传递取消信号和共享状态信息，从而更好地管理并发任务。
2.3 context的使用场景
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
| func main() {
ctx, cancel := context.WithTimeout(context.Background(), 3 * time.Second)
defer cancel()
go SlowOperation(ctx)
go func() {
for {
time.Sleep(300 * time.Millisecond)
fmt.Println("goroutine:", runtime.NumGoroutine())
}
}()
time.Sleep(4 * time.Second)
}
func SlowOperation(ctx context.Context) {
done := make(chan int, 1)
go func() {
dur := time.Duration(rand.Intn(5)+1) * time.Second
time.Sleep(dur)
done <- 1
}()
select {
case <-ctx.Done():
fmt.Println("SlowOperation timeout:", ctx.Err())
case <-done:
fmt.Println("Complete work")
}
}
|
上面代码会不停打印当前groutine数量，可以观察到SlowOperation函数执行超时之后，goroutine数量由4个变成2个，相关goroutetine退出
再看一个关于超时处理的例子
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
|
package main
import (
"context"
"fmt"
"io/ioutil"
"net/http"
"time"
)
func QueryFrameworkStats(ctx context.Context, framework string) <-chan string {
stats := make(chan string)
go func() {
repos := "https://api.github.com/repos/" + framework
req, err := http.NewRequest("GET", repos, nil)
if err != nil {
return
}
req = req.WithContext(ctx)
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
return
}
data, err := ioutil.ReadAll(resp.Body)
if err != nil {
return
}
defer resp.Body.Close()
stats <- string(data)
}()
return stats
}
func main() {
ctx, cancel := context.WithTimeout(context.Background(), 3*time.Second)
defer cancel()
framework := "gin-gonic/gin"
select {
case <-ctx.Done():
fmt.Println(ctx.Err())
case statsInfo := <-QueryFrameworkStats(ctx, framework):
fmt.Println(framework, " fork and start info : ", statsInfo)
}
}
|
Context另外一个用途就是传递上下文信息。从WithValue方法我们可以创建一个可以储存键值的context
2.4 context的类型
1
2
3
4
5
6
7
8
9
10
11
12
|
type Context interface {
Deadline() (deadline time.Time, ok bool)
Done() <-chan struct{}
Err() error
Value(key interface{}) interface{}
}
|
2.5 实现Context接口的类型
Context一共有4个类型，分别是: emptyCtx,cancelCtx,timerCtx,valueCtx
- emptyCtx: 是一个空的context，作为其他context的基础
- cancelCtx: 通过WithCancel函数创建的context类型，支持取消操作
- timerCtx: 通过WithDeadline和WithTimeout函数创建的context类型，支持超时操作
- valueCtx: 通过WithValue函数创建的context类型，支持存储键值对
2.6 Context使用规范
使用Context的是应该准守以下原则来保证在不同包中使用时候的接口一致性，以及能让静态分析工具可以检查context的传播：
不要将Context作为结构体的一个字段存储，相反而应该显示传递Context给每一个需要它的函数，Context应该作为函数的第一个参数，并命名为ctx
不要传递一个nil Context给一个函数，即使该函数能够接受它。如果你不确定使用哪一个Context，那你就传递context.TODO
context是并发安全的，相同的Context能够传递给运行在不同goroutine的函数
__END__
