ASP.NET Core 3.0使用gRPC的具体方法

2023-08-04 02:34:04 150

一.简介

gRPC是一个由Google开源的，跨语言的，高性能的远程过程调用（RPC）框架。gRPC使客户端和服务端应用程序可以透明地进行通信，并简化了连接系统的构建。它使用HTTP/2作为通信协议，使用ProtocolBuffers作为序列化协议。

它的主要优点：

现代高性能轻量级RPC框架。
约定优先的API开发，默认使用ProtocolBuffers作为描述语言，允许与语言无关的实现。
可用于多种语言的工具，以生成强类型的服务器和客户端。
支持客户端，服务器双向流调用。
通过ProtocolBuffers二进制序列化减少网络使用。
使用HTTP/2进行传输

这些优点使gRPC非常适合：

高性能轻量级微服务-gRPC设计为低延迟和高吞吐量通信，非常适合需要高性能的轻量级微服务。
多语言混合开发-gRPC工具支持所有流行的开发语言，使gRPC成为多语言开发环境的理想选择。
点对点实时通信-gRPC对双向流调用提供出色的支持。gRPC服务可以实时推送消息而无需轮询。
网络受限环境-使用ProtocolBuffers二进制序列化消息，该序列化始终小于等效的JSON消息，对网络带宽需求比JSON小

不建议使用gRPC的场景：

浏览器可访问的API-浏览器不完全支持gRPC。虽然gRPC-Web可以提供浏览器支持，但是它有局限性，引入了服务器代理
广播实时通信-gRPC支持通过流进行实时通信，但不存在向已注册连接广播消息的概念
进程间通信-进程必须承载HTTP/2才能接受传入的gRPC调用，对于Windows，进程间通信管道是一种更快速的方法。

摘自微软官方文档

支持的语言如下：

二.gRPCon.NETCore

gRPC现在可以非常简单的在.NETCore和ASP.NETCore中使用，在.NETCore上的实现的开源地址：https://github.com/grpc/grpc-dotnet，它目前由微软官方ASP.NET项目的人员进行维护，良好的接入.NETCore生态。

.NETCore的gRPC功能如下：

Grpc.AspNetCore一个用于在ASP.NETCore承载gRPC服务的框架，将gRPC和ASP.NETCore功能集成在一起，如：日志、依赖注入、身份认证和授权。
Grpc.Net.Client基于HttpClient（HttpClient现已支持HTTP/2）的gRPC客户端
Grpc.Net.ClientFactory与gRPC客户端集成的HttpClientFactory，允许对gRPC客户端进行集中配置，并使用DI注入到应用程序中

三.使用ASP.NETCore创建gRPC服务

通过VisualStudio2019（16.3.0）提供的模板，可以快速创建gRPC服务。

来扒拉一下默认源码包含了什么东东。

①配置文件appsettings.json，多了Kestrel启用HTTP/2的配置，因为gRPC是基于HTTP/2来通信的

②PB协议文件greet.proto用于自动生成服务、客户端和消息（表示传递的数据）的C#Class

③服务类GreeterService，服务类集成的Greeter.GreeterBase来自于根据proto文件自动生成的，生成的类在obj\Debug\netcoreapp3.0目录下

自动生成的类：

④Startup.cs类，将gRPC服务添加到了终结点路由中

⑤csproj项目文件，包含了proto文件引用

2.运行

第一次运行会提示是否信任证书，点击“是”

这是因为HTTP/2需要HTTPS，尽管HTTP/2协议没有明确规定需要HTTPS，但是为了安全在浏览器实现上都要求了HTTPS，所以现在的HTTP/2和HTTPS基本都是一对。

四.创建gRPC客户端

1.添加一个.NETCore控制台应用程序

2.通过nuget添加包：Grpc.Net.Client、Google.Protobuf、Grpc.Tools

3.将服务的proto文件复制到客户端

4.编辑客户端项目文件，添加关于proto文件的描述

