前言

日常开发中咱们大概率会遇到超时管制的场景，比方一个批量耗时工作、网络申请等；一个良好的超时管制能够无效的防止一些问题（比方 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#L41