ConfigurationBuilder Třída

Definice

Obor názvů:

Microsoft.Extensions.Configuration

Sestavení:

Microsoft.Extensions.Configuration.dll

Balíček:

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

Zdroj:

ConfigurationBuilder.cs

Používá se k sestavení nastavení konfigurace na základě klíče a hodnoty pro použití v aplikaci.

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

Dědičnost

Object

ConfigurationBuilder

Implementuje

IConfigurationBuilder

Poznámky

Pomocí této třídy můžete například uložit konfigurační hodnoty do souboru JSON a pak je načíst za běhu. Další informace najdete v tématu Konfigurace – základní příklad.

Pokud migrujete aplikaci na .NET Core 3.1 nebo novější verzi, můžete tuto třídu použít k nahrazení funkcí app.config souborů, které jste mohli dříve použít ke konfiguraci aplikace.

Příklad

Následující fragment kódu ukazuje zjednodušenou aplikaci, která vytvoří ConfigurationBuilder objekt pro načtení řetězcové hodnoty ze souboru JSON za běhu.

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

Obsah souboru JSON se zobrazí tady.

{
  "weather": "stormy"
}

Konstruktory

ConfigurationBuilder()

Inicializuje novou instanci ConfigurationBuilder třídy .

Vlastnosti

Properties	Získá kolekci klíč/hodnota, kterou lze použít ke sdílení dat mezi IConfigurationBuilder a registrovanými zprostředkovateli konfigurace.
Sources	Získá zdroje použité k získání konfiguračních hodnot.

Metody

Add(IConfigurationSource)	Přidá nový zdroj konfigurace.
Build()	Vytvoří objekt s klíči IConfiguration a hodnotami ze sady zprostředkovatelů zaregistrovaných v Sources.
Equals(Object)	Určí, zda se zadaný objekt rovná aktuálnímu objektu. (Zděděno od Object)
GetHashCode()	Slouží jako výchozí hashovací funkce. (Zděděno od Object)
GetType()	Type Získá z aktuální instance. (Zděděno od Object)
MemberwiseClone()	Vytvoří mělkou kopii aktuálního Objectsouboru . (Zděděno od Object)
ToString()	Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object)

Metody rozšíření