注意GrpcServices="Client"这里是Client和服务是不一样的

5.生成客户端项目可以通过proto文件生成类

6.添加客户端调用代码

staticasyncTaskMain(string[]args)
{
varchannel=GrpcChannel.ForAddress("https://localhost:5001");
varclient=newGreeter.GreeterClient(channel);
varreply=awaitclient.SayHelloAsync(
newHelloRequest{Name="晓晨"});
Console.WriteLine("Greeter服务返回数据:"+reply.Message);
Console.ReadKey();
}

7.先启动服务，然后运行客户端

这里可以看到，客户端成功调用了服务，收到了返回的消息。

五.自己动手写一个服务

前面我们使用的Greeter服务是由模板自动给我们创建的，现在我们来自己动手写一个服务。

1.定义proto文件LuCat.proto，并在csproj项目文件中添加描述

syntax="proto3";

optioncsharp_namespace="AspNetCoregRpcService";

import"google/protobuf/empty.proto";
packageLuCat;//定义包名

//定义服务
serviceLuCat{
//定义吸猫方法
rpcSuckingCat(google.protobuf.Empty)returns(SuckingCatResult);
}

messageSuckingCatResult{
stringmessage=1;
}

2.实现服务LuCatService.cs

publicclassLuCatService:LuCat.LuCatBase
{
privatestaticreadonlyListCats=newList(){"英短银渐层","英短金渐层","美短","蓝猫","狸花猫","橘猫"};
privatestaticreadonlyRandomRand=newRandom(DateTime.Now.Millisecond);
publicoverrideTaskSuckingCat(Emptyrequest,ServerCallContextcontext)
{
returnTask.FromResult(newSuckingCatResult()
{
Message=$"您吸了一只{Cats[Rand.Next(0,Cats.Count)]}"
});
}
}

3.在Startup终结点路由中注册

endpoints.MapGrpcService();

4.添加客户端调用

varcatClient=newLuCat.LuCatClient(channel);
varcatReply=awaitcatClient.SuckingCatAsync(newEmpty());
Console.WriteLine("调用撸猫服务："+catReply.Message);

5.运行测试

六.实际使用中的技巧

技巧1

上面章节的操作步骤中，我们需要在服务和客户端之间复制proto，这是一个可以省略掉的步骤。

1.复制Protos文件夹到解决方案根目录（sln文件所在目录）

2.删除客户端和服务项目中的Protos文件夹

3.在客户端项目文件csproj中添加关于proto文件的描述

4.在服务项目文件csproj中添加关于proto文件的描述

在实际项目中，请自己计算相对路径

5.这样两个项目都是使用的一个proto文件，只用维护这一个文件即可

技巧2

我们在实际项目中使用，肯定有多个proto文件，难道我们每添加一个proto文件都要去更新csproj文件？

我们可以使用MSBuild变量来帮我们完成，我们将csproj项目文件中引入proto文件信息进行修改。

服务端：

客户端：

示例：

七.总结

gRPC现目前是一款非常成熟的高性能RPC框架，当前的生态是非常好的，很多公司的产品或者开源项目都有在使用gRPC，有了它，相信可以让我们更容易的构建.NETCore微服务，可以让.NETCore更好的接入gRPC生态。不得不说这是.NETCore3.0带来的最令人振奋的特性之一。

参考资料：

proto3说明文档

在ASP.NETCore中创建gRPC客户端和服务

Demo地址

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持毛票票。

声明：本文内容来源于网络，版权归原作者所有，内容由互联网用户自发贡献自行上传，本网站不拥有所有权，未作人工编辑处理，也不承担相关法律责任。如果您发现有涉嫌版权的内容，欢迎发送邮件至：czq8825#qq.com（发邮件时，请将#更换为@）进行举报，并提供相关证据，一经查实，本站将立刻删除涉嫌侵权内容。

ASP.NET Core 3.0使用gRPC的具体方法

热门推荐

随机推荐