.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


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM