簡介

gRPC提供了很多的語言開發(fā)包，C#也可以很容易使用。結(jié)合使用protobuf及其編譯器，很容易地生成了gRPC的服務(wù)stub和proxy。
在CSharp中使用gRPC和Protobuf，可以簡單地使用Nuget安裝grpc和protobuf的支持包。
protobuf的編譯器使用各種語言的支持插件，可以創(chuàng)建各種語言的Message及序列化操作列，以及grpc服務(wù)定義類。這些插件有java、c#、python……。

簡單示例

此示例創(chuàng)建一個(gè)gRPC的服務(wù)，已經(jīng)調(diào)用client端。利用了protobuf定義文件和protobuf編譯器來自動(dòng)生成框架。

定義一個(gè)庫項(xiàng)目

在這個(gè)庫中，使用protobuf定義傳遞的Message，已經(jīng)service的api定義。 如下的`grpchello.pb`這是一個(gè)protobuf定義文件。 syntax = "proto3"; package grpcDemo;message HelloRequest {string name = 1; }message HelloReply {string message = 1; }service gRPC {rpc SayHello (HelloRequest) returns (HelloReply) {} }

接著需要使用protobuf編譯器，編譯準(zhǔn)備好的protobuf定義文件，為我們生成服務(wù)定義和消息定義等各種class。

• 先使用nuget安裝grpc和protobuf包：搜索Grpc包和Google.Protobuf依賴包，這2個(gè)包在下面的server和client工程中也需要安裝。
• 這個(gè)庫因?yàn)樾枰褂胮rotobuf的編譯器，還需要安裝一個(gè)Grpc.Tools的工具包。

在安裝了Grpc.Tools后，在solution目錄下的packages\Grpc.Tools.1.4.1\tools\windows_x64下，包括了protoc.exe已經(jīng)cs的生成插件grpc_csharp_plugin.exe。然后我們可以使用它們編譯protobuf定義文件，生成cs源碼了。
到protoc.exe命令的對(duì)應(yīng)目錄下，執(zhí)行

packages\Grpc.Tools.1.4.1\tools\windows_x64\protoc.exe -IgrpcDemo --csharp_out grpcDemo --grpc_out grpcDemo --plugin=protoc-gen-grpc=packages\Grpc.Tools.1.4.1\tools\windows_x64\grpc_csharp_plugin.exe grpcDemo\grpchello.pb

執(zhí)行后，會(huì)生成Grpchello.cs和GrpchelloGrpc.cs源碼文件。將源碼文件添加到工程中，然后編譯好庫文件。
- 在Grpchello.cs類，定義了傳遞的Message。
- 在GrpchelloGrpc.cs中，定義了grpc服務(wù)stub和proxy的形式。

插件grpc的服務(wù)端

現(xiàn)在，根據(jù)我們定義的grpc服務(wù)接口API，我們需要實(shí)現(xiàn)服務(wù)，為調(diào)用的客戶端提供服務(wù)。

創(chuàng)建一個(gè)應(yīng)用工程，就使用最簡單的Console 應(yīng)用。添加上面的庫工程依賴。然后使用Nuget安裝Grpc依賴。

• 實(shí)現(xiàn)服務(wù)API

實(shí)現(xiàn)gRPC.gRPCBase類，實(shí)現(xiàn)我們定義的方法。

class gRPCImpl : gRPC.gRPCBase{// 實(shí)現(xiàn)SayHello方法public override Task<HelloReply> SayHello(HelloRequest request, ServerCallContext context){Console.WriteLine("Get : " + request.Name);return Task.FromResult(new HelloReply { Message = "Hello " + request.Name });}}

• 在應(yīng)用中啟動(dòng)服務(wù)

使用Grpc.Core中提供的Server類，指定服務(wù)端口，和提供服務(wù)的實(shí)現(xiàn)類。

using Grpc.Core;using GrpcDemo;//....class Program{static void Main(string[] args){const int Port = 9007;Server server = new Server{Services = { gRPC.BindService(new gRPCImpl()) },Ports = { new ServerPort("localhost", Port, ServerCredentials.Insecure) }};server.Start();Console.WriteLine("gRPC server listening on port " + Port);Console.WriteLine("任意鍵退出...");Console.ReadKey();server.ShutdownAsync().Wait();}}

創(chuàng)建客戶端

為使用grpc服務(wù)，需要一個(gè)客戶端。簡單地創(chuàng)建一個(gè)Console App應(yīng)用。
然后添加Grpc依賴包，和開始的工程依賴庫grpcDemo。

using Grpc.Core; using GrpcDemo;//....class Program{static void Main(string[] args){Channel channel = new Channel("127.0.0.1:9007", ChannelCredentials.Insecure);var client = new gRPC.gRPCClient(channel);for (int i = 0; i < 5; i++){var reply = client.SayHello(new HelloRequest { Name = " -- client "+ i});Console.WriteLine("來自" + reply.Message);}channel.ShutdownAsync().Wait();Console.WriteLine("任意鍵退出...");Console.ReadKey();}}

如示例所示，客戶端通過一個(gè)channel創(chuàng)建一個(gè)gRPCClient，在Channel中指定了服務(wù)地址和安全方式，client為服務(wù)的proxy。調(diào)用方式很簡單，和普通的API一致。

執(zhí)行測(cè)試

編譯完成后，分別到服務(wù)端和客戶端，啟動(dòng)應(yīng)用，可以看到調(diào)用及結(jié)果。

總結(jié)

以上是生活随笔為你收集整理的在C#中使用gRPC及protobuf简介的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。