ConfigurationBuilder 類別

定義

命名空間:

Microsoft.Extensions.Configuration

組件:

Microsoft.Extensions.Configuration.dll

套件:

Microsoft.Extensions.Configuration v11.0.0-rc.1.26425.128

來源:

ConfigurationBuilder.cs

建立用於應用程式的鍵值設定。

public ref class ConfigurationBuilder : Microsoft::Extensions::Configuration::IConfigurationBuilder

public class ConfigurationBuilder : Microsoft.Extensions.Configuration.IConfigurationBuilder

type ConfigurationBuilder = class
    interface IConfigurationBuilder

Public Class ConfigurationBuilder
Implements IConfigurationBuilder

繼承

Object

ConfigurationBuilder

實作

IConfigurationBuilder

備註

透過這個類別，你可以將設定值儲存在 JSON 檔案中，然後在執行時取回。 欲了解更多資訊，請參閱 Configuration - 基本範例。

如果你正在將應用程式遷移到 .NET Core 3.1 或更新版本，你可以用這個類別取代你之前用來設定應用程式的 app.config 檔案功能。

範例

以下程式碼片段展示了一個簡化的應用程式，該應用程式在執行時建立 ConfigurationBuilder 物件，從 JSON 檔案擷取字串值。

using Microsoft.Extensions.Configuration;

IConfigurationBuilder builder = new ConfigurationBuilder().AddJsonFile("appsettings.json", false, true);
IConfigurationRoot root = builder.Build();

Console.WriteLine($"Hello, { root["weather"] } world!");

/* This program outputs the following text:
 * 
 * Hello, stormy world!
 */

JSON 檔案的內容如下所示。

{
  "weather": "stormy"
}

建構函式

名稱	Description
ConfigurationBuilder()	初始化 ConfigurationBuilder 類別的新執行個體。

屬性

名稱	Description
Properties	會取得一個鍵值集合，可用於在註冊提供者與註冊IConfigurationBuilder提供者之間IConfigurationProvider共享資料。
Sources	取得用來取得設定值的來源。

方法

名稱	Description
Add(IConfigurationSource)	新增一個新的設定來源。
Build()	從註冊IConfiguration的提供者集合中建立 與 Sources 鍵值。

擴充方法

