- 配置規則
- 命令列配置提供程式
- 環境變數配置提供程式
- 檔案配置提供程式
- 配置的讀取
- 自定義配置資料源
ASP.NET Core中的配置項可以通過命令列、環境變數、json/xml/ini組態檔來提供，
Web應用在生成主機時會呼叫CreateDefaultBuilder方法，這個方法按照下面的順序添加各種配置提供程式：
- 檔案配置提供程式，用于加載appsetting.json
- 檔案配置提供程式，用于加載appsetting.{Environment}.json
- 環境變數配置提供程式
- 命令列配置提供程式
對于同一配置，后面加載的配置提供程式會覆寫前面加載的內容，所以配置的默認優先級從低到高依次為：檔案 -> 環境變數 -> 命令列，
配置規則
分層配置資料
配置 API 能夠通過在配置鍵中使用分隔符來展平分層資料以保持分層配置資料，
比如，這樣的json檔案：
{
"section0": {
"key0": "value",
"key1": "value"
},
"section1": {
"key0": "value",
"key1": "value"
}
}
配置提供程式加載時，將使用冒號 (?? 展平節和鍵，以這樣的方式創建唯一鍵以保持配置源的原始分層資料結構，
section0:key0
section0:key1
section1:key0
section1:key1
關于鍵和值的約定
配置鍵采用以下約定：
- 不區分大小寫；
- 如果由相同或不同的配置提供程式設定相同鍵的值，則鍵上設定的最后一個值就是所使用的值；
- 分層鍵默認使用冒號分隔符，但在環境變數中，冒號分隔符可能無法適用于所有平臺，可以用雙下劃線代替，
配置值的約定：
- 值是字串；
- NULL值不能存盤在配置中或系結到物件，
命令列配置提供程式
可以通過ConfigureHostConfiguration和ConfigureAppConfiguration方法來指定配置提供程式或者設定提供程式的優先級，
如果不需要CreateDefaultBuilder默認添加的配置提供提供程式，可以直接洗掉
.ConfigureAppConfiguration((hostingContext, config) =>
{
config.Sources.Clear();
})
在ConfigurationBuilder 的實體上呼叫 AddCommandLine 擴展方法可以激活命令列配置，不過CreateDefaultBuilder已經自動呼叫了AddCommandLine，并且命令列配置的優先級最高，若要添加其他配置提供程式并保持能夠用命令列引數替代這些提供程式的配置，可以在ConfigureAppConfiguration中添加完其他提供程式后，再呼叫一次AddCommandLine，
.ConfigureAppConfiguration((hostingContext, config) =>
{
// Call other providers here
config.AddCommandLine(args);
})
命令列配置的設定方式為：
dotnet run CommandLineKey=CommandLineValue
這種設定方法使用了等號（=），也可以用--或/作為前綴，并空格代替等號，下面的寫法都是合理的：
dotnet run --CommandLineKey2=value2
dotnet run --CommandLineKey2 value2
dotnet run /CommandLineKey3=value3
dotnet run /CommandLineKey3 value3
環境變數配置提供程式
在ConfigurationBuilder 的實體上呼叫 AddEnvironmentVariables 擴展方法可以激活環境變數配置，CreateDefaultBuilder也已經默認啟用了環境變數配置提供程式，
AddEnvironmentVariables方法還有一個多載支持加載指定前綴的環境變數，
比如
.AddEnvironmentVariables("CUSTOM_")
會只加載前綴為CUSTOM_的環境變數，
環境變數的設定方法：
- 命令列，set CUSTOM_ENV1=value1，但這種設定只在當前命令列視窗生效
- 設定全域系統變數；
- 通過visual studio，在launchSettings.json檔案中設定，
檔案配置提供程式
以Json檔案為例（INI、XML檔案類似）：
.ConfigureAppConfiguration((hostingContext, config) =>
{
config.AddJsonFile("MyConfig.json",
optional: true,
reloadOnChange: true);
.AddJsonFile($"MyConfig.{env.EnvironmentName}.json",
optional: true,
reloadOnChange: true);
})
以這種順序添加，后面MyConfig.{env.EnvironmentName}.json中的配置會覆寫MyConfig.json中的同名配置，
配置的讀取
GetValue
從配置中提取一個具有指定鍵的值，并將它轉換為指定的型別
var number = Configuration.GetValue<int>("NumberKey", 99);
GetSection
會回傳具有指定子節鍵的配置子節
section1 = configuration.GetSection("section1");
對于GetSection的結果，可以使用GetValue
使用Get可以直接把配置內容系結到類
var starship = _config.GetSection("starship").Get<Starship>();
{
"starship": {
"name": "USS Enterprise",
"registry": "NCC-1701",
"class": "Constitution",
"length": 304.8,
"commissioned": false,
"Array": [ "12", "23", "d3" ],
"ShipLog": {
"ID": "1"
}
}
...
}
public class Starship
{
public string Name { get; set; }
public string Registry { get; set; }
public string Class { get; set; }
public decimal Length { get; set; }
public bool Commissioned { get; set; }
public ShipLog ShipLog { get; set; }
public string[] Array { get; set; }
}
public class ShipLog
{
public string ID { get; set; }
}
自定義配置資料源
除了上述配置提供程式，還可以自定義配置資料源，比如可以統一從配置中心獲取配置，
要自定義配置源，需要實作IConfigurationSource和IConfigurationProvider，
實作IConfigurationSource：
class MyConfigurationSource : IConfigurationSource
{
public IConfigurationProvider Build(IConfigurationBuilder builder)
{
return new MyConfigurationProvider();
}
}
實作IConfigurationProvider，具體方式可以通過繼承ConfigurationProvider，然后重寫它的虛方法，下面的示例重寫了Load方法，在這里可以自行編碼獲取配置、設定到this.Data，Data是一個鍵和值型別都是string的字典，用于存盤配置，還用了一個定時器來模擬配置的變更，在發生配置變更時，觸發base.OnReload();
class MyConfigurationProvider : ConfigurationProvider
{
Timer timer;
public MyConfigurationProvider() : base()
{
timer = new Timer();
timer.Elapsed += (a, b) => Load(true);
timer.Interval = 3000;
timer.Start();
}
public override void Load()
{
//加載資料
Load(false);
}
void Load(bool reload)
{
this.Data["lastTime"] = DateTime.Now.ToString();
if (reload)
{
base.OnReload();
}
}
}
使用的時候：builder.Add(new MyConfigurationSource());
但這種方法會暴露具體的實作，可以封裝為擴展方法，如果把這個擴展類的命名空間指定為Microsoft.Extensions.Configuration，這樣在分發到第三方后，就可以直接使用，而不必using程式集的命名空間，而前面的實作類默認為internal，第三方無法訪問到，實作了整個類別庫只暴露出一個擴展方法的效果，
namespace Microsoft.Extensions.Configuration
{
public static class MyConfigurationBuilderExtensions
{
public static IConfigurationBuilder AddMyConfiguration(this IConfigurationBuilder builder)
{
builder.Add(new MyConfigurationSource());
return builder;
}
}
}
監聽配置變更的方法：
builder.AddMyConfiguration();
var configRoot = builder.Build();
ChangeToken.OnChange(() => configRoot.GetReloadToken(), () =>
{
//監聽到配置變更后的處理代碼
});
轉載請註明出處，本文鏈接：https://www.uj5u.com/net/50989.html
標籤：.NET Core