.Net Core中怎么使用Grpc(grpc,开发技术)

一、Grpc概述

　　gRPC 基于如下思想：定义一个服务， 指定其可以被远程调用的方法及其参数和返回类型。gRPC 默认使用protocol buffers作为接口定义语言，来描述服务接口和有效载荷消息结构。如果有需要的话，可以使用其他替代方案。

定义的服务分为4中类型：

• 单项 RPC，即客户端发送一个请求给服务端，从服务端获取一个应答，就像一次普通的函数调用。这种最常用。

• 服务端流式 RPC，即客户端发送一个请求给服务端，可获取一个数据流用来读取一系列消息。客户端从返回的数据流里一直读取直到没有更多消息为止。

• 客户端流式 RPC，即客户端用提供的一个数据流写入并发送一系列消息给服务端。一旦客户端完成消息写入，就等待服务端读取这些消息并返回应答。

• 双向流式 RPC，即两边都可以分别通过一个读写数据流来发送一系列消息。这两个数据流操作是相互独立的，所以客户端和服务端能按其希望的任意顺序读写，例如：服务端可以在写应答前等待所有的客户端消息，或者它可以先读一个消息再写一个消息，或者是读写相结合的其他方式。每个数据流里消息的顺序会被保持。

二、.Net Core中使用Grpc

使用Grpc 就三步：定义Grpc服务、实现Grpc服务、调用Grpc服务。

2.1 定义Grpc服务

1、在VS中选择.Net Core创建类库

2、引入Google.Protobuf、Grpc.Core包

3、创建proto文件，定义一个SsmServer服务，服务中提供两个方法，一个最简单的单项RPC方法，一个双向流式RPC。后面这个文件会生成一个同名的C#类文件。

syntax="proto3";//语法指定proto3
packageShenDa.SSM.Grpc;//后面生成C#文件的命名空间
import"Protos/Common.proto";
import"Protos/Health.proto";
import"Protos/User.proto";//指定定义服务中使用的参数的位置
serviceSsmService{
//健康检查单项RPC
rpcHealth(EmptyRequest)returns(HealthResponse){}
//双向流
rpcUser_Add(streamUserAddRequest)returns(streamUserAddResponse){}
}

定义的Health.proto文件

syntax="proto3";
packageShenDa.SSM.Grpc;
messageHealthResponse{//返回参数
boolSuccess=1;//每个字段必须要指定序号
stringMessage=2;
}

以上服务就定义完成了。现在需要将这个proto文件生成C#文件，可以使用命令，也可以使用工具。在这里我使用工具生成。

5、引用Grpc.Tools ，然后在工程文件中指定要生成的proto文件。

<ItemGroup>
<ProtobufInclude="Protos\User.proto"/>
<ProtobufInclude="Protos\Health.proto"/>
<ProtobufInclude="Protos\Common.proto"/>
<ProtobufInclude="Protos\SsmService.proto"/>
</ItemGroup>

生成项目，就会在 obj文件夹中生成对应的C#文件。其他文件都是生成对应的实体类，但是定义的服务的proto文件，比较特殊，它会生成一个同名的类文件，类中包含

• 一个抽象类，名称为服务名+Base。其中包含我们定义的虚两个方法

• 一个部分类，名称为服务名+Client，继承ClientBase<服务名Client>

以上所有的Grpc服务都已经定义完了。因为客户端不可能每个都通过添加应用项目的方式使用，所以我们还需要打包客户端Nuget包。

6、生成Nuget包，提供给客户端使用

　　通过VS设置打包生成Nuget包，生成Grpc客户端Nuget包。

2.2 实现Grpc服务

通过VS的GRPC模板创建项目，定义实现类并继承上面生成的抽象类，然后重写我们定义的方法。

publicpartialclassSsmServiceImpl:SsmService.SsmServiceBase
{
publicoverrideasyncTask<HealthResponse>Health(EmptyRequestrequest,ServerCallContextcontext)
{
varresponse=newHealthResponse()
{
Message=string.Empty,
Success=true
};
returnawaitTask.FromResult(response);
}
}

配置Grpc服务

publicvoidConfigureServices(IServiceCollectionservices)
{
services.AddGrpc();
}
publicvoidConfigure(IApplicationBuilderapp,IWebHostEnvironmentenv)
{
app.UseEndpoints(endpoints=>
{
endpoints.MapGrpcService<SsmServiceImpl>();//注入服务的实现。
endpoints.MapGet("/",asynccontext=>
{
awaitcontext.Response.WriteAsync("CommunicationwithgRPCendpointsmustbemadethroughagRPCclient.Tolearnhowtocreateaclient,visit:https://go.microsoft.com/fwlink/?linkid=2086909&quot;);
});
});
}

项目结构截图：

2.3 客户端调用Grpc

1、添加引用Google.Protobuf、Grpc.Core、Grpc.Net.Client 还有刚才生成的Nuget包ShenDa.SSM.Grpc

2、调用

classProgram
{
staticasyncTaskMain(string[]args)
{
varchannel=GrpcChannel.ForAddress("https://localhost:5001");
varclient=newSsmServiceClient(channel);
awaitHealthCheck(client);
}
publicstaticasyncTaskHealthCheck(SsmServiceClientclient)
{
varresponse=awaitclient.HealthAsync(newEmptyRequest());
System.Console.WriteLine(response.Success?"健康":"连接失败");
}
}

希望分享的内容对大家有帮助，更多相关知识，欢迎关注亿速云行业资讯频道！