Проверка в ASP.NET Core

Microsoft.Extensions.Validation поддерживает сложную валидацию модели в проектах Blazor и Minimal API.

Хотя API в Microsoft.Extensions.Validation пакете NuGet можно использовать в сценариях вне ASP.NET Core, эта статья посвящена ASP.NET Core. API не поддерживается для MVC или Razor Pages. Рекомендации по проверке, применимые к MVC и Razor Pages, см. в разделе "Проверка модели" в ASP.NET Core MVC.

Чтобы включить проверку, вызовите AddValidation для WebApplicationBuilder.Services в файле Program приложения:

builder.Services.AddValidation();

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

Проверка использует генератор источника, который обнаруживает только допустимые типы в сборке, где AddValidation вызывается. Если конечные точки Minimal API определены в сборке, на которую есть ссылка, а не в сборке, где вызывается AddValidation, зарегистрируйте валидацию, как показано в разделе Регистрация валидации в приложениях с несколькими сборками.

Регистрация проверки в приложениях с несколькими сборками

Чтобы проверить типы из отдельных сборок, выполните следующие действия.

• Если сборка является обычной библиотекой классов (она не основана на SDK Microsoft.NET.Sdk.Web или Microsoft.NET.Sdk.Razor), добавьте в проект ссылку на пакет NuGet Microsoft.Extensions.Validation.
• Создайте в каждой внешней сборке метод расширения, который вызывает AddValidation.
• Вызовите каждый из этих методов расширения в главном приложении.

Минимальный пример API

Если типы обработчиков конечных точек определяются для конечных точек в отдельной сборке API, но AddValidation вызываются только из сборки ведущего приложения, проверка не выполняется: недопустимые запросы обрабатываются и возвращают 200 - OK ответ вместо ожидаемого 400 - Bad Request ответа, даже если AddValidation зарегистрированы и типы запросов используют атрибуты проверки.

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

ServiceCollectionExtensions.cs в сборке, определяющей конечные точки, в которой используется пространство имён из примера MinimalApisAssembly.Extensions:

namespace MinimalApisAssembly.Extensions;

public static class ServiceCollectionExtensions
{
    public static IServiceCollection AddApiValidation(
        this IServiceCollection services)
    {
        return services.AddValidation();
    }
}

В файле ведущего приложения Program вызовите метод расширения вместо вызова AddValidation напрямую:

using MinimalApisAssembly.Extensions;

...

builder.Services.AddApiValidation();

...

var app = builder.Build();

app.MapApi();

В предыдущем примере MapApi — это метод расширения, определённый в сборке endpoints и сопоставляющий конечные точки Minimal API. Определите его вместе с AddApiValidation тем, чтобы сопоставления конечных точек и проверка регистрировались из одной сборки.

Blazor Web App пример

Если типы моделей форм определены в отдельной библиотеке или в проекте Blazor Web App компонента .Client, но AddValidation вызывается только из сборки серверного приложения, проверка форм не учитывает атрибуты валидации моделей.

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

Для проверки модели, определённой в проекте .ClientBlazor Web App:

• Создайте в проекте IServiceCollection метод, который принимает экземпляр .Client в качестве аргумента и вызывает для него AddValidation.
• В приложении вызовите как метод, так и AddValidation.

Предыдущий подход приводит к проверке типов из обеих сборок.

В следующем примере метод AddValidationForClientTypes создается для проекта .Client валидации с использованием типов, определяемых в проекте Blazor Web App.

ServiceCollectionExtensions.cs в проекте .Client, который определяет типы, подлежащие проверке, и использует пример пространства имен BlazorSample.Client.Extensions:

namespace BlazorSample.Client.Extensions;

public static class ServiceCollectionExtensions
{
    public static IServiceCollection AddValidationForClientTypes(
        this IServiceCollection services)
    {
        return services.AddValidation();
    }
}

В файле Program серверного проекта:

• Вызовите метод расширения коллекции служб проекта .Client, чтобы проверить типы в проекте .Client.
• Вызов AddValidation для проверки типов в серверном проекте.

using BlazorSample.Client.Extensions;

...

builder.Services.AddValidationForClientTypes();
builder.Services.AddValidation();

namespace Microsoft.Extensions.Validation.Embedded
{
    [AttributeUsage(AttributeTargets.Class)]
    internal sealed class ValidatableTypeAttribute : Attribute
    {
    }
}

Проверяемые сущности

Можно проверить три типа сущностей:

• Параметры (относящиеся к минимальным параметрам конечной точки API)
• Типы
• Properties

Проверка параметров

Проверка параметров — это первый шаг в конвейере проверки для минимальных конечных точек API. Для этого необходимо выполнить следующие действия.

1. Проверяйте экземпляры ValidationAttribute, применяемые к параметру Minimal API.
2. Если тип параметра — IEnumerable, проверьте тип для всех элементов, кроме null. В противном случае проверьте тип значения.

Проверка типов

Проверка типа является следующим шагом после проверки параметров (и является первым шагом в Blazor). Для этого необходимо выполнить следующие действия.

1. Проверьте свойства типа. Если обнаружены ошибки, процесс проверки останавливается.
2. Проверьте экземпляры на уровне типа ValidationAttribute. Если обнаружены ошибки, процесс проверки останавливается.
3. Проверьте реализации IValidatableObject.

Проверка свойств

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

1. Проверить экземпляры ValidationAttribute, примененные к свойству.
2. Если значение свойства равно IEnumerable, выполните проверку типа для всех элементов, кроме null. В противном случае выполните однократную проверку типа для значения.

Явный пропуск проверки

При необходимости можно пропустить проверку для определенного параметра, типа или свойства, применяя его SkipValidationAttribute.

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

Microsoft.Extensions.Validation работает через генератор исходного кода Roslyn, который определяет граф объектов и типы для параметров конечных точек Minimal API.

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

using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.Threading;
using System.Threading.Tasks;

public class ValidateUser : IAsyncValidatableObject
{
    [Required, EmailAddress]
    public string Email { get; set; } = string.Empty;

    // Asynchronous validation path
    public async IAsyncEnumerable<ValidationResult> ValidateAsync(
        ValidationContext validationContext, 
        [EnumeratorCancellation] CancellationToken cancellationToken = default)
    {
        var userService = validationContext.GetService<IUserService>();

        if (userService is not null)
        {
            // Asynchronous call that checks a database via a service
            if (await userService.IsEmailExistsAsync(Email, cancellationToken))
            {
                yield return new ValidationResult(
                    "Email is already registered.", new[] { nameof(Email) });
            }
        }
    }

    // Synchronous validation path that throws InvalidOperationException
    public IEnumerable<ValidationResult> Validate(ValidationContext validationContext)
    {
        throw new InvalidOperationException("Synchronous validation isn't supported.");
    }
}

Дополнительные ресурсы