asp.net-mvc - 如何从 ValidationAttribute 内部获取模型元数据？

Question

MVC2 附带了一个名为“PropertiesMustMatchAttribute”的验证属性的很好示例，它将比较两个字段以查看它们是否匹配。该属性的使用如下所示:

[PropertiesMustMatch("NewPassword", "ConfirmPassword", ErrorMessage = "The new password and confirmation password do not match.")]
public class ChangePasswordModel
{
    public string NewPassword { get; set; }
    public string ConfirmPassword { get; set; }
}

该属性附加到模型类并使用一些反射来完成其工作。您还会注意到此处直接指定了错误消息:“新密码和确认密码不匹配。”

如果您不指定消息，则使用如下代码生成默认消息(为了清楚起见，已缩短):

private const string _defaultErrorMessage = "'{0}' and '{1}' do not match.";
public override string FormatErrorMessage(string name)
{
    return String.Format(CultureInfo.CurrentUICulture, _defaultErrorMessage,
        OriginalProperty, ConfirmProperty);
}

问题在于，“OriginalProperty”和“ConfirmProperty”是属性中的硬编码字符串 - 在此示例中为“NewPassword”和“ConfirmPassword”。他们实际上并没有获得真正的模型元数据(例如 DisplayNameAttribute)来组合更灵活、可本地化的消息。我想要一个更普遍适用的比较属性，该属性使用已指定的元数据显示名称信息等。

假设我不想为 ValidationAttribute 的每个实例创建自定义错误消息，这意味着我需要获取对模型元数据的引用(或者至少是我正在验证的模型类型) )这样我就可以获取元数据信息并在错误消息中使用它。

如何从属性内部获取对我正在验证的模型的模型元数据的引用？

(虽然我发现了几个有关如何验证模型中的依赖字段的问题，但没有一个答案包含正确处理错误消息。)

Answer 1

这实际上是 how to get the instance decorated by an attribute, from the attribute 问题的子集(类似问题here)。

不幸的是，简短的答案是:你不能。

属性是元数据。属性不知道也不可能知道有关它所修饰的类或成员的任何信息。由该类的某些下游使用者来查找所述自定义属性并决定是否/何时/如何应用它们。

您必须将属性视为数据，而不是对象。尽管属性在技术上是类，但它们相当愚蠢，因为它们有一个关键的约束:关于它们的所有内容都必须在编译时定义。这实际上意味着他们无法访问任何运行时信息，除非他们公开一个采用运行时实例的方法，并且调用者决定调用它。

你可以选择后者。您可以设计自己的属性，只要控制验证器，就可以使验证器调用属性上的某些方法并让它执行几乎任何操作:

public abstract class CustomValidationAttribute : Attribute
{
    // Returns the error message, if any
    public abstract string Validate(object instance);
}

只要使用此类的人正确使用该属性，这就会起作用:

public class MyValidator
{
    public IEnumerable<string> Validate(object instance)
    {
        if (instance == null)
            throw new ArgumentNullException("instance");
        Type t = instance.GetType();
        var validationAttributes = (CustomValidationAttribute[])Attribute
            .GetCustomAttributes(t, typeof(CustomValidationAttribute));
        foreach (var validationAttribute in validationAttributes)
        {
            string error = validationAttribute.Validate(instance);
            if (!string.IsNullOrEmpty(error))
                yield return error;
        }
    }
}

如果这就是您使用属性的方式，那么实现您自己的属性就变得很简单:

public class PasswordValidationAttribute : CustomValidationAttribute
{
    public override string Validate(object instance)
    {
        ChangePasswordModel model = instance as ChangePasswordModel;
        if (model == null)
            return null;
        if (model.NewPassword != model.ConfirmPassword)
            return Resources.GetLocalized("PasswordsDoNotMatch");
        return null;
    }
}

这一切都很好，只是控制流与您在原始问题中指定的内容相反。该属性不知道它的应用对象是什么；使用该属性的验证器必须提供该信息(这很容易做到)。

当然，这并不是 MVC 2 中数据注释验证的实际工作方式(除非 self 上次查看以来它发生了重大变化)。我认为您无法将其与 ValidationMessageFor 和其他类似函数一起插入。但是，嘿，在 MVC 1 中，我们无论如何都必须编写自己的验证器。没有什么可以阻止您将 DataAnnotations 与您自己的自定义验证属性和验证器结合起来，它只是涉及更多的代码。无论您在何处编写验证代码，都必须调用特殊的验证器。

这可能不是您正在寻找的答案，但不幸的是，事实就是如此；验证属性无法知道它所应用的类，除非该信息由验证器本身提供。