mvc3 ValidationSummary 排除属性错误 IValidatableObject

Question

我的模型（ A 类）有一个 B 类型的属性（称为 b ），并实现了 IValidatableObject 。

View 在验证摘要中有 @Html.ValidationSummary(true)

我想排除与属性相关的错误。 在 B 类 IValidatableObject 实现中返回没有 memberNames 的 ValidationResult

但来自 IValidatableObject 的 B 类验证错误不会显示，因为 B 类是类的属性A

如何显示B类非属性验证错误？

Answer 1

我认为这非常简单，让我用一个例子来解释一下。
首先让我创建您面临的问题，然后我将解释如何解决。

1）声明我的模型。

public class ClassA
{
    [Required]
    public string Name { get; set; }
    public ClassB CBProp { get; set; }
}

public class ClassB:IValidatableObject
{
    [Required]
    public string MyProperty { get; set; }

    public IEnumerable<ValidationResult> Validate(ValidationContext validationContext)
    {
        if (!string.IsNullOrWhiteSpace(MyProperty) && MyProperty.Length > 10)
            yield return new ValidationResult("MaxLength reached");
    }
}

2) 声明简单的动作。

public class HomeController : Controller
{       
    [HttpGet]
    public ActionResult Test()
    {
        ClassA ca = new ClassA();
        return View(ca);
    }

    [HttpPost]
    public ActionResult Test(ClassA ca)
    {            
        return View(ca);
    }
}

3) 让我为 ClassB 创建一个简单的视图和编辑器模板。

测试视图：

@using (Html.BeginForm()) {
    @Html.ValidationSummary(true)
    <fieldset>
        <legend>ClassA</legend>

        <div class="editor-label">
            @Html.LabelFor(model => model.Name)
        </div>
        <div class="editor-field">
            @Html.EditorFor(model => model.Name)
            @Html.ValidationMessageFor(model => model.Name)
        </div>
            @Html.EditorFor(m => m.CBProp, "TestB")    
        <p>
            <input type="submit" value="Create" />
        </p>
    </fieldset>
}

EditorTemplate

<div class="editor-label">
        @Html.LabelFor(model => model.MyProperty)
    </div>
    <div class="editor-field">
        @Html.EditorFor(model => model.MyProperty)
        @Html.ValidationMessageFor(model => model.MyProperty)
    </div>

4) 现在视图将如下所示：

5) 现在，如果我们单击“提交” 。无需输入任何数据。它将按预期显示属性验证错误。

6) 现在，如果我们输入一个长度 > 的字符串10 在 MyProperty 中，应该显示错误消息“MaxLength returned”，但不会显示错误:) :)

原因

因此，如果我们查看视图的代码，我们可以找到这一行

 @Html.ValidationSummary(true)  /// true, will excludePropertyErrors

：Since, CBProp is a property in ClassA, ValidationSummary(true) 将排除 CBProp 中的任何错误。所以你不会发现显示错误消息。然而，有多种选择可以实现这一点。

选项

1) 设置@Html.ValidationSummary()

这将显示错误消息，但它也会显示任何其他错误消息（这是多余的），例如，

2) 在编辑器模板中设置@Html.ValidationSummary(true)。但它会显示错误消息，例如

3) 在 ClassB 的 Validate 方法中，指定属性名称以及ValidationResult 中的错误消息。现在它将被视为属性的验证错误，并将由编辑器模板中的 @Html.ValidationMessageFor(model => model.MyProperty) 显示。

代码

public IEnumerable<ValidationResult> Validate(ValidationContext validationContext)
    {
        if (!string.IsNullOrWhiteSpace(MyProperty) && MyProperty.Length > 10)
            yield return new ValidationResult("MaxLength reached", new List<string> { "MyProperty" });
    }

错误看起来像

I我认为现在已经清楚为什么没有显示错误消息，以及可用的选项是什么。由您决定最适合您的方法。

干杯

Answer 2

