为什么须要超时管制？

  • 申请工夫过长，用户侧可能曾经来到本页面了，服务端还在耗费资源解决，失去的后果没有意义
  • 过长时间的服务端解决会占用过多资源，导致并发能力降落，甚至呈现不可用事变

Go 超时管制必要性

Go 失常都是用来写后端服务的，个别一个申请是由多个串行或并行的子工作来实现的，每个子工作可能是另外的外部申请，那么当这个申请超时的时候，咱们就须要疾速返回，开释占用的资源，比方goroutine，文件描述符等。

服务端常见的超时管制

  • 过程内的逻辑解决
  • 读写客户端申请，比方HTTP或者RPC申请
  • 调用其它服务端申请，包含调用RPC或者拜访DB等

没有超时管制会怎么？

为了简化本文，咱们以一个申请函数 hardWork 为例，用来做啥的不重要，顾名思义，可能解决起来比较慢。

func hardWork(job interface{}) error {    time.Sleep(time.Minute)    return nil}func requestWork(ctx context.Context, job interface{}) error {  return hardWork(job)}

这时客户端看到的就始终是大家相熟的画面

<img src="https://gitee.com/kevwan/static/raw/master/doc/images/loading.jpg" width="25%">

绝大部分用户都不会看一分钟菊花，早早弃你而去，空留了整个调用链路上一堆资源的占用，本文不究其它细节，只聚焦超时实现。

上面咱们看看该怎么来实现超时，其中会有哪些坑。

第一版实现

大家能够先不往下看，本人试着想想该怎么实现这个函数的超时，第一次尝试：

func requestWork(ctx context.Context, job interface{}) error {    ctx, cancel := context.WithTimeout(ctx, time.Second*2)    defer cancel()    done := make(chan error)    go func() {        done <- hardWork(job)    }()    select {    case err := <-done:        return err    case <-ctx.Done():        return ctx.Err()    }}

咱们写个 main 函数测试一下

func main() {    const total = 1000    var wg sync.WaitGroup    wg.Add(total)    now := time.Now()    for i := 0; i < total; i++ {        go func() {            defer wg.Done()            requestWork(context.Background(), "any")        }()    }    wg.Wait()    fmt.Println("elapsed:", time.Since(now))}

跑一下试试成果

➜ go run timeout.goelapsed: 2.005725931s

超时曾经失效。但这样就搞定了吗？

goroutine 泄露

让咱们在main函数开端加一行代码看看执行完有多少goroutine

time.Sleep(time.Minute*2)fmt.Println("number of goroutines:", runtime.NumGoroutine())

sleep 2分钟是为了期待所有工作完结，而后咱们打印一下以后goroutine数量。让咱们执行一下看看后果

➜ go run timeout.goelapsed: 2.005725931snumber of goroutines: 1001

goroutine泄露了，让咱们看看为啥会这样呢？首先，requestWork 函数在2秒钟超时后就退出了，一旦 requestWork 函数退出，那么 done channel 就没有goroutine接管了，等到执行 done <- hardWork(job) 这行代码的时候就会始终卡着写不进去，导致每个超时的申请都会始终占用掉一个goroutine，这是一个很大的bug，等到资源耗尽的时候整个服务就失去响应了。

那么怎么fix呢？其实也很简略，只有 make chan 的时候把 buffer size 设为1，如下：

done := make(chan error, 1)

这样就能够让 done <- hardWork(job) 不论在是否超时都能写入而不卡住goroutine。此时可能有人会问如果这时写入一个曾经没goroutine接管的channel会不会有问题，在Go外面channel不像咱们常见的文件描述符一样，不是必须敞开的，只是个对象而已，close(channel) 只是用来通知接收者没有货色要写了，没有其它用处。

改完这一行代码咱们再测试一遍：

➜ go run timeout.goelapsed: 2.005655146snumber of goroutines: 1

goroutine泄露问题解决了！

panic 无奈捕捉

让咱们把 hardWork 函数实现改成

panic("oops")

批改 main 函数加上捕捉异样的代码如下：

go func() {  defer func() {    if p := recover(); p != nil {      fmt.Println("oops, panic")    }  }()  defer wg.Done()  requestWork(context.Background(), "any")}()

此时执行一下就会发现panic是无奈被捕捉的，起因是因为在 requestWork 外部起的goroutine里产生的panic其它goroutine无奈捕捉。

解决办法是在 requestWork 里加上 panicChan 来解决，同样，须要 panicChan 的 buffer size 为1，如下：

func requestWork(ctx context.Context, job interface{}) error {    ctx, cancel := context.WithTimeout(ctx, time.Second*2)    defer cancel()    done := make(chan error, 1)    panicChan := make(chan interface{}, 1)    go func() {        defer func() {            if p := recover(); p != nil {                panicChan <- p            }        }()        done <- hardWork(job)    }()    select {    case err := <-done:        return err    case p := <-panicChan:        panic(p)    case <-ctx.Done():        return ctx.Err()    }}

改完就能够在 requestWork 的调用方解决 panic 了。

超时时长肯定对吗？

下面的 requestWork 实现疏忽了传入的 ctx 参数，如果 ctx 已有超时设置，咱们肯定要关注此传入的超时是不是小于这里给的2秒，如果小于，就须要用传入的超时，go-zero/core/contextx 曾经提供了办法帮咱们一行代码搞定，只需批改如下：

ctx, cancel := contextx.ShrinkDeadline(ctx, time.Second*2)

Data race

这里 requestWork 只是返回了一个 error 参数，如果须要返回多个参数，那么咱们就须要留神 data race，此时能够通过锁来解决，具体实现参考 go-zero/zrpc/internal/serverinterceptors/timeoutinterceptor.go，这里不做赘述。

残缺示例

package mainimport (    "context"    "fmt"    "runtime"    "sync"    "time"    "github.com/tal-tech/go-zero/core/contextx")func hardWork(job interface{}) error {    time.Sleep(time.Second * 10)    return nil}func requestWork(ctx context.Context, job interface{}) error {    ctx, cancel := contextx.ShrinkDeadline(ctx, time.Second*2)    defer cancel()    done := make(chan error, 1)    panicChan := make(chan interface{}, 1)    go func() {        defer func() {            if p := recover(); p != nil {                panicChan <- p            }        }()        done <- hardWork(job)    }()    select {    case err := <-done:        return err    case p := <-panicChan:        panic(p)    case <-ctx.Done():        return ctx.Err()    }}func main() {    const total = 10    var wg sync.WaitGroup    wg.Add(total)    now := time.Now()    for i := 0; i < total; i++ {        go func() {            defer func() {                if p := recover(); p != nil {                    fmt.Println("oops, panic")                }            }()            defer wg.Done()            requestWork(context.Background(), "any")        }()    }    wg.Wait()    fmt.Println("elapsed:", time.Since(now))    time.Sleep(time.Second * 20)    fmt.Println("number of goroutines:", runtime.NumGoroutine())}

更多细节

请参考 go-zero 源码：

  • go-zero/core/fx/timeout.go
  • go-zero/zrpc/internal/clientinterceptors/timeoutinterceptor.go
  • go-zero/zrpc/internal/serverinterceptors/timeoutinterceptor.go

我的项目地址

https://github.com/tal-tech/go-zero

欢送应用 go-zero 并 star 反对咱们！

微信交换

关注『微服务实际』公众号并回复 进群 获取社区群二维码。

go-zero 系列文章见『微服务实际』公众号