微服務 - 服務之間的通信gRPC

微服務之間的通信之gRPC

介紹

gRPC是一種與語言無關的高性能遠程過程調用 (RPC) 框架，gRPC是Google發布的基於HTTP 2.0傳輸層協議承載的高性能開源軟件框架，提供了支持多種編程語言的、對網絡設備進行配置和納管的方法。由於是開源框架，通信的雙方可以進行二次開發，所以客戶端和服務器端之間的通信會更加專注於業務層面的內容，減少了對由gRPC框架實現的底層通信的關注。

gRPC 的主要優點是：

• 現代高性能輕量級 RPC 框架。
• 協定優先 API 開發，默認使用協議緩沖區，允許與語言無關的實現。
• 可用於多種語言的工具，以生成強類型服務器和客戶端。
• 支持客戶端、服務器和雙向流式處理調用。
• 使用 Protobuf 二進制序列化減少對網絡的使用。

這些優點使 gRPC 適用於：

• 效率至關重要的輕量級微服務。

• 需要多種語言用於開發的 Polyglot 系統。

• 需要處理流式處理請求或響應的點對點實時服務。

以上摘自Microsoft Document

微服務中gRPC的交互過程

 

1. 交換機在開啟gRPC功能后充當gRPC客戶端的角色，采集服務器充當gRPC服務器角色；
2. 交換機會根據訂閱的事件構建對應數據的格式（GPB/JSON），通過Protocol Buffers進行編寫proto文件，交換機與服務器建立gRPC通道，通過gRPC協議向服務器發送請求消息；
3. 服務器收到請求消息后，服務器會通過Protocol Buffers解譯proto文件，還原出最先定義好格式的數據結構，進行業務處理；
4. 數據梳理完后，服務器需要使用Protocol Buffers重編譯應答數據，通過gRPC協議向交換機發送應答消息；

交換機收到應答消息后，結束本次的gRPC交互。上圖展示的是gRPC交互過程的具體流程，這也是Telemetry觸發方式其中之一，稱為Dial-out模式。簡單地說，gRPC就是在客戶端和服務器端開啟gRPC功能后建立連接，將設備上配置的訂閱數據推送給服務器端。我們可以看到整個過程是需要用到Protocol Buffers將所需要處理數據的結構化數據在proto文件中進行定義。

微服務中gRPC的使用

1、想要使用grpc首先需要先引入gRPC的包

　　引入包的方法是：選中服務--->打開管理庫程序包管理器--->選中瀏覽--->輸入  Grpc.AspNetCore  --->選中第一個下載即可

　　注釋：兩個服務之間需要通信則這兩個服務都需要引入gRPC的包

2、添加gRPC文件

　　在服務端中添加Protos文件夾（存儲所有gRPC文件），在文件夾中添加一個  協議緩沖區文件，文件后綴為 .proto

　　設計 gRPC 的文件語法，有關 gRPC 文件語法的詳細信息，參考一些國內的博客，如《Protobuf語言指南——.proto文件語法詳解》。

　　我項目中使用的語法：

syntax = "proto3";

option csharp_namespace = "BS.GrpcServices.WorkTask";

package BS.GrpcServices.WorkTask;

service WorkTaskGrpc{
    rpc SubmitWorkTask(SubmitRequest) returns (SubmitResponse);
}  

message SubmitRequest{
    string Id = 1;
    int32  Survey = 2;
    string OrderId = 3;
}

message SubmitResponse{
    bool Result = 1;
}

代碼詳解：

• BS.GrpcServices.WorkTask：生成的程序集，供外部引用，引入方法：using BS.GrpcServices.WorkTask;

• WorkTaskGrpc：程序集中的類，也是存儲服務之間通信的方法集，引入程序集后通過繼承當前類，則可以調用類中的方法

• SubmitWorkTask：類中的方法，也是兩個服務之間通信的方法，通信的主要邏輯均存在當前方法中

• SubmitRequest：Request默認代表傳入參數，Submit與方法相匹配

• SubmitResponse：Response默認代表返回值，Submit與方法相匹配

3、項目文件配置

