今天同事在分享 ASP.NET Core 時介紹使用 YAML 作為組態設定檔，自己在過去比較少接觸 YAML 設定檔，也趁此機會來好好讓彼此熟悉一下，在 YAML 官網介紹說明文字如下
YAML is a human friendly data serialization standard for all programming languages.YAML 是一種可讀性高，適用於表達資料序列化的格式，在公司 CI\CD 流程中 Docker 以及 Ansible 都有用到 yaml 作為設定檔情境，被越來越多系統使用，YAML 語法在使用上特性區分大小寫，用 空白 縮行做為資料的階層，可以使用 # 作為註解方便人員閱讀，如果有興趣可以閱讀 YAML 语言教程 了解更多關於 YAML 使用方式，使用方式這裡不在多加說明。在 ASP.NET Core 中在預設 Template 專案範本是使用 json 作為設定檔，今天就是要分享的是將 ASP.NET Core 設定檔轉換為 YAML 的方式，若有問題歡迎提出一起討論或是給予指導
在使用前要安裝 YAML 相關的 Library，這裡要介紹的是由微軟 MVP Andrew Lock 所開發 NetEscapades.Configuration，首先先開啟 Nuget Package Manage 輸入 NetEscapades，選擇 NetEscapades.Configuration.Yaml，點選下載
安裝完畢之後到專案檔底下確認是否有安裝成功
- Install-Package NetEscapades.Configuration.Yaml -Version 1.6.0
備註 : YAML 官網推薦 ASP.NET 套件為 YamlDotNet、yaml-net、yatools.net，有興趣也可以試試看
- <PackageReference Include="NetEscapades.Configuration.Yaml" Version="1.6.0" />
接著新增 settings.yml 並設定檔案內容如下，自訂 Account 區段，其中裡面定義 Account 為 Marcus 與 Title 為 This is a book from Yaml config 其組態設定屬性與相對應的值
請記得調整 yml 檔案的 copy to output Directory 指定為 copy always 或是 copy if news，避免測試時找不到
- Account:
- Name: Marcus
- Title: This is a book from Yaml config.
下一步就是告知應用程式啟動時需要一併考慮 settings.yml 檔案內容，修改 progmam.cs 中的 CreateWebHostBuilder 的代碼如下
- public class Account
- {
- public string Name { get; set; }
- public string Title { get; set; }
- }
- public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
- WebHost.CreateDefaultBuilder(args)
- .ConfigureAppConfiguration(builder =>
- {
- builder.AddYamlFile("settings.yml", optional: true);
- })
- .UseStartup<Startup>();
小提醒 : 在 WebHost.CreateDefaultBuilder 中有定義 BasePath 路徑位置，如果是 console 就需要自己設定 config 路徑
接著調整 Startup 檔案中 ConfigureService 加上以下代碼，指定要取得的內容是從 Account 區段中取得
接著調整 Startup 檔案中 ConfigureService 加上以下代碼，指定要取得的內容是從 Account 區段中取得
這邊使用在 Controller 建構子時注入 IOptions，其型別為 Account
- services.Configure<Account>(Configuration.GetSection("Account"));
接著可以直接在 get 方法使用 Account 類別內容，回傳 name 與 title 的值
- public Account _account { get; set; }
- public ValuesController(IOptions<Account> accountConfig)
- {
- _account = accountConfig.Value;
- }
最後輸出結果如下，成功的取得 setting.yml 檔案中的內容
- [HttpGet]
- public ActionResult<string> Get()
- {
- return new string[] {_account.Name, _account.Title};
- }
同場加映
同事在介紹過程中提到如果不熟悉 yaml 語法的話，可以透過 JSON TO YAML 網站將 json 內容快速轉換為 YAML 格式，如果各位跟我一樣是 YAML 新手的話也可以試試看此網站 : 傳送門，讓寫出來的 YAML 檔案格式更正確，Happy Coding !
參考
Configuration in ASP.NET Core
Creating a custom ConfigurationProvider in ASP.NET Core to parse YAML
0 意見:
張貼留言