这篇文章给大家介绍ASP.NET Core中gRPC如何使用，内容非常详细，感兴趣的小伙伴们可以参考借鉴，希望对大家能有所帮助。
10年积累的网站设计制作、成都网站建设经验，可以快速应对客户对网站的新想法和需求。提供各种问题对应的解决方案。让选择我们的客户得到更好、更有力的网络服务。我虽然不认识你，你也不认识我。但先网站设计后付款的网站建设流程，更有文成免费网站建设让你可以放心的选择与我们合作。
gRPC是Google基于HTTP/2和protobuf推出的一款也是当下热门的开源RPC（Remote Procedure Call）框架。可在程序或者服务之间进行高性能低带宽的通信，并且支持身份认证、日志系统等等需要用到的功能。在微服务作为主流的时代，各个服务之间的通信也是一个亟需解决的问题。在ASP.NET Core 3.x下，gRPC也是微软传统RPC框架WCF的有效替代。
使用gRPC，可以让客户端像调用本地方法一样地去调用服务端中的方法。gRPC是一种合约优先的API开发模式，就是我们需要先具体地定义好方法和参数后，再进行服务端功能开发和客户端调用。并且客户端和服务端可以是使用不同语言开发的程序，通过gRPC，一旦我们在自己的服务中定义了proto文件，任何其他gRPC支持的语言开发的程序都可以来调用这个通信，通信中涉及到的环境、序列化等gRPC都帮我们完成了。默认情况下，gRPC是使用Protocol Buffers作为其接口定义语言（Interface Definition Language），就是用来定义通信中要用的方法和参数。Protocol Buffers不依赖特定的语言，根据不同需求，编译器就可以将其转换生成C#、Java、Python、Go等十几种语言供我们开发使用，并且在通信中数据是序列化成二进制流的，从而获得更好的传输性能。
Protocol Buffers 基本用法
○ 文件名后缀用 ".proto"
○ 别忘记在文首加上一句“syntax = "proto3"，来指明使用的是proto3的语法（因为之前还有一个proto2）
○ 通过在proto文件中定义message类型来指明你想序列化传输的对象，可以类比成一个类其中包含你需要的多个字段。比如定义一个叫Person的message，其中包含3个字段。
message Person { string name = 1; int32 id = 2; bool has_ponycopter = 3; }○ 简单介绍下Protocol Buffer中常用的数据类型
§ 数值：double, float, int32, int64, uint32, uint64, sint32, sint64, fixed32, fixed64, sfixed32, sfixed64
§ 字符串：string
§ 布尔：bool
§ 字节：bytes ，最大长度232
§ 枚举：enum
□ 定义枚举的方法，另外支持使用别名，别名是用不同的名称表示同一个枚举值，如下面的 EnumAllowingAlias.STARTED 和 EnumAllowingAlias.RUNNING 表示的是同一个枚举值。
enum EnumAllowingAlias { option allow_alias = true; //表示可以使用别名 UNKNOWN = 0; //枚举的编号是从0开始的 STARTED = 1; RUNNING = 1; }○ 定义message时，注意到每个字段都加了一个“唯一标识”的编号，这些编号用来在message转成二进制形式后标识具体字段是啥，在投入使用后尽可能避免修改字段的编号。编号范围是1~229-1其中编号1~15的字段使用一个字节来编码，编号16~2047则使用两个字节。所以将使用频率高的字段用1~15来编号，另外19000~19999是Protocol Buffers的保留字段，最好别用。
○ 字段的规则分为两种，singular（proto3中默认）和repeated，定义字段时二选一
§ singular
大概是表示为单值，这个字段的值最多一个，与repeated相对
§ repeated
大概像是集合类型，比如定义一个字段如“repeated string emails”大概意思可理解为List
○ 注释的写法和C#文件中注释的写法基本一致，用“//”或者“/* … */”
○ 保留字段。如果一个已投入使用的proto中移除了某些字段的话，而用户仍然使用这些字段编号就会造成一些较严重的错误。解决办法是将这些想移除的字段名或者字段编号使用reserved关键字修饰。使用了reserved标注的字段在未来使用时，protocol buffer编译器将会抛出错误。
message Foo { reserved 2, 15, 9 to 11; reserved "foo", "bar"; }○ 当使用protocol buffer编译器将proto文件编译成C#语言，会自动生成.cs文件，其中为每个message编译成class。
○ 编译后的类型与C#中类型的对应关系
| proto类型 | double | float | int32 | int64 | string | bool | bytes | enum |
| C#类型 | double | float | int | long | string | bool | ByteString | enum |
| 默认值 | 0 | 0 | 0 | 0 | string.Empty | false | 空字节数组 | 枚举中的第一个值 |
○ 定义完message后，可以将其打包供其他service或者message引用，那么在protocol buffer中打包和引用的方法也很简单
§ 打包语法：
package foo.bar;message Open { ... }§ 指定生成自定义的C#命名空间的语法：
option csharp_namespace = "Foo.MyBar";
§ 引用其他proto文件中定义的message类型的语法：
import "myproject/other_protos.proto";
○ 有了message的定义，要在RPC中应用的话就需要定义“方法”，在protocol buffer中即是service。在.proto文件中定义service的语法是：
service SearchService {
rpc Search (SearchRequest) returns (SearchResponse);
}○ 其中service和rpc都是关键字，Search是“方法”名，SearchRequest与SearchResponse都是定义的message类型。
○ 定义好service后，proto编译器就会将service使用我们选择的语言编译成的服务接口的代码。
○ Protocol buffers的一些其他关键字如any，oneof等暂时没用上，就先不列出了，可参考官方文档。
IDE使用的VS2019，首先使用ASP.NET Core建立一个gRPC的服务端，使用一个WPF程序作为客户端实现最基本的gRPC通信Demo，以一个员工信息的增查为例来演示gRPC中的常用场景。
gRPC 通常有四种模式的通信，分别是“一元（unary）”，“客户端流（client streaming）”，“服务端流（server streaming）” 以及“双向流模式（ bidirectional streaming）”，对于 HTTP 2 来说其实都是用流的模式，以下实验是参考杨旭大佬的教程。
首先创建gRPC服务端，新建一个空白的ASP.NET Core Web应用程序命名为gRPC.Server。用NuGet安装“Grpc.AspNetCore”。新建一个Protos文件夹来存放.proto文件，新建一个名为Message.proto的文件来定义通信过程中需要的message。
syntax = "proto3"; //给编译器指明语法为proto3 //员工 message Employee{ int32 Id = 1; //Id string Name = 2; //姓名 int32 EmployeeNo = 3; //工号 Gender Gender = 4; //性别 Date BirthDay = 5; //生日 string Department = 6; //部门 bool IsValid = 7; //有效性 bytes Photo = 8; //照片 } //性别（枚举） enum Gender{ NOT_SPESIFICED = 0; FEMALE = 1; MALE = 2; } //日期 message Date{ int32 Year = 1; int32 Month = 2; int32 Day = 3; } //Service 用的参数: //根据Id查询员工信息 message GetEmployeeByIdRequest{
int32 Id = 1; } //上传的员工信息请求 message EmployeeRequest{ Employee Employee = 1; } //返回员工信息 message EmployeeResponse{ Employee Employee = 1; } //根据条件查询员工 message GetEmployeeCollectionRequest{ string SearchTerm = 1; bool IsValid = 2; } //返回员工信息集合 message GetEmployeeCollectionReponse{ Employee Employee = 1; } //上传员工照片 message AddPhotoRequest{ bytes Photo = 1; } //上传员工照片响应 message AddPhotoReponse{ bool IsOK = 1; }message.proto
接着新建定义service的proto文件，其中定义了5个方法，包括了gRPC的四种通行模式。
syntax = "proto3"; import "Message.proto"; service EmployeeService{ //根据ID获取员工（一元消息） rpc GetEmployeeById(GetEmployeeByIdRequest) returns (EmployeeResponse); //上传员工信息（一元消息） rpc SaveEmployee(EmployeeRequest) returns (EmployeeResponse); //根据条件获取全部员工（服务端流） rpc GetEmployeeCollection(GetEmployeeCollectionRequest) returns (stream GetEmployeeCollectionReponse); //员工上传照片（客户端流） rpc AddPhoto(stream AddPhotoRequest) returns (AddPhotoReponse); //（双向流）
rpc SaveEmployees(stream EmployeeRequest) returns (stream EmployeeResponse); }定义好proto文件之后便可以在VS中编译项目，在编译前，需要为两个proto文件配置好属性。在message.proto上右键属性，build action选择protobuf compiler，gRPC Stub Classes选择“Do not generate”。类似的对Service.proto文件build action选择protobuf compiler，gRPC Stub Classes选择“Server only”。
编译好之后可以发现编译器帮我们生成了两个同名的cs文件，包含生成了一个 EmployeeServiceBase 类。将我们使用Protocol Buffer定义的message和service生成相应的class和method。此时，在服务端的通信接口相当于就已经定义好了。客户端若需要与之通信就需要通过这个接口的定义来发送请求。接下来新建一个客户端程序（本文这里选用了一个WPF程序），在NuGet上添加需要用到的三个包，分别是“Google.Protobuf”，“Grpc.Tools”，“Grpc.Net.Client”。接下来通过强大的VS可以快速获得服务端定义的接口信息。在项目上右键，选择“添加”→选择“服务引用”→选择“添加新的gRPC引用”，可以选择在服务端定义好的两个proto文件，在选择文件界面的下方的选项将message.proto选择生成为“仅限消息”，service.proto选择生成为“客户端”便完成了添加操作，这时客户端项目中会多出一个Protos文件夹，刚刚添加的两个文件也在其中。编译后编译器依然会为我们生成两个同名的cs文件，包含生成了一个 EmployeeServiceClient 类。
在定义好了通信接口之后，只需要在客户端和服务端实现具体的接口业务便可以完成通信了。
（1）Simple RPC
首先看下最简单的调用方式即一元模式，该演示用的方法 GetEmployeeById 从客户端获取单个参数并返回相应的员工信息，为了简单起见这里的数据就不涉及数据库操作了使用一个静态的 List
由于已经定好了通信的接口，服务端只需实现服务端定义的接口方法即可，创建一个Service类来继承从Service.proto生成的 EmployeeServiceBase 类型，命名为 GrpcEmployeeService ，我们通过override EmployeeServiceBase 中的抽象方法来实现具体业务逻辑。编译器生成的方法签名除了我们在proto文件中定义的请求参数类型 GetEmployeeByIdRequest 外，另外还有一个 ServerCallContext 类型的上下文参数，通过它便可以操作通信过程中的Header和HttpStatus等。
public class GrpcEmployeeService: EmployeeService.EmployeeServiceBase //继承
{
///
/// 一元操作演示 —— 根据id获取员工数据
///
///
///
/// 一旦客户端调用了存根（Stab，客户端上接口方法），服务端的RPC方法便会被调用并收到客户端发送的参数与元数据信息。但是服务端怎样将客户端的请求定位到接口定义的实现呢？来到服务端项目的Startup.cs中指定映射即可。
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
if(env.IsDevelopment())
{
app.UseDeveloperExceptionPage();
}
app.UseRouting();
app.UseEndpoints(endpoints =>
{
endpoints.MapGrpcService < GrpcEmployeeService > (); //将进入的请求映射到特定的服务类中
});
}另外还需要将gRPC的服务注册到服务容器中（在ConfigureServices中增加 services.AddGrpc(); ）
接下来在客户端调用方法存根即可。
private const string serverAdderss = "https://localhost:5001"; //服务端的地址
protected void GetEmployeeById()
{
Response1 = string.Empty; //清空前台显示
var metaData = new Metadata //元数据都是一些 key-value对
{
{
"myKey", "myValue"
} //随便模拟一点 key-value对
};
if(int.TryParse(Request1, out var id))
{
//*****************************主要是这里********************************
using var channel = GrpcChannel.ForAddress(serverAdderss); //创建通道
var client = new EmployeeService.EmployeeServiceClient(channel);
var response = client.GetEmployeeById(new GetEmployeeByIdRequest
{
Id = id
} //参数一：request参数（员工Id）
, metaData); //参数二：用户自定义的元数据
//*********************************************************************
Response1 = response.ToString(); //将响应信息输出前台显示
return;
}
MessageBox.Show("request is unValid");
}（2）Server-side streaming RPC
与一元模式不同的是，服务端流模式中服务端向客户端返回数据是一个流响应，编译器帮我们生成的服务端的方法 GetEmployeeCollection 中包含 IServerStreamWriter
