C#中使用gRPC通訊的示例詳解

更新時間：2024年04月11日 08:44:10 作者：叫我少年

這篇文章主要為大家詳細介紹了C#中如何使用gRPC通訊,包括GRPC文件的創(chuàng)建生成、服務端和客戶端函數類庫的封裝等,需要的可以了解下

創(chuàng)建并生成GRPC服務文件

創(chuàng)建新項目控制臺應用 , 項目名稱(MgRPC)
安裝三個nuget包 Google.Protobuf , Grpc.Core , Grpc.Tools
項目添加新建項，選擇類，修改名稱為Link.proto，添加后把Link.proto里面內容清空

定義Protocol

添加代碼。測試實例為服務端和客戶端傳輸字符串消息，只定義了一個方法（客戶端調用，服務端重寫），傳輸內容包括請求字符串和回復字符串。此處可自行定義。

syntax = "proto3";//proto3 是 Protocol Buffers 的第三個版本

// 指定了生成的 C# 代碼的命名空間為 LinkService。當使用 protobuf 編譯器 (protoc) 將這個 .proto 文件轉換為 C# 代碼時，生成的類將位于 LinkService 命名空間中
option csharp_namespace = "LinkService";

//定義了一個名為 Link 的 gRPC 服務。在 gRPC 中，服務是由一個或多個 RPC 方法組成的
service Link
{
	//定義了一個 RPC 方法。這個方法名為 GetMessage，它接受一個 Mes 類型的消息作為參數，
	//并返回一個 Mes 類型的消息。在 gRPC 中，客戶端可以調用這個方法，并發(fā)送一個 Mes 消息給服務端，然后服務端會處理這個消息并返回一個 Mes 消息給客戶端。
	rpc GetMessage(Mes) returns (Mes);
}

//定義了一個名為 Mes 的消息類型。在 protobuf 中，消息是由一系列字段組成的，每個字段都有一個名稱、一個類型和一個標識符。
message Mes
{
    // 客戶端發(fā)送
	// 定義了一個名為 StrRequest 的字段，類型為 string，標識符為 1。這個標識符在消息內部是唯一的，并且一旦分配就不能更改，因為它被用于序列化和反序列化過程中的字段識別。
	string StrRequest = 1;
	// 同樣定義了一個名為 StrReply 的字段，類型為 string，標識符為 2。(服務端回復)
	string StrReply = 2;
}

設置Link.proto

右鍵Link.proto文件選擇屬性，生成操作選擇如圖：

生成cs文件代碼

生成解決方案。在下圖路徑得到自動生成的兩個類。

至此，獲得GRPC服務需要的三個文件：Link.proto、Link.cs、LinkGrpc.cs。可以將這三個文件放在一個項目中直接使用，需要重寫一下服務端方法、創(chuàng)建服務端和客戶端的啟動方法。但是如果不同的項目軟件之間通訊需要各自如此開發(fā)?？梢韵确庋b成一個GRPC類庫供其他項目直接調用。

服務端和客戶端類庫的封裝

創(chuàng)建類庫(.NET Framework)項目 , 項目名稱(GrpcLink)
項目添加現(xiàn)有項，上面獲得的三個文件(Link.cs , LinkGrpc.cs)。安裝nuget包：Grpc.Core和Google.Protobuf。
創(chuàng)建兩個類：LinkFunc用于放此類庫可用于外部引用調用的方法。LinkServerFunc基于Link.LinkBase，用于重寫在proto文件中定義的方法。

對于不同的項目，在客戶端請求時，服務端要根據自身情況回復想回的內容，因此可以提供一個委托供外部自行開發(fā)回復函數。

在LinkFunc類中定義如下：

public static Func<string, string> ReplyMes;

LinkServerFunc

在LinkServerFunc類重寫GetMessage方法如下

using Grpc.Core;
using LinkService;
using System.Threading.Tasks;
using static LinkService.Link;

namespace GrpcLink
{
    /// <summary>
    /// 重寫在proto文件中定義的方法
    /// </summary>
    public class LinkServerFunc : LinkBase
    {
        public override Task<Mes> GetMessage(Mes request,ServerCallContext context)
        {
            Mes mes = new Mes();
            mes.StrReply = LinkFunc.ReplyMes(request.StrRequest);
            return Task.FromResult(mes);
        }
    }
}

