NET Core使用Grpc通訊（一）：一元請求

gRPC是一個現代的開源高效能遠端過程呼叫(RPC)框架，它可以高效地連線資料中心內和跨資料中心的服務，支援負載平衡、跟蹤、執行狀況檢查和身份驗證。

gRPC透過使用 Protocol Buffers 作為資料傳輸格式，實現了在不同平臺上的通訊，並支援雙向流和流式傳輸。RPC 是遠端過程呼叫的縮寫，實現跨伺服器呼叫。在開發中，規定呼叫規則、網路傳輸協議以及資料序列化反序列化規範是確保前後端通訊規範性的關鍵。

瞭解GRpc前需要了解Rpc概念。

什麼是 RPC

RPC 是 Remote Procedure Call 的簡稱，中文叫遠端過程呼叫。

說的白話一點，可以這麼理解：比如有兩臺伺服器A和B，A伺服器上的應用想呼叫B伺服器上的另一個應用提供的方法，但由於不在同一個記憶體空間，無法直接呼叫，所以需要透過網路來實現呼叫效果。

其實大家在平時開發中有接觸過，例如：前端去請求後端的介面。我們來想一下前後端要制定什麼規則，才能進行介面請求：

• 呼叫的語義，也可以理解為介面規範。(比如 RESTful )
• 網路傳輸協議 (比如 HTTP )
• 資料序列化反序列化規範(比如 JSON )

只有制定了這些規則，才能保證前後端通訊的規範性

互動圖

從上圖中可以看出，RPC 是一種客戶端-服務端（Client/Server）模式。從某種角度來看，所有本身應用程式之外的呼叫都可以歸類為 RPC。無論是微服務、第三方 HTTP 介面，還是讀寫資料庫中介軟體 Mysql、Redis。

RPC 特點

• RPC 是一種協議。RPC實現包括：Dubbo、Thrift、Grpc、Netty等。
• 網路協議和網路 IO 模型對其透明。RPC 的客戶端認為自己是在呼叫本地物件，因此其對使用的網路協議（ HTTP 協議等）以及網路 IO 模型，是不關心的。
• 資訊格式對其透明。呼叫方法是需要傳遞引數的，對於遠端呼叫來說，傳遞過程中引數的資訊格式是怎樣構成，以及提供者如何使用這些引數，都是不用關心的。
• 有跨語言能力。因為呼叫方實際上也不清楚遠端伺服器的應用程式是使用什麼語言執行的。那麼對於呼叫方來說，無論伺服器方使用的是什麼語言，本次呼叫都應該成功，並且返回值也應該按照呼叫方程式語言所能理解的形式進行描述。

RPC 與 HTTP 的對比

其實 RPC 跟 HTTP 不是一個層級的東西，RPC 應該是跟 HTTP + RestFul 進行對比。

深入瞭解：HTTP 與 RPC 介面區別

傳輸協議

RPC 可以基於 HTTP 或者 TCP 進行傳輸，而 HTTP 只能基於 HTTP

傳輸效率

RPC 包含了 HTTP2 的優點，所以他的傳輸效率比 HTTP1 更高~

效能消耗

RPC 包含 HTTP2 的優點，比如二進位制傳輸、頭部壓縮等，所以效能消耗自然比 HTTP1 低~

負載均衡

RPC 基本都自帶負載均衡策略，而 HTTP 需要配置 Nginx/HAProxy 來完成

服務治理

RPC 能做到自動通知，不影響上游，而 HTTP 需要事先通知，修改 Nginx/HAProxy 配置

gRPC 和 RPC 的關係

Grpc 是由谷歌開源的一種 RPC 框架，設計之初便是為了解決谷歌內部的 RPC 使用場景所遇到的問題。因此你可以說 gRPC 就是一種 RPC 框架型別。具體來說:

• RPC是一種程式設計正規化,定義了客戶端像呼叫本地函式一樣呼叫遠端函式的方式。
• gRPC 是 Google 基於 HTTP/2 和 Protocol Buffers 實現的 RPC 框架。
• gRPC 支援雙向流、流控、頭壓縮等,效能優異。

