ConfigurationBuilder Osztály

Definíció

Névtér:

Microsoft.Extensions.Configuration

Szerelvény:

Microsoft.Extensions.Configuration.dll

Csomag:

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

Forrás:

ConfigurationBuilder.cs

Kulcs-/értékalapú konfigurációs beállításokat hoz létre egy alkalmazásban való használatra.

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

Öröklődés

Object

ConfigurationBuilder

Megvalósítás

IConfigurationBuilder

Megjegyzések

Az osztály használatával például egy JSON-fájlban tárolhatja a konfigurációs értékeket, majd lekérheti őket futásidőben. További információ: Konfiguráció – egyszerű példa.

Ha egy alkalmazást .NET Core 3.1-es vagy újabb verzióra migrál, ezzel az osztálysal lecserélheti az alkalmazás konfigurálásához korábban használt app.config fájlfunkciót.

Example

Az alábbi kódrészlet egy egyszerűsített alkalmazást mutat be, amely létrehoz egy ConfigurationBuilder objektumot egy sztringérték lekéréséhez egy JSON-fájlból futás közben.

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

A JSON-fájl tartalma itt látható.

{
  "weather": "stormy"
}

Konstruktorok

Name	Description
ConfigurationBuilder()	Inicializálja a ConfigurationBuilder osztály új példányát.

Tulajdonságok

Name	Description
Properties	Lekéri a kulcs/érték gyűjteményt, amellyel adatokat oszthat meg a IConfigurationBuilder regisztrált IConfigurationProvider szolgáltatók között.
Sources	Lekéri a konfigurációs értékek beszerzéséhez használt forrásokat.

Metódusok

Name	Description
Add(IConfigurationSource)	Új konfigurációs forrást ad hozzá.
Build()	Létrehoz egy IConfiguration kulcsokat és értékeket a regisztrált Sourcesszolgáltatók készletéből.

Bővítő metódusok

