ConfigurationBuilder 類別

定義

命名空間:

Microsoft.Extensions.Configuration

組件:

Microsoft.Extensions.Configuration.dll

套件:

Microsoft.Extensions.Configuration v9.0.0-preview.7.24405.7

來源:

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 檔案中，例如，然後在運行時間擷取它們。 如需詳細資訊，請參閱 組態 - 基本範例。

如果您要將應用程式移轉至 .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"
}

建構函式

ConfigurationBuilder()

初始化 ConfigurationBuilder 類別的新實例。

屬性

Properties	取得索引鍵/值集合，可用來在 IConfigurationBuilder 和已註冊的組態提供者之間共享數據。
Sources	取得用來取得組態值的來源。

方法

Add(IConfigurationSource)	新增組態來源。
Build()	使用在 Sources中註冊之提供者集的索引鍵和值，建置 IConfiguration。
Equals(Object)	判斷指定的物件是否等於目前的物件。 (繼承來源 Object)
GetHashCode()	做為預設哈希函式。 (繼承來源 Object)
GetType()	取得目前實例的 Type。 (繼承來源 Object)
MemberwiseClone()	建立目前 Object的淺層複本。 (繼承來源 Object)
ToString()	傳回表示目前 物件的字串。 (繼承來源 Object)

擴充方法

