ASP.NET Core結合Nacos來完成配置管理和服務發現
[TOC]html
前言
今年4月份的時候，和平臺組的同事一塊兒調研了一下Nacos，也就在那個時候寫了.net core版本的非官方版的SDK。mysql
雖然公司內部因爲某些緣由最後沒有真正的用起來，但不少人仍是挺看好的。在和鎮汐大大溝通後，決定寫一篇博客簡單介紹一下。git
下面這個圖，就是本文的重點了。github
Nacos的簡介
Nacos是一個易於構建雲原生應用的動態服務發現、配置管理和服務管理平臺，它提供了一組簡單易用的特性集，幫助咱們快速實現動態服務發現、服務配置、服務元數據及流量管理。算法
它有下面的關鍵特性sql
- 服務發現和服務健康監測
- 動態配置服務
- 動態 DNS 服務
- 服務及其元數據管理
- ...
特性仍是挺多的，也有挺多值的挖掘的地方。有關Nacos的更多信息能夠訪問下面的地址：docker
下面就開始正題了，第一步確定是先把Nacos跑起來。數據庫
啓動Nacos
因爲是演示，因此直接用docker啓動了Standalone Mysql模式的。json
git clone --depth 1 https://github.com/nacos-group/nacos-docker.git cd nacos-docker docker-compose -f example/standalone-mysql.yaml up
運行docker-compose後，會先拉取幾個鏡像回來，而後就看到下面的輸出，基本就是正常啓動了。api
打開瀏覽器訪問 http://localhost:8848/nacos 就能夠看到Nacos控制檯的登陸界面了。
初始的用戶名和密碼都是 nacos，登陸進來以後大概是這樣的。
能夠看到運行起來的Nacos，版本是1.1.3，還有清晰可見的幾個大菜單，這些都是能夠很方便咱們去進行管理的。
那咱們就先來看一下Nacos的配置管理吧。
配置管理
在上面的特性大圖中，已經很明確的告訴了咱們配置管理的幾個重要功能。
在配置中有幾個比較重要的概念須要先了解一下。
- tenant 租戶信息，對應 Nacos 的命名空間字段。
- dataId 配置ID。
- group 配置分組。
先添加下面這個nuget包，而後看一下這個配置要怎麼玩。
dotnet add package nacos-sdk-csharp-unofficial
還有必不可少的就是在Startup裏面進行配置。
public void ConfigureServices(IServiceCollection services)
{
// configuration
services.AddNacos(configure =>
{
// default timeout
configure.DefaultTimeOut = 8;
// nacos's endpoint
configure.ServerAddresses = new System.Collections.Generic.List<string> { "localhost:8848" };
// namespace
configure.Namespace = "";
// listen interval
configure.ListenInterval = 1000;
});
services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
}
這個也算是比較常見的配置了，就很少說了，還能夠經過配置文件來加載配置。
這些配置裏面，其實最主要的就是Nacos的地址。
先來看看最簡單的獲取配置信息。
SDK中提供了一個名爲INacosConfigClient的Client接口，這個接口裏面的全部內容都是操做配置相關的。
[Route("api/[controller]")]
[ApiController]
public class ConfigController : ControllerBase
{
private readonly INacosConfigClient _configClient;
public ConfigController(INacosConfigClient configClient)
{
_configClient = configClient;
}
// GET api/config?key=demo1
[HttpGet("")]
public async Task<string> Get([FromQuery]string key)
{
var res = await _configClient.GetConfigAsync(new GetConfigRequest
{
DataId = key,
Group = "DEFAULT_GROUP",
//Tenant = "tenant"
}) ;
return string.IsNullOrWhiteSpace(res) ? "Not Found" : res;
}
}
上面獲取配置的這個獲取配置的方法，大意就是 讀取默認命名空間(public)下面的DEFAULT_GROUP這個配置分組下面的，名爲key的配置Id的值。
若是咱們輸入的key，在Nacos上面沒有，那個這個方法就會返回 Not Found給調用方，若是有，那就會返回具體的配置值。
因爲咱們是剛運行起行，什麼都沒有操做，因此確定是沒有任何配置信息的。
那咱們就先添加一個，看看效果如何。
一樣在上面的控制器中加入下面的發佈配置的方法，一樣也是經過INacosConfigClient來添加配置。
// GET api/config/add?key=demo1&value=123
[HttpGet("add")]
public async Task<string> Add([FromQuery]string key, [FromQuery]string value)
{
var res = await _configClient.PublishConfigAsync(new PublishConfigRequest
{
DataId = key,
Group = "DEFAULT_GROUP",
//Tenant = "tenant"
Content = value
});
return res.ToString();
}
這個時候咱們已經添加成功了。
\回去控制檯，也能夠看到剛纔加的配置已經出來了。
再一次訪問獲取配置信息的接口，就已經能夠拿到對應的配置內容了。
下面經過控制檯去修改一下配置的內容。
點發布按鈕的時候，會有一個比較頁面，讓咱們對比先後修改了那些內容。
這個時候咱們經過INacosConfigClient去訪問的話，發現是獲取不到咱們剛纔更新的內容的。
這個是由於，從Nacos讀取配置成功後，會寫入配置信息到本地緩存中，後面訪問的話會優先去讀緩存的內容。
那麼要怎麼作到有人修改了配置內容後，它能實時生效呢？其實很簡單，只須要添加一下對配置的監聽就能夠了。
這個得益於Nacos容許咱們監聽配置，以便實時感知配置變動。若是配置變動，則用獲取配置接口獲取配置的最新值，動態刷新本地緩存。
下面是一個簡單的示例，這裏用的是BackgroundService來處理的。
public class ListenConfigurationBgTask : BackgroundService
{
private readonly ILogger _logger;
private readonly INacosConfigClient _configClient;
public ListenConfigurationBgTask(ILoggerFactory loggerFactory, INacosConfigClient configClient)
{
_logger = loggerFactory.CreateLogger<ListenConfigurationBgTask>();
_configClient = configClient;
}
protected override async Task ExecuteAsync(CancellationToken stoppingToken)
{
// Add listener
await _configClient.AddListenerAsync(new AddListenerRequest
{
DataId = "demo1",
//Group = "DEFAULT_GROUP",
//Tenant = "tenant",
Callbacks = new List<Action<string>>
{
x =>
{
_logger.LogInformation($" We found something changed!!! {DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss.fff")} [{x}]");
},
}
});
}
public override async Task StopAsync(CancellationToken cancellationToken)
{
// Remove listener
await _configClient.RemoveListenerAsync(new RemoveListenerRequest
{
DataId = "demo1",
Callbacks = new List<Action>
{
() =>
{
_logger.LogInformation($" Removed listerner ");
},
}
});
await base.StopAsync(cancellationToken);
}
}
這裏其實沒有什麼內容，就是在程序啓動的時候添加一下監聽，而後在程序退出的時候，一樣也退出監聽。
不要忘記在Startup中加下面的代碼，這樣配置的監聽纔會生效！
services.AddHostedService<ListenConfigurationBgTask>();
當咱們添加監聽以後，修改了配置文件的內容，它就能夠動態的更新加載了。
一樣的，控制檯裏面也有監聽的記錄，能夠在監聽查詢裏面找到。
下面是具體的程序日誌輸出
配置的每一次修改，都會有歷史記錄，能夠從歷史版本裏面找到。
除了能看歷史的記錄，還能夠回滾到指定的版本，這是個頗有用的功能。
在數據庫中，配置信息的保存是這樣的
還有一個刪除配置的方法，這裏就不介紹了，都是差很少的用法，不過正常狀況下是不該該刪除配置的，除非是多餘的。
關於Nacos配置管理的介紹就先到這裏了，有興趣的朋友能夠繼續去深究。
下面咱們就來看看Nacos的服務發現。
服務發現
關於服務註冊和發現，聽的比較多的大概就是，consul, eureka, etcd , k8s 等等。
思路其實都差很少，在服務啓動的時候，把當前服務的相關信息註冊上去，而後要調用某個服務的時候，就獲取這個服務下面的列表，而後選一個可用的進行訪問。最後就是當服務中止的時候，咱們要註銷當前的服務。
目前這個SDK提供了兩種形式，一種是原始的API，一種是對原始API進行了封裝，能夠直接註冊和發現相應的下游服務。
原始的API在一個名爲INacosNamingClient的Client接口中提供，這個接口裏面的全部內容都是服務發現相關的。
不過在這裏只介紹封裝事後的使用方法，固然也能夠本身根據原始的API進行封裝處理。
首先要添加下面這個nuget包。
dotnet add package nacos-sdk-csharp-unofficial.AspNetCore
先起來一個服務。
先在配置文件appsettings.json中添加下面的內容
{
"nacos": {
"ServerAddresses": [ "localhost:8848" ],
"DefaultTimeOut": 15,
"Namespace": "",
"ListenInterval": 1000,
"ServiceName": "BaseService",
"Weight": 10
}
}
這個配置主要表達了，這個實例的服務名是 BaseService， 權重是10， Nacos的地址是 localhost:8848。
而後在Startup中把當前實例註冊到Nacos。
namespace BaseService
{
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Nacos.AspNetCore;
public class Startup
{
public Startup(IConfiguration configuration)
{
Configuration = configuration;
}
public IConfiguration Configuration { get; }
public void ConfigureServices(IServiceCollection services)
{
// important step
services.AddNacosAspNetCore(Configuration);
services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
}
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
if (env.IsDevelopment())
{
app.UseDeveloperExceptionPage();
}
app.UseMvc();
// important step
app.UseNacosAspNetCore();
}
}
}
這裏只須要簡單的配置這兩個地方就能夠完成服務的註冊功能了！！
下面就啓動這個程序。
能夠看到在啓動程序的時候，當前實例就會向Nacos發送心跳，心跳的裏面包含了IP和端口等信息。
回到控制檯，咱們能夠看到這個服務如今已經有一個實例了。
再啓動一個同服務名的實例，這裏只對接口返回的內容作了一下調整，其餘都是同樣的！
這個時候點進服務的詳情裏面，能夠看到更加具體的信息。
服務如今是已經註冊上來了，下面咱們就再來一個服務去調用上面這個註冊好的服務。
Startup中的內容都是差很少的，不一樣的是，若是肯定服務不被內部其它應用調用的話，能夠不註冊到Nacos上面。
public class Startup
{
public Startup(IConfiguration configuration)
{
Configuration = configuration;
}
public IConfiguration Configuration { get; }
public void ConfigureServices(IServiceCollection services)
{
services.AddHttpClient();
services.AddNacosAspNetCore(Configuration);
services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
}
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
if (env.IsDevelopment())
{
app.UseDeveloperExceptionPage();
}
app.UseMvc();
//app.UseNacosAspNetCore();
}
}
而後就是發現服務了。
INacosServerManager裏面提供了一個只根據服務名來獲取健康的實例的地址信息。不足的地方就是忽略了命名空間和集羣這些參數，會考慮在後面的版本中加上吧。
這裏獲取到的地址信息是隨機取出來的，最簡單的輪訓算法。。獲取到一次全部的實例地址信息後會緩存10秒鐘，這10秒鐘裏面就會直接從緩存中的地址信息取一個。
[Route("api/[controller]")]
[ApiController]
public class ValuesController : ControllerBase
{
private readonly INacosServerManager _serverManager;
private readonly IHttpClientFactory _clientFactory;
public ValuesController(INacosServerManager serverManager, IHttpClientFactory clientFactory)
{
_serverManager = serverManager;
_clientFactory = clientFactory;
}
// GET api/values
[HttpGet]
public async Task<string> GetAsync()
{
var result = await GetResultAsync();
if (string.IsNullOrWhiteSpace(result))
{
result = "ERROR!!!";
}
return result;
}
private async Task<string> GetResultAsync()
{
var baseUrl = await _serverManager.GetServerAsync("BaseService");
if (string.IsNullOrWhiteSpace(baseUrl))
{
return "";
}
var url = $"{baseUrl}/api/values";
var client = _clientFactory.CreateClient();
var result = await client.GetAsync(url);
return await result.Content.ReadAsStringAsync();
}
}
效果就來看動圖了。
在兩個實例的健康狀態都是true的時候，會隨機調用一個實例。
當把其中一個實例停掉的時候，這個實例的健康狀態就會被標識爲false，這個時候就不會調用到這個false的實例。
當把這個實例從新運行以後，又恢復到隨機調用的狀況。
Nacos的服務發現除了上面介紹的，還有系統開關，數據指標，集羣信息等功能，有待去深刻挖掘。
寫在最後
Nacos使用起來不算複雜，算是比較容易上手的，用的公司也挺多的了。
還有個把 steeltoe 和Nacos結合起來的項目 skynet-cloud 也能夠看看。
文中的示例代碼能夠戳這裏 NacosDemo
SDK的地址 nacos-sdk-csharp
但願感興趣的大佬給個星星，也十分但願有大佬來一塊兒維護這個項目，和提些建議。
由於是第一次寫SDK類的東西，參考了其餘平臺提供.NET的SDK，而後結合Nacos的Open API寫的，有可能會有很多遺漏和bug，還請各位大佬多多包涵。
原文出處：https://www.cnblogs.com/catcher1994/p/11489052.html