ConfigurationBuilder Klasa

Definicja

Przestrzeń nazw:: Microsoft.Extensions.Configuration

Zestaw:: Microsoft.Extensions.Configuration.dll

Pakiet:: Microsoft.Extensions.Configuration v11.0.0-preview.4.26230.115

Źródło:: ConfigurationBuilder.cs

Źródło:: ConfigurationBuilder.cs

Źródło:: ConfigurationBuilder.cs

Źródło:: ConfigurationBuilder.cs

Ważne

Niektóre informacje odnoszą się do produktu w wersji wstępnej, który może zostać znacząco zmodyfikowany przed wydaniem. Firma Microsoft nie udziela żadnych gwarancji, jawnych lub domniemanych, w odniesieniu do informacji podanych w tym miejscu.

Tworzy ustawienia konfiguracji oparte na kluczach/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 Konfiguracja — podstawowy przykład.

Jeśli migrujesz aplikację do .NET Core 3.1 lub nowszej wersji, możesz użyć tej klasy, aby zastąpić app.config funkcjonalność pliku, która mogła zostać wcześniej użyta do skonfigurowania aplikacji.

Example

Poniższy fragment kodu przedstawia uproszczoną aplikację, która tworzy ConfigurationBuilder obiekt 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

Nazwa	Opis
ConfigurationBuilder()	Inicjuje nowe wystąpienie klasy ConfigurationBuilder.

Właściwości

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

Metody

Nazwa	Opis
Add(IConfigurationSource)	Dodaje nowe źródło konfiguracji.
Build()	Tworzy element IConfiguration z kluczami i wartościami z zestawu dostawców zarejestrowanych w programie Sources.

Metody rozszerzania

