ConfigurationBuilder Třída

Definice

Obor názvů:

Microsoft.Extensions.Configuration

Sestavení:

Microsoft.Extensions.Configuration.dll

Balíček:

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

Zdroj:

ConfigurationBuilder.cs

Používá se k sestavení nastavení konfigurace založeného na klíči nebo hodnotě 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 naleznete 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 možná dříve použili ke konfiguraci aplikace.

Příklad

Následující fragment kódu ukazuje zjednodušenou aplikaci, která vytvoří objekt ConfigurationBuilder 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!
 */

Tady se zobrazí obsah souboru JSON.

{
  "weather": "stormy"
}

Konstruktory

ConfigurationBuilder()

Inicializuje novou instanci ConfigurationBuilder třídy.

Vlastnosti

Properties	Získá kolekci klíč/hodnota, která se dá použít ke sdílení dat mezi IConfigurationBuilder a registrovanými poskytovateli konfigurace.
Sources	Získá zdroje používané k získání hodnot konfigurace.

Metody

Add(IConfigurationSource)	Přidá nový zdroj konfigurace.
Build()	Vytvoří IConfiguration s klíči a hodnotami ze sady zprostředkovatelů zaregistrovaných v Sources.
Equals(Object)	Určuje, zda je zadaný objekt roven aktuálnímu objektu. (Zděděno od Object)
GetHashCode()	Slouží jako výchozí funkce hash. (Zděděno od Object)
GetType()	Získá Type aktuální instance. (Zděděno od Object)
MemberwiseClone()	Vytvoří mělkou kopii aktuálního Object. (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á IConfigurationProvider, která čte konfigurační hodnoty z příkazového řádku.
AddCommandLine(IConfigurationBuilder, String[])	Přidá CommandLineConfigurationProvider, která čte konfigurační hodnoty z příkazového řádku.
AddCommandLine(IConfigurationBuilder, String[], IDictionary<String,String>)	Přidá CommandLineConfigurationProvider, která čte konfigurační hodnoty 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á IConfigurationProvider, která čte konfigurační hodnoty z proměnných prostředí.
AddEnvironmentVariables(IConfigurationBuilder, Action<EnvironmentVariablesConfigurationSource>)	Přidá IConfigurationProvider, která čte konfigurační hodnoty z proměnných prostředí.
AddEnvironmentVariables(IConfigurationBuilder, String)	Přidá IConfigurationProvider, která čte konfigurační hodnoty z proměnných prostředí se zadanou předponou.
GetFileLoadExceptionHandler(IConfigurationBuilder)	Získá výchozí IFileProvider použít pro zprostředkovatele založené na souborech.
GetFileProvider(IConfigurationBuilder)	Získá výchozí IFileProvider použít pro zprostředkovatele založené na souborech.
SetBasePath(IConfigurationBuilder, String)	Nastaví FileProvider pro zprostředkovatele založené na souborech na PhysicalFileProvider se základní cestou.
SetFileLoadExceptionHandler(IConfigurationBuilder, Action<FileLoadExceptionContext>)	Nastaví výchozí akci, která se má vyvolat u zprostředkovatelů založených na souborech, když dojde k chybě.
SetFileProvider(IConfigurationBuilder, IFileProvider)	Nastaví výchozí IFileProvider, které se použijí pro zprostředkovatele založené na souborech.
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 path do builder.
AddIniFile(IConfigurationBuilder, String, Boolean)	Přidá zprostředkovatele konfigurace INI v path do builder.
AddIniFile(IConfigurationBuilder, String, Boolean, Boolean)	Přidá zprostředkovatele konfigurace INI v path do builder.
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 v path do builder.
AddJsonFile(IConfigurationBuilder, String, Boolean)	Přidá zprostředkovatele konfigurace JSON v path do builder.
AddJsonFile(IConfigurationBuilder, String, Boolean, Boolean)	Přidá zprostředkovatele konfigurace JSON v 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živatele. Vyhledá assembly instanci UserSecretsIdAttribute, která určuje ID tajných kódů uživatele. ID tajných kódů uživatele je jedinečná hodnota použitá 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živatele. Vyhledá assembly instanci UserSecretsIdAttribute, která určuje ID tajných kódů uživatele. ID tajných kódů uživatele je jedinečná hodnota použitá 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živatele. Vyhledá assembly instanci UserSecretsIdAttribute, která určuje ID tajných kódů uživatele. ID tajných kódů uživatele je jedinečná hodnota použitá 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živatele se zadaným ID tajných kódů uživatele. ID tajných kódů uživatele je jedinečná hodnota použitá 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živatele se zadaným ID tajných kódů uživatele. ID tajných kódů uživatele je jedinečná hodnota použitá 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živatele. Vyhledá sestavení obsahující typ T instanci UserSecretsIdAttribute, která určuje ID tajných kódů uživatele. ID tajných kódů uživatele je jedinečná hodnota použitá 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živatele. Vyhledá sestavení obsahující typ T instanci UserSecretsIdAttribute, která určuje ID tajných kódů uživatele. ID tajných kódů uživatele je jedinečná hodnota použitá 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živatele. Vyhledá sestavení obsahující typ T instanci UserSecretsIdAttribute, která určuje ID tajných kódů uživatele. ID tajných kódů uživatele je jedinečná hodnota použitá 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 path do builder.
AddXmlFile(IConfigurationBuilder, String, Boolean)	Přidá zprostředkovatele konfigurace XML v path do builder.
AddXmlFile(IConfigurationBuilder, String, Boolean, Boolean)	Přidá zprostředkovatele konfigurace XML v path do builder.
AddXmlStream(IConfigurationBuilder, Stream)	Přidá zdroj konfigurace XML do builder.

Viz také

• konfigurace v rozhraní .NET