快捷導(dǎo)航

Go?gRPC進(jìn)階教程服務(wù)超時設(shè)置

更新時間：2022年06月16日 09:19:35 作者：煙花易冷人憔悴

這篇文章主要為大家介紹了Go?gRPC進(jìn)階，gRPC請求的超時時間設(shè)置，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪

前言

gRPC默認(rèn)的請求的超時時間是很長的，當(dāng)你沒有設(shè)置請求超時時間時，所有在運行的請求都占用大量資源且可能運行很長的時間，導(dǎo)致服務(wù)資源損耗過高，使得后來的請求響應(yīng)過慢，甚至?xí)鹫麄€進(jìn)程崩潰。

為了避免這種情況，我們的服務(wù)應(yīng)該設(shè)置超時時間。

前面的入門教程

Go gRPC環(huán)境安裝教程示例詳解

Go gRPC教程實現(xiàn)Simple RPC

Go gRPC服務(wù)端流式RPC教程示例

Go gRPC服務(wù)客戶端流式RPC教程

Go gRPC服務(wù)雙向流式RPC教程

提到當(dāng)客戶端發(fā)起請求時候，需要傳入上下文context.Context，用于結(jié)束超時或取消的請求。

本篇以簡單RPC為例，介紹如何設(shè)置gRPC請求的超時時間。

客戶端請求設(shè)置超時時間

修改調(diào)用服務(wù)端方法

1.把超時時間設(shè)置為當(dāng)前時間+3秒

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

2.響應(yīng)錯誤檢測中添加超時檢測

       // 傳入超時時間為3秒的ctx
	res, err := grpcClient.Route(ctx, &req)
	if err != nil {
		//獲取錯誤狀態(tài)
		statu, ok := status.FromError(err)
		if ok {
			//判斷是否為調(diào)用超時
			if statu.Code() == codes.DeadlineExceeded {
				log.Fatalln("Route timeout!")
			}
		}
		log.Fatalf("Call Route err: %v", err)
	}
	// 打印返回值
	log.Println(res.Value)

完整的client.go代碼

package main
import (
	"context"
	"log"
	"time"
	"google.golang.org/grpc"
	"google.golang.org/grpc/codes"
	"google.golang.org/grpc/status"
	pb "go-grpc-example/6-grpc_deadlines/proto"
)
// Address 連接地址
const Address string = ":8000"
var grpcClient pb.SimpleClient
func main() {
	// 連接服務(wù)器
	conn, err := grpc.Dial(Address, grpc.WithInsecure())
	if err != nil {
		log.Fatalf("net.Connect err: %v", err)
	}
	defer conn.Close()
	ctx := context.Background()
	// 建立gRPC連接
	grpcClient = pb.NewSimpleClient(conn)
	route(ctx, 2)
}
// route 調(diào)用服務(wù)端Route方法
func route(ctx context.Context, deadlines time.Duration) {
	//設(shè)置3秒超時時間
	clientDeadline := time.Now().Add(time.Duration(deadlines * time.Second))
	ctx, cancel := context.WithDeadline(ctx, clientDeadline)
	defer cancel()
	// 創(chuàng)建發(fā)送結(jié)構(gòu)體
	req := pb.SimpleRequest{
		Data: "grpc",
	}
	// 調(diào)用我們的服務(wù)(Route方法)
	// 傳入超時時間為3秒的ctx
	res, err := grpcClient.Route(ctx, &req)
	if err != nil {
		//獲取錯誤狀態(tài)
		statu, ok := status.FromError(err)
		if ok {
			//判斷是否為調(diào)用超時
			if statu.Code() == codes.DeadlineExceeded {
				log.Fatalln("Route timeout!")
			}
		}
		log.Fatalf("Call Route err: %v", err)
	}
	// 打印返回值
	log.Println(res.Value)
}

服務(wù)端判斷請求是否超時

當(dāng)請求超時后，服務(wù)端應(yīng)該停止正在進(jìn)行的操作，避免資源浪費。

// Route 實現(xiàn)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協(xié)程
	case <-time.After(4 * time.Second): // 模擬耗時操作
		res := pb.SimpleResponse{
			Code:  200,
			Value: "hello " + req.Data,
		}
		// //修改數(shù)據(jù)庫前進(jìn)行超時判斷
		// if ctx.Err() == context.Canceled{
		// 	...
		// 	//如果已經(jīng)超時，則退出
		// }
		data <- &res
	}
}

一般地，在寫庫前進(jìn)行超時檢測，發(fā)現(xiàn)超時就停止工作。

完整server.go代碼

package main
import (
	"context"
	"log"
	"net"
	"runtime"
	"time"
	"google.golang.org/grpc"
	"google.golang.org/grpc/codes"
	"google.golang.org/grpc/status"
	pb "go-grpc-example/6-grpc_deadlines/proto"
)
// SimpleService 定義我們的服務(wù)
type SimpleService struct{}
const (
	// Address 監(jiān)聽地址
	Address string = ":8000"
	// Network 網(wǎng)絡(luò)通信協(xié)議
	Network string = "tcp"
)
func main() {
	// 監(jiān)聽本地端口
	listener, err := net.Listen(Network, Address)
	if err != nil {
		log.Fatalf("net.Listen err: %v", err)
	}
	log.Println(Address + " net.Listing...")
	// 新建gRPC服務(wù)器實例
	grpcServer := grpc.NewServer()
	// 在gRPC服務(wù)器注冊我們的服務(wù)
	pb.RegisterSimpleServer(grpcServer, &SimpleService{})
	//用服務(wù)器 Serve() 方法以及我們的端口信息區(qū)實現(xiàn)阻塞等待，直到進(jìn)程被殺死或者 Stop() 被調(diào)用
	err = grpcServer.Serve(listener)
	if err != nil {
		log.Fatalf("grpcServer.Serve err: %v", err)
	}
}
// Route 實現(xiàn)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協(xié)程
	case <-time.After(4 * time.Second): // 模擬耗時操作
		res := pb.SimpleResponse{
			Code:  200,
			Value: "hello " + req.Data,
		}
		// //修改數(shù)據(jù)庫前進(jìn)行超時判斷
		// if ctx.Err() == context.Canceled{
		// 	...
		// 	//如果已經(jīng)超時，則退出
		// }
		data <- &res
	}
}