ConfigurationBuilder Класс

Ссылка

Определение

Пространство имен:: Microsoft.Extensions.Configuration

Сборка:: Microsoft.Extensions.Configuration.dll

Пакет:: Microsoft.Extensions.Configuration v8.0.0

Пакет:: Microsoft.Extensions.Configuration v9.0.0-preview.7.24405.7

Исходный код:: ConfigurationBuilder.cs

Исходный код:: ConfigurationBuilder.cs

Исходный код:: ConfigurationBuilder.cs

Исходный код:: 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-файле, например, а затем получить их во время выполнения. Дополнительные сведения см. в разделе Configuration — базовый пример.

Если вы переносите приложение на .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`.
AddKeyPerFile(IConfigurationBuilder, Action<KeyPerFileConfigurationSource>)	Добавляет конфигурацию с помощью файлов из каталога. Имена файлов используются в качестве ключа, содержимое файла используется в качестве значения.
AddKeyPerFile(IConfigurationBuilder, String)	Добавляет конфигурацию с помощью файлов из каталога. Имена файлов используются в качестве ключа, содержимое файла используется в качестве значения.
AddKeyPerFile(IConfigurationBuilder, String, Boolean)	Добавляет конфигурацию с помощью файлов из каталога. Имена файлов используются в качестве ключа, содержимое файла используется в качестве значения.
AddKeyPerFile(IConfigurationBuilder, String, Boolean, Boolean)	Добавляет конфигурацию с помощью файлов из каталога. Имена файлов используются в качестве ключа, содержимое файла используется в качестве значения.
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)	Добавляет источник конфигурации секретов пользователя. Выполняет поиск сборки, содержащей тип `T` для экземпляра UserSecretsIdAttribute, который задает идентификатор секретов пользователя. Идентификатор секретов пользователя — это уникальное значение, используемое для хранения и идентификации коллекции значений конфигурации секретов.
AddUserSecrets<T>(IConfigurationBuilder, Boolean)	Добавляет источник конфигурации секретов пользователя. Выполняет поиск сборки, содержащей тип `T` для экземпляра UserSecretsIdAttribute, который задает идентификатор секретов пользователя. Идентификатор секретов пользователя — это уникальное значение, используемое для хранения и идентификации коллекции значений конфигурации секретов.
AddUserSecrets<T>(IConfigurationBuilder, Boolean, Boolean)	Добавляет источник конфигурации секретов пользователя. Выполняет поиск сборки, содержащей тип `T` для экземпляра UserSecretsIdAttribute, который задает идентификатор секретов пользователя. Идентификатор секретов пользователя — это уникальное значение, используемое для хранения и идентификации коллекции значений конфигурации секретов.
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

Бөлісу құралы: