ConfigurationBuilder Класс

Определение

Пространство имен:

Microsoft.Extensions.Configuration

Сборка:

Microsoft.Extensions.Configuration.dll

Пакет:

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

Исходный код:

ConfigurationBuilder.cs

Используется для создания параметров конфигурации на основе ключей и значений для использования в приложении.

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

Наследование

Object

ConfigurationBuilder

Реализации

IConfigurationBuilder

Комментарии

С помощью этого класса можно, например, хранить значения конфигурации в JSON-файле, а затем извлекать их во время выполнения. Дополнительные сведения см. в разделе Конфигурация — базовый пример.

Если вы переносите приложение на .NET Core 3.1 или более позднюю версию, этот класс можно использовать для замены функций файлаapp.config , которые вы могли использовать ранее для настройки приложения.

Пример

В следующем фрагменте кода показано упрощенное приложение, которое создает ConfigurationBuilder объект для получения строкового значения из JSON-файла во время выполнения.

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

Здесь показано содержимое JSON-файла.

{
  "weather": "stormy"
}

Конструкторы

ConfigurationBuilder()

Инициализирует новый экземпляр класса ConfigurationBuilder.

Свойства

Properties	Возвращает коллекцию ключей и значений, которую можно использовать для совместного IConfigurationBuilder использования данных между и зарегистрированным поставщиками конфигурации.
Sources	Возвращает источники, используемые для получения значений конфигурации.

Методы

Add(IConfigurationSource)	Добавляет новый источник конфигурации.
Build()	Создает IConfiguration с ключами и значениями на основе набора поставщиков, зарегистрированных в Sources.
Equals(Object)	Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object)
GetHashCode()	Служит хэш-функцией по умолчанию. (Унаследовано от Object)
GetType()	Возвращает объект Type для текущего экземпляра. (Унаследовано от Object)
MemberwiseClone()	Создает неполную копию текущего объекта Object. (Унаследовано от Object)
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Object)

Методы расширения