所以 gRPC 是 RPC 模式的一種高效實現，提供了語言中立、高效能、安全的 RPC 服務框架，使得RPC服務呼叫更加高效、簡單、通用。它是 RPC 模式的一種優秀代表。

gRPC 的優勢有哪些？

gRPC 是基於 HTTP/2 設計的~所以 gRPC 的優點自然也包含了 HTTP/2 的優點：

• 資料傳輸二進位制分幀
• 多路複用
• 服務端推送
• 頭部壓縮

gRPC的主要優勢及其簡要描述：

優勢	描述
高效能	利用HTTP/2提供高效的網路傳輸，支援雙向流、頭部壓縮、多路複用。
跨語言支援	支援多種程式語言間的無縫通訊和整合。
自動化生成程式碼	使用Protobuf定義服務，自動生成客戶端和伺服器程式碼。
錯誤處理	定義豐富的錯誤碼和狀態碼，便於異常處理和除錯。
通訊模式多樣	支援多種RPC通訊模型，如一對一、服務端流、客戶端流、雙向流等。
可擴充套件性	攔截器和外掛機制允許功能的擴充套件和定製。
社群和生態系統	擁有活躍的社群支援和豐富的相關工具及庫。

gRPC 是怎麼傳輸的？

服務端 Stub 接收客戶端請求,處理請求中的 Protobuf 資料並進行反序列化，然後將請求物件傳入伺服器並實現業務邏輯處理。最終再將響應序列化後返回給客戶端，從而形成一次完整的介面呼叫過程。

以上概念以及相關知識點來自apifox。

NET Core實現Grpc呼叫

話不多說，以下內容詳細介紹一元呼叫的過程，貼程式碼。

-----------------服務端程式碼 Start-----------------

步驟一：

在Grpc服務端(Server)先建立一個.potos檔案。檔名（IBook_Service.proto）檔案路徑（Protos/IBook_Service.proto）

//表明使用protobuf的編譯器版本為v2,目前最新的版本為v3。
syntax = "proto3";

//定義名稱空間
option csharp_namespace = "ZP_BookService_Grpc.Application.Book_Service";

//包名：多個 .proto 檔案生成程式碼時，可避免命名衝突。
package Book_Service;

//1、定義介面名稱，用於後期實現
service IBook_Service{
 
 // 1.1 根據商品主鍵，獲取商品
 rpc GetBook (BookFrom) returns (BookDto);
}

// 2、定義入參(類)Form：順序要寫，且不能重複
message BookFrom{
    string BookName = 1; 
}

// 3、定義出參Dto(類)：順序要寫，且不能重複
message BookDto{
    string ID = 1; 
    string CreateTime = 2; 
    string BookName = 3; 
    string BookPrice =4;
    string PublicationDate = 5;
    string Type = 6;
    string Publisher = 7;
    int32  Residue = 8;
}

步驟二：

檔案建立好後需要在專案的csproj檔案中Project內加上檔案的目錄（Protos\IBook_Service.prot） GrpcServices意思是服務端，一定要加上<Protobuf Include="Protos\IBook_Service.proto" GrpcServices="Server" />

引用包（Google.Protobuf、Grpc.AspNetCore、Grpc.Tools）

完成以上步驟，右鍵專案選擇 “重新生成”。生成以後可以在專案的obj資料夾（~\Application_Grpc\obj\Debug\net7.0\Protos）看到一個自動生成的Protos資料夾

<ItemGroup>
    <PackageReference Include="Google.Protobuf" Version="3.26.0" />
    <PackageReference Include="Grpc.AspNetCore" Version="2.61.0" />
    <PackageReference Include="Grpc.Tools" Version="2.62.0" />
</ItemGroup>
<ItemGroup>
	<Protobuf Include="Protos\IBook_Service.proto" GrpcServices="Server" />
</ItemGroup>

步驟三：

建立一個實現類（Book_Service）用於實現protos資料夾內自動生成的介面（IBook_Service.IBook_ServiceBase）。注：實現帶有Base的介面。介面名稱是定義proto檔案的時候自定義的。

