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

Posted 2021-04-18

鉴于以下类别：

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;}
}

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

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

答案

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

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; }
    }
}

另一答案

我知道这是旧的，但为了帮助遇到这个问题的其他人并像我一样偶然发现这个问题，你可能想看看使用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(string.Format("{0} is required.", context.DisplayName));
        } else if (string.IsNullOrWhiteSpace(contact.Name)) {
            result = new ValidationResult(string.Format("{0} name is required.", context.DisplayName));
        }

        return result;
    }
}

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

另一答案

我也在寻找答案，到目前为止我找到的内容如果你做了类似的事情：“{0}联系人名称是必需的”在错误信息中它将自动替换变量的名称。我认为有一种方法可以明确地使用这个功能。