ASP.NET Core Web API中IEnumerable参数验证不生效问题

问题现象 #

当接口参数为IEnumerable<MediaDto>类型时，DTO上的数据验证规则（包括自定义验证特性AllowedExtensionsAttribute）均不生效；但将参数改为单个MediaDto对象时，验证规则可正常执行。

问题原因 #

ASP.NET Core的模型验证系统默认仅验证集合本身（比如[Required]会检查集合是否为null或空），不会自动遍历集合中的每个元素并应用其内部的验证规则。

解决方案 #

方案1：手动验证集合中的每个元素 #

在控制器动作中遍历集合，手动触发每个MediaDto对象的验证，并将错误合并到ModelState中：

using System.ComponentModel.DataAnnotations;
using System.Linq;

public IActionResult AddMedia([FromForm][Required] IEnumerable<MediaDto> media)
{
    if (!ModelState.IsValid)
    {
        return BadRequest(ModelState);
    }

    var mediaList = media.ToList();
    foreach (var (item, index) in mediaList.Select((item, idx) => (item, idx)))
    {
        var validationContext = new ValidationContext(item);
        var validationResults = new List<ValidationResult>();
        
        // 开启全属性验证，确保所有规则都被执行
        if (!Validator.TryValidateObject(item, validationContext, validationResults, validateAllProperties: true))
        {
            foreach (var validationResult in validationResults)
            {
                // 添加带索引的错误键，便于定位问题元素
                var errorKey = $"media[{index}].{validationResult.MemberNames.FirstOrDefault() ?? string.Empty}";
                ModelState.AddModelError(errorKey, validationResult.ErrorMessage);
            }
        }
    }

    if (!ModelState.IsValid)
    {
        return BadRequest(ModelState);
    }

    return Ok(_momentService.AddMedia(media));
}

方案2：自定义集合验证特性 #

创建一个通用的验证特性，自动验证集合中的每个元素，无需在控制器中编写重复代码：

自定义验证特性代码

using System.Collections;
using System.ComponentModel.DataAnnotations;

public class ValidateEachElementAttribute : ValidationAttribute
{
    protected override ValidationResult? IsValid(object? value, ValidationContext validationContext)
    {
        if (value is not IEnumerable collection)
        {
            return ValidationResult.Success;
        }

        var errorMessages = new List<string>();
        var index = 0;

        foreach (var item in collection)
        {
            var itemValidationContext = new ValidationContext(item);
            var itemValidationResults = new List<ValidationResult>();
            
            if (!Validator.TryValidateObject(item, itemValidationContext, itemValidationResults, validateAllProperties: true))
            {
                foreach (var result in itemValidationResults)
                {
                    var memberName = result.MemberNames.FirstOrDefault() ?? string.Empty;
                    errorMessages.Add($"media[{index}].{memberName}: {result.ErrorMessage}");
                }
            }
            index++;
        }

        return errorMessages.Any() ? new ValidationResult(string.Join("; ", errorMessages)) : ValidationResult.Success;
    }
}

控制器中应用特性

public IActionResult AddMedia([FromForm][Required][ValidateEachElement] IEnumerable<MediaDto> media)
{
    if (!ModelState.IsValid)
    {
        return BadRequest(ModelState);
    }
    
    return Ok(_momentService.AddMedia(media));
}

关键注意点 #

• 必须将Validator.TryValidateObject的validateAllProperties参数设为true，否则只会验证[Required]属性，忽略MaxFileSize、自定义特性等其他规则。
• 带索引的错误键格式（如media[0].File）可以帮助前端快速定位是集合中第几个元素的哪个属性不符合要求。

内容的提问来源于stack exchange，提问作者Ahmad Elkenany