用 FieldMask 提高 C# gRpc 的服务性能

目录

• 前言：
• 一.FieldMask
• 二、Demo
• ​1.定义.proto文件​
• ​2.实现服务端​
• ​3.实现客户端​
• ​4.修改服务端​

前言：

想象一下，有一个服务提供个多个客户端调用，但不是所有客户端都需要全部的返回参数:

​比如商品列表服务返回商品的所有信息，而订单服务调用商品列表服务，但它其实只需要商品的编码和名称就够了。​

当然，我们可以为这个需求单独创建一个服务，但是这样不太灵活，比如又需要商品的编码和分类的时候怎么办？

但是，大而全的服务方法会导致计算和传输成本可能很高，如果我们能够了解响应中哪些字段不需要提供给调用者，从而避免进行不必要的计算和传输，这对提高服务性能通常是非常有益的。

在实现 gRPC 服务时，我们可以使用​protobuf FieldMask ​实现上述功能。

一.FieldMask

默认情况下，gRPC 使用 protobuf 作为其接口定义语和数据序列化协议。

FieldMask 是一个 protobuf 消息，包含一个名为 paths 的字段，用于指定用于指定读取操作返回或更新操作修改的字段：

message FieldMask {
  repeated string paths = 1;
}

下面，让我们看一个例子，如何在C# gRpc 服务中使用它。

二、Demo

​1.定义 .proto 文件​

在 .proto 文件中定义服务和消息:

syntax = "proto3";

option csharp_namespace = "GrpcService2";
import "google/protobuf/field_mask.proto";

package greet;

// The greeting service definition.
service Greeter {
  // Sends a greeting
  rpc SayHello (HelloRequest) returns (HelloReply);
}

// The request message containing the user's name.
message HelloRequest {
  string name = 1;
  google.protobuf.FieldMask field_mask = 2;
}

// The response message containing the greetings.
message HelloReply {
  string message1 = 1;
  string message2 = 2;
  string message3 = 3;
  string message4 = 4;
  string message5 = 5;
}

关键点是下面2句：

// 引用 field_mask 消息
import "google/protobuf/field_mask.proto";

//定义请求字段
google.protobuf.FieldMask field_mask = 2;

​2.实现服务端​

服务端代码如下，返回了5个字段：

public class GreeterService : Greeter.GreeterBase
{
    private readonly ILogger<GreeterService> _logger;
    public GreeterService(ILogger<GreeterService> logger)
    {
        _logger = logger;
    }

    public override Task<HelloReply> SayHello(HelloRequest request, ServerCallContext context)
    {
        var reply = new HelloReply
        {
            Message1 = "Hello " + request.Name + "，这是第1条消息",
            Message2 = "Hello " + request.Name + "，这是第2条消息",
            Message3 = "Hello " + request.Name + "，这是第3条消息",
            Message4 = "Hello " + request.Name + "，这是第4条消息",
            Message5 = "Hello " + request.Name + "，这是第5条消息"
        };

        return Task.FromResult(reply);
    }
}

​3.实现客户端​

客户端代码如下：

using var channel = GrpcChannel.ForAddress("https://localhost:5001");
var client = new Greeter.GreeterClient(channel);

FieldMask fieldMask = new FieldMask();
fieldMask.Paths.AddRange(new string[] { "message2", "message4" });

var request = new HelloRequest { Name = "My IO" };
request.FieldMask = fieldMask;

var reply = await client.SayHelloAsync(request);
            Console.WriteLine($@"Greeting: 
{reply.Message1}
{reply.Message2}
{reply.Message3}
{reply.Message4}
{reply.Message5}
" );

传入了 FieldMask，这里只需要 message2、message4 字段。

运行程序，发现有问题，还是返回了所有字段：

​4.修改服务端​

这其实是在服务端没有判断 fieldMask，修改服务端代码：

var mergedReply = new HelloReply();
request.FieldMask.Merge(reply, mergedReply);

return Task.FromResult(mergedReply);

结论：

在本文中，我们看到了如何使用 FieldMask ，这里仅仅是控制不返回字段，大家可以自行实现其他逻辑。

到此这篇关于用 FieldMask 提高 C# gRpc 的服务性能的文章就介绍到这了,更多相关用 FieldMask 提高 C# gRpc 的服务性能内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们！