　　雙擊客戶端的服務項目，打開項目文件（.csproj后綴的文件），在文件中輸入以下代碼：

<ItemGroup>
  <Protobuf Include="Protos\WorkTask.proto" GrpcServices="Server" />
</ItemGroup>

　　輸入完成之后保存即可；

　　雙擊客戶端的服務項目，打開項目文件（.csproj后綴的文件），在文件中輸入以下代碼：

<ItemGroup>
  <Protobuf Include="..\BS.WorkTask.API\Protos\WorkTask.proto" GrpcServices="Client" Link="Protos\WorkTask.proto" />
</ItemGroup>

　　輸入完成之后保存即可；

4、Startup.cs文件

　　客戶端打開Startup.cs文件，輸入以下代碼：

AppContext.SetSwitch("System.Net.Http.SocketsHttpHandler.Http2UnencryptedSupport", true); //允許使用不加密的HTTP/2協議
services.AddGrpcClient<WorkTaskGrpc.WorkTaskGrpcClient>(options =>
{
     options.Address = new Uri(Configuration.GetValue<string>("ServiceUrls:WorkTaskAPI"));
});

　　代碼注解：上述代碼是打通gRPC通信的最后一個關鍵點，客戶端通過以上方法與gRPC展開通信，才能訪問到服務端的gRPC程序集（BS.GrpcServices.WorkTask）

　　特別注意：上述代碼的第一行，備注為允許使用不加密的 HTTP/2協議 是一定不能忽略的，少了此行代碼通信則無法完成，因為gRPC就是通過當前協議來完成通信的

5、方法的實現

　　實現方法通過引用gRPC程序集，繼承 WorkTaskGrpc.WorkTaskGrpcBase 類，實現方法如下：

using BS.GrpcServices.WorkTask;
using Grpc.Core;

namespace BS.WorkTask.API.Services
{
    public class WorkTaskService : WorkTaskGrpc.WorkTaskGrpcBase
    {
        public override async Task<SubmitResponse> SubmitWorkTask(SubmitRequest request, ServerCallContext context)
        {
            。。。。。。

            if(result.Succeeded)
                return new SubmitResponse() { Result = true };
            else
                return new SubmitResponse() { Result = false };
        }
    }
}

　　調用方法通過引用gRPC程序集，創建 WorkTaskGrpc.WorkTaskGrpcClient 對象，通過對象調用類中的方法，調用方法如下：

using BS.GrpcServices.WorkTask;

namespace BS.ApiAggregator.Controllers
{
    [Route("api/worktask")]
    [ApiController]
    public class WorkTaskController: ControllerBase
    {
        WorkTaskGrpc.WorkTaskGrpcClient _workTaskClient;
        public WorkTaskController(WorkTaskGrpc.WorkTaskGrpcClient workTaskClient)
        {
            _workTaskClient = workTaskClient;
        }

        [HttpPost("submit")]
        public async Task<IActionResult> SubmitAsync(GrpcServices.WorkTask.SubmitRequest request)
        {
            try
            {
                var clientResult = await _workTaskClient.SubmitWorkTaskAsync(request);
                if (clientResult.Result)
                {
                    。。。。。。
                    return Ok(OperateResult.Success);
                }
            }
            catch (Exception ex)
            {
                。。。。。
            }
        }
    }
}  

　　提醒事項：

1. 中間省略的代碼是處理邏輯，與gRPC無關
2. 調用方法在客戶端內編寫，實現方法在服務服務端被編寫，兩個位置不可混淆
3. 客戶端代表的是調用方，服務端代表的是被調用方

 總結：

　　gRPC的配置相對來說比較復雜，對於一些服務比較少的微服務來說，不建議使用，可以通過傳統的httpclient通信即可，相對於純文本傳輸來說，gRPC傳輸的是二進制數據，使得傳輸數據體積小、負載低，保持更加緊湊和高效，對於傳入的參數較大的情況的話，用gRPC的話則顯得不夠靈活

文章參考自：https://blog.csdn.net/zhaobw831/article/details/101638695

　　　　　　  https://baijiahao.baidu.com/s?id=1633335936037018920&wfr=spider&for=pc