名稱	Description
Add<TSource>(IConfigurationBuilder, Action<TSource>)	新增一個新的設定來源。
AddApplicationMetadata(IConfigurationBuilder, IHostEnvironment, String)	註冊一個應用程式元資料的設定提供者。
AddCommandLine(IConfigurationBuilder, Action<CommandLineConfigurationSource>)	新增一個 IConfigurationProvider 從命令列讀取設定值的設定值。
AddCommandLine(IConfigurationBuilder, String[], IDictionary<String,String>)	新增一個 CommandLineConfigurationProviderIConfigurationProvider ，利用指定的交換器映射從命令列讀取設定值。
AddCommandLine(IConfigurationBuilder, String[])	新增一個 CommandLineConfigurationProviderIConfigurationProvider 從命令列讀取設定值的 a。
AddConfiguration(IConfigurationBuilder, IConfiguration, Boolean)	將現有配置加入 configurationBuilder。
AddConfiguration(IConfigurationBuilder, IConfiguration)	將現有配置加入 configurationBuilder。
AddEnvironmentVariables(IConfigurationBuilder, Action<EnvironmentVariablesConfigurationSource>)	新增一個 IConfigurationProvider 能從環境變數讀取設定值的設定值。
AddEnvironmentVariables(IConfigurationBuilder, String, Func<String,String>)	新增一個 IConfigurationProvider 能讀取環境變數設定值，並以指定的前綴和變數名稱轉換。
AddEnvironmentVariables(IConfigurationBuilder, String)	新增 IConfigurationProvider 一個能讀取環境變數設定值的指定前綴。
AddEnvironmentVariables(IConfigurationBuilder)	新增一個 IConfigurationProvider 能從環境變數讀取設定值的設定值。
AddIniFile(IConfigurationBuilder, Action<IniConfigurationSource>)	將 INI 配置來源 builder加入 。
AddIniFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	將 INI 配置來源 builder加入 。
AddIniFile(IConfigurationBuilder, String, Boolean, Boolean)	將 INI 配置提供者 加入 pathbuilder。
AddIniFile(IConfigurationBuilder, String, Boolean)	將 INI 配置提供者 加入 pathbuilder。
AddIniFile(IConfigurationBuilder, String)	將 INI 配置提供者 加入 pathbuilder。
AddIniStream(IConfigurationBuilder, Stream)	將 INI 配置來源 builder加入 。
AddInMemoryCollection(IConfigurationBuilder, IEnumerable<KeyValuePair<String,String>>)	將記憶體配置提供者 configurationBuilder加入 。
AddInMemoryCollection(IConfigurationBuilder)	將記憶體配置提供者 configurationBuilder加入 。
AddJsonFile(IConfigurationBuilder, Action<JsonConfigurationSource>)	將 JSON 配置原始碼加入 builder。
AddJsonFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	將 JSON 配置原始碼加入 builder。
AddJsonFile(IConfigurationBuilder, String, Boolean, Boolean)	將 JSON 配置提供者 加入 pathbuilder。
AddJsonFile(IConfigurationBuilder, String, Boolean)	將 JSON 配置提供者 加入 pathbuilder。
AddJsonFile(IConfigurationBuilder, String)	將 JSON 配置提供者 加入 pathbuilder。
AddJsonStream(IConfigurationBuilder, Stream)	將 JSON 配置原始碼加入 builder。
AddKeyPerFile(IConfigurationBuilder, Action<KeyPerFileConfigurationSource>)	透過目錄中的檔案來新增設定。 檔案名稱作為鍵，檔案內容作為值。
AddKeyPerFile(IConfigurationBuilder, String, Boolean, Boolean)	透過目錄中的檔案來新增設定。 檔案名稱作為鍵，檔案內容作為值。
AddKeyPerFile(IConfigurationBuilder, String, Boolean)	透過目錄中的檔案來新增設定。 檔案名稱作為鍵，檔案內容作為值。
AddKeyPerFile(IConfigurationBuilder, String)	透過目錄中的檔案來新增設定。 檔案名稱作為鍵，檔案內容作為值。
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean, Boolean)	新增使用者秘密的設定來源。 此方法搜尋 assembly 的 UserSecretsIdAttribute實例，指定使用者秘密的 ID。 使用者秘密 ID 是用來儲存和識別一組秘密設定值的唯一值。
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean)	新增使用者秘密的設定來源。 此方法搜尋 assembly 的 UserSecretsIdAttribute實例，指定使用者秘密的 ID。 使用者秘密 ID 是用來儲存和識別一組秘密設定值的唯一值。
AddUserSecrets(IConfigurationBuilder, Assembly)	新增使用者秘密的設定來源。 此方法搜尋 assembly 的 UserSecretsIdAttribute實例，指定使用者秘密的 ID。 使用者秘密 ID 是用來儲存和識別一組秘密設定值的唯一值。
AddUserSecrets(IConfigurationBuilder, String, Boolean)	新增使用者秘密設定來源及指定的使用者秘密 ID。 使用者秘密 ID 是用來儲存和識別一組秘密設定值的唯一值。
AddUserSecrets(IConfigurationBuilder, String)	新增使用者秘密設定來源及指定的使用者秘密 ID。 使用者秘密 ID 是用來儲存和識別一組秘密設定值的唯一值。
AddUserSecrets<T>(IConfigurationBuilder, Boolean, Boolean)	新增使用者秘密的設定來源。 搜尋包含型態 T 的組合語言，尋找指定使用者秘密 ID 的實例 UserSecretsIdAttribute。 使用者秘密 ID 是用來儲存和識別一組秘密設定值的唯一值。
AddUserSecrets<T>(IConfigurationBuilder, Boolean)	新增使用者秘密的設定來源。 搜尋包含型態 T 的組合語言，尋找指定使用者秘密 ID 的實例 UserSecretsIdAttribute。 使用者秘密 ID 是用來儲存和識別一組秘密設定值的唯一值。
AddUserSecrets<T>(IConfigurationBuilder)	新增使用者秘密的設定來源。 搜尋包含型態 T 的組合語言，尋找指定使用者秘密 ID 的實例 UserSecretsIdAttribute。 使用者秘密 ID 是用來儲存和識別一組秘密設定值的唯一值。
AddXmlFile(IConfigurationBuilder, Action<XmlConfigurationSource>)	新增 XML 設定來源。builder
AddXmlFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	新增 XML 設定來源。builder
AddXmlFile(IConfigurationBuilder, String, Boolean, Boolean)	將 XML 配置提供者 在 pathbuilder。
AddXmlFile(IConfigurationBuilder, String, Boolean)	將 XML 配置提供者 在 pathbuilder。
AddXmlFile(IConfigurationBuilder, String)	將 XML 配置提供者 在 pathbuilder。
AddXmlStream(IConfigurationBuilder, Stream)	新增 XML 設定來源。builder
GetFileLoadExceptionHandler(IConfigurationBuilder)	當發生錯誤時，會有一個預設動作用於檔案型提供者。
GetFileProvider(IConfigurationBuilder)	預設 IFileProvider 是用於檔案型提供者。
SetBasePath(IConfigurationBuilder, String)	將檔案型提供者的 FileProvider 設定為帶有基礎路徑的 PhysicalFileProvider。
SetFileLoadExceptionHandler(IConfigurationBuilder, Action<FileLoadExceptionContext>)	設定一個預設動作，當檔案型提供者發生錯誤時會被呼叫。
SetFileProvider(IConfigurationBuilder, IFileProvider)	預設 IFileProvider 為用於檔案型提供者。

另請參閱

• .NET 中的設定