AddApplicationMetadata(IConfigurationBuilder, IHostEnvironment, String)	Zaregistruje zprostředkovatele konfigurace pro metadata aplikace.
AddConfiguration(IConfigurationBuilder, IConfiguration)	Přidá existující konfiguraci do configurationBuilder.
AddConfiguration(IConfigurationBuilder, IConfiguration, Boolean)	Přidá existující konfiguraci do configurationBuilder.
AddCommandLine(IConfigurationBuilder, Action<CommandLineConfigurationSource>)	Přidá objekt IConfigurationProvider , který čte konfigurační hodnoty z příkazového řádku.
AddCommandLine(IConfigurationBuilder, String[])	Přidá parametr , CommandLineConfigurationProvider který čte konfigurační hodnoty z příkazového řádku.
AddCommandLine(IConfigurationBuilder, String[], IDictionary<String,String>)	Přidá parametr CommandLineConfigurationProvider , který čte hodnoty konfigurace z příkazového řádku pomocí zadaných mapování přepínačů.
Add<TSource>(IConfigurationBuilder, Action<TSource>)	Přidá nový zdroj konfigurace.
AddEnvironmentVariables(IConfigurationBuilder)	Přidá objekt IConfigurationProvider , který čte hodnoty konfigurace z proměnných prostředí.
AddEnvironmentVariables(IConfigurationBuilder, Action<EnvironmentVariablesConfigurationSource>)	Přidá objekt IConfigurationProvider , který čte hodnoty konfigurace z proměnných prostředí.
AddEnvironmentVariables(IConfigurationBuilder, String)	Přidá objekt IConfigurationProvider , který čte konfigurační hodnoty z proměnných prostředí se zadanou předponou.
GetFileLoadExceptionHandler(IConfigurationBuilder)	Získá výchozí IFileProvider pro souborové zprostředkovatele.
GetFileProvider(IConfigurationBuilder)	Získá výchozí IFileProvider pro souborové zprostředkovatele.
SetBasePath(IConfigurationBuilder, String)	Nastaví FileProvider pro souborové zprostředkovatele physicalFileProvider se základní cestou.
SetFileLoadExceptionHandler(IConfigurationBuilder, Action<FileLoadExceptionContext>)	Nastaví výchozí akci, která se má vyvolat u souborových zprostředkovatelů, když dojde k chybě.
SetFileProvider(IConfigurationBuilder, IFileProvider)	Nastaví výchozí IFileProvider nastavení pro souborové zprostředkovatele.
AddIniFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Přidá zdroj konfigurace INI do builder.
AddIniFile(IConfigurationBuilder, Action<IniConfigurationSource>)	Přidá zdroj konfigurace INI do builder.
AddIniFile(IConfigurationBuilder, String)	Přidá zprostředkovatele konfigurace INI v do pathbuilder.
AddIniFile(IConfigurationBuilder, String, Boolean)	Přidá zprostředkovatele konfigurace INI v do pathbuilder.
AddIniFile(IConfigurationBuilder, String, Boolean, Boolean)	Přidá zprostředkovatele konfigurace INI v do pathbuilder.
AddIniStream(IConfigurationBuilder, Stream)	Přidá zdroj konfigurace INI do builder.
AddJsonFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Přidá zdroj konfigurace JSON do builder.
AddJsonFile(IConfigurationBuilder, Action<JsonConfigurationSource>)	Přidá zdroj konfigurace JSON do builder.
AddJsonFile(IConfigurationBuilder, String)	Přidá zprostředkovatele konfigurace JSON na adrese path do builder.
AddJsonFile(IConfigurationBuilder, String, Boolean)	Přidá zprostředkovatele konfigurace JSON na adrese path do builder.
AddJsonFile(IConfigurationBuilder, String, Boolean, Boolean)	Přidá zprostředkovatele konfigurace JSON na adrese path do builder.
AddJsonStream(IConfigurationBuilder, Stream)	Přidá zdroj konfigurace JSON do builder.
AddKeyPerFile(IConfigurationBuilder, Action<KeyPerFileConfigurationSource>)	Přidá konfiguraci pomocí souborů z adresáře. Názvy souborů se používají jako klíč, obsah souboru se používá jako hodnota.
AddKeyPerFile(IConfigurationBuilder, String)	Přidá konfiguraci pomocí souborů z adresáře. Názvy souborů se používají jako klíč, obsah souboru se používá jako hodnota.
AddKeyPerFile(IConfigurationBuilder, String, Boolean)	Přidá konfiguraci pomocí souborů z adresáře. Názvy souborů se používají jako klíč, obsah souboru se používá jako hodnota.
AddKeyPerFile(IConfigurationBuilder, String, Boolean, Boolean)	Přidá konfiguraci pomocí souborů z adresáře. Názvy souborů se používají jako klíč, obsah souboru se používá jako hodnota.
AddInMemoryCollection(IConfigurationBuilder)	Přidá zprostředkovatele konfigurace paměti do configurationBuilder.
AddInMemoryCollection(IConfigurationBuilder, IEnumerable<KeyValuePair<String,String>>)	Přidá zprostředkovatele konfigurace paměti do configurationBuilder.
AddUserSecrets(IConfigurationBuilder, Assembly)	Přidá zdroj konfigurace tajných kódů uživatelů. assembly Vyhledá instanci , která určuje ID tajných UserSecretsIdAttributekódů uživatelů. ID tajných kódů uživatele je jedinečná hodnota, která slouží k ukládání a identifikaci kolekce hodnot konfigurace tajných kódů.
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean)	Přidá zdroj konfigurace tajných kódů uživatelů. assembly Vyhledá instanci , která určuje ID tajných UserSecretsIdAttributekódů uživatelů. ID tajných kódů uživatele je jedinečná hodnota, která slouží k ukládání a identifikaci kolekce hodnot konfigurace tajných kódů.
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean, Boolean)	Přidá zdroj konfigurace tajných kódů uživatelů. assembly Vyhledá instanci , která určuje ID tajných UserSecretsIdAttributekódů uživatelů. ID tajných kódů uživatele je jedinečná hodnota, která slouží k ukládání a identifikaci kolekce hodnot konfigurace tajných kódů.
AddUserSecrets(IConfigurationBuilder, String)	Přidá zdroj konfigurace tajných kódů uživatelů se zadaným ID tajných kódů uživatelů. ID tajných kódů uživatele je jedinečná hodnota, která slouží k ukládání a identifikaci kolekce hodnot konfigurace tajných kódů.
AddUserSecrets(IConfigurationBuilder, String, Boolean)	Přidá zdroj konfigurace tajných kódů uživatelů se zadaným ID tajných kódů uživatelů. ID tajných kódů uživatele je jedinečná hodnota, která slouží k ukládání a identifikaci kolekce hodnot konfigurace tajných kódů.
AddUserSecrets<T>(IConfigurationBuilder)	Přidá zdroj konfigurace tajných kódů uživatelů. Vyhledá v sestavení obsahujícím typ T instance , která určuje ID tajných UserSecretsIdAttributekódů uživatelů. ID tajných kódů uživatele je jedinečná hodnota, která slouží k ukládání a identifikaci kolekce hodnot konfigurace tajných kódů.
AddUserSecrets<T>(IConfigurationBuilder, Boolean)	Přidá zdroj konfigurace tajných kódů uživatelů. Vyhledá v sestavení obsahujícím typ T instance , která určuje ID tajných UserSecretsIdAttributekódů uživatelů. ID tajných kódů uživatele je jedinečná hodnota, která slouží k ukládání a identifikaci kolekce hodnot konfigurace tajných kódů.
AddUserSecrets<T>(IConfigurationBuilder, Boolean, Boolean)	Přidá zdroj konfigurace tajných kódů uživatelů. Vyhledá v sestavení obsahujícím typ T instance , která určuje ID tajných UserSecretsIdAttributekódů uživatelů. ID tajných kódů uživatele je jedinečná hodnota, která slouží k ukládání a identifikaci kolekce hodnot konfigurace tajných kódů.
AddXmlFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Přidá zdroj konfigurace XML do builder.
AddXmlFile(IConfigurationBuilder, Action<XmlConfigurationSource>)	Přidá zdroj konfigurace XML do builder.
AddXmlFile(IConfigurationBuilder, String)	Přidá zprostředkovatele konfigurace XML v do pathbuilder.
AddXmlFile(IConfigurationBuilder, String, Boolean)	Přidá zprostředkovatele konfigurace XML v do pathbuilder.
AddXmlFile(IConfigurationBuilder, String, Boolean, Boolean)	Přidá zprostředkovatele konfigurace XML v do pathbuilder.
AddXmlStream(IConfigurationBuilder, Stream)	Přidá zdroj konfigurace XML do builder.

Viz také

• Konfigurace v .NET