虽然验证摘要的这种行为可能不适合您的情况，但通常必须将其视为“正确”。当模型中包含的子对象中创建错误时，会将正确的前缀添加到错误中。也就是说，如果子对象包含在属性 MyProp 中，则前缀 MyProp 会自动添加到所有错误中。这对于为创建的所有错误提供正确的名称是必要的 - 否则 Validationsummary 和 ValidationMessageFor 都无法正常工作 - 因为它们引用全名（包括整个前缀）。这是避免歧义的唯一方法，因为两个不同的子对象中可能有两个 Name 属性。

然而，通常，当子对象中生成的错误不是简单的属性级别错误而是“整个对象”级别错误时，这种“正确”行为是不合适的。在这种情况下，您可能希望它们出现在一般验证摘要中。

您可以通过两种方式面对这个问题：

1. 使用另一个特定于子对象的验证摘要
2. 错误冒泡 - 我经常使用错误冒泡来表示模型的子部分（未显示在屏幕上）包含错误，因此用户可以打开一个详细信息窗口（jQuery 对话框或类似）来查看它们。基本上，错误冒泡包括使用 foreach 处理 ModelState 中的所有错误，然后提升其中的一些错误。提升意味着删除错误前缀的最后部分。当升级错误时，您可以保留或不保留原始错误 - 保留原始错误也更容易，并且在大多数情况下这是正确的做法。请注意，您无法在循环遍历所有条目时删除条目 - 您必须将其放入列表中，然后在循环终止后将其删除。

促销标准可能取决于您的需求。我举个例子：

• 提升属性级别错误会将其转换为对象级别错误。
• 提升子对象级别错误会将其转换为外部对象的对象级别错误。您应该对这种情况感兴趣 - 只需提升与包含整个对象而不是简单值的根 ViewModel 的属性相关的对象级错误！

错误处理可以在您可以定义的自定义 ActionFilter 中执行，并与多个操作方法一起重复使用。

下面是一个简单的PromoteAttribute ActionFilter 的代码。它的用途是：

