使用数据注释进行模型验证的错误消息

Question

给定以下类：

using System.ComponentModel.DataAnnotations;

public class Book{
   public Contact PrimaryContact{get; set;}
   public Contact SecondaryContact{get; set;}

   [Required(ErrorMessage="Book name is required")]
   public string Name{get; set;}
}
public class Contact{
    [Required(ErrorMessage="Name is required")]
    public string Name{get; set;}
}

是否有一种干净的方法可以使用 DataAnnotations 为 Book 中的每个 Contact 实例提供不同的错误消息？例如，如果 PrimaryContact 实例中缺少姓名，则错误将显示为“需要主要联系人姓名”。

我当前的解决方案是创建一个验证服务，检查模型状态中的字段错误，然后删除所述错误并使用我想要的特定语言将它们添加回来。

Answer 1

这是我所知道的唯一方法，但它远非干净。它涉及使用子类化和元数据类来“覆盖”错误消息。

public class Book
{
    public PrimaryContact PrimaryContact { get; set; }
    public SecondaryContact SecondaryContact { get; set; }

    [Required(ErrorMessage = "Book name is required")]
    public string Name { get; set; }
}

public class Contact
{
    [Required(ErrorMessage = "Name is required")]
    public string Name { get; set; }
}

[MetadataType(typeof(PrimaryContactMD))]
public class PrimaryContact : Contact
{
    class PrimaryContactMD
    {
        [Required(ErrorMessage = "Primary Contact Name is required")]
        public string Name { get; set; }
    }
}

[MetadataType(typeof(SecondaryContactMD))]
public class SecondaryContact : Contact
{
    class SecondaryContactMD
    {
        [Required(ErrorMessage = "Secondary Contact Name is required")]
        public string Name { get; set; }
    }
}

Answer 2

您可能需要考虑对此类属性使用 CustomValidation 属性，而不是依赖 Required 属性。

CustomValidation 将允许您更精细地根据您正在验证的属性定制验证消息。为了简洁起见，我使用了 context.DisplayName 来动态显示正在验证的属性的名称，但这可以根据您的需要进一步自定义。

如果需要进一步自定义，您可以为每个单独的属性编写不同的 CustomValidation 处理程序，而不是像我在代码示例中那样重复使用相同的处理程序。

using System.ComponentModel.DataAnnotations;

public class Book {
    [CustomValidation(typeof(Book), "ValidateContact")]
    public Contact PrimaryContact { get; set; }

    [CustomValidation(typeof(Book), "ValidateContact")]
    public Contact SecondaryContact { get; set; }

    [Required(ErrorMessage = "Book name is required")]
    public string Name { get; set; }

    public static ValidationResult ValidateContact(Contact contact, ValidationContext context) {
        ValidationResult result = null;

        if (contact == null) {
            result = new ValidationResult($"{context.DisplayName} is required.");
        } else if (string.IsNullOrWhiteSpace(contact.Name)) {
            result = new ValidationResult($"{context.DisplayName} name is required.");
        }

        return result;
    }
}

public class Contact {
    [Required(ErrorMessage = "Name is required")]
    public string Name { get; set; }
}

Answer 3

下面的 C# 代码用于格式化数据注释错误并以附加格式格式化单个字符串

  public class ValidateModelAttribute : ActionFilterAttribute
    {
        public override void OnActionExecuting(HttpActionContext actionContext)
        {
            if (actionContext.ModelState.IsValid == false)
            {
                if (actionContext.ModelState.IsValid) return;
                string errors = actionContext.ModelState.SelectMany(state => state.Value.Errors).Aggregate("", (current, error) => current + (error.ErrorMessage + ". "));
            }
        }
    }

Answer 4

我也在寻找这个问题的答案，到目前为止我发现如果您在错误消息中执行类似以下操作：“需要{0}联系人姓名”，它会自动替换变量的名称。我认为有一种方法可以显式地使用此功能。