用 FieldMask 提高 C# gRpc 的服务性能
前言：
想象一下，有一个服务提供个多个客户端调用，但不是所有客户端都需要全部的返回参数:
比如商品列表服务返回商品的所有信息，而订单服务调用商品列表服务，但它其实只需要商品的编码和名称就够了。
当然，我们可以为这个需求单独创建一个服务，但是这样不太灵活，比如又需要商品的编码和分类的时候怎么办？
但是，大而全的服务方法会导致计算和传输成本可能很高，如果我们能够了解响应中哪些字段不需要提供给调用者，从而避免进行不必要的计算和传输，这对提高服务性能通常是非常有益的。
在实现 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 的服务性能内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！
相关文章
这篇文章介绍了C#之Socket(套接字)通信，文中通过示例代码介绍的非常详细。对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下2022-05-05
这篇文章主要给大家介绍了关于C#控制台程序如何发布到服务器Linux上运行的相关资料,文中通过图文介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下2021-11-11
这篇文章主要介绍了C#实现的中国移动官网手机号码采集器,本文先是采集号码入库,同时给出了筛选各类靓号的SQL语句,需要的朋友可以参考下2014-10-10
C#中FormClosing与FormClosed的区别详细解析
本文是对C#中FormClosing与FormClosed的区别进行了详细的分析介绍，需要的朋友可以过来参考下，希望对大家有所帮助2013-10-10
这篇文章主要为大家详细介绍了Unity键盘WASD实现物体移动，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2019-02-02
这篇文章主要介绍了C#设计模式之观察者模式实例讲解,本文详细讲解了观察者模式的定义、优缺点、代码实例等,需要的朋友可以参考下2014-10-10
这篇文章介绍了C#基于NPOI操作Excel的方法，文中通过示例代码介绍的非常详细。对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下2022-04-04
C# 中属性PropertyInfo的setvalue用法说明
这篇文章主要介绍了C# 中属性PropertyInfo的setvalue用法说明，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧2021-01-01
这篇文章主要介绍了C#中枚举类型和radiobox关联操作的方法,实例分析了C#中枚举类型及与控件关联操作的相关技巧,需要的朋友可以参考下2015-04-04
本篇文章是对c#中实现无标题栏窗口拖动的方法进行了详细的分析介绍，需要的朋友参考下2013-06-06
最新评论