前言
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) {
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
}
}
一般地,在寫庫前進行超時檢測,發現超時就停止工作。
完整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/