ASP.NET Core 7中如何验证IAsyncEnumerable的数据注解？

ASP.NET Core默认不会自动对IAsyncEnumerable<T>中的每个元素触发数据注解验证——流式集合的模型绑定逻辑不会逐个元素执行验证，这就是你遇到验证未生效的核心原因。以下是几种可行的解决方案：

方案一：手动迭代验证每个元素 #

在遍历IAsyncEnumerable时，通过Validator.TryValidateObject逐个验证元素，同时收集错误信息，这种方式保留流式处理优势，适合大数据量场景：

using System.ComponentModel.DataAnnotations;

public record struct Car([Required][RegularExpression(@"^[0-9]{8}$")] string? Number);

public class MyController : ControllerBase
{
    [HttpPost("cars")]
    public async IAsyncEnumerable<Car> PostCarsAsync([FromBody] IAsyncEnumerable<Car> cars, CancellationToken ct)
    {
        var validationContext = new ValidationContext(new object());
        await foreach (var car in cars.WithCancellation(ct))
        {
            validationContext.ObjectInstance = car;
            var validationResults = new List<ValidationResult>();
            var isValid = Validator.TryValidateObject(car, validationContext, validationResults, validateAllProperties: true);

            if (!isValid)
            {
                // 将验证错误添加到ModelState
                foreach (var error in validationResults)
                {
                    var memberName = error.MemberNames.FirstOrDefault() ?? nameof(Car.Number);
                    ModelState.AddModelError($"Car.{memberName}", error.ErrorMessage);
                }
                // 可根据需求选择：跳过无效元素/返回错误标识/终止请求
            }

            yield return car;
        }

        // 若存在验证错误，可在此处处理（如抛出异常或调整响应逻辑）
        if (!ModelState.IsValid)
        {
            // 注意：由于返回IAsyncEnumerable，无法直接返回BadRequest，需结合业务场景调整
        }
    }
}

方案二：自定义ActionFilter统一验证 #

创建ActionFilter在动作执行前遍历IAsyncEnumerable并验证所有元素，适合数据量不大、希望统一处理验证的场景：

using System.ComponentModel.DataAnnotations;
using Microsoft.AspNetCore.Mvc.Filters;

public class ValidateAsyncEnumerableAttribute : ActionFilterAttribute
{
    public override async Task OnActionExecutionAsync(ActionExecutingContext context, ActionExecutionDelegate next)
    {
        foreach (var arg in context.ActionArguments.Values)
        {
            if (arg is not IAsyncEnumerable<object> asyncEnumerable) continue;

            var validationContext = new ValidationContext(new object());
            await foreach (var item in asyncEnumerable)
            {
                validationContext.ObjectInstance = item;
                var validationResults = new List<ValidationResult>();
                if (!Validator.TryValidateObject(item, validationContext, validationResults, validateAllProperties: true))
                {
                    foreach (var error in validationResults)
                    {
                        var memberName = error.MemberNames.FirstOrDefault() ?? "Unknown";
                        context.ModelState.AddModelError($"{item.GetType().Name}.{memberName}", error.ErrorMessage);
                    }
                }
            }
        }

        if (!context.ModelState.IsValid)
        {
            context.Result = new BadRequestObjectResult(context.ModelState);
            return;
        }

        await next();
    }
}

在控制器动作上添加该特性即可启用验证：

[ValidateAsyncEnumerable]
[HttpPost("cars")]
public async IAsyncEnumerable<Car> PostCarsAsync([FromBody] IAsyncEnumerable<Car> cars, CancellationToken ct)
{
    await foreach (var car in cars.WithCancellation(ct))
    {
        yield return car;
    }
}

注意：此方法会先完整枚举整个集合再执行动作，失去流式处理的性能优势。

方案三：改用List作为输入类型 #

如果数据量不大，直接将输入参数改为List<Car>，ASP.NET Core会自动验证集合中的每个元素，实现成本最低：

[HttpPost("cars")]
public IActionResult PostCars([FromBody] List<Car> cars)
{
    if (!ModelState.IsValid)
    {
        return BadRequest(ModelState);
    }

    // 业务处理逻辑
    return Ok(cars);
}

内容的提问来源于stack exchange，提问作者Anton Larin