前言
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)
完整的client.go代码
服务端判断请求是否超时
当请求超时后,服务端应该停止正在进行的操作,避免资源浪费。事实上,我并不能很好控制服务端停止工作而避免资源浪费,只能尽量减少资源浪费。一般地,在耗时操作或写库前进行超时检测,发现超时就停止工作。
// Route 实现Route方法
func (s *SimpleService) Route(ctx context.Context, req *pb.SimpleRequest) (*pb.SimpleResponse, error) {
timeout := make(chan struct{}, 1)
data := make(chan *pb.SimpleResponse, 1)
go func() {
time.Sleep(4 * time.Second)
res := pb.SimpleResponse{
Code: 200,
Value: "hello " + req.Data,
}
log.Println("goroutine still running")
data <- &res
}()
go func() {
for {
if ctx.Err() == context.Canceled {
timeout <- struct{}{}
}
}
}()
select {
case res := <-data:
return res, nil
case <-timeout:
return nil, status.Errorf(codes.Canceled, "Client cancelled, abandoning.")
}
}
上面这段代码,当超时后,获取数据的goroutine仍然在运行,并不能避免资源浪费。所以还是那句话,在耗时操作或写库前进行超时检测,发现超时就停止工作。除非找到更好解决的解决方案。
完整server.go代码
运行结果
服务端:
:8000 net.Listing...
goroutine still running
客户端:
Route timeout!
总结
超时时间的长短需要根据自身服务而定,例如返回一个hello grpc
,可能只需要几十毫秒,然而处理大量数据的同步操作则可能要很长时间。需要考虑多方面因素来决定这个超时时间,例如系统间端到端的延时,哪些RPC是串行的,哪些是可以并行的等等。
教程源码地址:https://github.com/Bingjian-Zhu/go-grpc-example
参考:https://grpc.io/blog/deadlines/
有疑问加站长微信联系(非本文作者)