ASP.NET Core结合Nacos来完成配置管理和服务发现

前言

今年4月份的时候,和平台组的同事一起调研了一下Nacos,也就在那个时候写了.net core版本的非官方版的SDK。

虽然公司内部由于某些原因最后没有真正的用起来,但很多人还是挺看好的。在和镇汐大大沟通后,决定写一篇博客简单介绍一下。

下面这个图,就是本文的重点了。

640?wx_fmt=png

Nacos的简介

Nacos是一个易于构建云原生应用的动态服务发现、配置管理和服务管理平台,它提供了一组简单易用的特性集,帮助我们快速实现动态服务发现、服务配置、服务元数据及流量管理。

它有下面的关键特性

  • 服务发现和服务健康监测

  • 动态配置服务

  • 动态 DNS 服务

  • 服务及其元数据管理

  • ...

特性还是挺多的,也有挺多值的挖掘的地方。有关Nacos的更多信息可以访问下面的地址:

  • https://nacos.io/zh-cn/

  • https://github.com/nacos-group

  • 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后,会先拉取几个镜像回来,然后就看到下面的输出,基本就是正常启动了。

640?wx_fmt=png

打开浏览器访问 http://localhost:8848/nacos 就可以看到Nacos控制台的登录界面了。

640?wx_fmt=png

初始的用户名和密码都是 nacos,登录进来之后大概是这样的。

640?wx_fmt=png

可以看到运行起来的Nacos,版本是1.1.3,还有清晰可见的几个大菜单,这些都是可以很方便我们去进行管理的。

那我们就先来看一下Nacos的配置管理吧。

配置管理

640?wx_fmt=png

在上面的特性大图中,已经很明确的告诉了我们配置管理的几个重要功能。

在配置中有几个比较重要的概念需要先了解一下。

  • tenant 租户信息,对应 Nacos 的命名空间字段。

  • dataId 配置ID。

  • group 配置分组。

先添加下面这个nuget包,然后看一下这个配置要怎么玩。

dotnet add package nacos-sdk-csharp-unofficial

还有必不可少的就是在Startup里面进行配置。

public void ConfigureServices(IServiceCollection services)
{services.AddNacos(configure =>{configure.DefaultTimeOut = 8;configure.ServerAddresses = new System.Collections.Generic.List<string> { "localhost:8848" };configure.Namespace = "";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;}[HttpGet("")]public async Task<string> Get([FromQuery]string key){var res = await _configClient.GetConfigAsync(new GetConfigRequest{DataId = key,Group = "DEFAULT_GROUP",}) ;return string.IsNullOrWhiteSpace(res) ? "Not Found" : res;}
}

上面获取配置的这个获取配置的方法,大意就是 读取默认命名空间(public)下面的DEFAULT_GROUP这个配置分组下面的,名为key的配置Id的值。

如果我们输入的key,在Nacos上面没有,那个这个方法就会返回 Not Found给调用方,如果有,那就会返回具体的配置值。

由于我们是刚运行起行,什么都没有操作,所以肯定是没有任何配置信息的。

640?wx_fmt=png

那我们就先添加一个,看看效果如何。

同样在上面的控制器中加入下面的发布配置的方法,同样也是通过INacosConfigClient来添加配置。


[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",Content = value});return res.ToString();
}

640?wx_fmt=png

这个时候我们已经添加成功了。

\回去控制台,也可以看到刚才加的配置已经出来了。

640?wx_fmt=png

再一次访问获取配置信息的接口,就已经可以拿到对应的配置内容了。

640?wx_fmt=png

下面通过控制台去修改一下配置的内容。

640?wx_fmt=png

点发布按钮的时候,会有一个比较页面,让我们对比前后修改了那些内容。

640?wx_fmt=png

这个时候我们通过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){await _configClient.AddListenerAsync(new AddListenerRequest{DataId = "demo1",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){await _configClient.RemoveListenerAsync(new RemoveListenerRequest{DataId = "demo1",Callbacks = new List<Action>{() =>{_logger.LogInformation($" Removed listerner  ");},}});await base.StopAsync(cancellationToken);}
}

这里其实没有什么内容,就是在程序启动的时候添加一下监听,然后在程序退出的时候,同样也退出监听。

不要忘记在Startup中加下面的代码,这样配置的监听才会生效!

services.AddHostedService<ListenConfigurationBgTask>();

当我们添加监听之后,修改了配置文件的内容,它就可以动态的更新加载了。

640?wx_fmt=gif

同样的,控制台里面也有监听的记录,可以在监听查询里面找到。

640?wx_fmt=png

下面是具体的程序日志输出

640?wx_fmt=png

配置的每一次修改,都会有历史记录,可以从历史版本里面找到。

640?wx_fmt=png

除了能看历史的记录,还可以回滚到指定的版本,这是个很有用的功能。

在数据库中,配置信息的保存是这样的

640?wx_fmt=png

还有一个删除配置的方法,这里就不介绍了,都是差不多的用法,不过正常情况下是不应该删除配置的,除非是多余的。

关于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){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();}}
}

