一、簡介
簡單解析一下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{
int id=1;
}
//查詢訂單傳回結果
message QueryResult{
int 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
{
OrderInfo=new OrderInfo
{
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的服務。
結果: