mvc3 ValidationSummary排除属性错误IValidatableObject

Question

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

视图有@Html.ValidationSummary(true)

在验证摘要中，我要排除与属性有关的错误。 在类B中， IValidatableObject实现返回没有成员名的ValidationResult

但是，由于类B是类A的属性，因此不会显示IValidatableObject类B可变错误。

如何显示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>
}

编辑器模板

<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）现在，如果我们在MyProperty中输入长度大于10的字符串，它应该显示错误消息“ MaxLength到达”， 但是不会显示错误 :) :)

原因

因此，如果我们看到该视图的代码，则可以找到该行

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

由于CBProp是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" });
    }

错误看起来像

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

干杯

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="" />

如果我们将后动作定义为：

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

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

但是，由DefaultModelBinder针对A模型执行的模型验证将调用为Model 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的绑定，因此需要在post操作中将其单独绑定并添加到我们的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 （如其他答案中所述）。

如果显式添加摘要级别验证错误，则通常可以这样做（对根对象）...

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，在modelState之外）;

var isExcludePropertyErrors = modelState！= null;