c#description_浅议C#客户端和服务端通信的几种方法：Rest和GRPC和其他

本文来自&＃xff1a;https://michaelscodingspot.com/rest-vs-grpc-for-asp-net/

在C&＃xff03;客户端和C&＃xff03;服务器之间进行通信的方法有很多。一些功能强大&＃xff0c;而其他功能则不是很多。有些非常快&＃xff0c;有些则不是。知道不同的选择很重要&＃xff0c;这样您才能决定最适合自己的选择。

本文将介绍当今最流行的技术&＃xff0c;以及为何如此广泛地使用它们。我们将讨论REST&＃xff0c;gRPC及其两者之间的所有内容。

最佳方案

让我们考虑一下我们希望如何在最佳环境中使客户端与服务器之间的通信看起来像。我在想像这样的东西&＃xff1a;

// on client sidepublic void Foo(){ var server &＃61; new MyServer(new Uri("https://www.myserver.com/");) int sum &＃61; server.Calculator.SumNumbers(12,13); }

// on server sideclass CalculatorController : Controller{ public int SumNumbers(int a, int b) { return a &＃43; b; }}

我当然想要完整的Intellisense。当我单击server并. 希望Visual Studio显示所有控制器时。当我单击CalculatorController和时.&＃xff0c;我想查看所有操作。我还想要一流的性能&＃xff0c;很少的网络负载和双向通信。而且我想要一个能够完美处理版本控制的强大系统&＃xff0c;这样我就可以毫不费力地部署新的客户端版本和新的服务器版本。

要求太多吗&＃xff1f;

请注意&＃xff0c;我在这里谈论的是无状态API。这等效于C&＃xff03;项目&＃xff0c;其中只有两种类型的类&＃xff1a;

•静态类&＃xff0c;只有静态方法。•POCO类^[1]仅具有类型为基本类型或其他POCO类的字段和属性。

在API中使用状态会带来复杂性&＃xff0c;而这正是万恶之源。因此&＃xff0c;为了本文的方便&＃xff0c;让我们保持美好和无状态。

传统REST

REST API出现在2000年代初期&＃xff0c;席卷了整个互联网。到目前为止&＃xff0c;它是创建Web服务的最流行的方法。

REST为客户端到服务器的请求定义了一组固定的操作GET&＃xff0c;POST&＃xff0c;PUT和DELETE。每个请求都将通过包含有效负载(通常为JSON)的响应来回答。请求包含在查询本身中的参数&＃xff0c;或者在它是POST请求时包含为有效负载(通常为JSON)的参数。

有一个称为RESTful API的标准&＃xff0c;它定义了以下规则(您实际上不必使用它)&＃xff1a;

•GET用于检索资源•PUT用于更改资源状态•POST用于创建资源•DELETE用于删除资源

如果您到目前为止还不熟悉REST&＃xff0c;则上面的解释可能不会减少它&＃xff0c;因此这里有一个示例。在.NET中&＃xff0c;内置了对REST的支持。实际上&＃xff0c;默认情况下&＃xff0c;ASP.NET Web API被构建为REST Web服务。这是典型的客户端和ASP.NET服务器的外观&＃xff1a;

在服务器中&＃xff1a;

