Продам сайты

Создание системы валидации на основе Fluent API

Создание системы валидации на основе Fluent API с использованием C# — это эффективный подход для управления проверками данных и обеспечения целостности веб-приложений или бизнес-логики. Флуентная структура позволяет читать правила валидации как естественный текст, что делает код более понятным и легко поддерживаемым. В этой статье мы рассмотрим шаги по созданию такой системы с нуля.

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

  • Читаемость: Правила валидации представляются как последовательность методов, что делает их простыми для понимания.
  • Поддерживаемость: Код легко анализировать и поддерживать благодаря его структурной ясности.
  • Масштабируемость: Позволяет добавлять новые правила без необходимости изменения существующих.

Чтобы создать систему валидации на основе Fluent API, нам понадобятся следующие ключевые элементы:

  1. ValidationRule: Абстракция для представления отдельного правила валидации.
  2. ValidatorContext: Контекст, который будет использоваться при проверке объекта на соответствие правилам.
  3. IValidatableObject: Интерфейс или базовый класс для объектов, которые должны быть проверены.
  4. ValidationResult: Структура для хранения результатов валидации.

Каждое правило валидации будет представлять собой небольшой класс или структуру, которая определяет логику проверки и сообщение об ошибке в случае неудачной проверки.

public abstract class ValidationRule<T>
{
    protected readonly T Subject;

    public ValidationResult Result { get; private set; }

    public ValidationRule(T subject)
    {
        Subject = subject;
    }

    public abstract void Validate();

    protected void Fail(string message) => Result = new ValidationResult(false, message);

    protected void Pass() => Result = new ValidationResult(true);
}

Это класс будет предоставлять контекст для выполнения проверок. Он содержит список правил и методы для добавления новых.

public class ValidatorContext<T>
{
    private readonly List<ValidationRule<T>> _rules = new();

    public void AddRule(ValidationRule<T> rule)
    {
        _rules.Add(rule);
    }

    public IEnumerable<ValidationResult> Validate()
    {
        foreach (var rule in _rules)
        {
            rule.Validate();
            yield return rule.Result;
        }
    }
}

В C# есть интерфейс IValidatableObject, предоставляемый .NET, который можно расширить для внедрения собственной логики проверки.

public interface IValidatable<T>
{
    IEnumerable<ValidationResult> Validate();
}

Класс для хранения результата каждого правила валидации:

public class ValidationResult
{
    public bool IsValid { get; }
    public string ErrorMessage { get; }

    public ValidationResult(bool isValid, string errorMessage = null)
    {
        IsValid = isValid;
        ErrorMessage = errorMessage;
    }
}

Для демонстрации создадим несколько базовых правил: проверка на непустое значение и проверка диапазона для числовых значений.

Проверяем, что поле не пусто.

public class RequiredFieldValidationRule<T> : ValidationRule<T>
{
    private readonly string _fieldName;

    public RequiredFieldValidationRule(T subject, string fieldName) : base(subject)
    {
        _fieldName = fieldName;
    }

    public override void Validate()
    {
        if (Subject == null || string.IsNullOrWhiteSpace(Subject.ToString()))
        {
            Fail($"{_fieldName} is required.");
        }
        else
        {
            Pass();
        }
    }
}

Проверяем, что число находится в определенном диапазоне.

public class RangeValidationRule<T> : ValidationRule<T>
{
    private readonly T _min;
    private readonly T _max;

    public RangeValidationRule(T subject, T min, T max) : base(subject)
    {
        _min = min;
        _max = max;
    }

    public override void Validate()
    {
        if (!IsWithinRange())
        {
            Fail($"Value must be between {_min} and {_max}.");
        }
        else
        {
            Pass();
        }
    }

    private bool IsWithinRange()
    {
        var comparableSubject = (IComparable) Subject;
        return comparableSubject.CompareTo(_min) >= 0 && comparableSubject.CompareTo(_max) <= 0;
    }
}

Теперь давайте создадим простой класс User, который будет проверяться с помощью нашей системы валидации.

public class User : IValidatable<User>
{
    public string Name { get; set; }
    public int Age { get; set; }

    public IEnumerable<ValidationResult> Validate()
    {
        var context = new ValidatorContext<User>(this);

        context.AddRule(new RequiredFieldValidationRule<User>(Name, nameof(Name)));
        context.AddRule(new RangeValidationRule<int>(Age, 0, 120));

        return context.Validate();
    }
}
var user = new User { Name = "", Age = 150 };

foreach (var validationResult in user.Validate())
{
    if (!validationResult.IsValid)
    {
        Console.WriteLine(validationResult.ErrorMessage);
    }
}

Ваша система может быть расширена для включения большего количества правил, таких как проверка форматов (например, email), регулярные выражения и многое другое. Вы также можете интегрировать асинхронную валидацию для операций с базами данных или API.

Для этого можно изменить метод Validate в классах ValidationRule и ValidatorContext, чтобы они были асинхронными:

public abstract class ValidationRule<T>
{
    // ...
    public abstract Task ValidateAsync();
}

public class ValidatorContext<T>
{
    private readonly List<ValidationRule<T>> _rules = new();

    public void AddRule(ValidationRule<T> rule)
    {
        _rules.Add(rule);
    }

    public async IAsyncEnumerable<ValidationResult> ValidateAsync()
    {
        foreach (var rule in _rules)
        {
            await rule.ValidateAsync();
            yield return rule.Result;
        }
    }
}

Если вы интегрируете вашу систему в ASP.NET Core, можете использовать middleware для автоматической проверки данных модели перед их обработкой контроллерами.

Создание системы валидации на основе Fluent API в C# позволяет создавать наглядные и легко масштабируемые правила проверки данных. Такая структура не только делает код более читаемым, но и предоставляет гибкость для добавления новых типов валидации без изменения существующего кода.

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

Оцените статью
Все о языке программирования C#