ConfigurationBuilder Třída

Definice

Obor názvů:

Microsoft.Extensions.Configuration

Sestavení:

Microsoft.Extensions.Configuration.dll

Balíček:

Microsoft.Extensions.Configuration v11.0.0-preview.5.26302.115

Zdroj:

ConfigurationBuilder.cs

Vytvoří nastavení konfigurace založené 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 pomocí této třídy nahradit funkci souboru app.config, kterou jste už dříve použili 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!
 */

Tady se zobrazí obsah souboru JSON.

{
  "weather": "stormy"
}

Konstruktory

Name	Description
ConfigurationBuilder()	Inicializuje novou instanci ConfigurationBuilder třídy.

Vlastnosti

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

Metody

Name	Description
Add(IConfigurationSource)	Přidá nový zdroj konfigurace.
Build()	Vytvoří klíč IConfiguration s klíči a hodnotami ze sady zprostředkovatelů registrovaných v Sources.

Metody rozšíření

Name	Description
Add<TSource>(IConfigurationBuilder, Action<TSource>)	Přidá nový zdroj konfigurace.
AddApplicationMetadata(IConfigurationBuilder, IHostEnvironment, String)	Zaregistruje zprostředkovatele konfigurace pro metadata aplikace.
AddCommandLine(IConfigurationBuilder, Action<CommandLineConfigurationSource>)	IConfigurationProvider Přidá hodnotu konfigurace z příkazového řádku.
AddCommandLine(IConfigurationBuilder, String[], IDictionary<String,String>)	CommandLineConfigurationProvider IConfigurationProvider Přidá hodnotu konfigurace z příkazového řádku pomocí zadaných mapování přepínačů.
AddCommandLine(IConfigurationBuilder, String[])	CommandLineConfigurationProvider IConfigurationProvider Přidá hodnotu, která čte hodnoty konfigurace z příkazového řádku.
AddConfiguration(IConfigurationBuilder, IConfiguration, Boolean)	Přidá existující konfiguraci do configurationBuildersouboru .
AddConfiguration(IConfigurationBuilder, IConfiguration)	Přidá existující konfiguraci do configurationBuildersouboru .
AddEnvironmentVariables(IConfigurationBuilder, Action<EnvironmentVariablesConfigurationSource>)	IConfigurationProvider Přidá hodnotu konfigurace z proměnných prostředí.
AddEnvironmentVariables(IConfigurationBuilder, String)	Přidá hodnotu IConfigurationProvider konfigurace z proměnných prostředí se zadanou předponou.
AddEnvironmentVariables(IConfigurationBuilder)	IConfigurationProvider Přidá hodnotu konfigurace z proměnných prostředí.
AddIniFile(IConfigurationBuilder, Action<IniConfigurationSource>)	Přidá zdroj konfigurace INI do builder.
AddIniFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Přidá zdroj konfigurace INI do builder.
AddIniFile(IConfigurationBuilder, String, Boolean, Boolean)	Přidá zprostředkovatele konfigurace INI do pathbuilder.
AddIniFile(IConfigurationBuilder, String, Boolean)	Přidá zprostředkovatele konfigurace INI do pathbuilder.
AddIniFile(IConfigurationBuilder, String)	Přidá zprostředkovatele konfigurace INI do pathbuilder.
AddIniStream(IConfigurationBuilder, Stream)	Přidá zdroj konfigurace INI do builder.
AddInMemoryCollection(IConfigurationBuilder, IEnumerable<KeyValuePair<String,String>>)	Přidá zprostředkovatele konfigurace paměti do configurationBuildersouboru .
AddInMemoryCollection(IConfigurationBuilder)	Přidá zprostředkovatele konfigurace paměti do configurationBuildersouboru .
AddJsonFile(IConfigurationBuilder, Action<JsonConfigurationSource>)	Přidá zdroj konfigurace JSON do buildersouboru .
AddJsonFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Přidá zdroj konfigurace JSON do buildersouboru .
AddJsonFile(IConfigurationBuilder, String, Boolean, Boolean)	Přidá zprostředkovatele path konfigurace JSON do buildersouboru .
AddJsonFile(IConfigurationBuilder, String, Boolean)	Přidá zprostředkovatele path konfigurace JSON do buildersouboru .
AddJsonFile(IConfigurationBuilder, String)	Přidá zprostředkovatele path konfigurace JSON do buildersouboru .
AddJsonStream(IConfigurationBuilder, Stream)	Přidá zdroj konfigurace JSON do buildersouboru .
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, 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.
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)	Přidá konfiguraci pomocí souborů z adresáře. Názvy souborů se používají jako klíč, obsah souboru se používá jako hodnota.
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean, Boolean)	Přidá zdroj konfigurace tajných kódů uživatele. assembly Vyhledá instanci , která určuje ID tajných UserSecretsIdAttributekó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. assembly Vyhledá instanci , která určuje ID tajných UserSecretsIdAttributekó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)	Přidá zdroj konfigurace tajných kódů uživatele. assembly Vyhledá instanci , která určuje ID tajných UserSecretsIdAttributekó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(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<T>(IConfigurationBuilder, Boolean, Boolean)	Přidá zdroj konfigurace tajných kódů uživatele. Vyhledá sestavení, které obsahuje typ T instance , který určuje ID tajných UserSecretsIdAttributekó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í, které obsahuje typ T instance , který určuje ID tajných UserSecretsIdAttributekó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í, které obsahuje typ T instance , který určuje ID tajných UserSecretsIdAttributekó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, Action<XmlConfigurationSource>)	Přidá zdroj konfigurace XML do buildersouboru .
AddXmlFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Přidá zdroj konfigurace XML do buildersouboru .
AddXmlFile(IConfigurationBuilder, String, Boolean, Boolean)	Přidá zprostředkovatele konfigurace XML do pathbuildersouboru .
AddXmlFile(IConfigurationBuilder, String, Boolean)	Přidá zprostředkovatele konfigurace XML do pathbuildersouboru .
AddXmlFile(IConfigurationBuilder, String)	Přidá zprostředkovatele konfigurace XML do pathbuildersouboru .
AddXmlStream(IConfigurationBuilder, Stream)	Přidá zdroj konfigurace XML do buildersouboru .
GetFileLoadExceptionHandler(IConfigurationBuilder)	Získá výchozí akci, která se vyvolá pro zprostředkovatele založené na souborech, když dojde k chybě.
GetFileProvider(IConfigurationBuilder)	Získá výchozí IFileProvider hodnotu, která se použije 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 hodnotu, která se použije pro zprostředkovatele založené na souborech.

Viz také

• Konfigurace v .NET