c# - 数组必须包含 1 个元素

Question

我有以下课程：

public class CreateJob
{
    [Required]
    public int JobTypeId { get; set; }
    public string RequestedBy { get; set; }
    public JobTask[] TaskDescriptions { get; set; }
}

我想在上面有一个数据注释，TaskDescriptions以便数组必须包含至少一个元素？很像[Required]。这可能吗？

Answer 1

它可以使用标准的 Required 和 MinLength 验证属性来完成，但仅适用于数组：

public class CreateJob
{
    [Required]
    public int JobTypeId { get; set; }
    public string RequestedBy { get; set; }
    [Required, MinLength(1)]
    public JobTask[] TaskDescriptions { get; set; }
}

Answer 2

我以前见过用于此的自定义验证属性，如下所示：

（我已经给出了带有列表的示例，但可以适用于数组，或者您可以使用列表）

public class MustHaveOneElementAttribute : ValidationAttribute
{
    public override bool IsValid(object value)
    {
        var list = value as IList;
        if (list != null)
        {
            return list.Count > 0;
        }
        return false;
    }
}

[MustHaveOneElementAttribute (ErrorMessage = "At least a task is required")]
public List<Person> TaskDescriptions { get; private set; }

// as of C# 8/9 this could be more elegantly done with     
public class MustHaveOneElementAttribute : ValidationAttribute
{
    public override bool IsValid(object value)
    {
        return value is IList {Count: > 0};
    }
}

感谢 Antonio Falcão Jr.的优雅

Answer 3

这是@dove 解决方案的一些改进版本，它处理不同类型的集合，例如 HashSet、List 等...

public class MustHaveOneElementAttribute : ValidationAttribute
{
    public override bool IsValid(object value)
    {
        var collection = value as IEnumerable;
        if (collection != null && collection.GetEnumerator().MoveNext())
        {
            return true;
        }
        return false;
    }
}

Answer 4

请允许我在 .NET Core 中使用 MinLengthAttribute。

Microsoft 建议使用从 .NET Core 2.0 开始的 Razor Pages。

目前，在 PageModel 中的属性上使用 MinLengthAttribute 的验证不起作用：

[BindProperty]
[Required]
[MinLength(1)]
public IEnumerable<int> SelectedStores { get; set; }

当 SelectedStores.Count() == 0 时，ModelState.IsValid 返回 true。

使用 .NET Core 2.1 Preview 2 进行测试。

Answer 5

您必须使用 2 个标准注释属性

public class CreateJob
{
    [MaxLength(1), MinLength(1)]
    public JobTask[] TaskDescriptions { get; set; }
}

Answer 6

除了 mynkow 的回答之外，我还添加了将最小计数值传递给属性并生成有意义的失败消息的功能：

public class MinimumElementsRequiredAttribute : ValidationAttribute
{
  private readonly int _requiredElements;

  public MinimumElementsRequiredAttribute(int requiredElements)
  {
    if (requiredElements < 1)
    {
      throw new ArgumentOutOfRangeException(nameof(requiredElements), "Minimum element count of 1 is required.");
    }

    _requiredElements = requiredElements;
  }

  protected override ValidationResult IsValid(object value, ValidationContext validationContext)
  {
    if (!(value is IEnumerable enumerable))
    {
      return new ValidationResult($"The {validationContext.DisplayName} field is required.");
    }

    int elementCount = 0;
    IEnumerator enumerator = enumerable.GetEnumerator();
    while (enumerator.MoveNext())
    {
      if (enumerator.Current != null && ++elementCount >= _requiredElements)
      {
        return ValidationResult.Success;
      }
    }

    return new ValidationResult($"At least {_requiredElements} elements are required for the {validationContext.DisplayName} field.");
  }
}

像这样使用它：

public class Dto
{
  [MinimumElementsRequired(2)]
  public IEnumerable<string> Values { get; set; }
}

Answer 7

只需更新 Dove (@dove) 对 C# 9 语法的响应：

    public class MustHaveOneElementAttribute : ValidationAttribute
    {
        public override bool IsValid(object value)
            => value is IList {Count: > 0};
    }

Answer 8

MinLength 属性认为该值为 null 的值是有效的。因此，只需将模型中的属性初始化为空数组即可。

MinLength(1, ErrorMessageResourceName = nameof(ValidationErrors.AtLeastOneSelected), ErrorMessageResourceType = typeof(ValidationErrors))]
int[] SelectedLanguages { get; set; } = new int[0];