（8）ASP.NET Core3.1 Ocelot Consul服務註冊與發現
1.服務註冊與發現（Service Discovery）
●服務註冊：我們通過在每個服務例項寫入註冊程式碼，例項在啟動的時候會先去註冊中心（例如Consul、ZooKeeper、etcd、Eureka）註冊一下，那麼客戶端通過註冊中心可以知道每個服務例項的地址，埠號，健康狀態等等資訊，也可以通過註冊中心刪除服務例項。這裡註冊中心相當於是負責維護服務例項的管控中心。
●服務發現：服務例項在註冊中心註冊之後，客戶端通過註冊中心可以瞭解這些服務例項執行狀況。
2.Consul
如果要實現服務註冊與發現，需要一個註冊中心，這裡主要介紹是Consul。
Consul官網：https://www.consul.io/，它主要功能有：服務註冊與發現、健康檢查、Key/Value、多資料中心。
如果在Linux上部署Consul，大夥可以移步我之前寫過這篇文章“Consul在linux環境的叢集部署”參考下。
3.Asp.Net Core向Consul註冊服務例項
Asp.Net Core向Consul註冊服務例項呼叫過程如下圖所示（圖片來源於https://www.cnblogs.com/zhouandke/p/10534836.html）：
Asp.Net Core向Consul註冊服務例項需要在Gateway專案中引用Consul支援的NuGet軟體包，安裝命令如下：
Install-Package Ocelot.Provider.Consul
然後將以下內容新增到您的ConfigureServices方法中：
services.AddOcelot().AddConsul();
在Ocelot服務發現專案示例中，通過APIGateway專案GlobalConfiguration選項可以配置服務註冊與發現，檔案配置具體程式碼如下：
{
"Routes": [
{
"UseServiceDiscovery": true,
"DownstreamPathTemplate": "/{url}",
"DownstreamScheme": "http",
"ServiceName": "MyService",
"LoadBalancerOptions": {
"Type": "RoundRobin"
},
"UpstreamPathTemplate": "/{url}",
"UpstreamHttpMethod": [ "Get" ],
"ReRoutesCaseSensitive": false
}
],
"GlobalConfiguration": {
//服務發現配置
"ServiceDiscoveryProvider": {
//註冊中心Consul地址
"Host": "192.168.113.128",
//註冊中心Consul埠號
"Port": 8500,
"Type": "Consul",
//以毫秒為單位，告訴Ocelot多久呼叫一次Consul來更改服務配置。
"PollingInterval": 100,
//如果你有在Consul上配置key/value，則在這裡輸入配置key。
"ConfigurationKey": "MyService_AB"
}
}
}ServiceDiscoveryProvider選項說明：
●Host：註冊中心Consul地址。
●Port：註冊中心Consul埠號。
●Type：註冊中心型別。
●PollingInterval：以毫秒為單位，告訴Ocelot多久呼叫一次Consul來更改服務配置。
●ConfigurationKey：如果你有在Consul上配置key/value，則在這裡輸入配置key。
4.專案演示
4.1APIGateway專案
ConfigureServices新增Ocelot、Consul注入：
services.AddOcelot().AddConsul();
Configure新增使用Ocelot：
app.UseOcelot().Wait();
服務發現配置如Ocelot服務發現專案示例一樣。
4.2Common專案
先安裝Consul的NuGet軟體包，安裝命令如下：
Install-Package Consul
在該專案新增一個AppExtensions擴充套件類，用來對服務APIServiceA、APIServiceB專案在Consul註冊例項，為了展示效果，具體程式碼稍作修改如下：
public static class AppExtensions
{
public static IServiceCollection AddConsulConfig(this IServiceCollection services, IConfiguration configuration)
{
services.AddSingleton<IConsulClient, ConsulClient>(p => new ConsulClient(consulConfig =>
{
var address = configuration.GetValue<string>("Consul:Host");
consulConfig.Address = new Uri(address);
}));
return services;
}
public static IApplicationBuilder UseConsul(this IApplicationBuilder app, string host = null, string port = null)
{
//獲取consul客戶端例項
var consulClient = app.ApplicationServices.GetRequiredService<IConsulClient>();
var logger = app.ApplicationServices.GetRequiredService<ILoggerFactory>().CreateLogger("AppExtensions");
var lifetime = app.ApplicationServices.GetRequiredService<IApplicationLifetime>();
if (!(app.Properties["server.Features"] is FeatureCollection features)) return app;
//var addresses = features.Get<IServerAddressesFeature>();
//var address = addresses.Addresses.FirstOrDefault();
//if (address == null)
//{
// return app;
//}
var address = host + ":" + port;
if (string.IsNullOrWhiteSpace(host) || string.IsNullOrWhiteSpace(port))
{
Console.WriteLine($"host或者port為空！");
return app;
}
Console.WriteLine($"address={address}");
var uri = new Uri(address);
Console.WriteLine($"host={uri.Host},port={uri.Port}");
var registration = new AgentServiceRegistration()
{
ID = $"MyService-{uri.Port}",
Name = "MyService",
Address = $"{uri.Host}",
Port = uri.Port,
Check = new AgentServiceCheck()
{
DeregisterCriticalServiceAfter = TimeSpan.FromSeconds(5),//服務啟動多久後註冊
Interval = TimeSpan.FromSeconds(10),//健康檢查時間間隔
HTTP = $"{address}/HealthCheck",//健康檢查地址
Timeout = TimeSpan.FromSeconds(5)//超時時間
}
};
logger.LogInformation("Registering with Consul");
logger.LogInformation($"Consul RegistrationID:{registration.ID}");
//登出
consulClient.Agent.ServiceDeregister(registration.ID).ConfigureAwait(true);
//註冊
consulClient.Agent.ServiceRegister(registration).ConfigureAwait(true);
//應用程式關閉時候
lifetime.ApplicationStopping.Register(() =>
{
//正在登出
logger.LogInformation("Unregistering from Consul");
consulClient.Agent.ServiceDeregister(registration.ID).ConfigureAwait(true);
});
//每個服務都需要提供一個用於健康檢查的介面，該介面不具備業務功能。服務註冊時把這個介面的地址也告訴註冊中心，註冊中心會定時呼叫這個介面來檢測服務是否正常，如果不正常，則將它移除，這樣就保證了服務的可用性。
app.Map("/HealthCheck", s =>
{
s.Run(async context =>
{
await context.Response.WriteAsync("ok");
});
});
return app;
}
}
4.3APIServiceA專案
專案新增一個Get方法，對應APIGateway專案的路由上下游配置，具體程式碼如下：
[Route("api/[controller]")]
[ApiController]
public class ValuesController : ControllerBase
{
// GET api/values
[HttpGet]
public ActionResult<IEnumerable<string>> Get()
{
var port = Request.Host.Port;
return new string[] { "value1", "value2", port.Value.ToString() };
}
}
appsettings.json配置加入Consul地址：
"Consul": {
"Host": "http://192.168.113.128:8500"
}
4.4APIServiceB專案
專案新增一個Get方法，對應APIGateway專案的路由上下游配置，具體程式碼如下：
[Route("api/[controller]")]
[ApiController]
public class ValuesController : ControllerBase
{
// GET api/values
[HttpGet]
public ActionResult<IEnumerable<string>> Get()
{
var port = Request.Host.Port;
return new string[] { "value3", "value4", port.Value.ToString() };
}
}
appsettings.json配置加入Consul地址：
"Consul": {
"Host": "http://192.168.113.128:8500"
}
4.5專案執行
在APIServiceA、APIServiceB專案的ConfigureServices新增Consul配置：
services.AddConsulConfig(Configuration);
在Configure新增Consul服務註冊：
APIServiceA：app.UseConsul("http://172.168.18.73", "9999");
APIServiceB：app.UseConsul("http://172.168.18.73", "9998");
把APIGateway、APIServiceA、APIServiceB三個專案部署到IIS上：
三個專案執行起來後，通過瀏覽器Consul客戶端可以看到MyService節點服務情況：
點選開啟MyService節點可以看到註冊到Consul的APIServiceA、APIServiceB服務狀況：
如果把APIServiceB服務例項站點停掉：
通過Consul客戶端會看到APIServiceB服務例項已經被剔除了：
如果輸入CTRL+C把叢集中某一個Consul服務關閉，那麼叢集會重新選舉一個新的leader，負責處理所有服務例項的查詢和事務：
參考文獻：
Ocelot