namespace Application_Grpc.Application.BusinessServices
{
    //注入作用域生命週期
    [Service(ServiceLifetime.Scoped)]
    public class Book_Service : IBook_Service.IBook_ServiceBase
    {
        private IBook_Repository _bookRepository { get; }
        private IMapper _mapper { get; }
        public Book_Service(IBook_Repository book_Repository, IMapper mapper)
        {
            _bookRepository = book_Repository;
            _mapper = mapper;
        }
        public override async Task<BookDto> GetBook(BookFrom request, ServerCallContext context)
        {
            BookDto data=new BookDto();
            data.ID = Guid.NewGuid().ToString();
            data.CreateTime = DateTime.Now.ToString();
            data.BookName = request.BookName;
            data.BookPrice = "29.99";
            data.PublicationDate = "1999-03-21";
            data.Type = "經典";
            data.Publisher = "清華大學出版社";
            data.Residue = 5;
            return data;
        }
    }
}

至此，服務端的Grpc就完成了。剩下的就是把專案進行服務依賴注入操作，本例項程式碼透過貼特徵方式注入。可以在 Program.cs 以常規方式注入自己的服務。

如：builder.Services.AddSingleton<Book_Service>();

-----------------服務端程式碼 END-----------------

-----------------客戶端程式碼 Start-----------------

步驟一：

步驟一：

在Grpc服務端(Client)先建立一個.potos檔案。檔名（IBook_Service.proto）檔案路徑（Protos/IBook_Service.proto）。其實就是複製服務端的 proto 修改下 名稱空間

//表明使用protobuf的編譯器版本為v2,目前最新的版本為v3。
syntax = "proto3";

//定義名稱空間
option csharp_namespace = "ZP_ProjectEntrance.MicroService.Book_Service";

//包名：多個 .proto 檔案生成程式碼時，可避免命名衝突。
package Book_Service;

//1、定義介面名稱，用於後期實現
service IBook_Service{
 
 // 1.1 根據商品主鍵，獲取商品
 rpc GetBook (BookFrom) returns (BookDto);
}

// 2、定義入參(類)Form：順序要寫，且不能重複
message BookFrom{
    string BookName = 1; 
}

// 3、定義出參Dto(類)：順序要寫，且不能重複
message BookDto{
    string ID = 1; 
    string CreateTime = 2; 
    string BookName = 3; 
    string BookPrice =4;
    string PublicationDate = 5;
    string Type = 6;
    string Publisher = 7;
    int32  Residue = 8;
}

步驟二：

檔案建立好後需要在專案的csproj檔案中加上檔案的目錄（Protos\IBook_Service.prot） GrpcServices意思是客戶端（Client），一定要加上 <Protobuf Include="Protos\IBook_Service.proto" GrpcServices="Client" />

引用包（Google.Protobuf、Grpc.AspNetCore、Grpc.Tools）

完成以上步驟，右鍵專案選擇 “重新生成”。生成以後可以在專案的obj資料夾（~\ZP_ProjectEntrance\obj\Debug\net7.0\Protos）看到一個自動生成的Protos資料夾

<ItemGroup>
    <PackageReference Include="Google.Protobuf" Version="3.26.0" />
    <PackageReference Include="Grpc.AspNetCore" Version="2.61.0" />
    <PackageReference Include="Grpc.Tools" Version="2.62.0" />
</ItemGroup>
<ItemGroup>
	<Protobuf Include="Protos\IBook_Service.proto" GrpcServices="Client" />
</ItemGroup>

步驟三：重點、重點、重點~

建立一個客戶端類（ClientHelper）用於對接到Grpc的服務端，透過Func型委託形式構建，做成公共的請求服務端入口。

