ASP.NET Core結合Nacos來完成配置管理和服務發(fā)現

目錄

* 前言 <https://www.cnblogs.com/catcher1994/p/11489052.html#前言>
* Nacos的簡介 <https://www.cnblogs.com/catcher1994/p/11489052.html#nacos的簡介>
* 啟動Nacos <https://www.cnblogs.com/catcher1994/p/11489052.html#啟動nacos>
* 配置管理 <https://www.cnblogs.com/catcher1994/p/11489052.html#配置管理>
* 服務發(fā)現 <https://www.cnblogs.com/catcher1994/p/11489052.html#服務發(fā)現>
* 寫在最后 <https://www.cnblogs.com/catcher1994/p/11489052.html#寫在最后>
前言

今年4月份的時候，和平臺組的同事一起調研了一下Nacos，也就在那個時候寫了.net core版本的非官方版的SDK
<https://github.com/catcherwong/nacos-sdk-csharp>。

雖然公司內部由于某些原因最后沒有真正的用起來，但很多人還是挺看好的。在和鎮(zhèn)汐大大溝通后，決定寫一篇博客簡單介紹一下。

下面這個圖，就是本文的重點了。



Nacos的簡介


Nacos是一個易于構建云原生應用的動態(tài)服務發(fā)現、配置管理和服務管理平臺，它提供了一組簡單易用的特性集，幫助我們快速實現動態(tài)服務發(fā)現、服務配置、服務元數據及流量管理。

它有下面的關鍵特性

* 服務發(fā)現和服務健康監(jiān)測
* 動態(tài)配置服務
* 動態(tài) DNS 服務
* 服務及其元數據管理
* ...
特性還是挺多的，也有挺多值的挖掘的地方。有關Nacos的更多信息可以訪問下面的地址：

* https://nacos.io/zh-cn/ <https://nacos.io/zh-cn/>
* https://github.com/nacos-group <https://github.com/nacos-group>
* https://github.com/alibaba/nacos <https://github.com/alibaba/nacos>
下面就開始正題了，第一步肯定是先把Nacos跑起來。

啟動Nacos

由于是演示，所以直接用docker啟動了Standalone Mysql模式的。
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后，會先拉取幾個鏡像回來，然后就看到下面的輸出，基本就是正常啟動了。



打開瀏覽器訪問 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給調用方，如果有，那就會返回具體的配置值。

由于我們是剛運行起行，什么都沒有操作，所以肯定是沒有任何配置信息的。



那我們就先添加一個，看看效果如何。

同樣在上面的控制器中加入下面的發(fā)布配置的方法，同樣也是通過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(); }


這個時候我們已經添加成功了。

\回去控制臺，也可以看到剛才加的配置已經出來了。



再一次訪問獲取配置信息的接口，就已經可以拿到對應的配置內容了。



下面通過控制臺去修改一下配置的內容。



點發(fā)布按鈕的時候，會有一個比較頁面，讓我們對比前后修改了那些內容。



這個時候我們通過INacosConfigClient去訪問的話，發(fā)現是獲取不到我們剛才更新的內容的。

這個是因為，從Nacos讀取配置成功后，會寫入配置信息到本地緩存中，后面訪問的話會優(yōu)先去讀緩存的內容。

那么要怎么做到有人修改了配置內容后，它能實時生效呢？其實很簡單，只需要添加一下對配置的監(jiān)聽就可以了。

這個得益于Nacos允許我們監(jiān)聽配置，以便實時感知配置變更。如果配置變更，則用獲取配置接口獲取配置的最新值，動態(tài)刷新本地緩存。

下面是一個簡單的示例，這里用的是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); } }
這里其實沒有什么內容，就是在程序啟動的時候添加一下監(jiān)聽，然后在程序退出的時候，同樣也退出監(jiān)聽。

不要忘記在Startup中加下面的代碼，這樣配置的監(jiān)聽才會生效！
services.AddHostedService<ListenConfigurationBgTask>();
當我們添加監(jiān)聽之后，修改了配置文件的內容，它就可以動態(tài)的更新加載了。



同樣的，控制臺里面也有監(jiān)聽的記錄，可以在監(jiān)聽查詢里面找到。



下面是具體的程序日志輸出



配置的每一次修改，都會有歷史記錄，可以從歷史版本里面找到。



除了能看歷史的記錄，還可以回滾到指定的版本，這是個很有用的功能。

在數據庫中，配置信息的保存是這樣的



還有一個刪除配置的方法，這里就不介紹了，都是差不多的用法，不過正常情況下是不應該刪除配置的，除非是多余的。

關于Nacos配置管理的介紹就先到這里了，有興趣的朋友可以繼續(xù)去深究。

下面我們就來看看Nacos的服務發(fā)現。

服務發(fā)現

關于服務注冊和發(fā)現，聽的比較多的大概就是，consul, eureka, etcd , k8s 等等。


思路其實都差不多，在服務啟動的時候，把當前服務的相關信息注冊上去，然后要調用某個服務的時候，就獲取這個服務下面的列表，然后選一個可用的進行訪問。最后就是當服務停止的時候，我們要注銷當前的服務。

目前這個SDK提供了兩種形式，一種是原始的API，一種是對原始API進行了封裝，可以直接注冊和發(fā)現相應的下游服務。

原始的API在一個名為INacosNamingClient的Client接口中提供，這個接口里面的所有內容都是服務發(fā)現相關的。

不過在這里只介紹封裝過后的使用方法，當然也可以自己根據原始的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發(fā)送心跳，心跳的里面包含了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(); } }
然后就是發(fā)現服務了。

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();
} }
效果就來看動圖了。



在兩個實例的健康狀態(tài)都是true的時候，會隨機調用一個實例。

當把其中一個實例停掉的時候，這個實例的健康狀態(tài)就會被標識為false，這個時候就不會調用到這個false的實例。

當把這個實例重新運行之后，又恢復到隨機調用的情況。

Nacos的服務發(fā)現除了上面介紹的，還有系統(tǒng)開關，數據指標，集群信息等功能，有待去深入挖掘。

寫在最后

Nacos使用起來不算復雜，算是比較容易上手的，用的公司也挺多的了。

還有個把 steeltoe 和Nacos結合起來的項目 skynet-cloud
<https://github.com/magicsgxie/skynet-cloud> 也可以看看。

文中的示例代碼可以戳這里 NacosDemo
<https://github.com/catcherwong-archive/2019/tree/master/09/NacosDemo>

SDK的地址 nacos-sdk-csharp <https://github.com/catcherwong/nacos-sdk-csharp>

希望感興趣的大佬給個星星，也十分希望有大佬來一起維護這個項目，和提些建議。

因為是第一次寫SDK類的東西，參考了其他平臺提供.NET的SDK，然后結合Nacos的Open API寫的，有可能會有不少遺漏和bug，還請各位大佬多多包涵。

• ? 上一篇：FreeSql （二十七）將已寫好的 SQL 語句，與實體類映射進行二次查詢
• ? 下一篇： CSI介紹