Go 中实现超时控制的方案

前言

日常开发中我们大概率会遇到超时控制的场景，比如一个批量耗时任务、网络请求等；一个良好的超时控制可以有效的避免一些问题（比如 goroutine 泄露、资源不释放等）。

timer

在 go 中实现超时控制的方法非常简单，首先第一种方案是 time.after(d duration)：

func main() {
	fmt.println(time.now())
	x := <-time.after(3 * time.second)
	fmt.println(x)
}

output:

2021-10-27 23:06:04.304596 +0800 cst m=+0.000085653
2021-10-27 23:06:07.306311 +0800 cst m=+3.001711390

time.after() 会返回一个 channel，该 channel 会在延时 d 段时间后写入数据。

有了这个特性就可以实现一些异步控制超时的场景：

func main() {
	ch := make(chan struct{}, 1)
	go func() {
		fmt.println("do something...")
		time.sleep(4*time.second)
		ch<- struct{}{}
	}()
	
	select {
	case <-ch:
		fmt.println("done")
	case <-time.after(3*time.second):
		fmt.println("timeout")
	}
}

这里假设有一个 goroutine 在跑一个耗时任务，利用 select 有一个 channel 获取到数据便退出的特性，当 goroutine 没有在有限时间内完成任务时，主 goroutine 便会退出，也就达到了超时的目的。

output:

do something...
timeout

timer.after 取消，同时 channel 发出消息，也可以关闭通道等通知方式。

注意 channel 最好是有大小，防止阻塞 goroutine ，导致泄露。

context

第二种方案是利用 context，go 的 context 功能强大；

利用 context.withtimeout() 方法会返回一个具有超时功能的上下文。

ch := make(chan string)
	timeout, cancel := context.withtimeout(context.background(), 3*time.second)
	defer cancel()
	go func() {
		time.sleep(time.second * 4)

		ch <- "done"
	}()

	select {
	case res := <-ch:
		fmt.println(res)
	case <-timeout.done():
		fmt.println("timout", timeout.err())
	}

同样的用法，context 的 done() 函数会返回一个 channel，该 channel 会在当前工作完成或者是上下文取消生效。

timout context deadline exceeded

通过 timeout.err() 也能知道当前 context 关闭的原因。

goroutine 传递 context

使用 context 还有一个好处是，可以利用其天然在多个 goroutine 中传递的特性，让所有传递了该 context 的 goroutine 同时接收到取消通知，这点在多 go 中应用非常广泛。

func main() {
	total := 12
	var num int32
	log.println("begin")
	ctx, cancelfunc := context.withtimeout(context.background(), 3*time.second)
	for i := 0; i < total; i++ {
		go func() {
			//time.sleep(3 * time.second)
			atomic.addint32(&num, 1)
			if atomic.loadint32(&num) == 10 {
				cancelfunc()
			}
		}()
	}
	for i := 0; i < 5; i++ {
		go func() {

			select {
			case <-ctx.done():
				log.println("ctx1 done", ctx.err())
			}

			for i := 0; i < 2; i++ {
				go func() {
					select {
					case <-ctx.done():
						log.println("ctx2 done", ctx.err())
					}
				}()
			}

		}()
	}

	time.sleep(time.second*5)
	log.println("end", ctx.err())
	fmt.printf("执行完毕 %v", num)
}

在以上例子中，无论 goroutine 嵌套了多少层，都是可以在 context 取消时获得消息（当然前提是 context 得传递走）

某些特殊情况需要提前取消 context 时，也可以手动调用 cancelfunc() 函数。

gin 中的案例

gin 提供的 shutdown(ctx) 函数也充分使用了 context。

ctx, cancel := context.withtimeout(context.background(), 10*time.second)
	defer cancel()
	if err := srv.shutdown(ctx); err != nil {
		log.fatal("server shutdown:", err)
	}
	log.println("server exiting")

比如以上代码便是超时等待 10s 进行 gin 的资源释放，实现的原理也和上文的例子相同。

总结

因为写 go 的时间不长，所以自己写了一个练手的项目：一个接口压力测试工具。

其中一个很常见的需求就是压测 n 秒后退出，这里正好就应用到了相关知识点，同样是初学 go 的小伙伴可以参考。

https://github.com/crossoverjie/ptg/blob/d0781fcb5551281cf6d90a86b70130149e1525a6/duration.go

到此这篇关于go 里的超时控制的文章就介绍到这了,更多相关go 超时控制内容请搜索以前的文章或继续浏览下面的相关文章希望大家以后多多支持！