客製化ASP.NET 6.0的應用設定

大家好，我是張飛洪，感謝您的閱讀，我會不定期和你分享學習心得，希望我的文章能成為你成長路上的墊腳石，讓我們一起精進。

本文的主題是應用程式設定。要介紹的是如何使用設定、如何自定義設定，以採用不同的方式設定。也許您已經有了現有的XML設定，或者希望在不同的應用上共用YAML組態檔，或者從資料庫中讀取設定值，總之，設定是我們繞不開的話題。

本文，我們將討論以下主題：

設定組態檔
使用型別化設定
使用初始化（INI）檔案進行設定
設定提供程式

本文中的主題仍然是處在ASP.NET Core的Host層：

2.1設定組態檔

讓我們從各種設定選項開始，自ASP.NET Core2.0 ，為了確保Startup.cs的乾淨和簡單，設定被隱藏在WebHostBuilder的預設設定中，不再是Startup.cs的一部分。

在ASP.NET Core3.1到ASP.NET Core 5.0，程式碼如下所示：

public class Program {     
public static void Main(string[] args)
{
    CreateWebHostBuilder(args).Build().Run();     
}     

public static IHostBuilder CreateHostBuilder(string[] args) => 
    Host.CreateDefaultBuilder(args).
    ConfigureWebHostDefaults(webBuilder =>{ 
        webBuilder.UseStartup(); 
    }
}

在ASP.NET Core 6.0中，為了進一步的簡化，Microsoft引入了最小應用程式程式設計介面（API）方法：去除Startup.cs檔案，把所有的設定放在在Program.cs檔案中，讓我們看看是什麼樣子：

Var builder = WebApplication.CreateBuilder(args); 
// Add services to the container. 
builder.Services.AddControllersWithViews(); 
var app = builder.Build();

上面兩個版本都自帶預設設定，也支援自定義設定。我們可以使用ConfigureAppConfiguration()方法擴充套件了IWebHostBuilder。

下面是ASP.NET Core3.1到ASP.NET Core 5.0中的使用最小API方法時的客製化程式碼：

Host.CreateDefaultBuilder(args).ConfigureWebHostDefaults(webBuilder =>
{         
    webBuilder.ConfigureAppConfiguration((builderContext,config) =>
    {             
        //這裡是設定內容     
    }).UseStartup();     
});

您還可以使用ConfigureAppConfiguration來設定應用程式設定：

builder.WebHost.ConfigureAppConfiguration((builderContext, config) => 
{     
    //這裡是設定內容
});

還有一種更簡單的方法，通過存取builder的Configuration屬性：

builder.Configuration.AddJsonFile("appsettings.json",optional: false,reloadOnChange: true);

當我們建立ASP.NET Core專案，會生成一些預設的組態檔，比如appsettings.json和appsettings.Development.json，大多數ASP.NET Core開發人員會使用預設的組態檔來設定。

以下展示了一段用於讀取appsettings.json的預設程式碼：

var env = builder.Environment; 
builder.Configuration.SetBasePath(env.ContentRootPath); 
builder.Configuration.AddJsonFile("appsettings.json",optional: false,reloadOnChange:true); 
builder.Configuration.AddJsonFile($"appsettings.{env.EnvironmentName}.json",optional:true,reloadOnChange:true); 
builder.Configuration.AddEnvironmentVariables();

該設定通過環境變數設定了應用程式的基本路徑，這裡使用AddEnvironmentVariables()設定方法是一種最佳實踐。另外，設定順序也很重要，後新增的設定將覆蓋之前新增的設定，這裡的環境變數始終做最後的覆蓋。

IConfigurationBuilder有很多擴充套件方法可以新增更多設定，例如XML或INI組態檔和記憶體設定，甚至您也可以在社群了找到的其他設定提供程式，以讀取YAML檔案、資料庫值等。

2.2 使用型別化設定

在嘗試讀取INI檔案之前，有必要了解如何使用型別化設定，而不是通過IConfiguration逐鍵讀取設定。要讀取型別化設定，需要定義待設定的型別。假設我們建立一個名為AppSettings的類，如下所示：

namespace ConfigureSample; 
public class AppSettings {     
    public int Foo { get; set; }     
    public string Bar { get; set; }
}

這是一個簡單的POCO類，然後，我們可以在Startup.cs的ConfigureServices方法內填充這些類。直到ASP。NET Core 5.0：

services.Configure<AppSettings>(Configuration.GetSection("AppSettings"));

使用迷你API（minimal API）方法，設定如下所示：

builder.Services.Configure<AppSettings>(builder.Configuration.GetSection("AppSettings"));

這樣，型別化設定也可以在依賴注入（DI）容器中註冊為服務，並且可以在應用程式中的任何地方使用。您可以為每個設定建立不同的設定型別。在大多數情況下，一個設定足以應對，但有時為了需要會將設定劃分為不同的設定。

下面的程式碼演示瞭如何在MVC控制器中使用型別設定：

using Microsoft.Extensions.Options; 
// ... 
public class HomeController : Controller {     
    private readonly AppSettings _options;     
    public HomeController(IOptions<AppSettings> options)     
    {         
        _options = options.Value;     
    }     
    public IActionResult Index()     
    {         
        ViewData["Message"] = _options.Bar;         
        return View();     
    }
}

IOptions是AppSettings型別的包裝器，Value屬性包含AppSettings類的範例，包括組態檔中的值。

要讀取設定，需要先在appsettings.json檔案中設定AppSettings部分，否則值將為null或未設定。現在，讓我們將該部分新增到appsettings.json檔案，如下所示：

{
    "Logging": { "LogLevel": { "Default": "Warning" }},
    "AllowedHosts": "*", 
    "AppSettings": {"Foo": 123,"Bar": "Bar"} 
}

2.3 使用INI檔案進行設定

要使用INI檔案來設定應用程式，您需要在Program.cs的ConfigureAppConfiguration()方法中新增INI設定，如下所示：

builder.Configuration.AddIniFile("appsettings.ini",optional: false,reloadOnChange: true); 
builder.Configuration.AddJsonFile($"appsettings.{env.EnvironmentName}.ini", optional: true, reloadOnChange: true);

此程式碼以與JSON組態檔載入方式相同。第一行是必需的設定，第二行是可選的設定，具體取決於當前執行時環境。

INI檔案可能如下所示：

[AppSettings] Bar="FooBar"

此檔案包含一個名為AppSettings和一個名為Bar的屬性。

前面我們說過，設定的順序很重要。如果通過JSON檔案進行設定之後再新增兩行有關INI檔案的設定，INI檔案將覆蓋JSON檔案中的設定，Bar屬性值將被FooBar覆蓋。此外，INI檔案中的值將通過之前建立的型別化設定提供。

其他所有設定提供程式都將以相同的機制工作。

2.4 設定提供程式

設定提供程式是IConfigurationProvider的實現，它是由設定源建立的（設定源是IConfigurationSource的實現）。設定提供程式從設定源頭讀取資料，並通過字典對外提供資料。

將自定義或第三方設定提供程式新增到ASP.NET Core中，您需要呼叫ConfigurationBuilder上的Add方法新增設定源：

// add new configuration source 
builder.Configuration.Add(new MyCustomConfigurationSource { 
    SourceConfig = //設定資料來源     
    Optional = false,  
    ReloadOnChange = true 
});

通常，我們會建立一個擴充套件方法來更優雅地新增設定源，如下所示：

builder.Configuration.AddMyCustomSource("source", optional: false, reloadOnChange: true);

2.4 回顧

其實在大多數情況下，我們不需要新增其他設定提供程式或建立自己的設定提供程式，但是為了以防萬一，但最好知道如何客製化它。此外，使用型別化設定是讀取和提供設定的好方法。在經典的ASP.NET中，我們往往使用手動的方式讀取設定，現在，我們只需提供一個型別即可自動完成此操作，因為該型別將通過DI自動範例化。