（8）ASP.NET Core3.1 Ocelot Consul服務註冊與發現
1.服務註冊與發現（Service Discovery）
●服務註冊：我們通過在每個服務實例寫入註冊程式碼，實例在啟動的時候會先去註冊中心（例如Consul、ZooKeeper、etcd、Eureka）註冊一下，那麼客戶端通過註冊中心可以知道每個服務實例的地址，埠號，健康狀態等等資訊，也可以通過註冊中心刪除服務實例。這裡註冊中心相當於是負責維護服務實例的管控中心。
●服務發現：服務實例在註冊中心註冊之後，客戶端通過註冊中心可以了解這些服務實例運行狀況。
2.Consul
如果要實現服務註冊與發現，需要一個註冊中心，這裡主要介紹是Consul。
Consul官網：//www.consul.io/，它主要功能有：服務註冊與發現、健康檢查、Key/Value、多數據中心。
如果在Windows上部署Consul，在consul.exe目錄下執行consul.exe agent -dev命令行即可。
如果在Linux上部署Consul，大夥可以移步我之前寫過這篇文章「Consul在linux環境的集群部署」參考下。
3.Asp.Net Core向Consul註冊服務實例
Asp.Net Core向Consul註冊服務實例調用過程如下圖所示（圖片來源於//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": "//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": "//192.168.113.128:8500" }
4.5項目運行
在APIServiceA、APIServiceB項目的ConfigureServices添加Consul配置：
services.AddConsulConfig(Configuration);
在Configure添加Consul服務註冊：
APIServiceA：app.UseConsul("//172.168.18.73", "9999"); APIServiceB：app.UseConsul("//172.168.18.73", "9998");
把APIGateway、APIServiceA、APIServiceB三個項目部署到IIS上：
三個項目運行起來後，通過瀏覽器Consul客戶端可以看到MyService節點服務情況：
點擊打開MyService節點可以看到註冊到Consul的APIServiceA、APIServiceB服務狀況：
如果把APIServiceB服務實例站點停掉：
通過Consul客戶端會看到APIServiceB服務實例已經被剔除了：
如果輸入CTRL+C把集群中某一個Consul服務關閉，那麼集群會重新選舉一個新的leader，負責處理所有服務實例的查詢和事務：
參考文獻：
Ocelot官網
