kklldog/agile_config

AgileConfig

!GitHub Workflow Status !GitHub stars !Commit Date !Nuget !Nuget !GitHub license

这是一个基于.NET Core开发的轻量级配置中心。配置中心常与微服务关联，但实际上，许多分布式程序（如传统SOA应用）或容器化部署的非微服务应用，因部署分散而面临配置修改困难的问题。AgileConfig的开发目标并非局限于微服务，而是为各类分布式、容器化应用提供简单的配置读取与修改能力。

AgileConfig秉承轻量化理念，部署简单、配置简单、使用简单、学习简单，仅保留必要功能，无需如Apollo般复杂庞大，却足以替换web.config、appsettings.json等传统配置文件。若不想为配置中心部署复杂架构，AgileConfig是理想选择。

特点

1. 部署简单，最少仅需一个数据节点，支持Docker部署
2. 支持多节点分布式部署以保证高可用
3. 配置支持按应用隔离，应用内配置支持分组隔离
4. 应用支持继承，可将公共配置提取至父应用供其他应用继承
5. 采用长连接技术，配置信息实时推送至客户端
6. 支持IConfiguration、IOptions模式读取配置，原程序几乎无需改造
7. 配置修改支持版本记录，可随时回滚配置
8. 所有节点故障时，客户端支持从本地缓存读取配置
9. 支持Restful API维护配置

演示地址：AgileConfig Server Demo 密码：***
客户端项目：https://github.com/kklldog/AgileConfig_Client
示例项目：
https://github.com/kklldog/AgileConfig_Client/tree/master/AgileConfigMVCSample
https://github.com/kklldog/AgileConfig_Client/tree/master/AgileConfigWPFSample
https://github.com/kklldog/AgileConfig_Client/tree/master/AgileConfigConsoleSample
教程 - 如何使用AgileConfig.Client读取配置
https://github.com/kklldog/AgileConfig/wiki/Restful-API

架构

![]([***]

AgileConfig架构主要分为三部分：

客户端

客户端程序基于.NET Standard 2.0开发，可通过NuGet安装（搜索agileconfig.client）。初始化时可配置多个节点地址，客户端会随机选择节点建立长连接；连接中断后自动重连其他节点，确保配置获取连续性。

节点、管理程序

节点基于ASP.NET Core开发，为简化部署，管理程序与节点服务合二为一。通过环境变量可启用任意节点的管理程序功能，实现配置维护。

数据库

使用数据库存储配置数据，支持SqlServer、MySQL、Sqlite、PostgreSQL、Oracle五种数据库（基于Freesql数据访问组件）。用户仅需创建空库，表结构将在首次启动时自动生成。

注意：版本≤1.0.4的用户请勿更新，EFCore与Freesql自动建库存在差异，避免兼容性问题。

关于高可用

AgileConfig节点无状态，支持横向扩展部署。客户端配置多节点地址后，可自动切换连接节点，保障高可用：

数据库高可用需依赖数据库自身方案（如MySQL的binlog），与Apollo架构类似，数据库单点问题由数据库层面解决。

部署服务端

初始化数据库

用户需手动创建空库，首次启动时自动生成所有表结构。支持数据库及provider对照：

• SqlServer: SqlServer
• MySQL: MySql
• Sqlite: Sqlite
• PostgreSQL: PostgreSql
• Oracle: Oracle

运行服务端

使用Docker部署示例：

bash
sudo docker run --name agile_config -e adminConsole=true -e db:provider=sqlite -e db:conn="Data Source=agile_config.db" -p 5000:5000 -v /etc/localtime:/etc/localtime  kklldog/agile_config:latest

环境变量说明：

• adminConsole: 是否启用管理程序功能（true/false）
• db:provider: 数据库类型（如sqlite）
• db:conn: 数据库连接串

初始化管理员密码

首次运行需设置管理员密码，访问部署地址（如http://localhost:5000），按提示完成初始化。

节点配置

多节点部署时，需在管理界面添加所有节点信息（含启用管理程序的节点），实现统一管理。

应用配置

支持多应用隔离，应用间可配置继承关系（提取公共配置至父应用，子应用继承并覆盖）。应用内配置支持分组管理，提升配置组织灵活性。

配置项管理

配置项支持分组，新增配置需手动“上线”以推送至客户端；修改、删除、回滚操作实时推送。配置版本记录完整，支持任意版本回滚。

客户端监控

管理界面可查看已连接客户端状态，包括应用ID、连接时间等信息。

系统日志

记录服务运行关键事件（如配置变更、节点状态等），便于问题排查。

使用客户端

安装客户端

通过NuGet安装客户端类库：

bash
Install-Package AgileConfig.Client

初始化客户端

以ASP.NET Core MVC项目为例，在appsettings.json添加配置：

json
{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  },
  "AllowedHosts": "*",
  "AgileConfig": {
    "appId": "app", // 应用ID
    "secret": "xxx", // 应用密钥
    "nodes": "http://localhost:5000,http://localhost:5001" // 多个节点用逗号分隔
  }
}

在Program.cs中配置客户端：

csharp
public static IHostBuilder CreateHostBuilder(string[] args) =>
    Host.CreateDefaultBuilder(args)
        .ConfigureAppConfiguration((context, config) =>
        {
            var configClient = new ConfigClient(); // 从appsettings.json读取配置
            config.AddAgileConfig(configClient); // 添加AgileConfig配置源
            ConfigClient = configClient; // 挂载客户端实例供全局使用
            configClient.ConfigChanged += ConfigClient_ConfigChanged; // 注册配置变更事件
        })
        .ConfigureWebHostDefaults(webBuilder =>
        {
            webBuilder.UseStartup<Startup>();
        });

读取配置

支持IConfiguration、IOptions模式及客户端实例直接读取，示例：

csharp
public class HomeController : Controller
{
    private readonly IConfiguration _configuration;
    private readonly IOptions<DbConfigOptions> _dbOptions;

    public HomeController(IConfiguration configuration, IOptions<DbConfigOptions> dbOptions)
    {
        _configuration = configuration;
        _dbOptions = dbOptions;
    }

    // 使用IConfiguration读取
    public IActionResult ByIConfiguration()
    {
        var userId = _configuration["userId"];
        var dbConn = _configuration["db:connection"];
        return View();
    }

    // 使用IOptions读取
    public IActionResult ByOptions()
    {
        var dbConn = _dbOptions.Value.connection;
        return View();
    }

    // 使用客户端实例读取（需挂载Program.ConfigClient）
    public IActionResult ByInstance()
    {
        var userId = Program.ConfigClient["userId"];
        return View();
    }
}

联系信息

• ：
• QQ群：***