public static class GrpcClientHelper
{
    /// <summary>
    /// 一元rpc呼叫
    /// </summary>
    /// <typeparam name="TClient">客戶端型別</typeparam>
    /// <typeparam name="TRequest">請求型別  </typeparam>
    /// <typeparam name="TResponse">服務端響應返回型別</typeparam>
    /// <typeparam name="TResult">方法返回型別 </typeparam>
    /// <param name="serverAddress">請求服務端地址</param>
    /// <param name="callFunc">非同步呼叫 gRPC方法的委託 </param>
    /// <param name="request">封裝請求物件(資料)</param>
    /// <param name="clientFactory">建立 gRPC 客戶端的委託工廠方法  </param>
    /// <returns></returns>
    public static async Task<TResult> CallGrpcServiceAsync<TClient, TRequest, TResponse, TResult>(
        string serverAddress, Func<TClient, TRequest, Task<TResponse>> callFunc, TRequest request, Func<GrpcChannel, TClient> clientFactory)
        where TClient : class
        where TRequest : class
        where TResponse : class
    {
        using var channel = GrpcChannel.ForAddress(serverAddress);
        var client = clientFactory(channel);
        try
        {
            var response = await callFunc(client, request);
            // 這裡新增轉換邏輯，如果 TResponse 不是 TResult,強制型別轉換，需要確保型別相容 
            return (TResult)(object)response;
        }
        catch (RpcException)
        {
            // 處理異常  
            throw;
        }
    }
    /// <summary>
    /// 獲取某個欄位的值
    /// </summary>
    /// <typeparam name="Source"></typeparam>
    /// <param name="source"></param>
    /// <param name="field"></param>
    /// <returns></returns>
    public static object GetFieldValue<Source>(Source source, string field)
    {
        var fieldProperty = source.GetType().GetProperty(field);
        if (fieldProperty != null)
            return fieldProperty.GetValue(source);
        else
            return null;
    }
}

步驟四：

透過Controllers定義的方法，以請求方法形式進行呼叫到GrpcClientHelper

namespace ZP_ProjectEntrance.Controllers
{
    [Route("api/[controller]")]
    [ApiController]
    public class BooKController : ControllerBase
    {
        private readonly ILogger<BooKController> _logger;
        public BooKController(ILogger<BooKController> logger)
        {
            _logger = logger;
        }
        /// <summary>
        /// 獲取書籍資訊
        /// </summary>
        /// <returns></returns>
        [HttpGet(Name = "GetBook")]
        public async Task<BookDto> GetBookAsync()
        {
            // 服務端地址，可以擴充套件為請求分散式叢集
            string serverAddress = "http://localhost:5031";
            // 使用 GrpcClientHelper 來呼叫 gRPC 服務 ,  
            BookDto bookDto = await GrpcClientHelper.CallGrpcServiceAsync<IBook_Service.IBook_ServiceClient, BookFrom, BookDto, BookDto>(
                serverAddress,
                async (client, request) => await client.GetBookAsync(request),  // 非同步呼叫 gRPC 方法的委託  
                new BookFrom { BookName = "三國演義" },                          // 封裝請求物件(值)
                (channel) => new IBook_Service.IBook_ServiceClient(channel)     // 實現 gRPC 客戶端的委託方法  
            );
            _logger.LogInformation(JsonConvert.SerializeObject(bookDto));
            return bookDto;
        }
    }
}

至此，客戶端的Grpc就完成了。

-----------------客戶端程式碼 END-----------------

專案的結構

附：貼特徵形式實現依賴注入的程式碼，透過反射機制實現。

注：業務層和倉儲層必須是獨立層專案，或相同形式進行隔離(要麼統一介面I_BLL、I_DLL，要麼單純的BLL、DLL)，否則自行對自動註冊類進行改造。

程式碼可以寫在公共層 ExternalService 專案中，作為基礎服務進行引用。

using Microsoft.Extensions.DependencyInjection;
using System.Reflection;