这里只需要简单的配置这两个地方就可以完成服务的注册功能了!!

下面就启动这个程序。

640?wx_fmt=png

可以看到在启动程序的时候,当前实例就会向Nacos发送心跳,心跳的里面包含了IP和端口等信息。

回到控制台,我们可以看到这个服务现在已经有一个实例了。

640?wx_fmt=png

再启动一个同服务名的实例,这里只对接口返回的内容做了一下调整,其他都是一样的!

这个时候点进服务的详情里面,可以看到更加具体的信息。

640?wx_fmt=png

服务现在是已经注册上来了,下面我们就再来一个服务去调用上面这个注册好的服务。

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();}
}

然后就是发现服务了。

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;}[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();}
}

效果就来看动图了。

640?wx_fmt=gif

在两个实例的健康状态都是true的时候,会随机调用一个实例。

当把其中一个实例停掉的时候,这个实例的健康状态就会被标识为false,这个时候就不会调用到这个false的实例。

当把这个实例重新运行之后,又恢复到随机调用的情况。

Nacos的服务发现除了上面介绍的,还有系统开关,数据指标,集群信息等功能,有待去深入挖掘。

写在最后

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,还请各位大佬多多包涵。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/313896.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

Java 时间处理

时区、冬令时和夏令时、时间戳 时间戳 距离一个标准参照时间经过的秒数&#xff08;毫秒数&#xff09; 有两个常用参照时间&#xff1a; 1970-01-01 00:00:00 应用最广泛的时间戳参照点2001-01-01 00:00:00 常被苹果系统使用 注意&#xff1a;以上时间节点皆采用UTC的标准时…

试试这个Excel知识测验,得分超过80分算你赢

大家可能都知道&#xff0c;全世界使用Excel的用户超过了10亿。Excel的知识真所谓是博大精深&#xff0c;并且还很有趣味。我最近编写了一个Excel小工具&#xff0c;可以让大家可以在Excel里面进行各种知识小测验&#xff0c;并且与全世界的高手一比高低。这个小工具&#xff0…

自学架构设计?帮你总结了 4 个方法

从编程思维到架构思维的升级&#xff0c;是工作 3、5 年的程序员遇到的第一个槛&#xff0c;特别是当你准备晋升考核时。我有个哥们&#xff0c;技术和业务都很不错&#xff0c;腾讯 T2.3 升 T3.1&#xff0c;就卡在了架构设计这部分。架构这个事儿&#xff0c;不像算法和代码&…

.NET Core 3.0及ASP.NET Core 3.0 前瞻

前几天微软发布了 .NET Core 3.0 Preview 9 &#xff0c;这是.NET Core 3.0 最后一个预览版。[翻译] .NET Core 3.0 Preview 9 发布.NET Core 3.0 正式发布将在.NET Conf 上发布&#xff0c;.NET Conf 时间是9月23日至25日。Visual Studio 2019 16.3预览版3和Visual Studio for…

有了Unicode为啥还需要UTF-8

有了Unicode为啥还需要UTF-8 要回答这个问题&#xff0c;需要吃透“编码”的概念&#xff0c;刚好看到大神阮一峰写的文章&#xff1a;字符编码笔记&#xff1a;ASCII&#xff0c;Unicode 和 UTF-8 抄录如下&#xff0c;便于查找&#xff1a; 一、ASCII 码 我们知道&#xf…

升职却不加薪,为什么我还觉得老板说的挺有道理

前几天晚上&#xff0c;DevOps交流群里&#xff0c;有人抛出这样一个观点&#xff1a;如果有人来找我加薪&#xff0c;我一定告诉他我要给他升职&#xff0c;因为升职是免费的&#xff0c;加薪可是真的要花钱。但是我也会许诺他&#xff0c;如果他能把那个团队搞好&#xff0c;…

细节之中自有天地,整洁成就卓越代码

溪源 | 长沙.NET技术社区开篇我们总是很容易就能写出满足某个特定功能的代码&#xff0c;却很难写出优雅代码。又最欣赏那些优雅的代码&#xff0c;因为优雅代码更能体现一个开发者的积累。就像写一篇散文&#xff0c;有的就像初学者不得其门而入&#xff0c;遣词造句都非常困难…

一次业务网关用ASP.NET Core 2.1重构的小结

前言对于API网关&#xff0c;业界貌似对它进行下划分&#xff0c;有下面几个分类/场景。面向Web App面向Mobile App面向Partner OpenAPI面向Partner ExternalAPI其他。。。在18年8月份的时候&#xff0c;有幸用.NET Core 2.1重构了一个对外的业务网关项目&#xff0c;这个项目的…

