ConfigurationBuilder Klasa

Definicja

Przestrzeń nazw:

Microsoft.Extensions.Configuration

Zestaw:

Microsoft.Extensions.Configuration.dll

Pakiet:

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

Źródło:

ConfigurationBuilder.cs

Służy do tworzenia ustawień konfiguracji opartych na kluczu/wartościach do użycia w aplikacji.

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

Dziedziczenie

Object

ConfigurationBuilder

Implementuje

IConfigurationBuilder

Uwagi

Korzystając z tej klasy, można przechowywać wartości konfiguracji w pliku JSON, na przykład, a następnie pobierać je w czasie wykonywania. Aby uzyskać więcej informacji, zobacz Configuration — podstawowy przykład.

Jeśli migrujesz aplikację do platformy .NET Core 3.1 lub nowszej wersji, możesz użyć tej klasy, aby zastąpić funkcję app.config pliku, która była wcześniej używana do konfigurowania aplikacji.

Przykład

Poniższy fragment kodu przedstawia uproszczoną aplikację, która tworzy obiekt ConfigurationBuilder w celu pobrania wartości ciągu z pliku JSON w czasie wykonywania.

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!
 */

Zawartość pliku JSON jest wyświetlana tutaj.

{
  "weather": "stormy"
}

Konstruktory

ConfigurationBuilder()

Inicjuje nowe wystąpienie klasy ConfigurationBuilder.

Właściwości

Properties	Pobiera kolekcję klucz/wartość, która może służyć do udostępniania danych między IConfigurationBuilder a zarejestrowanymi dostawcami konfiguracji.
Sources	Pobiera źródła używane do uzyskiwania wartości konfiguracji.

Metody

Add(IConfigurationSource)	Dodaje nowe źródło konfiguracji.
Build()	Tworzy IConfiguration z kluczami i wartościami z zestawu dostawców zarejestrowanych w Sources.
Equals(Object)	Określa, czy określony obiekt jest równy bieżącemu obiektowi. (Odziedziczone po Object)
GetHashCode()	Służy jako domyślna funkcja skrótu. (Odziedziczone po Object)
GetType()	Pobiera Type bieżącego wystąpienia. (Odziedziczone po Object)
MemberwiseClone()	Tworzy płytkią kopię bieżącego Object. (Odziedziczone po Object)
ToString()	Zwraca ciąg reprezentujący bieżący obiekt. (Odziedziczone po Object)

Metody rozszerzania

