目錄

• 一、簡介
• 二、創建gRPC服務端
  • 1.創建gRPC項目
  • 2.編寫自己的服務
• 三、創建gRPC客戶端
  • 1.創建客戶端項目
  • 2.grPC服務https的調用
  • 3.gRPC內網http調用
  • 4.IOC註入的方式調用gRPC
• 四、webapi中加入gRPC

一、簡介

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

特點：

• 跨語言
• 內容protobuf格式（比json體積小）,網路傳輸快
• 使用HTTP/2進行傳輸

適合高性能輕量的微服務，一般對外的介面用restful api，內部服務的調用用gRPC。gRPC是一個分散式服務框架，和以前的WebService，WCF類似。

二、創建gRPC服務端

1.創建gRPC項目

新建一個gRPC模板的項目

 特別的地方就這裡4點。

1.基於http2來通信。

2.proto協議文件，greet.proto是項目預設給我們的一個hello world的示例。它會根據協議自動生成需要的類。

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

 自動生成的類：

 4.Program.cs添加了gRPC服務，和把GreeterService註冊到管道中。

2.編寫自己的服務

怎麼樣寫自己的調用服務呢？

 1.創建proto文件

參照上面的示例創建自己的Proto文件

 代碼:

syntax = "proto3";

option csharp_namespace = "GrpcDemo.Service";

package order;

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

//創建訂單請求參數
message CreateRequest {
  string orderNo = 1;
  string orderName=2;
  double price=3;
}

//創建訂單返回結果
message CreateResult {
  bool result = 1;
  string message=2;
}

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

生成一下就能看到對應的類已經生成了。

 2.實現定義的服務

 創建OrderService.cs

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

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

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

繼承的Order.OrderBase 是上面的proto文件生成的，然後實現了proto裡面定義的兩個服務。

然後在program.cs裡面把服務註入管道。

 到這裡服務端就完成了，就可以啟動服務端了。

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

三、創建gRPC客戶端

1.創建客戶端項目

1.1、這裡創建一個控制台程式。

1.2、然後添加Nuget包

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

1.3、把服務端的proto文件拷貝過來

 1.4、編輯項目文件，把proto裡面的內容替換掉，預設是服務端的配置

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

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

2.grPC服務https的調用

因為服務端提供了http和https的埠，這裡先調用https的

創建GrpcRequestTest.cs類

 /// <summary>
    /// gRPC請求測試
    /// </summary>
    public class GrpcRequestTest
    {
        public void CreateOrder()
        {
            //常規使用，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($"結果:{reply.Result},message:{reply.Message}");
            }
            Console.ReadKey();
        }
    }

結果：

3.gRPC內網http調用

      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($"結果:{reply.Result},message:{reply.Message}");
            }
            Console.ReadKey();
        }

比起https，前面多了一行。結果：

4.IOC註入的方式調用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

//構建容器
IServiceProvider serviceProvider = services.BuildServiceProvider();
//解析grpc請求測試
var grpcRequestTest = serviceProvider.GetService<GrpcRequestTest>();
//執行
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($"結果:{reply.Result},message:{reply.Message}");
            Console.ReadKey();
        }
    }

結果：

四、webapi中加入gRPC

通常我們的服務有對外提供對外介面，又要對內提供gRPC服務，那怎麼做呢，下麵在webapi中加入gRPC服務

1.創建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>
        /// 創建訂單
        /// </summary>
        /// <param name="request"></param>
        /// <param name="context"></param>
        /// <returns></returns>
        public override Task<CreateResult> CreateOrder(CreateRequest request, ServerCallContext context)
        {
            //報存資料庫 todo

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

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

5.註冊gRPC服務

在Program.cs文件中

到這裡，就把gRPC加入到webapi裡面了。 

6.驗證

啟動asp.net core mvc程式

瀏覽器能訪問，證明 restful api是沒問題的。

然後再用上面的客戶端訪問一下gRPC的服務。

 結果：

 這樣就成功對外提供api介面和對內提供gRPC服務了。

源碼地址：https://github.com/weixiaolong325/GrpcDemo.Service