在上一篇 .net core grpc 實現通信(一) 中,我們實現的grpc通信在.net core中的可行性,但要在微服務中真正使用,還缺少 服務註冊,服務發現及負載均衡等,本篇我們將在 .net core grpc 通信 的基礎上加上 服務註冊,服務發現,負載均衡。 如對.net core g ...
在上一篇 .net core grpc 實現通信(一) 中,我們實現的grpc通信在.net core中的可行性,但要在微服務中真正使用,還缺少 服務註冊,服務發現及負載均衡等,本篇我們將在 .net core grpc 通信 的基礎上加上 服務註冊,服務發現,負載均衡。
如對.net core grpc 通信不太熟悉的,可以看上一篇 .net core grpc 實現通信(一) ,然後再看本篇。
grpc(https://grpc.io/)是google發佈的一個開源、高性能、通用RPC(Remote Procedure Call)框架,使用HTTP/2協議,支持多路復用,並用ProtoBuf作為序列化工具,提供跨語言、跨平臺支持。
Consul(https://www.consul.io)是一個分散式,高可用、支持多數據中心的服務註冊、發現、健康檢查和配置共用的服務軟體,由 HashiCorp 公司用 Go 語言開發。
本次服務註冊、發現 通過 Consul Api 來實現,開發過程中結合.net core 依賴註入,切麵管道思想等。
軟體版本
.net Core:2.0
grpc:1.11.0
Consul:1.1.0
Consul Nuget註冊組件:0.7.2.5
項目結構
.net core 代碼部分:
Snai.GrpcClient 客戶端 .net core 2.0控制台程式
Snai.GrpcService.Hosting 服務端宿主,Api服務註冊,asp.net core 2.0網站程式
Snai.GrpcService.Impl 協議方法實現 .net standard 2.0類庫
Snai.GrpcService.Protocol 生成協議方法 .net standard 2.0類庫
Consul:
conf 配置目錄,本次用api註冊服務,可以刪除
data 緩存數據目錄,可清空裡面內容
dist Consul UI目錄,本次用預設的UI,可以刪除
consul.exe 註冊軟體
startup.bat 執行腳本
項目實現
一、服務端
服務端主要包括Grpc服務端,Consul Api服務註冊、健康檢查等。
新建Snai.GrpcService解決方案,由於這次加入了 Consul Api 服務註冊,所以我們先從 Api 服務註冊開始。
1、實現 Consul Api 服務註冊
新建 Snai.GrpcService.Hosting 基於Asp.net Core 2.0空網站,在 依賴項 右擊 管理NuGet程式包 瀏覽 找到 Consul 版本0.7.2.5安裝,用於Api服務註冊使用
新建 appsettings.json 配置文件,配置 GrpcService Grpc服務端IP和埠,HealthService健康檢測名稱、IP和地址,ConsulService Consul的IP和埠,代碼如下
{
"GrpcService": {
"IP": "localhost",
"Port": "5031"
},
"HealthService": {
"Name": "GrpcService",
"IP": "localhost",
"Port": "5021"
},
"ConsulService": {
"IP": "localhost",
"Port": "8500"
}
}
新建Consul目錄,用於放Api註冊相關代碼
在Consul目錄下新建Entity目錄,在Entity目錄下新建HealthService.cs,ConsulService.cs類,分別對應HealthService,ConsulService兩個配置項,代碼如下
HealthService.cs
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
namespace Snai.GrpcService.Hosting.Consul.Entity
{
public class HealthService
{
public string Name { get; set; }
public string IP { get; set; }
public int Port { get; set; }
}
}
ConsulService.cs
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
namespace Snai.GrpcService.Hosting.Consul.Entity
{
public class ConsulService
{
public string IP { get; set; }
public int Port { get; set; }
}
}
在 Consul 目錄下新建 AppRregister.cs 類,添加 IApplicationBuilder 擴展方法 RegisterConsul,來調用 Consul Api 實現服務註冊,代碼如下
using Consul;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Options;
using Snai.GrpcService.Hosting.Consul.Entity;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
namespace Snai.GrpcService.Hosting.Consul
{
public static class AppRregister
{
// 服務註冊
public static IApplicationBuilder RegisterConsul(this IApplicationBuilder app, IApplicationLifetime lifetime, IOptions<HealthService> healthService, IOptions<ConsulService> consulService)
{
var consulClient = new ConsulClient(x => x.Address = new Uri($"http://{consulService.Value.IP}:{consulService.Value.Port}"));//請求註冊的 Consul 地址
var httpCheck = new AgentServiceCheck()
{
DeregisterCriticalServiceAfter = TimeSpan.FromSeconds(5),//服務啟動多久後註冊
Interval = TimeSpan.FromSeconds(10),//健康檢查時間間隔,或者稱為心跳間隔
HTTP = $"http://{healthService.Value.IP}:{healthService.Value.Port}/health",//健康檢查地址
Timeout = TimeSpan.FromSeconds(5)
};
// Register service with consul
var registration = new AgentServiceRegistration()
{
Checks = new[] { httpCheck },
ID = healthService.Value.Name + "_" + healthService.Value.Port,
Name = healthService.Value.Name,
Address = healthService.Value.IP,
Port = healthService.Value.Port,
Tags = new[] { $"urlprefix-/{healthService.Value.Name}" }//添加 urlprefix-/servicename 格式的 tag 標簽,以便 Fabio 識別
};
consulClient.Agent.ServiceRegister(registration).Wait();//服務啟動時註冊,內部實現其實就是使用 Consul API 進行註冊(HttpClient發起)
lifetime.ApplicationStopping.Register(() =>
{
consulClient.Agent.ServiceDeregister(registration.ID).Wait();//服務停止時取消註冊
});
return app;
}
}
}
修改 Startup.cs 代碼
加入 Startup(IConfiguration configuration) 構造函數,實現配置註入,如果建的是Web Api或MVC網站,預設是有的
修改 ConfigureServices(IServiceCollection services) 方法,註冊全局配置
修改 Configure() 方法,添加健康檢查路由地址 app.Map("/health", HealthMap),調用 RegisterConsul 擴展方法實現服務註冊
添加 HealthMap(IApplicationBuilder app) 實現health路由。由於只有一個健康檢查地址,所以沒有建Web Api網站,只建了個空網站
代碼如下,註冊配置GrpcService 、 註冊Rpc服務、啟動Rpc服務 後面用到等下講
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Options;
using Snai.GrpcService.Hosting.Consul;
using Snai.GrpcService.Hosting.Consul.Entity;
using Snai.GrpcService.Impl;
namespace Snai.GrpcService.Hosting
{
public class Startup
{
public Startup(IConfiguration configuration)
{
Configuration = configuration;
}
public IConfiguration Configuration { get; }
// This method gets called by the runtime. Use this method to add services to the container.
// For more information on how to configure your application, visit https://go.microsoft.com/fwlink/?LinkID=398940
public void ConfigureServices(IServiceCollection services)
{
//註冊全局配置
services.AddOptions();
services.Configure<Impl.Entity.GrpcService>(Configuration.GetSection(nameof(Impl.Entity.GrpcService)));
services.Configure<HealthService>(Configuration.GetSection(nameof(HealthService)));
services.Configure<ConsulService>(Configuration.GetSection(nameof(ConsulService)));
//註冊Rpc服務
services.AddSingleton<IRpcConfig, RpcConfig>();
}
// This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
public void Configure(IApplicationBuilder app, IHostingEnvironment env, IApplicationLifetime lifetime, IOptions<HealthService> healthService, IOptions<ConsulService> consulService, IRpcConfig rpc)
{
if (env.IsDevelopment())
{
app.UseDeveloperExceptionPage();
}
// 添加健康檢查路由地址
app.Map("/health", HealthMap);
// 服務註冊
app.RegisterConsul(lifetime, healthService, consulService);
// 啟動Rpc服務
rpc.Start();
}
private static void HealthMap(IApplicationBuilder app)
{
app.Run(async context =>
{
await context.Response.WriteAsync("OK");
});
}
}
}
修改 Program.cs 代碼,調置網站地址為 .UseUrls("http://localhost:5021"),代碼如下
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.Logging;
namespace Snai.GrpcService.Hosting
{
public class Program
{
public static void Main(string[] args)
{
BuildWebHost(args).Run();
}
public static IWebHost BuildWebHost(string[] args) =>
WebHost.CreateDefaultBuilder(args)
.UseUrls("http://localhost:5021")
.UseStartup<Startup>()
.Build();
}
}
到此 Consul Api 服務註冊 已完成,最終項目結構如下:
2、協議編寫,將協議生成C#代碼
由於在上一篇 .net core grpc 實現通信(一) 有過介紹,這裡就簡單說下
新建 Snai.GrpcService.Protocol協議類庫項目,在 依賴項 右擊 管理NuGet程式包 瀏覽 找到 Grpc.Core 版本1.11.0,Google.Protobuf 版本3.5.1 包下載安裝
在根目錄下新建msg.proto 文件,編寫基於proto3語言的協議代碼,用於生成各語言協議,msg.proto 代碼如下
syntax = "proto3";
package Snai.GrpcService.Protocol;
service MsgService{
rpc GetSum(GetMsgNumRequest) returns (GetMsgSumReply){}
}
message GetMsgNumRequest {
int32 Num1 = 1;
int32 Num2 = 2;
}
message GetMsgSumReply {
int32 Sum = 1;
}
新建.net framework 項目類庫,引用安裝 Grpc.Tools、Google.Protobuf.Tools 組件程式包,分別得到 grpc_csharp_plugin.exe、protoc.exe 工具
到package目錄下,找到與系統相應的grpc_csharp_plugin.exe、protoc.exe工具,拷到 Snai.GrpcService.Protocol 項目下
在Snai.GrpcService.Protocol根目錄下新建 ProtocGenerate.cmd 文件,在其中輸入以下指令
protoc -I . --csharp_out . --grpc_out . --plugin=protoc-gen-grpc=grpc_csharp_plugin.exe msg.proto
然後直接雙擊運行,項目下生成了“Msg.cs”和“MsgGrpc.cs”兩個文件,這樣協議部分的所有工作就完成了,最終項目結構如下:
3、編寫協議實現代碼
新建 Snai.GrpcService.Impl 實現類庫項目,在 依賴項 下載安裝Grpc.Core 包,項目引用 Snai.GrpcService.Protocol
新建 Entity 目錄,在Entity目錄下新建 GrpcService.cs 類,對應 Snai.GrpcService.Hosting 項目下 appsettings.json 配置文件的 GrpcService 配置項,代碼如下
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
namespace Snai.GrpcService.Impl.Entity
{
public class GrpcService
{
public string IP { get; set; }
public int Port { get; set; }
}
}
在根目錄下新建 RpcService 目錄,在 RpcService 目錄下新建 MsgServiceImpl.cs 類,繼承 MsgService.MsgServiceBase 協議類,實現服務方法,代碼如下
using Grpc.Core;
using Snai.GrpcService.Protocol;
using System;
using System.Collections.Generic;
using System.Text;
using System.Threading.Tasks;
namespace Snai.GrpcService.Impl.RpcService
{
public class MsgServiceImpl : MsgService.MsgServiceBase
{
public override async Task<GetMsgSumReply> GetSum(GetMsgNumRequest request, ServerCallContext context)
{
var result = new GetMsgSumReply();
result.Sum = request.Num1 + request.Num2;
Console.WriteLine(request.Num1 + "+" + request.Num2 + "=" + result.Sum);
return result;
}
}
}
在根目錄下新建IRpcConfig.cs介面,定義 Start() 用於Rpc啟動基方法,代碼如下
using System;
using System.Collections.Generic;
using System.Text;
namespace Snai.GrpcService.Impl
{
public interface IRpcConfig
{
void Start();
}
}
在根目錄下新建 RpcConfig.cs 類,用於實現 IRpcConfig.cs 介面,啟動Rpc服務,代碼如下
using Grpc.Core;
using Microsoft.Extensions.Options;
using Snai.GrpcService.Impl.RpcService;
using Snai.GrpcService.Protocol;
using System;
using System.Collections.Generic;
using System.Text;
namespace Snai.GrpcService.Impl
{
public class RpcConfig: IRpcConfig
{
private static Server _server;
static IOptions<Entity.GrpcService> GrpcSettings;
&n