[Promote("prop1.SubProp1 Prop2")]
public ActionResult MyMethod( ...

也就是说，你向它传递一个你想要提升到 Root 模型的表达式错误列表，如果它在 ModelState 中发现与它们匹配的错误，它就会提升它们 - 显然这只是一个简单的例子 - 你可以只提升一个升级而不是根，你可以使用复杂的标准来定位错误以升级而不是列出它们：

public class PromoteAttribute : ActionFilterAttribute
{
    string[] expressions;
    public PromoteAttribute(string toPromote)
    {
        expressions = toPromote.Split(' ');
    }
    public override void OnActionExecuted(ActionExecutedContext filterContext)
    {
        ModelStateDictionary modelState=filterContext.Controller.ViewData.ModelState;
        foreach(var x in expressions)
        {
            if (modelState.ContainsKey(x))
            {
                var entry = modelState[x];
                if (entry.Errors.Count == 0) continue; 

                foreach (var error in entry.Errors) modelState.AddModelError("", error.ErrorMessage);

            }
        }
    }
}

Answer 3

找出 MVC3 的源代码并进行编辑以允许包含属性。

@Html.ValidationSummary(new [] { "PropertyName" })

将包括名为 PropertyName 的属性

@Html.ValidationSummary(new [] { "ArrayName[]" })

将包括属性 ArrayName[0]、ArrayName[1] 等

@Html.ValidationSummary(new [] { "ArrayName[]", "PropertyName" })

将包括两者。

public static MvcHtmlString ValidationSummary(this HtmlHelper htmlHelper, string[] includePropertyErrors)
{
    return ValidationSummary(htmlHelper, includePropertyErrors, null, null);
}

public static MvcHtmlString ValidationSummary(this HtmlHelper htmlHelper, string[] includePropertyErrors, string message)
{
    return ValidationSummary(htmlHelper, includePropertyErrors, message, null);
}

public static MvcHtmlString ValidationSummary(this HtmlHelper htmlHelper, string[] includePropertyErrors, string message, IDictionary<string, object> htmlAttributes)
{
    if (htmlHelper == null)
    {
        throw new ArgumentNullException("htmlHelper");
    }

    FormContext formContext = htmlHelper.ViewContext.ClientValidationEnabled ? htmlHelper.ViewContext.FormContext : null;
    if (htmlHelper.ViewData.ModelState.IsValid)
    {
        if (formContext == null)
        {  // No client side validation
            return null;
        }

        // TODO: This isn't really about unobtrusive; can we fix up non-unobtrusive to get rid of this, too?
        if (htmlHelper.ViewContext.UnobtrusiveJavaScriptEnabled)
        {  // No client-side updates
            return null;
        }
    }

    string messageSpan;
    if (!string.IsNullOrEmpty(message))
    {
        TagBuilder spanTag = new TagBuilder("span");
        spanTag.SetInnerText(message);
        messageSpan = spanTag.ToString(TagRenderMode.Normal) + Environment.NewLine;
    }
    else
    {
        messageSpan = null;
    }

    StringBuilder htmlSummary = new StringBuilder();
    TagBuilder unorderedList = new TagBuilder("ul");

    IEnumerable<ModelState> modelStates = from ms in htmlHelper.ViewData.ModelState
                                            where ms.Key == htmlHelper.ViewData.TemplateInfo.HtmlFieldPrefix ||
                                                includePropertyErrors.Any(property =>
                                                {
                                                    string prefixedProperty = string.IsNullOrEmpty(htmlHelper.ViewData.TemplateInfo.HtmlFieldPrefix) ? property : htmlHelper.ViewData.TemplateInfo.HtmlFieldPrefix + "." + property;
                                                    if (property.EndsWith("[]"))
                                                    {
                                                        return prefixedProperty.Substring(0, property.Length - 2) == Regex.Replace(ms.Key, @"\[[^\]]+\]", string.Empty);
                                                    }
                                                    else
                                                    {
                                                        return property == ms.Key;
                                                    }
                                                })
                                            select ms.Value;

    if (modelStates != null)
    {
        foreach (ModelState modelState in modelStates)
        {
            foreach (ModelError modelError in modelState.Errors)
            {
                string errorText = GetUserErrorMessageOrDefault(htmlHelper.ViewContext.HttpContext, modelError);
                if (!String.IsNullOrEmpty(errorText))
                {
                    TagBuilder listItem = new TagBuilder("li");
                    listItem.SetInnerText(errorText);
                    htmlSummary.AppendLine(listItem.ToString(TagRenderMode.Normal));
                }
            }
        }
    }

    if (htmlSummary.Length == 0)
    {
        htmlSummary.AppendLine(@"<li style=""display:none""></li>");
    }

    unorderedList.InnerHtml = htmlSummary.ToString();

    TagBuilder divBuilder = new TagBuilder("div");
    divBuilder.MergeAttributes(htmlAttributes);
    divBuilder.AddCssClass((htmlHelper.ViewData.ModelState.IsValid) ? HtmlHelper.ValidationSummaryValidCssClassName : HtmlHelper.ValidationSummaryCssClassName);
    divBuilder.InnerHtml = messageSpan + unorderedList.ToString(TagRenderMode.Normal);

    if (formContext != null)
    {
        if (!htmlHelper.ViewContext.UnobtrusiveJavaScriptEnabled)
        {
            // client val summaries need an ID
            divBuilder.GenerateId("validationSummary");
            formContext.ValidationSummaryId = divBuilder.Attributes["id"];
            formContext.ReplaceValidationSummary = false;
        }
    }

    return new MvcHtmlString(divBuilder.ToString(TagRenderMode.Normal));
}

private static string GetUserErrorMessageOrDefault(HttpContextBase httpContext, ModelError error)
{
    return string.IsNullOrEmpty(error.ErrorMessage) ? null : error.ErrorMessage;
}

Answer 4

让我们从我们所知道的开始：

正如描述所示，如果我们有模型：

模型 A：

public class A
{
    public B ModelB { get; set; }
}

模型 B：

public class B : IValidatableObject
{
    public string Name { get; set; }

    public IEnumerable<ValidationResult> Validate(ValidationContext validationContext)
    {
        List<ValidationResult> errors = new List<ValidationResult>();

        if (string.IsNullOrEmpty(Name)) {
            errors.Add(new ValidationResult("Please enter your name"));
        }

        return errors;
    }
}

我们的观点：

@model A

@Html.ValidationSummary(true)

@using (Html.BeginForm())
{
    @Html.EditorFor(model => model.ModelB.Name)

    <input type="submit" value="submit" />
}

那么编辑器将输出以下行：

<input class="text-box single-line" id="ModelB_Name" name="ModelB.Name" type="text" value="" />

如果我们将 post action 定义为：

[HttpPost]
public ActionResult Index(A model)
{
    if (ModelState.IsValid)
    {
        return RedirectToAction("NextAction");
    }
    return View();
}

那么当绑定到 A 模型时，DefaultModelBinder 将查找它将找到名为 ModelB.Name 的属性并绑定成功。

但是，DefaultModelBinder 针对 A 模型执行的模型验证将调用为模型 B 定义的验证。此验证将返回一条错误消息，该消息不是针对属性定义的，但因为此验证是复杂模型的一部分，所以它会使用“ModelB”键添加到 ModelState 中。

当调用 ValidationSummary 时，它会查找空白键（即为模型而不是属性定义的键）。由于不存在空白键，因此不会显示错误。

作为一个简单的解决方法，您可以为 B 模型定义一个 EditorTemplate。

在包含视图的文件夹中，定义一个名为 EditorTemplates 的文件夹，并在其中创建一个与模型同名的视图（例如，在我的例子中为 B.cshtml）。 编辑器模板的内容将定义为：

@model MvcApplication14.Models.B

@Html.EditorFor(m => m.Name)

然后，修改主视图，使 EditorFor 如下所示：

@Html.EditorFor(model => model.ModelB, null, "")

“”指定我们的编辑器模板输出的任何字段该字段不会有名称前缀。因此，现在的输出将是：

<input class="text-box single-line" id="Name" name="Name" type="text" value="" /> 

但是，这现在将阻止绑定 ModelB，因此需要在后期操作中单独绑定并添加到我们的 A 模型中：

[HttpPost]
public ActionResult Index(A modelA, B modelB)
{
    modelA.ModelB = modelB;
    if (ModelState.IsValid)
    {
        return RedirectToAction("NextAction");
    }
    return View();
}

现在，当绑定modelB时，验证消息将使用键“”写入ModelState。因此，现在可以使用 @ValidationMessage() 例程来显示它。

警告：上述解决方法假设 modelB 没有与 modelA 相同的字段名称。例如，如果 modelB 和 modelA 都有一个 Name 字段，那么 DefaultModelBinder 可能无法将这些字段绑定到正确的位置等价物。例如，如果 A 模型还有一个名为 Name 的字段，则必须将其写入视图：

@Html.EditorFor(model => model.Name, null, "modelA.Name")

以确保其正确绑定。

希望这应该允许您使用 MVC3 框架中已定义的方法来实现所需的结果。

Answer 5

对于那些发现这个问题的人，请看一下 ViewData.TemplateInfo.HtmlFieldPrefix （如其他答案中深入提到的）...

如果显式添加摘要级别验证错误，您通常可能会这样做（到root 对象）...

ModelState.AddModelError("", "This is a summary level error text for the model");

当为模型的属性添加类似摘要的验证错误时，该属性本身就是一个对象，您可以执行以下操作

ModelState.AddModelError("b", "This is a 'summary' error for the property named b");

： >b 是位于的属性的名称本身就是一种财产。

解释一下，直接添加摘要级别验证错误时，您只需指定对象属性的 HTML 前缀即可。

这可以使用 ViewData.TemplateInfo.HtmlFieldPrefix 获取。

Answer 6

ModelState modelState = 默认(ModelState);
Model.TryGetValue(this.ViewData.TemplateInfo.HtmlFieldPrefix, out modelState);

var isExcludePropertyErrors = modelState != null;