gRPC是高效能的RPC框架， 有效地用於服務通訊(不管是資料中心內部還是跨資料中心)。 由Google開源，目前是一個Cloud Native Computing Foundation（CNCF）孵化專案。 其功能包括： - 雙向流 - 強大的二進位制序列化 - 可插拔的身份驗證，負載平衡和執行狀況檢查  在gRPC中，客戶端應用程式可以**直接在A伺服器上呼叫B伺服器的方法，就好像它是本地物件一樣**，從而使您更輕鬆地建立分散式應用程式和微服務。 與許多RPC系統一樣，gRPC也是**圍繞著定義服務的思想**(定義可遠端呼叫方法的入參和返回值型別)。 > 在伺服器端，伺服器實現此介面並執行gRPC伺服器，以處理客戶端呼叫。 在客戶端，客戶端具有一個存根（在某些語言中僅稱為客戶端），提供與伺服器相同的方法。 在本文中，我將向您展示如何使用.NET5建立gRPC服務。我將分解gRPC的一些重要基礎概念，並給出一個通訊示例。 ## 1.建立一個gRPC伺服器 我們將從使用`gRPC服務模板`建立一個新的dotnet專案。 如果使用Visual Studio，請建立一個新專案，然後選擇gRPC Service模板，使用GrpcAuthor作為專案的名稱。 #### 1.1 The RPC Service Definition 客戶端與服務端使用`protocol buffers`交流/通訊： **`protocol buffers`既用作服務的介面定義語言(IDL)，又用作底層訊息交換格式**。 > ① 使用`protocol buffers`在.proto檔案中定義服務介面。在其中，定義可遠端呼叫的方法的入參和返回值型別。伺服器**實現此介面**並執行gRPC伺服器以處理客戶端呼叫。 > ② 定義服務後，使用protocol buffers編譯器`protoc`從.proto檔案生成資料訪問/傳輸類。該檔案包含服務介面中訊息和方法的實現。 關注VS腳手架專案Protos資料夾中的greet.proto。 ``` syntax = "proto3"; option csharp_namespace = "GrpcAuthor"; package greet; // The greeting service definition. service Greeter { // Sends a greeting rpc SayHello (HelloRequest) returns (HelloReply); } // The request message containing the user's name. message HelloRequest { string name = 1; } // The response message containing the greetings. message HelloReply { string message = 1; } ``` 讓我們分解一下.proto檔案，瞭解`protocol buffers`的基本語法 從.proto檔案上大致知道 定義的服務功能 (給某人一個迴應)， 這裡提示一些語法： ①. `syntax`指示使用的protocol buffers的版本。在這種情況下，proto3是撰寫本文時的最新版本。 ②. `csharp_namespace`指示生成的檔案所在的`名稱空間`。`package`說明符也是這個作用，用於防止協議訊息型別之間的名稱衝突。 > 對於C＃，如果提供選項csharp_namespace，csharp_namespace值將用作名稱空間； 在Java中，如果提供選項java_package，java_package將用作包名稱。 ③. service Greeter定義**服務基類名稱**, rpc SayHello (HelloRequest) returns (HelloReply); 是一個**一元**rpc呼叫 ④. `HelloRequest`和`HelloReply`是在客戶端和伺服器之間交換資訊的資料結構。它們被稱為`訊息`。 你在訊息欄位中定義的數字是不可重複的，當訊息被序列化為`Protobuf`時，該數字用於標識欄位，這是因為序列化一個數字比序列化整個欄位名稱要快。 #### 1.2 實現服務介面 為了從.proto檔案生成程式碼，可以使用`protoc`編譯器和C＃外掛來生成伺服器或客戶端程式碼。 腳手架專案使用`Grpc.AspNetCore` NuGet包：所需的類由構建過程自動生成, 你只需要在專案.csproj檔案中新增配置節： ```

``` > 生成的程式碼知道如何使用protocol buffers與其他服務/客戶端進行通訊。 C＃工具生成GreeterBase型別，將用作實現gRPC服務的基類。 ``` public class GreeterService : Greeter.GreeterBase { private readonly ILogger _logger; public GreeterService(ILogger logger) { _logger = logger; } public override Task SayHello(HelloRequest request, ServerCallContext context) { return Task.FromResult(new HelloReply { Message = "Hello " + request.Name }); } } ``` 最後注意註冊Grpc端點`endpoints.MapGrpcService();` --- 啟動服務---... ## 2. 建立gRPC .NET控制檯客戶端 Visual Studio建立一個名為GrpcAuthorClient的新控制檯專案。 安裝如下nuget包: Install-Package Grpc.Net.Client Install-Package Google.Protobuf Install-Package Grpc.Tools > `Grpc.Net.Client`包含.NET Core客戶端; `Google.Protobuf`包含protobuf訊息API; `Grpc.Tools`對Protobuf檔案進行編譯。 ① 拷貝服務端專案中的..proto檔案 ② 將選項csharp_namespace值修改為GrpcAuthorClient。 ③ 更新.csproj檔案的配置節 ```

