ConfigurationBuilder Класс

Определение

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

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

Пакет:: Microsoft.Extensions.Configuration v11.0.0-preview.4.26230.115

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

Если вы переносите приложение на .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 зарегистрированным IConfigurationProvider поставщиками.
Sources	Возвращает источники, используемые для получения значений конфигурации.

Методы

Имя	Описание
Add(IConfigurationSource)	Добавляет новый источник конфигурации.
Build()	IConfiguration Создает ключи и значения из набора поставщиков, зарегистрированных в Sources.

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

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

Применяется к

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

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

Обратная связь

Были ли сведения на этой странице полезными?