ASP.NET Core 3.0使用gRPC的具体方法
一.简介
grpc 是一个由google开源的,跨语言的,高性能的远程过程调用(rpc)框架。 grpc使客户端和服务端应用程序可以透明地进行通信,并简化了连接系统的构建。它使用http/2作为通信协议,使用 protocol buffers 作为序列化协议。
它的主要优点:
- 现代高性能轻量级 rpc 框架。
- 约定优先的 api 开发,默认使用 protocol buffers 作为描述语言,允许与语言无关的实现。
- 可用于多种语言的工具,以生成强类型的服务器和客户端。
- 支持客户端,服务器双向流调用。
- 通过protocol buffers二进制序列化减少网络使用。
- 使用 http/2 进行传输
这些优点使grpc非常适合:
- 高性能轻量级微服务 - grpc设计为低延迟和高吞吐量通信,非常适合需要高性能的轻量级微服务。
- 多语言混合开发 - grpc工具支持所有流行的开发语言,使grpc成为多语言开发环境的理想选择。
- 点对点实时通信 - grpc对双向流调用提供出色的支持。grpc服务可以实时推送消息而无需轮询。
- 网络受限环境 - 使用 protocol buffers二进制序列化消息,该序列化始终小于等效的json消息,对网络带宽需求比json小
不建议使用grpc的场景:
- 浏览器可访问的api - 浏览器不完全支持grpc。虽然grpc-web可以提供浏览器支持,但是它有局限性,引入了服务器代理
- 广播实时通信 - grpc支持通过流进行实时通信,但不存在向已注册连接广播消息的概念
- 进程间通信 - 进程必须承载http/2才能接受传入的grpc调用,对于windows,进程间通信管道是一种更快速的方法。
摘自
支持的语言如下:
二.grpc on .net core
grpc 现在可以非常简单的在 .net core 和 asp.net core 中使用,在 .net core 上的实现的开源地址: ,它目前由微软官方 asp.net 项目的人员进行维护,良好的接入 .net core 生态。
.net core 的 grpc 功能如下:
- grpc.aspnetcore 一个用于在asp.net core承载grpc服务的框架,将 grpc和asp.net core 功能集成在一起,如:日志、依赖注入、身份认证和授权。
- grpc.net.client 基于httpclient (httpclient现已支持http/2)的 grpc客户端
-
grpc.net.clientfactory 与grpc客户端集成的
httpclientfactory
,允许对grpc客户端进行集中配置,并使用di注入到应用程序中
三.使用 asp.net core 创建 grpc 服务
通过 visual studio 2019 (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.添加一个.net core 控制台应用程序
2.通过nuget添加包:grpc.net.client、google.protobuf、grpc.tools
3.将服务的 proto 文件复制到客户端
4.编辑客户端项目文件,添加关于proto文件的描述
<itemgroup> <protobuf include="protos\greet.proto" grpcservices="client" /> </itemgroup>
注意 grpcservices="client"
这里是client和服务是不一样的
5.生成客户端项目可以通过proto文件生成类
6.添加客户端调用代码
static async task main(string[] args) { var channel = grpcchannel.foraddress("https://localhost:5001"); var client = new greeter.greeterclient(channel); var reply = await client.sayhelloasync( new hellorequest { name = "晓晨" }); console.writeline("greeter 服务返回数据: " + reply.message); console.readkey(); }
7.先启动服务,然后运行客户端
这里可以看到,客户端成功调用了服务,收到了返回的消息。
五.自己动手写一个服务
前面我们使用的 greeter 服务是由模板自动给我们创建的,现在我们来自己动手写一个服务。
1.定义 proto 文件 lucat.proto
,并在csproj项目文件中添加描述
syntax = "proto3"; option csharp_namespace = "aspnetcoregrpcservice"; import "google/protobuf/empty.proto"; package lucat; //定义包名 //定义服务 service lucat{ //定义吸猫方法 rpc suckingcat(google.protobuf.empty) returns(suckingcatresult); } message suckingcatresult{ string message=1; }
2.实现服务 lucatservice.cs
public class lucatservice:lucat.lucatbase { private static readonly list<string> cats=new list<string>(){"英短银渐层","英短金渐层","美短","蓝猫","狸花猫","橘猫"}; private static readonly random rand=new random(datetime.now.millisecond); public override task<suckingcatresult> suckingcat(empty request, servercallcontext context) { return task.fromresult(new suckingcatresult() { message = $"您吸了一只{cats[rand.next(0, cats.count)]}" }); } }
3.在 startup
终结点路由中注册
endpoints.mapgrpcservice<lucatservice>();
4.添加客户端调用
var catclient = new lucat.lucatclient(channel); var catreply = await catclient.suckingcatasync(new empty()); console.writeline("调用撸猫服务:"+ catreply.message);
5.运行测试
六.实际使用中的技巧
技巧1
上面章节的操作步骤中,我们需要在服务和客户端之间复制proto,这是一个可以省略掉的步骤。
1.复制 protos 文件夹到解决方案根目录(sln文件所在目录)
2.删除客户端和服务项目中的 protos 文件夹
3.在客户端项目文件csproj中添加关于proto文件的描述
<itemgroup> <protobuf include="..\..\protos\greet.proto" grpcservices="client" link="protos\greet.proto" /> </itemgroup>
4.在服务项目文件csproj中添加关于proto文件的描述
<itemgroup> <protobuf include="..\..\protos\greet.proto" grpcservices="server" link="protos\greet.proto" /> </itemgroup>
在实际项目中,请自己计算相对路径
5.这样两个项目都是使用的一个proto文件,只用维护这一个文件即可
技巧2
我们在实际项目中使用,肯定有多个 proto 文件,难道我们每添加一个 proto 文件都要去更新 csproj文件?
我们可以使用msbuild变量来帮我们完成,我们将 csproj 项目文件中引入proto文件信息进行修改。
服务端:
<itemgroup> <protobuf include="..\..\protos\*.proto" grpcservices="server" link="protos\%(recursivedir)%(filename)%(extension)" /> </itemgroup>
客户端:
<itemgroup> <protobuf include="..\..\protos\*.proto" grpcservices="client" link="protos\%(recursivedir)%(filename)%(extension)" /> </itemgroup>
示例:
七.总结
grpc 现目前是一款非常成熟的高性能rpc框架,当前的生态是非常好的,很多公司的产品或者开源项目都有在使用grpc,有了它,相信可以让我们更容易的构建.net core 微服务,可以让 .net core 更好的接入 grpc 生态。不得不说这是 .net core 3.0 带来的最令人振奋的特性之一。
参考资料:
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。
推荐阅读
-
ASP.NET Core中使用默认MVC路由的配置
-
ASP.NET Core 3.0 WebApi中使用Swagger生成API文档简介
-
ASP.NET Core 3.0 : 二十四. 配置的Options模式
-
ASP.NET Core静态文件的使用方法
-
asp.net Core3.0区域与路由配置的方法
-
在ASP.NET Core 3.0中使用Swagger
-
详解在ASP.NET Core中使用Angular2以及与Angular2的Token base身份认证
-
在Asp.Net或.Net Core中配置使用MarkDown富文本编辑器有开源模板代码(代码是.net core3.0版本)
-
ASP.NET Core 3.0 : 二十八. 在Docker中的部署以及docker-compose的使用
-
我来告诉你:VS2019开发ASP.NET Core 3.0 Web项目,修改视图后,刷新浏览器看不到修改后的效果怎么处理