.NET 開源配置組件 AgileConfig 初體驗

介紹

在微服務大行其道的今天，系統會被拆分紅多個模塊，做爲單獨的服務運行，同時爲了集中化管理，咱們還須要日誌中心，配置中心等，不少開發人員可能更熟悉 ApolloConfig，這個組件功能也很完善，dotnet的客戶端也主要是國人在維護和開發，以前公司就是選型的Apollo，並且也在生產環境穩定運行，可是服務端是Java的，並且部署服務端也有些麻煩。

今天主要介紹 AgileConfig，這是一個基於.net core開發的輕量級配置中心，以前跟做者也有過溝通，也很熱情幫忙解決問題，它的特色有部署簡單、配置簡單、使用簡單、學習簡單等，同時也支持高可用（多節點）和docker部署，使用了FreeSql支持了多種多種數據庫存儲，Sqlserver, Mysql, Sqlite, PostgreSql,Oracle，FreeSql大法好！

架構圖

部署服務端

首先，咱們須要部署服務端，包含了控制檯UI和節點服務，節點服務使用了長鏈接，配置變動後，會實時推送給客戶端，部署推薦使用docker部署，由於項目是開源的，並且是.net core 編寫的，還有一種方式是能夠到github下載源代碼，編譯後發佈運行。

配置信息是在數據庫記錄的，咱們須要新建一個空的數據庫，而後運行命令，程序會自動幫咱們初始化表結構和數據。

docker run --name agile_config -e adminConsole=true -e db:provider=mysql -e db:conn="DataBase=configdb;Data Source=host.docker.internal;User Id=root;Password=123456;" -p 5000:5000 -d kklldog/agile_config:latest

參數介紹：

• adminConsole 配置程序是否爲管理控制檯，若是爲true則啓用控制檯功能，訪問該實例會出現管理界面，多節點部署的話，只須要開啓一個控制檯便可。
• db:provider 配置程序的數據庫類型，可選 sqlserver，mysql，sqlite，npgsql，oracle。
• db:conn 配置數據庫鏈接串

訪問 http://localhost:5000/, 第一次啓動，程序會要求咱們初始化管理員密碼，設置完成之後，進入到首頁，另外做者最近已經用 React 重構了UI，最近會更新，你們也能夠嚐鮮。

而後還須要配置節點，多節點保證了高可用，那若是全部節點都掛了的話，程序會讀取本地的配置緩存，來保證正常的運行，這點你們不用擔憂, 咱們須要在節點管理頁面手動添加節點，這裏我啓動了一個節點，添加的地址爲 http://192.168.100.103:5000 ，須要注意的是，這裏在docker環境不能使用 localhost。

接下來須要配置應用，點擊新增應用，填寫應用名稱，應用Id和應用密鑰。

在客戶端程序使用

這裏使用了asp net core web項目示例，首先須要安裝客戶端組件，執行一下命令或者經過Nuget安裝。

Install-Package AgileConfig.Client

而後修改appsetting.json 文件

{ 
  "AgileConfig": {
    "appId": "LogService",
    "secret": "123456",
    "nodes": "http://localhost:5000,http://localhost:5001"//多個節點使用逗號分隔
  }
}

而後修改 Program.cs

public static IHostBuilder CreateHostBuilder(string[] args) =>
       Host.CreateDefaultBuilder(args)
       .ConfigureAppConfiguration((context, config) =>
        {
           var configClient = new ConfigClient();
           config.AddAgileConfig(configClient);
       })
        .ConfigureWebHostDefaults(webBuilder =>
        {
            webBuilder.UseStartup<Startup>();
        });

準備工做完成，接下來就要開始使用了，咱們在配置項頁面上面添加配置，而後選中點擊上線。

而後能夠在代碼中使用注入的 IConfiguration 獲取配置便可

[Route("[controller]/[action]")]
    public class HomeController : ControllerBase
    {    
        private readonly IConfiguration _config;

        public HomeController(IConfiguration config)
        {
            _config = config; 
        }

        [HttpGet]
        public IActionResult Index()
        {
            var value = _config["AgileKey"];

            return Ok(new { value });
        }

而後啓動程序，就能夠盡情使用 AgileConfig 了，在頁面上修改配置的話，咱們的客戶端配置也是實時修改的。

在配置頁面上的配置都是字符串鍵值對的，那對於Json字符串應該怎麼處理呢, 咱們可使用 Tuhu.Extensions.Configuration.ValueBinder.Json 擴展，經過Nuget安裝便可，而後修改Startup.cs 文件

public void ConfigureServices(IServiceCollection services)
{ 
      services.ConfigureJsonValue<LogOptions>("", Configuration.GetSection("LogOptions"));  
}

LogOptions：

public class LogOptions : IOptions<LogOptions>
{
        public string Level { get; set; }

        public int Count { get; set; }

        public LogOptions Value => this;
}

這樣咱們就能夠在代碼中，使用注入的 IOptions<LogOptions> 來獲取讀取配置。

總結

AgileConfig 是使用 .net core 開發的配置組件，部署和使用起來都很簡單，可是目前還有一些不足，好比多帳號權限管理，和多環境支持，通常是開發，灰度和正式，不過沒有關係，項目都是開源的，你們感興趣的一塊兒建設，完善不足的功能，如今.NET 社區是愈來愈好了，若是對你們有幫助的，能夠支持一下！

https://github.com/kklldog/AgileConfig