Nazwa	Opis
Add<TSource>(IConfigurationBuilder, Action<TSource>)	Dodaje nowe źródło konfiguracji.
AddApplicationMetadata(IConfigurationBuilder, IHostEnvironment, String)	Rejestruje dostawcę konfiguracji dla metadanych aplikacji.
AddCommandLine(IConfigurationBuilder, Action<CommandLineConfigurationSource>)	Dodaje element IConfigurationProvider , który odczytuje wartości konfiguracji z wiersza polecenia.
AddCommandLine(IConfigurationBuilder, String[], IDictionary<String,String>)	Dodaje element CommandLineConfigurationProvider IConfigurationProvider , który odczytuje wartości konfiguracji z wiersza polecenia przy użyciu określonych mapowań przełącznika.
AddCommandLine(IConfigurationBuilder, String[])	Dodaje element CommandLineConfigurationProvider IConfigurationProvider , który odczytuje wartości konfiguracji z wiersza polecenia.
AddConfiguration(IConfigurationBuilder, IConfiguration, Boolean)	Dodaje istniejącą konfigurację do `configurationBuilder`elementu .
AddConfiguration(IConfigurationBuilder, IConfiguration)	Dodaje istniejącą konfigurację do `configurationBuilder`elementu .
AddEnvironmentVariables(IConfigurationBuilder, Action<EnvironmentVariablesConfigurationSource>)	Dodaje element IConfigurationProvider , który odczytuje wartości konfiguracji ze zmiennych środowiskowych.
AddEnvironmentVariables(IConfigurationBuilder, String)	Dodaje element IConfigurationProvider , który odczytuje wartości konfiguracji ze zmiennych środowiskowych z określonym prefiksem.
AddEnvironmentVariables(IConfigurationBuilder)	Dodaje element IConfigurationProvider , który odczytuje wartości konfiguracji ze zmiennych środowiskowych.
AddIniFile(IConfigurationBuilder, Action<IniConfigurationSource>)	Dodaje źródło konfiguracji INI do elementu `builder`.
AddIniFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Dodaje źródło konfiguracji INI do elementu `builder`.
AddIniFile(IConfigurationBuilder, String, Boolean, Boolean)	Dodaje dostawcę konfiguracji INI pod adresem `path` do .`builder`
AddIniFile(IConfigurationBuilder, String, Boolean)	Dodaje dostawcę konfiguracji INI pod adresem `path` do .`builder`
AddIniFile(IConfigurationBuilder, String)	Dodaje dostawcę konfiguracji INI pod adresem `path` do .`builder`
AddIniStream(IConfigurationBuilder, Stream)	Dodaje źródło konfiguracji INI do elementu `builder`.
AddInMemoryCollection(IConfigurationBuilder, IEnumerable<KeyValuePair<String,String>>)	Dodaje dostawcę konfiguracji pamięci do programu `configurationBuilder`.
AddInMemoryCollection(IConfigurationBuilder)	Dodaje dostawcę konfiguracji pamięci do programu `configurationBuilder`.
AddJsonFile(IConfigurationBuilder, Action<JsonConfigurationSource>)	Dodaje źródło konfiguracji JSON do elementu `builder`.
AddJsonFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Dodaje źródło konfiguracji JSON do elementu `builder`.
AddJsonFile(IConfigurationBuilder, String, Boolean, Boolean)	Dodaje dostawcę konfiguracji JSON pod adresem `path` do .`builder`
AddJsonFile(IConfigurationBuilder, String, Boolean)	Dodaje dostawcę konfiguracji JSON pod adresem `path` do .`builder`
AddJsonFile(IConfigurationBuilder, String)	Dodaje dostawcę konfiguracji JSON pod adresem `path` do .`builder`
AddJsonStream(IConfigurationBuilder, Stream)	Dodaje źródło konfiguracji JSON do elementu `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, 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ść.
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)	Dodaje konfigurację przy użyciu plików z katalogu. Nazwy plików są używane jako klucz, zawartość pliku jest używana jako wartość.
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean, Boolean)	Dodaje źródło konfiguracji wpisów tajnych użytkownika. Spowoduje to wyszukanie `assembly` wystąpienia UserSecretsIdAttributeklasy , 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. Spowoduje to wyszukanie `assembly` wystąpienia UserSecretsIdAttributeklasy , 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)	Dodaje źródło konfiguracji wpisów tajnych użytkownika. Spowoduje to wyszukanie `assembly` wystąpienia UserSecretsIdAttributeklasy , 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, 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(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<T>(IConfigurationBuilder, Boolean, Boolean)	Dodaje źródło konfiguracji wpisów tajnych użytkownika. Wyszukuje zestaw zawierający typ `T` 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` 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)	Dodaje źródło konfiguracji wpisów tajnych użytkownika. Wyszukuje zestaw zawierający typ `T` 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, Action<XmlConfigurationSource>)	Dodaje źródło konfiguracji XML do elementu `builder`.
AddXmlFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Dodaje źródło konfiguracji XML do elementu `builder`.
AddXmlFile(IConfigurationBuilder, String, Boolean, Boolean)	Dodaje dostawcę konfiguracji XML pod adresem `path` .`builder`
AddXmlFile(IConfigurationBuilder, String, Boolean)	Dodaje dostawcę konfiguracji XML pod adresem `path` .`builder`
AddXmlFile(IConfigurationBuilder, String)	Dodaje dostawcę konfiguracji XML pod adresem `path` .`builder`
AddXmlStream(IConfigurationBuilder, Stream)	Dodaje źródło konfiguracji XML do elementu `builder`.
GetFileLoadExceptionHandler(IConfigurationBuilder)	Pobiera domyślną akcję, która ma być wywoływana dla dostawców opartych na plikach w przypadku wystąpienia błędu.
GetFileProvider(IConfigurationBuilder)	Pobiera wartość domyślną IFileProvider , która ma być używana 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 wartość domyślną IFileProvider , która ma być używana dla dostawców opartych na plikach.

Dotyczy

Zobacz też

Konfiguracja na platformie .NET

Opinia

Czy ta strona była pomocna?