Продам сайты

FluentValidation

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

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

FluentValidation работает путём создания классов валидаторов, которые наследуются от AbstractValidator<T>, где T — это тип модели данных. В этих классах можно определить правила валидации для каждого свойства объекта.

Первым шагом на пути использования FluentValidation является его установка. Если вы работаете с проектом, основанным на .NET Core или .NET Framework, вам потребуется добавить библиотеку через NuGet.

Install-Package FluentValidation

Для проектов, использующих .NET CLI:

dotnet add package FluentValidation

Предположим, у нас есть простая модель пользователя, содержащая имя, электронную почту и пароль:

public class UserViewModel
{
    public string Name { get; set; }
    public string Email { get; set; }
    public string Password { get; set; }
}

Следующим шагом является создание класса валидатора. Это простой процесс, который состоит из наследования от AbstractValidator<T> и определения правил для каждого свойства:

using FluentValidation;

public class UserViewModelValidator : AbstractValidator<UserViewModel>
{
    public UserViewModelValidator()
    {
        RuleFor(x => x.Name)
            .NotEmpty().WithMessage("Имя обязательно к заполнению")
            .Length(2, 50).WithMessage("Имя должно содержать от 2 до 50 символов");

        RuleFor(x => x.Email)
            .NotEmpty().WithMessage("Электронная почта обязательна к заполнению")
            .EmailAddress().WithMessage("Некорректный формат электронной почты");

        RuleFor(x => x.Password)
            .NotEmpty().WithMessage("Пароль не может быть пустым")
            .MinimumLength(6).WithMessage("Длина пароля должна быть не менее 6 символов");
    }
}

Теперь, когда у нас есть класс UserViewModelValidator, его можно использовать для проверки объектов типа UserViewModel:

var user = new UserViewModel { Name = "", Email = "test", Password = "123" };
var validator = new UserViewModelValidator();

var results = validator.Validate(user);

if (!results.IsValid)
{
    foreach (var failure in results.Errors)
    {
        Console.WriteLine($"Поле: {failure.PropertyName} - Ошибка: {failure.ErrorMessage}");
    }
}

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

Вы можете объединять несколько классов валидатора для проверки более крупных объектов. Например, если у вас есть заказ с подробностями покупателя и адресом доставки:

public class OrderViewModel
{
    public UserViewModel Customer { get; set; }
    public AddressViewModel ShippingAddress { get; set; }
}

// Композитный валидатор для OrderViewModel
public class OrderViewModelValidator : AbstractValidator<OrderViewModel>
{
    public OrderViewModelValidator()
    {
        RuleFor(x => x.Customer).SetValidator(new UserViewModelValidator());
        RuleFor(x => x.ShippingAddress).SetValidator(new AddressViewModelValidator());
    }
}

FluentValidation позволяет определять глобальные правила, которые применяются ко всем объектам. Это можно сделать с помощью ValidatorOptions.GlobalDefaults:

ValidatorOptions.GlobalRuleSet = "Default";

ValidatorOptions.GlobalConfiguration
    .AddImplicitlyValidatedProperties()
    .IncludeFieldsFromOtherClasses();

Иногда необходимо выполнять проверки, требующие асинхронного доступа к данным. FluentValidation поддерживает такие сценарии:

public class UserViewModelValidator : AbstractValidator<UserViewModel>
{
    public UserViewModelValidator()
    {
        RuleFor(x => x.Email)
            .MustAsync(async (email, cancellation) =>
            {
                var user = await _userService.GetUserByEmail(email);
                return user == null;
            })
            .WithMessage("Пользователь с таким email уже существует");
    }
}

FluentValidation позволяет легко кастомизировать сообщения об ошибках, используя методы WithMessage() или глобальные шаблоны:

RuleFor(x => x.Email)
    .NotEmpty().WithMessage("Это поле не может быть пустым")
    .EmailAddress().WithMessage("Введите корректный email адрес");

Интеграция FluentValidation с ASP.NET Core производится через middleware, что делает его простым и удобным для использования:

services.AddControllers()
    .AddFluentValidation(fv => fv.RegisterValidatorsFromAssemblyContaining<Startup>());

Использование FluentValidation в проектах на C# предоставляет значительные преимущества для разработчиков, стремящихся к модульности и чистоте кода. Благодаря удобному синтаксису и широкой функциональности этой библиотеки процесс валидации данных становится намного более предсказуемым и управляемым. Надеюсь, эта статья поможет вам интегрировать FluentValidation в ваш проект и улучшить качество вашего кода.

Теперь вы знаете, как создавать правила валидации с использованием FluentValidation, как асинхронно выполнять проверки и как интегрировать библиотеку в проекты ASP.NET Core. Используйте эти знания для создания надежных и легко поддерживаемых приложений на C#.

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