``` ④ Client主檔案: ``` static void Main(string[] args) { var serverAddress = "https://localhost:5001"; using var channel = GrpcChannel.ForAddress(serverAddress); var client = new Greeter.GreeterClient(channel); var reply = client.SayHello(new HelloRequest { Name = "宋小寶！" }); Console.WriteLine(reply.Message.ToString()); Console.WriteLine("Press any key to exit..."); Console.ReadKey(); } ``` 使用伺服器地址建立`GrpcChannel`，然後使用GrpcChannel物件例項化`GreeterClient`；然後使用SayHello同步方法; 伺服器響應時，列印結果。 腳手架例子就可以入門，下面聊一聊另外的核心功能 ## 3. 其他核心功能 #### 3.1 通訊方式 - Unary RPC(一元Rpc呼叫): 上面的例子 - Server streaming RPC ： 伺服器流式RPC，客戶端在其中向伺服器傳送請求，並獲取流以讀取回一系列訊息。客戶端從返回的流中讀取，直到沒有更多訊息為止。 gRPC保證單個RPC呼叫中的訊息順序。 - Client streaming RPC：客戶端流式RPC，客戶端在其中編寫一系列訊息，然後再次使用提供的流將它們傳送到伺服器。客戶端寫完訊息後，它將等待伺服器讀取訊息並返回響應。同樣，gRPC保證了單個RPC呼叫中的訊息順序 - Bidirectional streaming RPC： 雙向流式RPC，雙方都使用讀寫流傳送一系列訊息。**這兩個流是獨立執行的**，因此客戶端和伺服器可以按照自己喜歡的順序進行讀寫：例如，伺服器可以在寫響應之前等待接收所有客戶端訊息，或者可以先讀取一條訊息再寫入一條訊息，或讀寫的其他組合。每個流中的訊息順序都會保留。 #### 3.2 Metadata 元資料是以鍵值對列表的形式提供的有關特定RPC呼叫的資訊（例如身份驗證詳細資訊），其中鍵是字串，值通常是字串，但可以是二進位制資料。 元資料對於gRPC本身是不透明的：它允許客戶端向伺服器提供與呼叫相關的資訊，反之亦然。 #### 3.3 Channels gRPC通道提供到指定主機和埠上的gRPC伺服器的連線。 建立客戶端存根時用到它，可以指定通道引數來修改gRPC的預設行為，例如開啟或關閉訊息壓縮。 通道具有狀態，包括已連線和空閒。 --- ## 4 gRPC打乒乓球 針對腳手架專案，稍作修改--->

乒乓球局 (考察gRpc雙向流式通訊、Timeout機制、異常處理): 客戶端傳送"gridsum", 服務端回發"musdirg"; 客戶端再發送"gridsum"， 往復...... ① 新增介面 ``` rpc PingPongHello(stream HelloRequest) returns (stream HelloReply); ``` ② 實現服務契約 ``` public override async Task PingPongHello(IAsyncStreamReader requestStream,IServerStreamWriter responseStream, ServerCallContext context) { try { while (!context.CancellationToken.IsCancellationRequested) { var asyncRequests = requestStream.ReadAllAsync(); // 客戶端與服務端"打乒乓" await foreach (var req in asyncRequests) { var send = Reverse(req.Name); await responseStream.WriteAsync(new HelloReply { Message = send, Id = req.Id + 1 }); Debug.WriteLine($"第{req.Id}回合，服務端收到 {req.Name}；開始第{req.Id + 1}回合,服務端回發 {send}"); } } } catch (RpcException ex) { System.Diagnostics.Debug.WriteLine($"{ex.Message}"); } catch (IOException ex) { System.Diagnostics.Debug.WriteLine($"{ex.Message}"); } } ``` ③ 新增客戶端程式碼，控制5s終斷連線 ``` using (var cancellationTokenSource = new CancellationTokenSource( 5* 1000)) { try { var duplexMessage = client.PingPongHello(null, null, cancellationTokenSource.Token); await duplexMessage.RequestStream.WriteAsync(new HelloRequest { Id = 1, Name = "gridsum" }) ; var asyncResp = duplexMessage.ResponseStream.ReadAllAsync(); await foreach (var resp in asyncResp) { var send = Reverse(resp.Message); await duplexMessage.RequestStream.WriteAsync(new HelloRequest {Id= resp.Id, Name = send }); Console.WriteLine($"第{resp.Id}回合，客戶端收到 {resp.Message}, 客戶端傳送{send}"); } } catch (RpcException ex) { Console.WriteLine("打乒乓球時間到了（客戶端5s後終斷gRpc連線）"); } } ```  https://github.com/zaozaoniao/GrpcAuthor ### 總結 gRPC是具有可插拔身份驗證和負載平衡功能的高效能RPC框架。 使用protocol buffers定義結構化資料;使用不同語言自動產生的原始碼在各種資料流中寫入和讀取結構化資料。 在本文中，您學習瞭如何使用protocol buffers（版本3）定義服務介面以及如何使用C＃實現服務。最後，您使用gRPC雙向流式通訊建立了 "打乒乓球"Demo。 ### Additional Resources • https://developers.google.com/protocol-buffers/docs/csharptutorial • https://www.grpc.io/docs/what-is-grpc/core-concepts/ • https://docs.microsoft.com/en-us/dotnet/architecture/grpc-for-wcf-developers/