.NET?Core(.NET6)中g(shù)RPC使用實踐

更新時間：2022年04月14日 10:37:47 作者：包子wxl

gRPC是高性能的遠程過程調(diào)用（RPC）框架，本文主要介紹了.NET?Core(.NET6)中g(shù)RPC使用，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧

一、簡介

簡單解析一下gRPC，gRPC 是一個由Google開源的，跨語言的，高性能的遠程過程調(diào)用（RPC）框架。

特點：

跨語言
內(nèi)容protobuf格式（比json體積?。?網(wǎng)絡(luò)傳輸快
使用HTTP/2進行傳輸

適合高性能輕量的微服務(wù)，一般對外的接口用restful api，內(nèi)部服務(wù)的調(diào)用用gRPC。gRPC是一個分布式服務(wù)框架，和以前的WebService，WCF類似。

二、創(chuàng)建gRPC服務(wù)端

1.創(chuàng)建gRPC項目

新建一個gRPC模板的項目

特別的地方就這里4點。

1.基于http2來通信。

2.proto協(xié)議文件，greet.proto是項目默認給我們的一個hello world的示例。它會根據(jù)協(xié)議自動生成需要的類。

3.服務(wù)類，Greeter.GreeterBase來自于2中的proto文件自動生成的類，生成的類在\obj\Debug\net6.0\Protos 目錄下。

自動生成的類：

4.Program.cs添加了gRPC服務(wù)，和把GreeterService注冊到管道中。

2.編寫自己的服務(wù)

怎么樣寫自己的調(diào)用服務(wù)呢？

1.創(chuàng)建proto文件

參照上面的示例創(chuàng)建自己的Proto文件

代碼:

syntax = "proto3";

option csharp_namespace = "GrpcDemo.Service";

package order;

// 訂單服務(wù)定義
service Order {
  // 創(chuàng)建訂單
  rpc CreateOrder (CreateRequest) returns (CreateResult);
  //查詢訂單
  rpc QueryOrder (QueryRequest) returns (QueryResult);
}

//創(chuàng)建訂單請求參數(shù)
message CreateRequest {
  string orderNo = 1;
  string orderName=2;
  double price=3;
}

//創(chuàng)建訂單返回結(jié)果
message CreateResult {
  bool result = 1;
  string message=2;
}

//查詢訂單請求參數(shù)
message QueryRequest{
    int id=1;
}
//查詢訂單返回結(jié)果
message QueryResult{
    int id=1;
    string orderNo=2;
    string orderName=3;
    double price=4;
}

生成一下就能看到對應的類已經(jīng)生成了。

2.實現(xiàn)定義的服務(wù)

創(chuàng)建OrderService.cs

public class OrderService:Order.OrderBase
    {
        private readonly ILogger<GreeterService> _logger;
        public OrderService(ILogger<GreeterService> logger)
        {
            _logger = logger;
        }
        /// <summary>
        /// 創(chuàng)建訂單
        /// </summary>
        /// <param name="request"></param>
        /// <param name="context"></param>
        /// <returns></returns>
        public override Task<CreateResult> CreateOrder(CreateRequest request, ServerCallContext context)
        {
            //報存數(shù)據(jù)庫 todo

            return Task.FromResult(new CreateResult
            {
                Result=true,
                Message="訂單創(chuàng)建成功"
            });
        }
        /// <summary>
        /// 查詢訂單
        /// </summary>
        /// <param name="request"></param>
        /// <param name="context"></param>
        /// <returns></returns>
        public override Task<QueryResult> QueryOrder(QueryRequest request, ServerCallContext context)
        {
            //查詢數(shù)據(jù)庫 //todo

            return Task.FromResult(new QueryResult
            {
                OrderInfo=new OrderInfo
                {
                    Id = request.Id,
                    OrderNo = DateTime.Now.ToString("yyyyMMddHHmmss"),
                    OrderName = "冰箱",
                    Price = 1288
                }
            });
        }
    }

繼承的Order.OrderBase 是上面的proto文件生成的，然后實現(xiàn)了proto里面定義的兩個服務(wù)。

然后在program.cs里面把服務(wù)注入管道。

到這里服務(wù)端就完成了，就可以啟動服務(wù)端了。

瀏覽器訪問不了，要通過gRPC客戶端才能訪問，下面就建一個gRPC客戶端。

三、創(chuàng)建gRPC客戶端

1.創(chuàng)建客戶端項目

1.1、這里創(chuàng)建一個控制臺程序。

1.2、然后添加Nuget包

Google.Protobuf
Grpc.Net.Client
Grpc.Tools
Grpc.Net.clientFactory

1.3、把服務(wù)端的proto文件拷貝過來

1.4、編輯項目文件，把proto里面的內(nèi)容替換掉，默認是服務(wù)端的配置

  <Protobuf Include="Protos\greet.proto" GrpcServices="Client" />
      <Protobuf Include="Protos\order.proto" GrpcServices="Client" />

生成的時候，客戶端也生成了對應proto的類

2.grPC服務(wù)https的調(diào)用

因為服務(wù)端提供了http和https的端口，這里先調(diào)用https的

