.Net Core+分布式配置中心(AgileConfig)

时间:2024-03-02 16:11:22

GitHub上AgileConfig非常详细,以下只是本人学习过程的整理

一、介绍

1、参考地址

https://github.com/dotnetcore/AgileConfig

https://www.cnblogs.com/kklldog/p/agile-config.html

2、概念

这是一个基于.net core开发的轻量级配置中心。说起配置中心很容易让人跟微服务联系起来,如果你选择微服务架构,那么几乎逃不了需要一个配置中心。事实上我这里并不是要蹭微服务的热度。这个世界上有很多分布式程序但它并不是微服务。比如有很多传统的SOA的应用他们分布式部署,但并不是完整的微服务架构。这些程序由于分散在多个服务器上所以更改配置很困难。又或者某些程序即使不是分布式部署的,但是他们采用了容器化部署,他们修改配置同样很费劲。所以我开发AgileConfig并不是为了什么微服务,我更多的是为了那些分布式、容器化部署的应用能够更加简单的读取、修改配置。

AgileConfig秉承轻量化的特点,部署简单、配置简单、使用简单、学习简单,它只提取了必要的一些功能,并没有像Apollo那样复杂且庞大。但是它的功能也已经足够你替换webconfig,appsettings.json这些文件了。如果你不想用微服务全家桶,不想为了部署一个配置中心而需要看N篇教程跟几台服务器那么你可以试试AgileConfig)

3、特点

1. 部署简单,最少只需要一个数据节点,支持docker部署

2. 支持多节点分布式部署来保证高可用

3. 配置支持按应用隔离,应用内配置支持分组隔离

4. 应用支持继承,可以把公共配置提取到一个应用然后其它应用继承它

5. 使用长连接技术,配置信息实时推送至客户端

6. 支持IConfiguration,IOptions模式读取配置,原程序几乎可以不用改造

7. 配置修改支持版本记录,随时回滚配置

8. 如果所有节点都故障,客户端支持从本地缓存读取配置

9. 支持Restful API维护配置

4、架构

 

AgileConfig的架构比较简单,主要是分3块:

A、客户端

客户端程序是使用netstandard2.0开发的一个类库,方便.net core程序接入,nuget搜agileconfig.client就可以安装。可以在启动客户端的时候配置多个节点的地址,客户端会随机挑选一个进行连接,连接成功后会维持一个websocket长连接。如果连接的节点发生故障导致连接中断,客户端会继续随机一个节点进行连接,直到连接成功。

B、节点、管理程序

节点是使用asp.net core开发的一个服务。为了部署简单,直接把管理程序跟节点服务合二为一了。任何一个节点都可以在启动的时候配置环境变量开启管理程序功能。

C、数据库

使用数据库来存储数据,目前支持Sqlserver, Mysql, Sqlite, PostgreSql,Oracle 五种数据库。最新版本已经切换为Freesql为数据访问组件。Freesql对多数据库的支持更加强劲,特别是对国产数据库的支持。但是因为没有国产数据库的测试环境,本项目并未支持,如果有需要我可是开分支尝试支持,但是测试工作就要靠用户啦。

注意:如果使用<=1.0.4之前版本的用户请不要更新,因为EFCore跟Freesql自动建的库可能存在稍许差异,保险起见不要更新吧。

D、关于高可用

AgileConfig的节点都是无状态的,所以可以横向部署多个节点来防止单点故障。在客户端配置多个节点地址后,客户端会随机连接至某个节点。

问题

影响

说明

控制台下线

无法维护配置,客户端无影响

因为控制台跟节点是共存的,所以某个控制台下线一般来说同样意味着一个节点的下线

某个节点下线

客户端重连至其他节点

无任何影响

所有节点下线

客户端从内存读取配置

启动的客户端会从内存读取配置,未启动的客户端会再尝试连接到节点多次失败后,尝试从本地文件缓存读取配置,保证应用可以启动

二、部署服务端

1、初始化数据库

用户只需要手工建一个空库,所有的表在第一次启动的时候都会自动生成。目前支持sqlserver,mysql,sqlite三种数据库。

三、使用服务端

1、运行服务端

通过docker建立一个agile_config实例

命令:

sudo docker run --name agile_config -e adminConsole=true -e db:provider=mysql -e db:conn="Database=TestConfig;Data Source=你的数据库IP地址;User Id=root;Password=123456;port=你的数据库端口" -p 5000:5000 kklldog/agile_config:latest

配置:

1. adminConsole 配置程序是否为管理控制台。如果为true则启用控制台功能,访问该实例会出现管理界面。

2. db:provider 配置程序的数据库类型。目前程序支持:sqlite,mysql,sqlserver 三种数据库。

3. db:conn 配置数据库连接串

2、浏览地址

 

3、初始化管理员密码

第一次远行程序需要初始化管理员密码

4、节点

AgileConfig支持多节点部署,所有的节点都是平行的。为了简化部署,AgileConfig并没有单独的控制台程序,请直接使用任意一个节点作为控制台。当环境变量adminConsole=true时,该节点同时兼备数据节点跟控制台功能。为了控制台能够管理节点,所以需要在控制台配置节点的信息。

注意:即使是作为控制台的数据节点同样需要添加到管理程序,以便管理它。

 

 

 

5、应用

AgileConfig支持多应用程序接入。需要为每个应用程序配置名称、ID、秘钥等信息。

 

6、配置项

配置完应用信息后可以为每个应用配置配置项。配置项支持分组。新添加的配置并不会被客户端感知到,需要手工点击“上线”才会推送给客户端。已上线的配置如果发生修改、删除、回滚操作,会实时推送给客户端。版本历史记录了配置的历史信息,可以回滚至任意版本。

7、客户端

控制台可以查看已连接的客户端。

 

8、系统日志

系统日志记录了AgileConfig生产中的一些关键信息。

 

四、使用客户端

1、安装客户端

2、修改appsettings.json

 

3、修改program

 

4、添加注入

5、自定义配置类

 

6、读取配置

AgileConfig支持asp.net core 标准的IConfiguration,跟IOptions模式读取配置。还支持直接通过AgileConfigClient实例直接读取

 

五、Other

初始化时只需要空库,配置后所有表与数据自动完成。