[Route("People")]public class PeopleController : Controller{ [HttpGet] public Person GetPersonById(int id) { Person person &＃61; _db.GetPerson(id); return person;//Automatically serialized to JSON }}

在客户中&＃xff1a;

var client &＃61; new HttpClient();string resultJson &＃61; await client.GetStringAsync("https://www.myserver.com/People/GetPersonById?id&＃61;123");Person person &＃61; JsonConvert.DeserializeObject(resultJson);

REST非常方便&＃xff0c;但是并没有达到最佳方案。因此&＃xff0c;让我们看看是否可以做得更好。

ReFit

ReFit不能替代REST。相反&＃xff0c;它建立在REST之上&＃xff0c;并允许我们像调用简单方法一样调用服务器端点。这是通过在客户端和服务器之间共享接口来实现的。在服务器端&＃xff0c;您的控制器将实现一个接口&＃xff1a;

public interface IMyEmployeeApi{ [Get("/employee/{id}")] Task GetEmployee(string id);}

然后&＃xff0c;在客户端&＃xff0c;您需要包括相同的接口并使用以下代码&＃xff1a;

var api &＃61; RestService.For("https://www.myserver.com");var employee &＃61; await api.GetEmployee("abc");

就这么简单。除了几个NuGet软件包外&＃xff0c;无需运行困难的自动化程序或使用任何第三方工具。

这更接近最佳方案。现在&＃xff0c;我们有了IntelliSense&＃xff0c;并且客户端和服务器之间的合同很牢固。但是还有另一种选择&＃xff0c;在某些方面甚至更好。

昂首阔步

像ReFit一样&＃xff0c;Swagger也建立在REST之上。OpenAPI^[2]或Swagger是REST API的规范。它描述了具有简单JSON文件的REST Web服务。这些文件是Web服务的API架构。它们包括&＃xff1a;

•API中的所有路径(URL)。•每个路径的预期操作(GET&＃xff0c;POST等)。每个路径可以处理不同的操作。例如&＃xff0c;单个路径https://mystore.com/Product可能接受添加产品的POST操作和返回产品的GET操作。•每个路径和操作的预期参数。•每个路径的预期响应。•每个参数和响应对象的类型。

该JSON文件实质上是客户端和服务器之间的合同。这是一个描述一个称为Swagger Petstore^[3]的Web服务的swagger文件的示例(为清楚起见&＃xff0c;我删除了一些部分)&＃xff1a;

{ "swagger":"2.0", "info":{ "version":"1.0.0", "title":"Swagger Petstore", "description":"A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification", }, "host":"petstore.swagger.io", "basePath":"/api", "schemes":[ "http" ], "consumes":[ "application/json" ], "produces":[ "application/json" ], "paths":{ "/pets":{ "get":{ "description":"Returns all pets from the system that the user has access to", "operationId":"findPets", "produces":[ "application/json", "application/xml", ], "parameters":[ { "name":"tags", "in":"query", "description":"tags to filter by", "required":false, "type":"array", "items":{ "type":"string" }, "collectionFormat":"csv" }, { "name":"limit", "in":"query", "description":"maximum number of results to return", "required":false, "type":"integer", "format":"int32" } ], "responses":{ "200":{ "description":"pet response", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/Pet" } } },...

让我们考虑一下这个结果。使用上面的JSON文件&＃xff0c;您可以潜在地创建具有完整IntelliSense的C&＃xff03;客户端。毕竟&＃xff0c;您知道所有路径&＃xff0c;操作&＃xff0c;它们期望的参数&＃xff0c;什么参数类型&＃xff0c;什么是响应等等。

有几种工具可以做到这一点。对于服务器端&＃xff0c;可以使用Swashbuckle.AspNetCore^[4]将Swagger添加到ASP.NET中并生成所述JSON文件。对于客户端&＃xff0c;您可以使用swagger-codegen^[5]和AutoRest^[6]来使用这些JSON文件并生成客户端。让我们看一个如何做到这一点的例子&＃xff1a;

将Swagger添加到ASP.NET服务器

首先添加NuGet包Swashbuckle.AspNetCore^[7]。在中ConfigureServices&＃xff0c;注册Swagger生成器&＃xff1a;

services.AddSwaggerGen(options &＃61;> options.SwaggerDoc("v1", new OpenApiInfo {Title &＃61; "My Web API", Version &＃61; "v1"}));

在添加Configure方法中Startup.cs&＃xff1a;

app.UseSwagger();

最后&＃xff0c;控制器内部的动作应使用[HttpXXX]和[FromXXX]属性修饰&＃xff1a;

[HttpPost]public async Task AddEmployee([FromBody]Employee employee){ //...}[HttpGet]public async Task Employee([FromQuery]string id){ //...}

就像服务器端一样简单。运行项目时&＃xff0c;swagger.json将生成一个文件&＃xff0c;可用于生成客户端。

使用AutoRest从Swagger生成客户端

要开始使用AutoRest^[8]&＃xff0c;与安装NPM^[9]&＃xff1a;npm install -g autorest。安装后&＃xff0c;您将需要使用AutoRest的命令行界面从该swagger.json文件生成C&＃xff03;客户端。这是一个例子&＃xff1a;

autorest --input-file&＃61;"./swagger.json" --output-folder&＃61;"GeneratedClient" --namespace&＃61;"MyClient" --override-client-name&＃61;"MyClient" --csharp

这将产生一个GeneratedClient包含生成的C&＃xff03;文件的文件夹。请注意&＃xff0c;名称空间和客户端名称被覆盖。从这里&＃xff0c;将此文件夹添加到Visual Studio中的客户端项目。

您需要安装Microsoft.Rest.ClientRuntimeNuGet软件包&＃xff0c;因为生成的代码取决于该软件包。安装后&＃xff0c;您可以像使用常规C&＃xff03;类一样使用API&＃xff1a;

var client &＃61; new MyClient();Employee employee &＃61; client.Employee(id: "abc");

您可以在AutoRest的文档中^[10]阅读一些细微之处。而且您需要使该过程自动化&＃xff0c;因此我建议阅读Patrik Svensson的教程&＃xff0c;^[11]以获得一些好的建议以及Peter Jausovec的这篇文章^[12]。

Swagger的问题是JSON文件是在运行时创建的&＃xff0c;因此这使得在CI / CD流程中实现自动化有点困难。

传统REST vs Swagger vs ReFit

进行选择时&＃xff0c;请注意以下几点。

•如果您有一个非常简单的私有REST API&＃xff0c;则也许不必理会客户端生成和共享接口。小任务并不能证明付出额外的努力是合理的。•Swagger支持多种语言&＃xff0c;而ReFit仅支持.NET。Swagger还是许多工具&＃xff0c;测试&＃xff0c;自动化和UI工具的基础。如果您要创建一个大型的公共API&＃xff0c;它将可能是最佳选择。•Swagger比ReFit复杂得多。使用ReFit&＃xff0c;只需在服务器和客户端项目中添加一个接口即可。另一方面&＃xff0c;使用ReFit&＃xff0c;您必须为每个控制器创建新的接口&＃xff0c;而Swagger会自动进行处理。

但是在决定任何事情之前&＃xff0c;请检查与REST无关的第四个选项。

gRPC

gRPC^[13](gRPC远程过程调用)是Google开发的开源远程过程调用系统。它有点像REST&＃xff0c;它提供了一种将请求从客户端发送到服务器的方式。但这在许多方面都不同&＃xff0c;这是相同点和不同点&＃xff1a;

•像REST一样&＃xff0c;gRPC与语言无关。有适用于所有流行语言的工具&＃xff0c;包括C&＃xff03;。•gRPC是契约的基础&＃xff0c;并使用.proto文件来定义契约。这有点类似于Swaggerswagger.json和ReFit的共享界面。可以从那些文件中生成任何编程语言的客户端。•gRPC使用协议缓冲区(Protobuf)^[14]二进制序列化。这与REST(通常序列化为JSON或XML)不同。二进制序列化较小&＃xff0c;因此更快。•gRPC用于使用HTTP / 2协议创建持久连接。该协议更简单&＃xff0c;更紧凑。REST使用HTTP 1.x协议(通常为HTTP 1.1)。•HTTP 1.1要求每个请求都进行TCP握手&＃xff0c;而HTTP / 2则保持连接打开。•HTTP / 2连接使用多路复用流。这意味着单个TCP连接可以支持许多流。这些流可以并行执行&＃xff0c;而不必像HTTP 1.1中那样互相等待。•gRPC允许双向流。

有两种使用gRPC的方法。对于.NET Core 3.0&＃xff0c;有一个完全托管的库&＃xff0c;称为.NET的gRPC^[15]。对于其中的任何内容&＃xff0c;您都可以使用gRPC C&＃xff03;^[16]&＃xff0c;它是使用本机代码构建的。这并不意味着适用于.NET的gRPC可以替代gRPC C&＃xff03;。让我们来看一个用于.NET的更新gRPC的示例。

.NET的gRPC的服务器端

这不是教程&＃xff0c;而是更多有关预期内容的一般性想法。这是示例控制器在gRPC中的外观&＃xff1a;

public class GreeterService : Greeter.GreeterBase{ public override Task SayHello(HelloRequest request, ServerCallContext context) { _logger.LogInformation("Saying hello to {Name}", request.Name); return Task.FromResult(new HelloReply { Message &＃61; "Hello " &＃43; request.Name }); }}

您需要添加以下的Configure在Startup.cs&＃xff1a;

app.UseEndpoints(endpoints &＃61;>{ endpoints.MapGrpcService();});

API在.proto文件中描述&＃xff0c;该文件是项目的一部分&＃xff1a;

syntax &＃61; "proto3";service Greeter { rpc SayHello (HelloRequest) returns (HelloReply);}message HelloRequest { string name &＃61; 1;}message HelloReply { string message &＃61; 1;}

此.proto文件添加到.csproj&＃xff1a;

Include&＃61;"Protos\greet.proto" />

.NET的gRPC客户端

客户端是从.proto文件生成的。代码本身非常简单&＃xff1a;

var channel &＃61; GrpcChannel.ForAddress("https://localhost:5001");var client &＃61; new Greeter.GreeterClient(channel);var response &＃61; await client.SayHello( new HelloRequest { Name &＃61; "World" });Console.WriteLine(response.Message);

gRPC与REST

gRPC听起来不错。它在框架下更快&＃xff0c;更简单。那么&＃xff0c;我们都应该从REST变为gRPC吗&＃xff1f;答案是&＃xff0c;这取决于你的应用场景。

以下是一些注意事项&＃xff1a;

从我的印象来看&＃xff0c;使用gRPC和ASP.NET仍然不是很好。借助对REST的成熟支持&＃xff0c;您会变得更好。就基于契约的通信而言&＃xff0c;这很不错&＃xff0c;除了在REST中有我们已经讨论过的类似替代方案&＃xff1a;Swagger和ReFit。

最大的优势是性能。根据这些基准^[17]&＃xff0c;在大多数情况下&＃xff0c;gRPC更快。特别是对于大型有效载荷&＃xff0c;Protobuf序列化确实有所作为。这意味着对于高负载服务器而言&＃xff0c;这是一个巨大的优势。

在大型ASP.NET应用程序中从REST过渡到gRPC将非常困难。但是&＃xff0c;如果您具有基于微服务的体系结构&＃xff0c;那么逐步完成此过渡就变得容易得多。

其他沟通方式

还有其他一些我完全没有提及的通信方式&＃xff0c;但是值得一提的是&＃xff1a;

•GraphQL^[18]是Facebook开发的API的查询语言。它允许客户端从服务器确切地要求它需要的数据。这样&＃xff0c;您可以在服务器上仅创建一个端点&＃xff0c;该端点将非常灵活&＃xff0c;并且仅返回客户端所需的数据。近年来&＃xff0c;GraphQL变得非常流行。•SignalR^[19]是一项允许服务器与客户端之间进行实时双向通信的技术。SignalR不仅允许客户端始终向服务器发送请求&＃xff0c;还允许服务器向客户端发送推送通知。这样可以查看Web应用程序中的实时更新。SignalR在ASP.NET中非常流行。•TcpClient^[20]和TcpListener^[21](在中System.Net.Sockets)提供基于TCP的低级连接。基本上&＃xff0c;您将建立连接并传输字节数组。对于大型应用程序而言&＃xff0c;它不是理想的选择&＃xff0c;在大型应用程序中&＃xff0c;您可以使用ASP.NET的控制器和操作在大型API中进行订购。•UdpClient^[22]提供了一种通过UDP协议进行通信的方法。TCP建立连接&＃xff0c;然后发送数据&＃xff0c;而UDP仅发送数据。TCP确保数据中没有错误&＃xff0c;而UDP没有。UDP可以更有效地快速传输数据&＃xff0c;您不必担心它是否可靠且没有错误。一些示例是&＃xff1a;视频流&＃xff0c;实时广播和IP语音(VoIP)。•WCF^[23]是一种较旧的技术&＃xff0c;主要在进程之间使用基于SOAP的通信。这是一个庞大的框架&＃xff0c;我要说的是它已不再受REST和JSON负载的欢迎。

References

[1] POCO类: https://www.c-sharpcorner.com/UploadFile/5d065a/poco-classes-in-entity-framework/[2] OpenAPI: https://swagger.io/specification/[3] Swagger Petstore: https://bfanger.nl/swagger-explained/#operationObject[4] Swashbuckle.AspNetCore: https://github.com/domaindrivendev/Swashbuckle.AspNetCore[5] swagger-codegen: https://github.com/swagger-api/swagger-codegen[6] AutoRest: https://azure.github.io/autorest/[7] Swashbuckle.AspNetCore: https://www.nuget.org/packages/Swashbuckle.AspNetCore[8] AutoRest: https://github.com/Azure/autorest[9] NPM: https://www.w3schools.com/nodejs/nodejs_npm.asp[10] 文档中: https://azure.github.io/autorest/client/ops.html[11] 教程&＃xff0c;: https://www.patriksvensson.se/2018/10/generating-api-clients-using-autorest[12] 文章: https://medium.com/&＃64;pjausovec/creating-c-client-library-for-web-api-projects-be132c831f9c[13] gRPC: https://grpc.io/[14] 协议缓冲区(Protobuf): https://en.wikipedia.org/wiki/Protocol_Buffers[15] .NET的gRPC: https://github.com/grpc/grpc-dotnet[16] gRPC C&＃xff03;: https://github.com/grpc/grpc/tree/master/src/csharp[17] 根据这些基准: https://www.yonego.com/nl/why-milliseconds-matter/#gref[18] GraphQL: https://graphql.org/[19] SignalR: https://github.com/SignalR/SignalR[20] TcpClient: https://docs.microsoft.com/en-us/dotnet/api/system.net.sockets.tcpclient?view&＃61;netframework-4.8[21] TcpListener: https://docs.microsoft.com/en-us/dotnet/api/system.net.sockets.tcplistener?view&＃61;netframework-4.8[22] UdpClient: https://docs.microsoft.com/en-us/dotnet/api/system.net.sockets.udpclient?view&＃61;netframework-4.8[23] WCF: https://docs.microsoft.com/en-us/dotnet/framework/wcf/whats-wcf