AddApplicationMetadata(IConfigurationBuilder, IHostEnvironment, String)	Регистрирует поставщик конфигурации для метаданных приложения.
AddConfiguration(IConfigurationBuilder, IConfiguration)	Добавляет существующую конфигурацию в configurationBuilder.
AddConfiguration(IConfigurationBuilder, IConfiguration, Boolean)	Добавляет существующую конфигурацию в configurationBuilder.
AddCommandLine(IConfigurationBuilder, Action<CommandLineConfigurationSource>)	Добавляет IConfigurationProvider, считывающий значения конфигурации из командной строки.
AddCommandLine(IConfigurationBuilder, String[])	Добавляет CommandLineConfigurationProvider, считывающий значения конфигурации из командной строки.
AddCommandLine(IConfigurationBuilder, String[], IDictionary<String,String>)	Добавляет CommandLineConfigurationProvider, считывающий значения конфигурации из командной строки с использованием указанных сопоставлений переключений.
Add<TSource>(IConfigurationBuilder, Action<TSource>)	Добавляет новый источник конфигурации.
AddEnvironmentVariables(IConfigurationBuilder)	Добавляет IConfigurationProvider, считывающий значения конфигурации из переменных среды.
AddEnvironmentVariables(IConfigurationBuilder, Action<EnvironmentVariablesConfigurationSource>)	Добавляет IConfigurationProvider, считывающий значения конфигурации из переменных среды.
AddEnvironmentVariables(IConfigurationBuilder, String)	Добавляет IConfigurationProvider, считывающий значения конфигурации из переменных среды с указанным префиксом.
GetFileLoadExceptionHandler(IConfigurationBuilder)	Возвращает IFileProvider по умолчанию, используемый для поставщиков на основе файлов.
GetFileProvider(IConfigurationBuilder)	Возвращает IFileProvider по умолчанию, используемый для поставщиков на основе файлов.
SetBasePath(IConfigurationBuilder, String)	Задает FileProvider для поставщиков на основе файлов равным PhysicalFileProvider с базовым путем.
SetFileLoadExceptionHandler(IConfigurationBuilder, Action<FileLoadExceptionContext>)	Задает действие по умолчанию, вызываемое для поставщиков на основе файлов при возникновении ошибки.
SetFileProvider(IConfigurationBuilder, IFileProvider)	Задает IFileProvider по умолчанию, используемый для поставщиков на основе файлов.
AddIniFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Добавляет источник конфигурации INI в builder.
AddIniFile(IConfigurationBuilder, Action<IniConfigurationSource>)	Добавляет источник конфигурации INI в builder.
AddIniFile(IConfigurationBuilder, String)	Добавляет поставщик конфигурации INI по пути path в builder.
AddIniFile(IConfigurationBuilder, String, Boolean)	Добавляет поставщик конфигурации INI по пути path в builder.
AddIniFile(IConfigurationBuilder, String, Boolean, Boolean)	Добавляет поставщик конфигурации INI по пути path в builder.
AddIniStream(IConfigurationBuilder, Stream)	Добавляет источник конфигурации INI в builder.
AddJsonFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Добавляет источник конфигурации JSON в builder.
AddJsonFile(IConfigurationBuilder, Action<JsonConfigurationSource>)	Добавляет источник конфигурации JSON в builder.
AddJsonFile(IConfigurationBuilder, String)	Добавляет поставщик конфигурации JSON по пути path в builder.
AddJsonFile(IConfigurationBuilder, String, Boolean)	Добавляет поставщик конфигурации JSON по пути path в builder.
AddJsonFile(IConfigurationBuilder, String, Boolean, Boolean)	Добавляет поставщик конфигурации JSON по пути path в builder.
AddJsonStream(IConfigurationBuilder, Stream)	Добавляет источник конфигурации JSON в builder.
AddInMemoryCollection(IConfigurationBuilder)	Добавляет поставщик конфигурации памяти в configurationBuilder.
AddInMemoryCollection(IConfigurationBuilder, IEnumerable<KeyValuePair<String,String>>)	Добавляет поставщик конфигурации памяти в configurationBuilder.
AddUserSecrets(IConfigurationBuilder, Assembly)	Добавляет источник конфигурации для секретов пользователя. Выполняет поиск assembly для экземпляра UserSecretsIdAttribute, который указывает идентификатор секретов пользователя. Идентификатор секретов пользователя — это уникальное значение, используемое для хранения и идентификации коллекции из значений конфигурации секретов.
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean)	Добавляет источник конфигурации для секретов пользователя. Выполняет поиск assembly для экземпляра UserSecretsIdAttribute, который указывает идентификатор секретов пользователя. Идентификатор секретов пользователя — это уникальное значение, используемое для хранения и идентификации коллекции из значений конфигурации секретов.
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean, Boolean)	Добавляет источник конфигурации для секретов пользователя. Выполняет поиск assembly для экземпляра UserSecretsIdAttribute, который указывает идентификатор секретов пользователя. Идентификатор секретов пользователя — это уникальное значение, используемое для хранения и идентификации коллекции из значений конфигурации секретов.
AddUserSecrets(IConfigurationBuilder, String)	Добавляет источник конфигурации для секретов пользователя с указанным идентификатором секретов пользователя. Идентификатор секретов пользователя — это уникальное значение, используемое для хранения и идентификации коллекции из значений конфигурации секретов.
AddUserSecrets(IConfigurationBuilder, String, Boolean)	Добавляет источник конфигурации для секретов пользователя с указанным идентификатором секретов пользователя. Идентификатор секретов пользователя — это уникальное значение, используемое для хранения и идентификации коллекции из значений конфигурации секретов.
AddUserSecrets<T>(IConfigurationBuilder)	Добавляет источник конфигурации для секретов пользователя. Выполняет поиск экземпляра UserSecretsIdAttribute, который указывает идентификатор секретов пользователя, в сборке, содержащей T типа. Идентификатор секретов пользователя — это уникальное значение, используемое для хранения и идентификации коллекции из значений конфигурации секретов.
AddUserSecrets<T>(IConfigurationBuilder, Boolean)	Добавляет источник конфигурации для секретов пользователя. Выполняет поиск экземпляра UserSecretsIdAttribute, который указывает идентификатор секретов пользователя, в сборке, содержащей T типа. Идентификатор секретов пользователя — это уникальное значение, используемое для хранения и идентификации коллекции из значений конфигурации секретов.
AddUserSecrets<T>(IConfigurationBuilder, Boolean, Boolean)	Добавляет источник конфигурации для секретов пользователя. Выполняет поиск экземпляра UserSecretsIdAttribute, который указывает идентификатор секретов пользователя, в сборке, содержащей T типа. Идентификатор секретов пользователя — это уникальное значение, используемое для хранения и идентификации коллекции из значений конфигурации секретов.
AddXmlFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Добавляет источник конфигурации XML в builder.
AddXmlFile(IConfigurationBuilder, Action<XmlConfigurationSource>)	Добавляет источник конфигурации XML в builder.
AddXmlFile(IConfigurationBuilder, String)	Добавляет поставщик конфигурации XML по пути path в builder.
AddXmlFile(IConfigurationBuilder, String, Boolean)	Добавляет поставщик конфигурации XML по пути path в builder.
AddXmlFile(IConfigurationBuilder, String, Boolean, Boolean)	Добавляет поставщик конфигурации XML по пути path в builder.
AddXmlStream(IConfigurationBuilder, Stream)	Добавляет источник конфигурации XML в builder.

См. также раздел

• Конфигурация в .NET