namespace ExternalService.RegisterServices
{
    /// <summary>
    /// 透過反射機制自動化進行依賴注入服務
    /// </summary>
    public static class ServiceCollectionExtension
    {
        /// <summary>
        /// 註冊介面型別服務，繼承介面（貼特徵）
        /// </summary>
        /// <param name="services">this服務</param>
        /// <param name="assembly">程式集</param>
        /// <returns></returns>
        public static IServiceCollection RegisterIntfaceTypeService(this IServiceCollection services, Assembly assembly)
        {
            var interfaces = assembly.GetTypes().Where(t => t.IsInterface).ToList();
            var types = assembly.GetTypes().Where(t => t.IsClass).ToList();

            foreach (var interf in interfaces)
            {
                if (interf == null)
                    continue;

                var type = types.FirstOrDefault(interf.IsAssignableFrom);
                if (type == null)
                    continue;

                var liftTime = ServiceLifetime.Scoped;
                var attr = type.GetCustomAttribute<ServiceAttribute>();
                if (attr != null)
                    liftTime = attr.LifeTime;
                else
                    continue;

                switch (liftTime)
                {
                    default:
                    case ServiceLifetime.Scoped:
                        {
                            //作用生命週期：同一請求之間狀態共享，跟隨HTTP請求生命週期
                            services.AddScoped(interf, type);
                            break;
                        }
                    case ServiceLifetime.Transient:
                        {
                            //瞬時生命週期：無狀態化，每次使用是 new ()
                            services.AddTransient(interf, type);
                            break;
                        }
                    case ServiceLifetime.Singleton:
                        {
                            //單例生命週期：整個程式所有請求狀態共享，整個程式只有一個例項
                            services.AddSingleton(interf, type);
                            break;
                        }
                }
            }
            return services;
        }
        /// <summary>
        /// 註冊普通類服務，非介面型別（貼特徵）
        /// </summary>
        /// <param name="services">this服務</param>
        /// <param name="assembly">程式集</param>
        /// <param name="NamespaceKeyWord">名稱空間關鍵字</param>
        /// <returns></returns>
        public static IServiceCollection RegisterClassService(this IServiceCollection services, Assembly assembly, string NamespaceKeyWord = "")
        {
            var ClassTypes = assembly.GetTypes().Where(t => t.IsClass && !t.IsAbstract).ToList();
            if (!string.IsNullOrEmpty(NamespaceKeyWord))
                ClassTypes = assembly.GetTypes().Where(t => t.Name.Contains(NamespaceKeyWord)).ToList();
            foreach (var types in ClassTypes)
            {
                if (types == null)
                    continue;

                var liftTime = ServiceLifetime.Scoped;
                var attr = types.GetCustomAttribute<ServiceAttribute>();
                if (attr != null)
                    liftTime = attr.LifeTime;
                else
                    continue;

                switch (liftTime)
                {
                    default:
                    case ServiceLifetime.Scoped:
                        {
                            //作用生命週期：同一請求之間狀態共享，跟隨HTTP請求生命週期
                            services.AddScoped(types);
                            break;
                        }
                    case ServiceLifetime.Transient:
                        {
                            //瞬時生命週期：無狀態化，每次使用是 new ()
                            services.AddTransient(types);
                            break;
                        }
                    case ServiceLifetime.Singleton:
                        {
                            //單例生命週期：整個程式所有請求狀態共享，整個程式只有一個例項
                            services.AddSingleton(types);
                            break;
                        }
                }
            }
            return services;
        }
    }

    /// <summary>
    /// 生命週期特徵
    /// </summary>
    [AttributeUsage(AttributeTargets.Class)]
    public class ServiceAttribute : Attribute
    {
        internal ServiceLifetime LifeTime { get; set; }

        public ServiceAttribute(ServiceLifetime lifeTime) => LifeTime = lifeTime;
    }
}

在使用的專案程式集內建立一個擴充套件服務 AddApplication_Register。然後呼叫註冊類擴充套件服務services.RegisterClassService(Assembly.GetExecutingAssembly());

using System.Reflection;

using ExternalService.RegisterServices;
using Microsoft.Extensions.DependencyInjection;

namespace Application_Grpc
{
    public static class Application_GrpcExtension
    {
        public static IServiceCollection AddApplication_Register(this IServiceCollection services)
        {
            services.RegisterClassService(Assembly.GetExecutingAssembly());
            return services;
        }
    }
}

在Program.cs內註冊新增專案程式集的擴充套件服務，把上面Application_GrpcExtension類的AddApplication_Register進行呼叫：builder.Services.AddApplication_Register();