AddApplicationMetadata(IConfigurationBuilder, IHostEnvironment, String)	註冊應用程式元數據的組態提供者。
AddConfiguration(IConfigurationBuilder, IConfiguration)	將現有的組態新增至 configurationBuilder。
AddConfiguration(IConfigurationBuilder, IConfiguration, Boolean)	將現有的組態新增至 configurationBuilder。
AddCommandLine(IConfigurationBuilder, Action<CommandLineConfigurationSource>)	新增從命令行讀取組態值的 IConfigurationProvider。
AddCommandLine(IConfigurationBuilder, String[])	新增從命令行讀取組態值的 CommandLineConfigurationProvider。
AddCommandLine(IConfigurationBuilder, String[], IDictionary<String,String>)	新增 CommandLineConfigurationProvider，以使用指定的交換器對應，從命令行讀取組態值。
Add<TSource>(IConfigurationBuilder, Action<TSource>)	新增組態來源。
AddEnvironmentVariables(IConfigurationBuilder)	新增從環境變數讀取組態值的 IConfigurationProvider。
AddEnvironmentVariables(IConfigurationBuilder, Action<EnvironmentVariablesConfigurationSource>)	新增從環境變數讀取組態值的 IConfigurationProvider。
AddEnvironmentVariables(IConfigurationBuilder, String)	新增 IConfigurationProvider，從具有指定前置詞的環境變數讀取組態值。
GetFileLoadExceptionHandler(IConfigurationBuilder)	取得要用於檔案型提供者的預設 IFileProvider。
GetFileProvider(IConfigurationBuilder)	取得要用於檔案型提供者的預設 IFileProvider。
SetBasePath(IConfigurationBuilder, String)	將檔案型提供者的 FileProvider 設定為具有基底路徑的 PhysicalFileProvider。
SetFileLoadExceptionHandler(IConfigurationBuilder, Action<FileLoadExceptionContext>)	設定發生錯誤時，要針對檔案型提供者叫用的默認動作。
SetFileProvider(IConfigurationBuilder, IFileProvider)	設定要用於檔案型提供者的預設 IFileProvider。
AddIniFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	將 INI 組態來源新增至 builder。
AddIniFile(IConfigurationBuilder, Action<IniConfigurationSource>)	將 INI 組態來源新增至 builder。
AddIniFile(IConfigurationBuilder, String)	將位於 path 的 INI 組態提供者新增至 builder。
AddIniFile(IConfigurationBuilder, String, Boolean)	將位於 path 的 INI 組態提供者新增至 builder。
AddIniFile(IConfigurationBuilder, String, Boolean, Boolean)	將位於 path 的 INI 組態提供者新增至 builder。
AddIniStream(IConfigurationBuilder, Stream)	將 INI 組態來源新增至 builder。
AddJsonFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	將 JSON 組態來源新增至 builder。
AddJsonFile(IConfigurationBuilder, Action<JsonConfigurationSource>)	將 JSON 組態來源新增至 builder。
AddJsonFile(IConfigurationBuilder, String)	將位於 path 的 JSON 組態提供者新增至 builder。
AddJsonFile(IConfigurationBuilder, String, Boolean)	將位於 path 的 JSON 組態提供者新增至 builder。
AddJsonFile(IConfigurationBuilder, String, Boolean, Boolean)	將位於 path 的 JSON 組態提供者新增至 builder。
AddJsonStream(IConfigurationBuilder, Stream)	將 JSON 組態來源新增至 builder。
AddKeyPerFile(IConfigurationBuilder, Action<KeyPerFileConfigurationSource>)	使用目錄中的檔案新增組態。 檔名會當做索引鍵使用，檔案內容會當做值使用。
AddKeyPerFile(IConfigurationBuilder, String)	使用目錄中的檔案新增組態。 檔名會當做索引鍵使用，檔案內容會當做值使用。
AddKeyPerFile(IConfigurationBuilder, String, Boolean)	使用目錄中的檔案新增組態。 檔名會當做索引鍵使用，檔案內容會當做值使用。
AddKeyPerFile(IConfigurationBuilder, String, Boolean, Boolean)	使用目錄中的檔案新增組態。 檔名會當做索引鍵使用，檔案內容會當做值使用。
AddInMemoryCollection(IConfigurationBuilder)	將記憶體群組態提供者新增至 configurationBuilder。
AddInMemoryCollection(IConfigurationBuilder, IEnumerable<KeyValuePair<String,String>>)	將記憶體群組態提供者新增至 configurationBuilder。
AddUserSecrets(IConfigurationBuilder, Assembly)	新增使用者秘密組態來源。 這會搜尋 assemblyUserSecretsIdAttribute實例，這個實例會指定使用者密碼標識碼。 使用者秘密標識碼是用來儲存和識別秘密組態值集合的唯一值。
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean)	新增使用者秘密組態來源。 這會搜尋 assemblyUserSecretsIdAttribute實例，這個實例會指定使用者密碼標識碼。 使用者秘密標識碼是用來儲存和識別秘密組態值集合的唯一值。
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean, Boolean)	新增使用者秘密組態來源。 這會搜尋 assemblyUserSecretsIdAttribute實例，這個實例會指定使用者密碼標識碼。 使用者秘密標識碼是用來儲存和識別秘密組態值集合的唯一值。
AddUserSecrets(IConfigurationBuilder, String)	新增具有指定使用者密碼識別碼的用戶密碼組態來源。 使用者秘密標識碼是用來儲存和識別秘密組態值集合的唯一值。
AddUserSecrets(IConfigurationBuilder, String, Boolean)	新增具有指定使用者密碼識別碼的用戶密碼組態來源。 使用者秘密標識碼是用來儲存和識別秘密組態值集合的唯一值。
AddUserSecrets<T>(IConfigurationBuilder)	新增使用者秘密組態來源。 搜尋包含類型 T 的元件，以取得 UserSecretsIdAttribute實例，其會指定使用者密碼識別碼。 使用者秘密標識碼是用來儲存和識別秘密組態值集合的唯一值。
AddUserSecrets<T>(IConfigurationBuilder, Boolean)	新增使用者秘密組態來源。 搜尋包含類型 T 的元件，以取得 UserSecretsIdAttribute實例，其會指定使用者密碼識別碼。 使用者秘密標識碼是用來儲存和識別秘密組態值集合的唯一值。
AddUserSecrets<T>(IConfigurationBuilder, Boolean, Boolean)	新增使用者秘密組態來源。 搜尋包含類型 T 的元件，以取得 UserSecretsIdAttribute實例，其會指定使用者密碼識別碼。 使用者秘密標識碼是用來儲存和識別秘密組態值集合的唯一值。
AddXmlFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	將 XML 組態來源新增至 builder。
AddXmlFile(IConfigurationBuilder, Action<XmlConfigurationSource>)	將 XML 組態來源新增至 builder。
AddXmlFile(IConfigurationBuilder, String)	將位於 path 的 XML 組態提供者加入至 builder。
AddXmlFile(IConfigurationBuilder, String, Boolean)	將位於 path 的 XML 組態提供者加入至 builder。
AddXmlFile(IConfigurationBuilder, String, Boolean, Boolean)	將位於 path 的 XML 組態提供者加入至 builder。
AddXmlStream(IConfigurationBuilder, Stream)	將 XML 組態來源新增至 builder。

另請參閱

• .NET 中的 組態