概述

context主要用来在goroutine之间传递上下文信息。

Go1.7加入了一个新的标准库context，它定义了Context类型，专门用来简化对于处理单个请求的多个 goroutine 之间与请求域的数据、取消信号、截止时间等相关操作。

可以使用WithCancel、WithDeadline、WithTimeout或WithValue创建的派生上下文。当一个上下文被取消时，它派生的所有上下文也被取消。

为什么需要Context？

如何解决通知goroutine退出？

全局变量

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()
	// 如何优雅的实现结束子goroutine
	time.Sleep(time.Second * 5) // 防止退出太快
	exit = true		// 修改全局变量
	wg.Wait()
	fmt.Println("over")
}

channel

var wg sync.WaitGroup

// channel方式通知goroutine退出

func worker(exitChan <-chan struct{}) {
label:
	for {
		select {
		case <-exitChan:
			break label
		default:
			fmt.Println("worker")
			time.Sleep(time.Second)
		}
	}
	wg.Done()
}

func main() {

    exitChan := make(chan struct{}) // 定义退出管道

	wg.Add(1)
	go worker(exitChan)
	time.Sleep(time.Second * 5) // 防止退出太快
	exitChan <- struct{}            // 通知协程退出
	wg.Wait()
	fmt.Println("over")
}

context - 官方方案

var wg sync.WaitGroup

// context方式通知协程退出

func worker(ctx context.Context) {
label:
	for {
		select {
		case <-ctx.Done():
			break label
		default:
			fmt.Println("worker")
			time.Sleep(time.Second)
		}
	}
	wg.Done()
}

func main() {

	ctx, cancel := context.WithCancel(context.Background())

	wg.Add(1)
	go worker(ctx)
	time.Sleep(time.Second * 5) // 防止退出太快
	cancel()                    // 调用cancel函数，告诉goroutine退出
	wg.Wait()
	fmt.Println("over")
}

当goroutine又启动一个goroutine时，只需要将ctx传入即可。通过context库，可以控制子孙协程的退出。

Context接口

context.Context是一个接口，该接口定义了四个需要实现的方法：

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

Deadline方法需要返回当前Context被取消的时间，也就是完成工作的截止时间（deadline）；
Done方法需要返回一个Channel，这个Channel会在当前工作完成或者上下文被取消之后关闭，多次调用Done方法会返回同一个Channel；
Err方法会返回当前Context结束的原因，它只会在Done返回的Channel被关闭时才会返回非空的值；
- 如果当前Context被取消就会返回Canceled错误；
- 如果当前Context超时就会返回DeadlineExceeded错误；
Value方法会从Context中返回键对应的值，对于同一个上下文来说，多次调用Value 并传入相同的Key会返回相同的结果，该方法仅用于传递跨API和进程间跟请求域的数据；

Background() 和 TODO()

context库有两个函数：Background()和TODO()，这两个函数分别返回一个实现了Context接口的background和todo。我们代码中最开始都是以这两个内置的上下文对象作为最顶层的partent context，衍生出更多的子上下文对象。

Background()：主要用于main函数、初始化以及测试代码中，作为Context这个树结构的最顶层的Context，也就是根Context。
TODO()：如果我们不知道该使用什么Context的时候，可以使用这个。

background和todo本质上都是emptyCtx结构体类型，是一个不可取消，没有设置截止时间，没有携带任何值的Context。

With系列函数

WithCancel

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

WithCancel返回带有新Done通道的父节点的副本。当调用返回的cancel函数或当关闭父上下文的Done通道时，将关闭返回上下文的Done通道。

WithDeadline

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

返回父上下文的副本，并将截止时间调整为不迟于deadline。如果父上下文的截止时间已经早于deadline，则WithDeadline(parent, d)在语义上等同于父上下文。当截止日过期时，或者当调用返回的cancel函数时，或者当父上下文的Done通道关闭时，返回上下文的Done通道将被关闭，以最先发生的情况为准。

WithTimeout

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

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

WithValue

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

WithValue函数能够将请求作用域的数据与 Context 对象建立关系。

所提供的键必须是可比较的，并且不应该是string类型或任何其他内置类型，以避免使用上下文在包之间发生冲突。WithValue的用户应该为键定义自己的类型。

ctx.Value(key)可以取出键对应的值。

// 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) // 假设正常连接数据库耗时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")
}

Dawn's Blogs

GO语言杂谈 (3) Context标准库

概述