Reo.Core.ConfigValidation 10.0.210

Reo.Core.ConfigValidation

Описание пакета

Пакет Reo.Core.ConfigValidation предназначен для проверки соответствия структуры конфигурации приложения заданным требованиям. Он позволяет:

• Обнаруживать отсутствующие разделы в конфигурации.
• Генерировать предупреждения о разделах, которые не требуются, но присутствуют в приложении.
• Использовать графы для сравнения структуры конфигурации из файла и текущей конфигурации приложения.

Пакет решает проблему несоответствия между ожидаемой и фактической структурой конфигурации, что особенно важно для приложений с высокими требованиями к надежности и корректности настроек.

Основные компоненты

1. IMatchingConfigValidatorService

Интерфейс, определяющий методы для проверки конфигурации. Основной метод: Validate() — выполняет сравнение структуры конфигурации.

2. MatchingConfigValidatorService

Реализация интерфейса IMatchingConfigValidatorService. Отвечает за:

• Создание графов конфигурации.
• Сравнение структуры конфигурации и генерацию ошибок/предупреждений.

3. ConfigSectionGraph

Класс, представляющий структуру конфигурации в виде графа. Содержит методы для:

• Сравнения графов.
• Получения списка отсутствующих разделов.
• Формирования пути к разделам (например, SectionA--SectionB).

4. IConfigSectionGraphCreator

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

5. ConfigValidatorSectionGraphBuilder

Реализация IConfigSectionGraphCreator, которая:

• Читает конфигурацию из файла (например, JSON).
• Строит граф на основе структуры этого файла.

6. SourceConfigSectionGraphBuilder

Реализация IConfigSectionGraphCreator, которая:

• Читает текущую конфигурацию приложения (например, из appsettings.json).
• Строит граф на основе этой конфигурации.

Требования

Совместимость с .NET

• .NET 8

Зависимости

• Microsoft.Extensions.Configuration
• Microsoft.Extensions.Logging
• System.IO.Abstractions (для работы с файловой системой)

Установка

NuGet Package Manager

Install-Package Reo.Core.ConfigValidation

.NET CLI

dotnet add package Reo.Core.ConfigValidation

Настройка

Регистрация в DI-контейнере (ASP.NET Core)

Добавьте сервис в Startup.cs или Program.cs:

services.AddSingleton<IMatchingConfigValidatorService, MatchingConfigValidatorService>();

Конфигурационные параметры

1. Создайте файл required-config.json с описанием обязательных разделов:

{
 "RequiredSections": [
 "SectionA",
 "SectionB/SectionC"
 ]
}

2. Укажите путь к файлу в appsettings.json:

{
 "ConfigValidation": {
 "RequiredConfigFilePath": "path/to/required-config.json"
 }
}

Использование

Пример 1: Проверка конфигурации

public class ConfigValidator
{
 private readonly IMatchingConfigValidatorService _validator;

 public ConfigValidator(IMatchingConfigValidatorService validator)
 {
 _validator = validator;
 }

 public void ValidateConfiguration()
 {
 try
 {
 _validator.Validate();
 Console.WriteLine("Конфигурация прошла проверку!");
 }
 catch (RequiredConfigSectionNotFoundException ex)
 {
 Console.WriteLine($"Ошибка: {ex.Message}");
 }
 }
}

Пример 2: Структура файла required-config.json

{
 "RequiredSections": [
 "Database/ConnectionStrings",
 "Logging/LogLevel",
 "Services/ExternalApi"
 ]
}

Пример 3: Результаты проверки

Если в appsettings.json отсутствует раздел Database/ConnectionStrings, будет сгенерировано исключение:

throw new RequiredConfigSectionNotFoundException(new List<string> { "Database--ConnectionStrings" });

Лицензия

Данный пакет распространяется под лицензией MIT.