1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

type Context interface {
    // 返回一个设置结束的时间，和OK
    Deadline() (deadline time.Time, ok bool)
    // Done 是一个只读的 channel
    Done() <-chan struct{}
    // 错误
    Err() error
    // 接收一个 key,返回一个 value
    Value(key interface{}) interface{}
}

1
2
3
4

// WithCancel 需在Main中使用,并且需要传根Context。( Background()或TODO() )
func WithCancel(parent Context) (ctx Context, cancel CancelFunc)

// 返回一个 ctx Context 和 一个 cancel函数

 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

package main

import (
	"context"
	"fmt"
)

// 创建一个 gen 函数, 返回一个 只读 int类型的 channel
func gen(ctx context.Context) <-chan int {
	// 创建并初始化一个 int 类型的通道
	dst := make(chan int)
	n := 1
	// 启动 goroutine
	// 闭包
	go func() {
		// 无限循环
		for {
			select {
			// 当 ctx.Done() 可以取到值的时候
			case <-ctx.Done():
				// return 结束该 goroutine 防止内存泄露
				return
			case dst <- n:
				// n = 1; n = n + 1
				n++
			}
		}
	}()
	// 返回 dst 通道
	return dst
}
func main() {
	// 创建一个 ctx 子 context
	ctx, cancel := context.WithCancel(context.Background())
	// main函数运行完以后执行 cancel。 退出 goroutine 。
	// main函数通过 ctx ( context ) 传递信号。
	defer cancel()
	// 循环 gen 函数 return 回来的 dst 通道
	for n := range gen(ctx) {
		fmt.Println(n)
		if n == 5 {
			break
		}
	}
}

 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

package main

import (
	"context"
	"fmt"
	"time"
)

func main() {
	// 获取当前时间 加 50 毫秒
	d := time.Now().Add(50 * time.Millisecond)

	// context 调用 withDeadline 传入 d
	ctx, cancel := context.WithDeadline(context.Background(), d)

	// main 函数执行完以后,发送关闭指令
        // ctx 会自动过期,但是官方建议还是尽量调用 cancel() 。
	defer cancel()

	select {
	// 1秒 后 会走 这个 case 分支
	case <-time.After(1 * time.Second):
		fmt.Println("overslept")
	// d = 50毫秒 结束, 会先走这个 case 分支
	case <-ctx.Done():
		// context 会报: context deadline exceeded 错误
		fmt.Println(ctx.Err())
	}
}

1
2

context deadline exceeded

 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
53
54
55

package main

import (
	"context"
	"fmt"
	"sync"
	"time"
)

// context.WithTimeout

// 定义全局的 等待组
var wg sync.WaitGroup

func worker(ctx context.Context) {
LOOP:
	for {
		fmt.Println("db connecting ...")
		// 假设正常连接数据库耗时10毫秒
		time.Sleep(time.Millisecond * 10)
		select {
		// 第一个case 分支 50毫秒后自动调用
		case <-ctx.Done():
			// 跳出这 for 循环到 LOOP 标签
			break LOOP
		default:
		}
	}
	// WithTimeout 超时,或者手动调用了 cancel() 会走到这里。
	fmt.Println("worker done!")
	// 完成 等待组
	wg.Done()
}

func main() {
	// 设置 timeout = 50毫秒 超时。
	ctx, cancel := context.WithTimeout(context.Background(), time.Millisecond*50)
	// 增加一个 等待组
	wg.Add(1)
	// 运行 goroutine 执行 worker 函数
	go worker(ctx)

	// 等待 5 秒
	for i := 1; i < 6; i++ {
		fmt.Printf("waiting %d ...\n", i)
		time.Sleep(time.Second * 1)
	}

	// 通知 子 goroutine 结束
	cancel()
	// 等待组 等待 wg.Done()
	wg.Wait()
	fmt.Println("over")
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

waiting 1 ...
db connecting ...
db connecting ...
db connecting ...
db connecting ...
db connecting ...
worker done!
waiting 2 ...
waiting 3 ...
waiting 4 ...
waiting 5 ...
over

 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
53
54
55
56
57

package main

import (
	"context"
	"fmt"
	"sync"
	"time"
)

// context.WithValue

type TraceCode string

var wg sync.WaitGroup

func worker(ctx context.Context) {
	key1 := TraceCode("TRACE_CODE1")
	key2 := TraceCode("TRACE_CODE2")
	// 在子goroutine中获取trace code 1
	traceCode1, ok := ctx.Value(key1).(string)
	traceCode2, ok := ctx.Value(key2).(int64)
	if !ok {
		fmt.Println("invalid trace code")
	}
LOOP:
	for {
		fmt.Printf("worker, trace code 1:%s\n", traceCode1)
		fmt.Printf("worker, trace code 2:%d\n", traceCode2)
		// 假设正常连接数据库耗时10毫秒
		time.Sleep(time.Millisecond * 10)
		select {
		// 50毫秒后自动调用
		case <-ctx.Done():
			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_CODE1"), "12512312234")
	ctx = context.WithValue(ctx, TraceCode("TRACE_CODE2"), int64(646464646464646464))

	wg.Add(1)
	go worker(ctx)
	time.Sleep(time.Second * 5)
	// 通知子goroutine结束
	cancel()
	wg.Wait()
	fmt.Println("over")
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

worker, trace code 1:12512312234
worker, trace code 2:646464646464646464
worker, trace code 1:12512312234
worker, trace code 2:646464646464646464
worker, trace code 1:12512312234
worker, trace code 2:646464646464646464
worker, trace code 1:12512312234
worker, trace code 2:646464646464646464
worker, trace code 1:12512312234
worker, trace code 2:646464646464646464
worker done!
over