推荐几个华为,字节跳动、蚂蚁金服等大佬的公众号

每一个公众号都是一个特色的图书馆&#xff0c;为我们的学习提供优质的服务&#xff0c;珍贵的资源&#xff0c;耐心看完&#xff0c;认真选择适合自己的良师益友吧。Python爱好者社区Python爱好者社区&#xff0c;这里有分类整理好的历史优秀文章数千篇供你学习&#xff0c;内…

使用Ingress来负载分发微服务

目录 使用Ingress来负载分发微服务 Demo规划 准备Demo并完成部署 创建部署&#xff08;Deployment&#xff09;资源 创建服务&#xff08;Service&#xff09;资源 创建Ingress资源并配置转发规则 使用Ingress来负载分发微服务NodePort Service存在太多缺陷&#xff0c;不适合…

并发和并行及多线程基本概念

并发&#xff08;Concurrent&#xff09; 在操作系统中&#xff0c;是指一个时间段中有几个程序都处于已启动运行到运行完毕之间&#xff0c;且这几个程序都是在同一个处理机上运行&#xff0c;但任一个时刻点上只有一个程序在处理机上运行。 并发&#xff0c;本质上是一个物理…

XUnit 依赖注入

XUnit 依赖注入Intro现在的开发中越来越看重依赖注入的思想&#xff0c;微软的 Asp.Net Core 框架更是天然集成了依赖注入&#xff0c;那么在单元测试中如何使用依赖注入呢&#xff1f;本文主要介绍如何通过 XUnit 来实现依赖注入&#xff0c; XUnit 主要借助 SharedContext 来…

程序员自家种水果,新鲜包邮配送!

点击上面“蓝字”关注我们&#xff01;上次猕猴桃的活动一经推出&#xff0c;得到了广大粉丝的支持&#xff0c;我感到十分欣慰&#xff0c;非常感谢大家对我的信任。好多小伙伴&#xff0c;买了一箱尝过后又下单了好几箱。事实证明&#xff0c;品质才是销量的最佳保证。有些粉…

实现一个简单的基于码云(Gitee) 的 Storage

实现一个简单的基于码云(Gitee) 的 StorageIntro上次在 asp.net core 从单机到集群 一文中提到存储还不支持分布式&#xff0c;并立了一个 flag基于 github 或者 开源中国的码云实现一个 storage于是这两天就来填坑了。。实现了一个简单的基于开源中国的码云的 storage准备工作…

Java线程的6种状态

线程的概念&#xff0c;以及线程的创建方式&#xff0c;见我之前写的博文 本篇文章主要讲Java线程的6种状态 6种状态&#xff1a;初始状态&#xff08;new&#xff09; 、可运行状态&#xff08;Runnable&#xff09;、运行状态&#xff08;Running&#xff09;、阻塞状态&am…

.NET Core 微信小程序支付——(统一下单)

最近公司研发了几个电商小程序&#xff0c;还有一个核心的电商直播&#xff0c;只要是电商一般都会涉及到交易信息&#xff0c;离不开支付系统&#xff0c;这里我们统一实现小程序的支付流程&#xff08;与服务号实现步骤一样&#xff09;。目录1、开通小程序的支付能力2、商户…

用.NET写“算命”程序

前言“算命”&#xff0c;是一种迷信&#xff0c;我父亲那一辈却执迷不悟&#xff0c;有时深陷其中&#xff0c;有时为求一“上上签”&#xff0c;甚至不惜重金&#xff0c;向“天神”保佑。我曾看到过有些算命网站&#xff0c;可以根据人的生辰八字&#xff0c;来求得这个人一…

ASP.NET Core 3.0 迁移避坑指南

一.前言.NET Core 3.0将会在 .NET Conf 大会上正式发布&#xff0c;截止今日发布了9个预览版&#xff0c;改动也是不少&#xff0c;由于没有持续关注&#xff0c;今天将前面开源的动态WebApi项目迁移到.NET Core 3.0还花了不少时间踩坑&#xff0c;给大家分享一下我在迁移过程中…

打不死我的,终将使我强大!DevOps黑客马拉松参赛心得

&#xff08;IDCF DevOps黑客马拉松到底是个啥活动&#xff1f;&#xff09;长得丑活得久、长得帅也惹人爱&#xff01;大家好&#xff0c;我是刘威。隆正信息的业务架构师-花名逸云。非常荣幸可以参加在北京举办的第一届DevOps黑客马拉松比赛。黑客马拉松不是突然冒出来的&…

Java线程池面试题

1、什么是线程池 java.util.concurrent.Executors提供了一个 java.util.concurrent.Executor接口的实现用于创建线程池 多线程技术主要解决处理器单元内多个线程执行的问题&#xff0c;它可以显著减少处理器单元的闲置时间&#xff0c;增加处理器单元的吞吐能力。 假设一个服…