Name	Description
Add<TSource>(IConfigurationBuilder, Action<TSource>)	Új konfigurációs forrást ad hozzá.
AddApplicationMetadata(IConfigurationBuilder, IHostEnvironment, String)	Regisztrál egy konfigurációszolgáltatót az alkalmazás metaadataihoz.
AddCommandLine(IConfigurationBuilder, Action<CommandLineConfigurationSource>)	Hozzáad egy IConfigurationProvider konfigurációs értékeket a parancssorból.
AddCommandLine(IConfigurationBuilder, String[], IDictionary<String,String>)	Hozzáad egy CommandLineConfigurationProviderIConfigurationProvider konfigurációs értékeket a parancssorból a megadott kapcsolóleképezések használatával.
AddCommandLine(IConfigurationBuilder, String[])	Hozzáad egy olyan értéket CommandLineConfigurationProviderIConfigurationProvider , amely beolvassa a konfigurációs értékeket a parancssorból.
AddConfiguration(IConfigurationBuilder, IConfiguration, Boolean)	Hozzáad egy meglévő konfigurációt a fájlhoz configurationBuilder.
AddConfiguration(IConfigurationBuilder, IConfiguration)	Hozzáad egy meglévő konfigurációt a fájlhoz configurationBuilder.
AddEnvironmentVariables(IConfigurationBuilder, Action<EnvironmentVariablesConfigurationSource>)	Hozzáad egy olyan értéket IConfigurationProvider , amely beolvassa a környezeti változók konfigurációs értékeit.
AddEnvironmentVariables(IConfigurationBuilder, String)	Hozzáad egy IConfigurationProvider konfigurációs értékeket egy megadott előtaggal rendelkező környezeti változókból.
AddEnvironmentVariables(IConfigurationBuilder)	Hozzáad egy olyan értéket IConfigurationProvider , amely beolvassa a környezeti változók konfigurációs értékeit.
AddIniFile(IConfigurationBuilder, Action<IniConfigurationSource>)	INI-konfigurációs forrás hozzáadása a következőhöz builder: .
AddIniFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	INI-konfigurációs forrás hozzáadása a következőhöz builder: .
AddIniFile(IConfigurationBuilder, String, Boolean, Boolean)	Hozzáadja az INI-konfigurációszolgáltatót a path következőhöz builder: .
AddIniFile(IConfigurationBuilder, String, Boolean)	Hozzáadja az INI-konfigurációszolgáltatót a path következőhöz builder: .
AddIniFile(IConfigurationBuilder, String)	Hozzáadja az INI-konfigurációszolgáltatót a path következőhöz builder: .
AddIniStream(IConfigurationBuilder, Stream)	INI-konfigurációs forrás hozzáadása a következőhöz builder: .
AddInMemoryCollection(IConfigurationBuilder, IEnumerable<KeyValuePair<String,String>>)	Hozzáadja a memóriakonfigurációs szolgáltatót a következőhöz configurationBuilder: .
AddInMemoryCollection(IConfigurationBuilder)	Hozzáadja a memóriakonfigurációs szolgáltatót a következőhöz configurationBuilder: .
AddJsonFile(IConfigurationBuilder, Action<JsonConfigurationSource>)	JSON-konfigurációs forrás hozzáadása a fájlhoz builder.
AddJsonFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	JSON-konfigurációs forrás hozzáadása a fájlhoz builder.
AddJsonFile(IConfigurationBuilder, String, Boolean, Boolean)	Hozzáadja a JSON-konfigurációszolgáltatót a path következőhöz builder: .
AddJsonFile(IConfigurationBuilder, String, Boolean)	Hozzáadja a JSON-konfigurációszolgáltatót a path következőhöz builder: .
AddJsonFile(IConfigurationBuilder, String)	Hozzáadja a JSON-konfigurációszolgáltatót a path következőhöz builder: .
AddJsonStream(IConfigurationBuilder, Stream)	JSON-konfigurációs forrás hozzáadása a fájlhoz builder.
AddKeyPerFile(IConfigurationBuilder, Action<KeyPerFileConfigurationSource>)	A címtárból származó fájlok használatával adja hozzá a konfigurációt. A rendszer a fájlneveket használja kulcsként, a fájl tartalmát pedig értékként.
AddKeyPerFile(IConfigurationBuilder, String, Boolean, Boolean)	A címtárból származó fájlok használatával adja hozzá a konfigurációt. A rendszer a fájlneveket használja kulcsként, a fájl tartalmát pedig értékként.
AddKeyPerFile(IConfigurationBuilder, String, Boolean)	A címtárból származó fájlok használatával adja hozzá a konfigurációt. A rendszer a fájlneveket használja kulcsként, a fájl tartalmát pedig értékként.
AddKeyPerFile(IConfigurationBuilder, String)	A címtárból származó fájlok használatával adja hozzá a konfigurációt. A rendszer a fájlneveket használja kulcsként, a fájl tartalmát pedig értékként.
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean, Boolean)	Hozzáadja a felhasználói titkos kulcsok konfigurációs forrását. Ez megkeresi assembly a UserSecretsIdAttributefelhasználói titkos kulcsok azonosítóját meghatározó példányt. A felhasználói titkos kódok azonosítója egyedi érték, amely titkos konfigurációs értékek gyűjteményének tárolására és azonosítására szolgál.
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean)	Hozzáadja a felhasználói titkos kulcsok konfigurációs forrását. Ez megkeresi assembly a UserSecretsIdAttributefelhasználói titkos kulcsok azonosítóját meghatározó példányt. A felhasználói titkos kódok azonosítója egyedi érték, amely titkos konfigurációs értékek gyűjteményének tárolására és azonosítására szolgál.
AddUserSecrets(IConfigurationBuilder, Assembly)	Hozzáadja a felhasználói titkos kulcsok konfigurációs forrását. Ez megkeresi assembly a UserSecretsIdAttributefelhasználói titkos kulcsok azonosítóját meghatározó példányt. A felhasználói titkos kódok azonosítója egyedi érték, amely titkos konfigurációs értékek gyűjteményének tárolására és azonosítására szolgál.
AddUserSecrets(IConfigurationBuilder, String, Boolean)	Hozzáadja a felhasználói titkos kódok konfigurációs forrását a megadott felhasználói titkos kódok azonosítójával. A felhasználói titkos kódok azonosítója egyedi érték, amely titkos konfigurációs értékek gyűjteményének tárolására és azonosítására szolgál.
AddUserSecrets(IConfigurationBuilder, String)	Hozzáadja a felhasználói titkos kódok konfigurációs forrását a megadott felhasználói titkos kódok azonosítójával. A felhasználói titkos kódok azonosítója egyedi érték, amely titkos konfigurációs értékek gyűjteményének tárolására és azonosítására szolgál.
AddUserSecrets<T>(IConfigurationBuilder, Boolean, Boolean)	Hozzáadja a felhasználói titkos kulcsok konfigurációs forrását. Megkeresi a szerelvényt, amely típust T tartalmaz a felhasználó titkos kulcsainak UserSecretsIdAttributeazonosítóját megadó példányhoz. A felhasználói titkos kódok azonosítója egyedi érték, amely titkos konfigurációs értékek gyűjteményének tárolására és azonosítására szolgál.
AddUserSecrets<T>(IConfigurationBuilder, Boolean)	Hozzáadja a felhasználói titkos kulcsok konfigurációs forrását. Megkeresi a szerelvényt, amely típust T tartalmaz a felhasználó titkos kulcsainak UserSecretsIdAttributeazonosítóját megadó példányhoz. A felhasználói titkos kódok azonosítója egyedi érték, amely titkos konfigurációs értékek gyűjteményének tárolására és azonosítására szolgál.
AddUserSecrets<T>(IConfigurationBuilder)	Hozzáadja a felhasználói titkos kulcsok konfigurációs forrását. Megkeresi a szerelvényt, amely típust T tartalmaz a felhasználó titkos kulcsainak UserSecretsIdAttributeazonosítóját megadó példányhoz. A felhasználói titkos kódok azonosítója egyedi érték, amely titkos konfigurációs értékek gyűjteményének tárolására és azonosítására szolgál.
AddXmlFile(IConfigurationBuilder, Action<XmlConfigurationSource>)	XML-konfigurációs forrás hozzáadása a fájlhoz builder.
AddXmlFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	XML-konfigurációs forrás hozzáadása a fájlhoz builder.
AddXmlFile(IConfigurationBuilder, String, Boolean, Boolean)	Hozzáadja az XML-konfigurációszolgáltatót a path következőhöz builder: .
AddXmlFile(IConfigurationBuilder, String, Boolean)	Hozzáadja az XML-konfigurációszolgáltatót a path következőhöz builder: .
AddXmlFile(IConfigurationBuilder, String)	Hozzáadja az XML-konfigurációszolgáltatót a path következőhöz builder: .
AddXmlStream(IConfigurationBuilder, Stream)	XML-konfigurációs forrás hozzáadása a fájlhoz builder.
GetFileLoadExceptionHandler(IConfigurationBuilder)	A fájlalapú szolgáltatók számára hiba esetén meghívandó alapértelmezett műveletet kap.
GetFileProvider(IConfigurationBuilder)	Lekéri a IFileProvider fájlalapú szolgáltatók alapértelmezett használatát.
SetBasePath(IConfigurationBuilder, String)	A fájlalapú szolgáltatók Fájlproviderét egy PhysicalFileProviderre állítja az alap elérési úttal.
SetFileLoadExceptionHandler(IConfigurationBuilder, Action<FileLoadExceptionContext>)	Beállít egy alapértelmezett műveletet a fájlalapú szolgáltatókhoz hiba esetén.
SetFileProvider(IConfigurationBuilder, IFileProvider)	Beállítja a IFileProvider fájlalapú szolgáltatók alapértelmezett használatát.

Lásd még

• Konfiguráció a .NET-ben