golang如何去除context的deadline

go去除 context 的 deadline go context deadline 2023-03-21 11:03:29 565人浏览安东尼

摘要

目录golang 去除 context 的 deadline背景方法一，创建一个新 context方法二，使用自定义结构体Golang 去除 context 的 deadline 背

Golang 去除 context 的 deadline

背景

在使用 context 的时候遇到了开协程处理任务的情况，但是直接在协程里使用主线程的 context 会导致当主线程返回时协程任务也会因为 context cancel 而失败。
本文提供了两种办法可以取消掉 context 里的 timeout 和 deadline，再设置一个新的 timeout 上去。

方法一，创建一个新 context

最简单的方案是通过创建一个新的 context 来解决这个问题。

func main() {
	ctx := context.WithValue(context.Background(), "trace", "123")
	ctx, cancel := context.WithTimeout(ctx, time.Second)
	defer cancel()

	go func(ctx context.Context) {
		newCtx := context.WithValue(context.Background(), "trace", ctx.Value("trace"))
		// do something with newCtx
	}(ctx)

	fmt.Println("main finished")
}

但是这种方案有一个缺点，当生成一个新的 context 的时候，需要手动把老 context 中的 value 手动拿出来，再设置到新的里面去。但是在很多情况下，这个 context 是上游传过来的，并不知道 value 里面有哪些具体的 key。或者里面的 value 过多，写起来很麻烦。

方法二，使用自定义结构体

通过看 context 的源码，其实可以发现 context 是一个 interface，这就给了我们操作的空间。

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

Context 是通过 Deadline() 这个函数控制整个 ctx 是否超时了的。那么我们就可以通过重写这个函数来规避超时。

// contextWithoutDeadline 伪造了一个没有 deadline 的 context
type contextWithoutDeadline struct {
	ctx context.Context
}

func (*contextWithoutDeadline) Deadline() (time.Time, bool) {
	return time.Time{}, false
}

func (*contextWithoutDeadline) Done() <-chan struct{} {
	return nil
}

func (*contextWithoutDeadline) Err() error {
	return nil
}

func (l *contextWithoutDeadline) Value(key interface{}) interface{} {
	return l.ctx.Value(key)
}

// DetachDeadline 从 context 剥离 deadline
func DetachDeadline(ctx context.Context) context.Context {
	return &contextWithoutDeadline{ctx: ctx}
}

// SetNewTimeout 设置新的超时时间
func SetNewTimeout(ctx context.Context, timeout time.Duration) (context.Context, context.CancelFunc) {
	return context.WithTimeout(DetachDeadline(ctx), timeout)
}

可以通过 DetachDeadline() 方法来将原 ctx 的 deadline 取消掉，或者直接通过 SetNewTimeout 的方法设置一个新的超时时间上去。

演示

func main() {
	ctx, _ := context.WithTimeout(context.Background(), time.Duration(10)*time.Second)
	fmt.Println(ctx.Deadline())

	newCtx := contextwarp.DetachDeadline(ctx)
	fmt.Println(newCtx.Deadline())

	newCtx2, _ := contextwarp.SetNewTimeout(ctx, time.Duration(1)*time.Second)
	fmt.Println(newCtx2.Deadline())
}