創(chuàng)建GrpcRequestTest.cs類

/// <summary>
    /// gRPC請求測試
    /// </summary>
    public class GrpcRequestTest
    {
        public void CreateOrder()
        {
            //常規(guī)使用，https
            string url = "https://localhost:7246";
            using(var channel=GrpcChannel.ForAddress(url))
            {
                var client = new Order.OrderClient(channel);
                var reply = client.CreateOrder(new CreateRequest()
                {
                    OrderNo = DateTime.Now.ToString("yyyMMddHHmmss"),
                    OrderName = "冰箱22款",
                    Price = 1688
                });

                Console.WriteLine($"結(jié)果:{reply.Result},message:{reply.Message}");
            }
            Console.ReadKey();
        }
    }

結(jié)果：

3.gRPC內(nèi)網(wǎng)http調(diào)用

public void CreateOrder()
        {
             //使用http
            AppContext.SetSwitch("System.Net.Http.SocketsHttpHandler.Http2UnencryptedSupport", true);
            string url = "http://localhost:5246";

            using(var channel=GrpcChannel.ForAddress(url))
            {
                var client = new Order.OrderClient(channel);
                var reply = client.CreateOrder(new CreateRequest()
                {
                    OrderNo = DateTime.Now.ToString("yyyMMddHHmmss"),
                    OrderName = "冰箱22款",
                    Price = 1688
                });

                Console.WriteLine($"結(jié)果:{reply.Result},message:{reply.Message}");
            }
            Console.ReadKey();
        }

比起https，前面多了一行。結(jié)果：

4.IOC注入的方式調(diào)用gRPC

4.1、program.cs里面注入gRPCClient

// See https://aka.ms/new-console-template for more information
using GrpcDemo.Client;
using GrpcDemo.Service;
using Microsoft.Extensions.DependencyInjection;

Console.WriteLine("Hello, World!");

IServiceCollection services = new ServiceCollection();
services.AddTransient<GrpcRequestTest>();

#region gRPC Client注冊
AppContext.SetSwitch("System.Net.Http.SocketsHttpHandler.Http2UnencryptedSupport", true);
services.AddGrpcClient<Order.OrderClient>(options =>
{
    options.Address = new Uri("http://localhost:5246");
}).ConfigureChannel(grpcOptions =>
{
    //可以完成各種配置，比如token
});
#endregion

//構(gòu)建容器
IServiceProvider serviceProvider = services.BuildServiceProvider();
//解析grpc請求測試
var grpcRequestTest = serviceProvider.GetService<GrpcRequestTest>();
//執(zhí)行
grpcRequestTest.CreateOrder();

grpcRequestTest里代碼：

/// <summary>
    /// gRPC請求測試
    /// </summary>
    public class GrpcRequestTest
    {
        private Order.OrderClient _orderClient;
        public GrpcRequestTest(Order.OrderClient orderClient)
        {
            _orderClient = orderClient;
        }
        public void CreateOrder()
        {
            var reply = _orderClient.CreateOrder(new CreateRequest()
            {
                OrderNo = DateTime.Now.ToString("yyyMMddHHmmss"),
                OrderName = "冰箱22款",
                Price = 1688
            });
            Console.WriteLine($"結(jié)果:{reply.Result},message:{reply.Message}");
            Console.ReadKey();
        }
    }

結(jié)果：

四、webapi中加入gRPC

通常我們的服務(wù)有對外提供對外接口，又要對內(nèi)提供gRPC服務(wù)，那怎么做呢，下面在webapi中加入gRPC服務(wù)

1.創(chuàng)建asp.net core mvc項目

2.安裝nuget包

Grpc.AspNetCore

3.添加protebuf文件

把上面的proto文件復制過來

4.添加Service

public class OrderService : Order.OrderBase
    {
        private readonly ILogger<OrderService> _logger;
        public OrderService(ILogger<OrderService> logger)
        {
            _logger = logger;
        }
        /// <summary>
        /// 創(chuàng)建訂單
        /// </summary>
        /// <param name="request"></param>
        /// <param name="context"></param>
        /// <returns></returns>
        public override Task<CreateResult> CreateOrder(CreateRequest request, ServerCallContext context)
        {
            //報存數(shù)據(jù)庫 todo

            return Task.FromResult(new CreateResult
            {
                Result = true,
                Message = "訂單創(chuàng)建成功"
            });
        }
        /// <summary>
        /// 查詢訂單
        /// </summary>
        /// <param name="request"></param>
        /// <param name="context"></param>
        /// <returns></returns>
        public override Task<QueryResult> QueryOrder(QueryRequest request, ServerCallContext context)
        {
            //查詢數(shù)據(jù)庫 //todo

            return Task.FromResult(new QueryResult
            {
                OrderInfo = new OrderInfo
                {
                    Id = request.Id,
                    OrderNo = DateTime.Now.ToString("yyyyMMddHHmmss"),
                    OrderName = "冰箱",
                    Price = 1288
                }
            });
        }
    }

5.注冊gRPC服務(wù)

在Program.cs文件中