ASP.NET Core 3.0 gRPC拦截器的使用

一. 前言

前面两篇文章给大家介绍了使用gRPC的入门以及双向流的使用，今天介绍的是gRPC中的拦截器。拦截器就像MVC的过滤器或者是ASP.NET Core middleware 一样，具有面向切面的思想，可以在调用服务的时候进行一些统一处理， 很适合在这里处理验证、日志等流程。本片文章就以记录日志为例来进行讲解。

二. Interceptor 类介绍

Interceptor类是gRPC服务拦截器的基类，是一个抽象类，它定了几个虚方法，分别如下：

1. public virtual TResponse BlockingUnaryCall<TRequest, TResponse>();
2. public virtual AsyncUnaryCall<TResponse> AsyncUnaryCall<TRequest, TResponse>();
3. public virtual AsyncServerStreamingCall<TResponse> AsyncServerStreamingCall<TRequest,TResponse>();
4. public virtual AsyncClientStreamingCall<TRequest, TResponse>AsyncClientStreamingCall<TRequest, TResponse>();
5. public virtual AsyncDuplexStreamingCall<TRequest, TResponse>AsyncDuplexStreamingCall<TRequest, TResponse>();
6. public virtual Task<TResponse> UnaryServerHandler<TRequest, TResponse>();
7. public virtual Task<TResponse> ClientStreamingServerHandler<TRequest, TResponse>();
8. public virtual Task ServerStreamingServerHandler<TRequest, TResponse>();
9. public virtual Task DuplexStreamingServerHandler<TRequest, TResponse>();

各个方法作用如下：

在实际使用中，可以根据自己的需要来使用对应的拦截方法。

三. 客户端拦截器

基于前面两篇文章使用的Demo。

在客户端项目新建一个类，命名为 ClientLoggerInterceptor，继承拦截器基类 Interceptor。

我们在前面使用的Demo，定义了撸猫服务，其中 SuckingCatAsync方法为异步调用，所以我们重写拦截器的 AsyncUnaryCall方法

1. public class ClientLoggerInterceptor:Interceptor
2. {
3. public override AsyncUnaryCall<TResponse> AsyncUnaryCall<TRequest, TResponse>(
4. TRequest request,
5. ClientInterceptorContext<TRequest, TResponse> context,
6. AsyncUnaryCallContinuation<TRequest, TResponse> continuation)
7. {
8. LogCall(context.Method);
9.  
10. return continuation(request, context);
11. }
12.  
13. private void LogCall<TRequest, TResponse>(Method<TRequest, TResponse> method)
14. where TRequest : class
15. where TResponse : class
16. {
17. var initialColor = Console.ForegroundColor;
18. Console.ForegroundColor = ConsoleColor.Green;
19. Console.WriteLine($"Starting call. Type: {method.Type}. Request: {typeof(TRequest)}. Response: {typeof(TResponse)}");
20. Console.ForegroundColor = initialColor;
21. }
22. }

注册拦截器：

1. var channel = GrpcChannel.ForAddress("https://localhost:5001");
2. var invoker = channel.Intercept(new ClientLoggerInterceptor());
3. var catClient = new LuCat.LuCatClient(invoker);
4. var catReply = await catClient.SuckingCatAsync(new Empty());
5. Console.WriteLine("调用撸猫服务："+ catReply.Message);

然后运行：

可以看到成功的在客户端拦截到了调用，并记录了调用信息。

四. 服务端拦截器

在服务端项目新建一个类，命名为 ServerLoggerInterceptor，继承拦截器基类 Interceptor。

我们在服务端需要实现的方法是 UnaryServerHandler

1. public class ServerLoggerInterceptor: Interceptor
2. {
3. private readonly ILogger<ServerLoggerInterceptor> _logger;
4.  
5. public ServerLoggerInterceptor(ILogger<ServerLoggerInterceptor> logger)
6. {
7. _logger = logger;
8. }
9.  
10. public override Task<TResponse> UnaryServerHandler<TRequest, TResponse>(
11. TRequest request,
12. ServerCallContext context,
13. UnaryServerMethod<TRequest, TResponse> continuation)
14. {
15. LogCall<TRequest, TResponse>(MethodType.Unary, context);
16. return continuation(request, context);
17. }
18.  
19. private void LogCall<TRequest, TResponse>(MethodType methodType, ServerCallContextcontext)
20. where TRequest : class
21. where TResponse : class
22. {
23. _logger.LogWarning($"Starting call. Type: {methodType}. Request: {typeof(TRequest)}. Response: {typeof(TResponse)}");
24. }
25. }

注册拦截器：

1. public void ConfigureServices(IServiceCollection services)
2. {
3. services.AddGrpc(options =>
4. {
5. options.Interceptors.Add<ServerLoggerInterceptor>();
6. });
7. }

运行：

可以看到服务端成功拦截到了，客户端的调用。

五. 参考资料

.NET Core 上的 gRPC 的简介

本文Demo

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持我们。