.NET Разработчик

День шестьсот девятый. #ЗаметкиНаПолях
Паттерн Options. Окончание
Начало
Продолжение

Валидация
Валидацию параметров можно осуществлять несколькими способами:
1. Аннотации
Аналогично валидации модели, можно использовать атрибуты из System.ComponentModel.DataAnnotations:

public class PositionOptions {
  public string Title { get; set; }
  [Required]
  public string Name { get; set; }
}

При этом в регистрации используется метод AddOptions, позволяющий добавить валидацию в цепочку:

services.AddOptions<PositionOptions>()
  .Bind(Configuration
         .GetSection("Position"))
  .ValidateDataAnnotations();

2. Метод Validate
Можно реализовать более сложную, чем аннотации, логику валидации при регистрации:

services.AddOptions<PositionOptions>()
  .Bind(Configuration
         .GetSection("Position"))
  .Validate(с => { … });

Метод должен возвращать результат валидации в виде булева значения.

3. IValidateOption<T>
При этом подходе создаётся класс валидации, реализующий IValidateOption<T>, например:

public class PositionOptionsValidation : 
    IValidateOption<PositionOptions> {
  …
}

Класс должен реализовать метод Validate интерфейса. Преимущество этого подхода в том, что для валидации можно использовать другие сервисы через DI. Регистрируется класс как Singleton после регистрации параметров:

services.Configure<MyConfigOptions>(
  Configuration.GetSection("Position"));
services.TryAddEnumerable(
  ServiceDescriptor
    .Singleton<
      IValidateOptions<PositionOptions>,
      PositionOptionsValidation>());

Метод TryAddEnumerable позволяет регистрировать в DI коллекцию реализаций для интерфейса, поскольку у нас может быть несколько классов валидаторов.

Остаётся одна проблема в том, что валидация происходит "лениво", то есть только при обращении к параметрам (только на той странице, где они используются), что может приводить к сложным в обнаружении проблемам. См. текущее положение дел.

В этом случае одним из вариантов может быть создание фонового сервиса, который будет запускаться вместе с приложением и проверять все параметры. Кроме того, ему можно передать реализацию IHostApplicationLifetime, позволяющую управлять основным приложением:

public class ValidateOptionsService : IHostedService { 
  public ValidateOptionsService(
      IHostApplicationLifetime appLifetime, 
      IOptions<PositionOptions> posOptions,
      //другие параметры…) {
    _appLifetime = appLifetime;
    _posOptions = posOptions;
    …
  }
}

IHostedService предполагает реализацию двух методов, возвращающих Task: StartAsync и StopAsync. В последнем можно ничего не делать, просто вернуть Task.CompletedTask.
А в StartAsync добавляется код проверки параметров. Как вариант, при возникновении ошибок валидации можно останавливать приложение:

public Task StartAsync(CancellationToken ct) {
  try {
    //доступ к параметру приводит к валидации
    _ = _posOptions.Value;
  }
  catch (OptionsValidationException ex) {
    // останавливаем приложение
    _appLifetime.StopApplication();
  }

  return Task.CompletedTask;
}

Источник: https://app.pluralsight.com/library/courses/dotnet-core-aspnet-core-configuration-options/

👍1

1.15K views05:10