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

SpringLeee 發表於 2021-04-06

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

介紹

在微服務大行其道的今天,系統會被拆分成多個模組,作為單獨的服務執行,同時為了集中化管理,我們還需要日誌中心,配置中心等,很多開發人員可能更熟悉 ApolloConfig,這個元件功能也很完善,dotnet的客戶端也主要是國人在維護和開發,之前公司就是選型的Apollo,而且也在生產環境穩定執行,但是服務端是Java的,而且部署服務端也有些麻煩。

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

架構圖

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

部署服務端

首先,我們需要部署服務端,包含了控制檯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,最近會更新,大家也可以嚐鮮。

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

然後還需要配置節點,多節點保證了高可用,那如果所有節點都掛了的話,程式會讀取本地的配置快取,來保證正常的執行,這點大家不用擔心, 我們需要在節點管理頁面手動新增節點,這裡我啟動了一個節點,新增的地址為 http://192.168.100.103:5000 ,需要注意的是,這裡在docker環境不能使用 localhost。

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

接下來需要配置應用,點選新增應用,填寫應用名稱,應用Id和應用金鑰。

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

在客戶端程式使用

這裡使用了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>();
        });

準備工作完成,接下來就要開始使用了,我們在配置項頁面上面新增配置,然後選中點選上線。

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

然後可以在程式碼中使用注入的 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