AddApplicationMetadata(IConfigurationBuilder, IHostEnvironment, String)	Rejestruje dostawcę konfiguracji dla metadanych aplikacji.
AddConfiguration(IConfigurationBuilder, IConfiguration)	Dodaje istniejącą konfigurację do configurationBuilder.
AddConfiguration(IConfigurationBuilder, IConfiguration, Boolean)	Dodaje istniejącą konfigurację do configurationBuilder.
AddCommandLine(IConfigurationBuilder, Action<CommandLineConfigurationSource>)	Dodaje IConfigurationProvider, który odczytuje wartości konfiguracji z wiersza polecenia.
AddCommandLine(IConfigurationBuilder, String[])	Dodaje CommandLineConfigurationProvider, który odczytuje wartości konfiguracji z wiersza polecenia.
AddCommandLine(IConfigurationBuilder, String[], IDictionary<String,String>)	Dodaje CommandLineConfigurationProvider, który odczytuje wartości konfiguracji z wiersza polecenia przy użyciu określonych mapowań przełącznika.
Add<TSource>(IConfigurationBuilder, Action<TSource>)	Dodaje nowe źródło konfiguracji.
AddEnvironmentVariables(IConfigurationBuilder)	Dodaje IConfigurationProvider, który odczytuje wartości konfiguracji ze zmiennych środowiskowych.
AddEnvironmentVariables(IConfigurationBuilder, Action<EnvironmentVariablesConfigurationSource>)	Dodaje IConfigurationProvider, który odczytuje wartości konfiguracji ze zmiennych środowiskowych.
AddEnvironmentVariables(IConfigurationBuilder, String)	Dodaje IConfigurationProvider, który odczytuje wartości konfiguracji ze zmiennych środowiskowych z określonym prefiksem.
GetFileLoadExceptionHandler(IConfigurationBuilder)	Pobiera domyślne IFileProvider, które mają być używane dla dostawców opartych na plikach.
GetFileProvider(IConfigurationBuilder)	Pobiera domyślne IFileProvider, które mają być używane dla dostawców opartych na plikach.
SetBasePath(IConfigurationBuilder, String)	Ustawia element FileProvider dla dostawców opartych na plikach na wartość PhysicalFileProvider ze ścieżką podstawową.
SetFileLoadExceptionHandler(IConfigurationBuilder, Action<FileLoadExceptionContext>)	Ustawia domyślną akcję, która ma być wywoływana dla dostawców opartych na plikach w przypadku wystąpienia błędu.
SetFileProvider(IConfigurationBuilder, IFileProvider)	Ustawia domyślne IFileProvider, które mają być używane dla dostawców opartych na plikach.
AddIniFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Dodaje źródło konfiguracji INI do builder.
AddIniFile(IConfigurationBuilder, Action<IniConfigurationSource>)	Dodaje źródło konfiguracji INI do builder.
AddIniFile(IConfigurationBuilder, String)	Dodaje dostawcę konfiguracji INI w path do builder.
AddIniFile(IConfigurationBuilder, String, Boolean)	Dodaje dostawcę konfiguracji INI w path do builder.
AddIniFile(IConfigurationBuilder, String, Boolean, Boolean)	Dodaje dostawcę konfiguracji INI w path do builder.
AddIniStream(IConfigurationBuilder, Stream)	Dodaje źródło konfiguracji INI do builder.
AddJsonFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Dodaje źródło konfiguracji JSON do builder.
AddJsonFile(IConfigurationBuilder, Action<JsonConfigurationSource>)	Dodaje źródło konfiguracji JSON do builder.
AddJsonFile(IConfigurationBuilder, String)	Dodaje dostawcę konfiguracji JSON w path do builder.
AddJsonFile(IConfigurationBuilder, String, Boolean)	Dodaje dostawcę konfiguracji JSON w path do builder.
AddJsonFile(IConfigurationBuilder, String, Boolean, Boolean)	Dodaje dostawcę konfiguracji JSON w path do builder.
AddJsonStream(IConfigurationBuilder, Stream)	Dodaje źródło konfiguracji JSON do builder.
AddKeyPerFile(IConfigurationBuilder, Action<KeyPerFileConfigurationSource>)	Dodaje konfigurację przy użyciu plików z katalogu. Nazwy plików są używane jako klucz, zawartość pliku jest używana jako wartość.
AddKeyPerFile(IConfigurationBuilder, String)	Dodaje konfigurację przy użyciu plików z katalogu. Nazwy plików są używane jako klucz, zawartość pliku jest używana jako wartość.
AddKeyPerFile(IConfigurationBuilder, String, Boolean)	Dodaje konfigurację przy użyciu plików z katalogu. Nazwy plików są używane jako klucz, zawartość pliku jest używana jako wartość.
AddKeyPerFile(IConfigurationBuilder, String, Boolean, Boolean)	Dodaje konfigurację przy użyciu plików z katalogu. Nazwy plików są używane jako klucz, zawartość pliku jest używana jako wartość.
AddInMemoryCollection(IConfigurationBuilder)	Dodaje dostawcę konfiguracji pamięci do configurationBuilder.
AddInMemoryCollection(IConfigurationBuilder, IEnumerable<KeyValuePair<String,String>>)	Dodaje dostawcę konfiguracji pamięci do configurationBuilder.
AddUserSecrets(IConfigurationBuilder, Assembly)	Dodaje źródło konfiguracji wpisów tajnych użytkownika. To wyszukiwanie assembly dla wystąpienia UserSecretsIdAttribute, które określa identyfikator wpisów tajnych użytkownika. Identyfikator wpisów tajnych użytkownika jest unikatową wartością używaną do przechowywania i identyfikowania kolekcji wartości konfiguracji wpisu tajnego.
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean)	Dodaje źródło konfiguracji wpisów tajnych użytkownika. To wyszukiwanie assembly dla wystąpienia UserSecretsIdAttribute, które określa identyfikator wpisów tajnych użytkownika. Identyfikator wpisów tajnych użytkownika jest unikatową wartością używaną do przechowywania i identyfikowania kolekcji wartości konfiguracji wpisu tajnego.
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean, Boolean)	Dodaje źródło konfiguracji wpisów tajnych użytkownika. To wyszukiwanie assembly dla wystąpienia UserSecretsIdAttribute, które określa identyfikator wpisów tajnych użytkownika. Identyfikator wpisów tajnych użytkownika jest unikatową wartością używaną do przechowywania i identyfikowania kolekcji wartości konfiguracji wpisu tajnego.
AddUserSecrets(IConfigurationBuilder, String)	Dodaje źródło konfiguracji wpisów tajnych użytkownika z określonym identyfikatorem wpisów tajnych użytkownika. Identyfikator wpisów tajnych użytkownika jest unikatową wartością używaną do przechowywania i identyfikowania kolekcji wartości konfiguracji wpisu tajnego.
AddUserSecrets(IConfigurationBuilder, String, Boolean)	Dodaje źródło konfiguracji wpisów tajnych użytkownika z określonym identyfikatorem wpisów tajnych użytkownika. Identyfikator wpisów tajnych użytkownika jest unikatową wartością używaną do przechowywania i identyfikowania kolekcji wartości konfiguracji wpisu tajnego.
AddUserSecrets<T>(IConfigurationBuilder)	Dodaje źródło konfiguracji wpisów tajnych użytkownika. Wyszukuje zestaw zawierający typ T dla wystąpienia UserSecretsIdAttribute, który określa identyfikator wpisów tajnych użytkownika. Identyfikator wpisów tajnych użytkownika jest unikatową wartością używaną do przechowywania i identyfikowania kolekcji wartości konfiguracji wpisu tajnego.
AddUserSecrets<T>(IConfigurationBuilder, Boolean)	Dodaje źródło konfiguracji wpisów tajnych użytkownika. Wyszukuje zestaw zawierający typ T dla wystąpienia UserSecretsIdAttribute, który określa identyfikator wpisów tajnych użytkownika. Identyfikator wpisów tajnych użytkownika jest unikatową wartością używaną do przechowywania i identyfikowania kolekcji wartości konfiguracji wpisu tajnego.
AddUserSecrets<T>(IConfigurationBuilder, Boolean, Boolean)	Dodaje źródło konfiguracji wpisów tajnych użytkownika. Wyszukuje zestaw zawierający typ T dla wystąpienia UserSecretsIdAttribute, który określa identyfikator wpisów tajnych użytkownika. Identyfikator wpisów tajnych użytkownika jest unikatową wartością używaną do przechowywania i identyfikowania kolekcji wartości konfiguracji wpisu tajnego.
AddXmlFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Dodaje źródło konfiguracji XML do builder.
AddXmlFile(IConfigurationBuilder, Action<XmlConfigurationSource>)	Dodaje źródło konfiguracji XML do builder.
AddXmlFile(IConfigurationBuilder, String)	Dodaje dostawcę konfiguracji XML pod adresem path do builder.
AddXmlFile(IConfigurationBuilder, String, Boolean)	Dodaje dostawcę konfiguracji XML pod adresem path do builder.
AddXmlFile(IConfigurationBuilder, String, Boolean, Boolean)	Dodaje dostawcę konfiguracji XML pod adresem path do builder.
AddXmlStream(IConfigurationBuilder, Stream)	Dodaje źródło konfiguracji XML do builder.

Zobacz też

• konfiguracja na platformie .NET