本篇文章我来介绍一下gRPC拦截器的使用,拦截器主要用于在服务器端和客户端拦截 RPC.

拦截器可以在 gRPC 中拦截 RPC 的执行,来满足一些特殊的需求,如日志,认证,访问控制等。 gRPC 提供了简单的接口,用来在客户端和服务端的 gRPC 协议中添加拦截器。

根据所使用的 gRPC 通信模式的不同,主要分为2种拦截器:1)一元拦截器,2)流拦截器。 既可以在客户端使用拦截器,也可以在服务端使用拦截器。

接下来,我会依次介绍在服务端和客户端的使用。

服务端拦截器

当客户端调用 gRPC 的远程调用方法时,可以通过服务端拦截器,在执行一些方法前,执行一些通用的操作。如果希望在 Rpc 服务中添加服务端拦截器,只需实现该拦截器,并在创建服务端时注册进来。

下面依次介绍两种服务端拦截器:1)一元拦截器,2)流拦截器。

一元拦截器

如果想在服务端拦截 一元 RPC 调用时,需要在服务端实现相应的函数,此函数的签名为:

1
type UnaryServerInterceptor func(ctx context.Context, req interface{}, info *UnaryServerInfo, handler UnaryHandler) (resp interface{}, err error)

我们在上一篇文章的代码中添加如下代码:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
func orderUnaryServerInterceptor(ctx context.Context, req interface{}, info *grpc.UnaryServerInfo, handler grpc.UnaryHandler) (interface{}, error) {
	
	log.Println("======= [Server Interceptor] ", info.FullMethod)
	log.Printf(" Pre Proc Message : %s", req)

	m, err := handler(ctx, req)
	if err != nil {
		log.Printf("Error : %v", err)
	}
	log.Printf(" Post Proc Message : %s", m)
	return m, err
}
func main() {
    initSampleData()
    lis, err := net.Listen("tcp", port)
    if err != nil {
    log.Fatalf("failed to listen: %v", err)
    }
    s := grpc.NewServer(grpc.UnaryInterceptor(orderUnaryServerInterceptor))
    pb.RegisterOrderManagementServer(s, &server{})
    // Register reflection service on gRPC server.
    // reflection.Register(s)
    if err := s.Serve(lis); err != nil {
    log.Fatalf("failed to serve: %v", err)
    }
}

一元拦截器的实现主要分为三个部分: 前置处理、调用 RPC 服务、后置处理。在前置处理阶段可以通过检查参数获得 RPC 的信息,比如 RPC 上下文、请求和服务端信息。

在调用阶段需要调用 Grpc UnaryHandler 来执行 RPC 服务,在后置处理阶段可以对返回值进行处理。接下来介绍服务端流拦截器。

流拦截器

服务器流拦截器会处理 gRPC 服务器处理的所有流 RPC。流拦截器包括前置处理阶段和流操作拦截阶段。

流拦截器需要实现特定的流拦截器类型: type StreamServerInterceptor func(srv interface{}, ss ServerStream, info *StreamServerInfo, handler StreamHandler) error

与一元拦截器类似,在前置处理阶段,可以在流 RPC 进入服务实现前进行拦截,在前置处理完后,可以调用streamhandler 完成方法的执行,。

客户端拦截器

客户端的拦截器和服务端的类似,只是在相应的接口和函数签名方面有区别。

当客户端发起 RPC 请求时,可以在客户端拦截 rpc 请求。

一元拦截器

客户端一元拦截器用于一元 RPC 客户端的调用,主要的函数类型:

type UnaryClientInterceptor func(ctx context.Context, method string, req, reply interface{}, cc *ClientConn, invoker UnaryInvoker, opts ...CallOption) error

与服务器一元拦截器一样,客户端一元拦截器也有不同的阶段,在前置阶段可以检查 RPC 的信息,我们甚至可以在原请求发送至服务端前,修改相应信息,处理阶段通过 UnaryInvoker 参数调用实际的一元 RPC, 后置阶段可以访问 RPC 的响应结果或错误结果。

注册一元拦截器,通过在 grpc.Dial 方法中通过 grpc.WithUnaryInterceptor 方法注册。

流拦截器

客户端流拦截器会处理所有的客户端流 RPC.具体的实现与服务端流拦截器类似,StreamClientInterceptor 是响应订单函数类型,其签名如下:

1
type StreamClientInterceptor func(ctx context.Context, desc *StreamDesc, cc *ClientConn, method string, streamer Streamer, opts ...CallOption) (ClientStream, error)

客户端流拦截器主要包括前置处理和流操作拦截。

参考