脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → C#教程 → 提高 C# gRpc 服务性能

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

 更新时间：2022年03月03日 16:10:50   作者：My IO  
这篇文章主要介绍了用 FieldMask 提高 C# gRpc 的服务性能,FieldMask 是一个 protobuf 消息，包含一个名为 paths 的字段，用于指定用于指定读取操作返回或更新操作修改的字,下文详细内容,需要的朋友可以参考一下

前言：

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

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

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

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

在实现 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# winform实现图片上传功能的方法

    基于C# winform实现图片上传功能的方法

    这篇文章主要介绍了基于C# winform实现图片上传功能的方法,很实用的功能,需要的朋友可以参考下
    2014-07-07
  • C#实现简单获取扫码枪信息代码

    C#实现简单获取扫码枪信息代码

    本文给大家分享的是使用C#实现简单获取扫码枪信息代码，非常的简单实用，有需要的小伙伴可以参考下。
    2016-07-07
  • C#数据类型实现背包、队列和栈

    C#数据类型实现背包、队列和栈

    本文详细讲解了C#数据结构类型，并实现背包、队列和栈的方法，文中通过示例代码介绍的非常详细。对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
    2022-04-04
  • c#中task与thread区别及其使用的方法示例

    c#中task与thread区别及其使用的方法示例

    本文主要介绍了c#中task与thread区别及其使用的方法示例，文中通过示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2022-02-02
  • C#实现日历效果

    C#实现日历效果

    这篇文章主要为大家详细介绍了C#实现日历效果，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2022-06-06
  • c# 实现圆形的进度条(ProgressBar)

    c# 实现圆形的进度条(ProgressBar)

    这篇文章主要介绍了c# 如何实现圆形的进度条(ProgressBar)，帮助大家更好的理解和学习使用c#，感兴趣的朋友可以了解下
    2021-03-03
  • C#条件编译、内联函数、CLS介绍

    C#条件编译、内联函数、CLS介绍

    这篇文章介绍了C#的条件编译、内联函数、CLS，文中通过示例代码介绍的非常详细。对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
    2022-03-03
  • C#目录和文件管理操作详解

    C#目录和文件管理操作详解

    在C#中常用的目录操作类有Directory,DirectoryInfo,下面这篇文章主要给大家介绍了关于C#目录和文件管理操作的相关资料,需要的朋友可以参考下
    2022-10-10
  • C#借助OpenCvSharp读取摄像头并显示的实现示例

    C#借助OpenCvSharp读取摄像头并显示的实现示例

    OpenCvSharp是一个OpenCV的.Net wrapper，应用最新的OpenCV库开发，本文主要介绍了C#借助OpenCvSharp读取摄像头并显示的实现示例，具有一定的参考价值，感兴趣的可以了解一下
    2022-05-05
  • C#中overrid和new修饰符有什么不同

    C#中overrid和new修饰符有什么不同

    在C#的继承中尝尝会用到相关的修饰词：override和new。这两个修饰符都可以在新的子类中，重写同名的父类方法。下面通过本文给大家介绍C#中overrid和new修饰符的区别，感兴趣的朋友一起看看吧
    2018-02-02

最新评论