LinkFunc

using Grpc.Core;
using LinkService;
using System;
using static LinkService.Link;

namespace GrpcLink
{
    public class LinkFunc
    {
        /// <summary>
        /// 用于服務端回復委托
        /// </summary>
        public static Func<string,string> ReplyMes;

        // 定義服務端和客戶端
        public static Server LinkServer;
        public static LinkClient LinkClient;

        /// <summary>
        ///  服務端啟動
        /// </summary>
        /// <param name="host"></param>
        /// <param name="port"></param>
        public static void LinkServerStart(string host,int port)
        {
            LinkServer = new Server
            {
                Services =
                    {
                        BindService(new LinkServerFunc())
                    },
                Ports = { new ServerPort(host,port,ServerCredentials.Insecure) }
            };
            LinkServer.Start();
        }

        /// <summary>
        ///  服務端關閉
        /// </summary>
        public static void LinkServerClose()
        {
            LinkServer?.ShutdownAsync().Wait();
        }

        /// <summary>
        /// 客戶端啟動
        /// </summary>
        /// <param name="strIp"></param>
        public static void LinkClientStart(string strIp)
        {
            Channel prechannel = new Channel(strIp,ChannelCredentials.Insecure);
            LinkClient = new LinkClient(prechannel);
        }

        /// <summary>
        /// 客戶端發(fā)送消息函數
        /// </summary>
        /// <param name="strRequest"></param>
        /// <returns></returns>
        public static string SendMes(string strRequest)
        {
            Mes mes = new Mes();
            mes.StrRequest = strRequest;
            var res = LinkClient.GetMessage(mes);
            return res.StrReply;
        }
    }
}

生成引用庫

生成解決方案。Debug中可以得到項目的dll文件GrpcLink.dll，其他項目可以引用使用了。

創(chuàng)建服務端和客戶端調用測試

創(chuàng)建兩個控制臺(.NET Framework)項目 , 項目名稱TestCilent , TestServer
將上述GrpcLink.dll文件分別放入兩個項目中，并添加dll引用。如果沒有則安裝nuget包：Grpc.Core和Google.Protobuf(此次測試沒有安裝)

TestServer服務端

using GrpcLink;
using System;
using System.Threading;

namespace TestServer
{
    /// <summary>
    /// 測試服務端
    /// </summary>
    internal class Program
    {
        static void Main(string[] args)
        {
            LinkFunc.LinkServerStart("127.0.0.1",9008);
            Thread.Sleep(500);
            LinkFunc.ReplyMes = ReplyMes;
            Console.ReadKey();
        }


        /// <summary>
        /// 接收到客戶端信息后回復
        /// </summary>
        /// <param name="strRequest">客戶端發(fā)送過來的內容</param>
        /// <returns></returns>
        public static string ReplyMes(string strRequest)
        {
            Console.WriteLine("接收到:" + strRequest);
            switch (strRequest)
            {
                case "1":
                return "Server識別到1";
                case "2":
                return "Server識別到2";
                case "測試":
                return "開始測試"; 
                case "連接服務端":
                return "true";
            }
            return "Server未識別到指定參數";
        }
    }
}

TestCilent客戶端

using GrpcLink;
using System;
using System.Threading;

namespace TestCilent
{
    internal class Program
    {
        static void Main(string[] args)
        {
            Thread.Sleep(2000);
            LinkFunc.LinkClientStart("127.0.0.1:9008");
            Console.WriteLine("連接服務端中");
            string conn = LinkFunc.SendMes("連接服務端");

            if (conn.Equals("true"))
            {
                Console.WriteLine("連接服務端成功!");


                for (int i = 0 ; i < 10 ; i++)
                {
                    Thread.Sleep(1000);
                    Console.WriteLine("輸入測試內容..");
                    var line = Console.ReadLine();
                    var ret = LinkFunc.SendMes(line);
                    //獲取到服務端返回的值
                    Console.WriteLine(ret);

                }
            }

            Console.WriteLine("連接失敗 , 即將退出");
            Thread.Sleep(2000);
        }
    }
}