RPC 系列(七):Go gRPC 超时设置

gRPC 默认的请求超时时间是很长的。当你没有设置请求超时时间时,所有在运行的请求都占用大量资源且可能运行很长的时间,导致服务资源损耗过高,使得后来的请求响应过慢,甚至会引起整个进程崩溃。

为了避免这种情况,我们的服务应该设置超时时间。当客户端发起请求时,需要传入上下文 context.Context,用于结束超时或取消的请求。

本篇以简单 RPC 为例,介绍如何设置 gRPC 请求的超时时间。

客户端请求设置超时时间

修改调用服务端的方法。

1. 把超时时间设置为当前时间 + 3 秒

clientDeadline := time.Now().Add(time.Duration(3 * time.Second))
ctx, cancel := context.WithDeadline(ctx, clientDeadline)
defer cancel()

2. 响应错误检测中添加超时检测

// 传入超时时间为3秒的ctx
res, err := grpcClient.Route(ctx, &req)
if err != nil {
    //获取错误状态
    statu, ok := status.FromError(err)
    if ok {
        //判断是否为调用超时
        if statu.Code() == codes.DeadlineExceeded {
            log.Fatalln("Route timeout!")
        }
    }
    log.Fatalf("Call Route err: %v", err)
}
// 打印返回值
log.Println(res.Value)

服务端判断请求是否超时

当请求超时后,服务端应该停止正在进行的操作,避免资源浪费。

// Route 实现Route方法
func (s *SimpleService) Route(ctx context.Context, req *pb.SimpleRequest) (*pb.SimpleResponse, error) {
    data := make(chan *pb.SimpleResponse, 1)
    go handle(ctx, req, data)
    select {
    case res := <-data:
        return res, nil
    case <-ctx.Done():
        return nil, status.Errorf(codes.Canceled, "Client cancelled, abandoning.")
    }
}

func handle(ctx context.Context, req *pb.SimpleRequest, data chan<- *pb.SimpleResponse) {
    select {
    case <-ctx.Done():
        log.Println(ctx.Err())
        runtime.Goexit() //超时后退出该Go协程
    case <-time.After(4 * time.Second): // 模拟耗时操作
        res := pb.SimpleResponse{
            Code:  200,
            Value: "hello " + req.Data,
        }
        // //修改数据库前进行超时判断
        // if ctx.Err() == context.Canceled{
        //     ...
        //     //如果已经超时,则退出
        // }
        data <- &res
    }
}

一般地,在耗时操作或写库前进行超时检测,发现超时就停止工作。

运行结果

服务端:

:8000 net.Listing...
goroutine still running

客户端:

Route timeout!

总结

超时时间的长短需要根据自身服务而定,例如返回一个 hello grpc,可能只需要几十毫秒,然而处理大量数据的同步操作则可能要很长时间。需要考虑多方面因素来决定这个超时时间,例如系统间端到端的延时,哪些 RPC 是串行的,哪些是可以并行的等等。

系列导航


   转载规则


《RPC 系列(七):Go gRPC 超时设置》 由 吴杭沉 采用 知识共享署名 4.0 国际许可协议 进行许可。
 上一篇
RPC 系列(八):Go gRPC 的 TLS 认证 RPC 系列(八):Go gRPC 的 TLS 认证
前面篇章的 gRPC 都是明文传输的,容易被篡改数据。本篇将介绍如何为 gRPC 添加安全机制,包括 TLS 证书认证和 Token 认证。 TLS 证书认证什么是 TLSTLS(Transport Layer Security,安全传输层
2023-10-24
下一篇 
RPC 系列(六):Go gRPC 双向流式 RPC RPC 系列(六):Go gRPC 双向流式 RPC
上一篇介绍了客户端流式 RPC,客户端不断地向服务端发送数据流,在发送结束或流关闭后,由服务端返回一个响应。本篇将介绍双向流式 RPC。 双向流式 RPC:客户端和服务端双方使用读写流去发送一个消息序列,两个流独立操作,双方可以同时发送和同
2023-10-10
  目录