如何在 ASP .NET MVC 中仅验证模型的一部分？

Question

我有一个大型模型（大型我的意思是模型类包含很多字段/属性，并且每个都至少有一个验证属性（例如Required、MaxLength、MinLength 等））。我不想创建一个包含大量输入的视图来让用户用数据填充模型，我想创建几个视图，用户将在其中填充部分模型字段并进入下一步（某种“wizard”）。在步骤之间重定向时，我将未填充的模型对象存储在 Session 中。如下所示：

型号：

public class ModelClass
{
    [MaxLength(100)] ...
    public string Prop1{get;set;}
    [MaxLength(100)] ...
    public string Prop2{get;set;}
    ...
    [Required][MaxLength(100)] ...
    public string Prop20{get;set;}
}

控制器：

[HttpPost]
public ActionResult Step1(ModelClass postedModel)
{    
    // user posts only for example Prop1 and Prop2
    // so while submit I have completly emty model object
    // but with filled Prop1 and Prop2
    // I pass those two values to Session["model"]
    var originalModel = Session["model"] as ModelClass ?? new ModelClass();
    originalModel.Prop1 = postedModel.Prop1;
    originalModel.Prop2 = postedModel.Prop2;
    Session["model"] = originalModel;

    // and return next step view
    return View("Step2");
}

[HttpPost]
public ActionResult Step2(ModelClass postedModel)
{
    // Analogically the same
    // I have posted only Prop3 and Prop4

    var originalModel = Session["model"] as ModelClass;
    if (originalModel!=null)
    {
        originalModel.Prop3 = postedModel.Prop3;
        originalModel.Prop4 = postedModel.Prop4;
        Session["model"] = originalModel;

        // return next step view
        return View("Step3");
    }
    return View("SomeErrorViewIfSessionBrokesSomeHow")
}

Step1 视图只有Prop1 和Prop2 的输入，Step2 视图包含Prop3 和Prop4 等的输入。

但事情是这样的

当用户打开时，例如，第 1 步，并用长度超过 100 个字符的值填充 Prop1，客户端验证工作正常。但是，当然，我必须在控制器的服务器端验证这个值。如果我有完整的模型，我会执行以下操作：

if(!ModelState.IsValid) return View("the same view with the same model object");

所以用户必须再次填写表格并更正。 但是在第 1 步用户只填写了 20 个属性，我需要验证它们。我不能使用ModelState.IsValid，因为模型状态将无效。如您所见，Prop20 标记有[Required] 属性，当用户提交Prop1 和Prop2 时，Prop20 为空，这就是ModelState 无效的原因。当然，我可以允许用户进入第 2 步，填写所有步骤并仅在最后一步验证模型状态，但我不想让用户进入第 2 步，如果他填写的第 1 步不正确。我希望在控制器中进行此验证。 所以问题是： 如何仅验证模型的一部分？如何验证只有部分模型属性与其验证属性匹配？

Answer 1

一种可能的解决方案：

1. 使用 ModelState.IsValidField(字符串键);

   if (ModelState.IsValidField("Name") && ModelState.IsValidField("Address"))
   { ... }
   

然后在一切完成后使用：

if(ModelState.IsValid) { .. }

Answer 2

我认为最优雅的方式是这样做：

List<string> PropertyNames = new List<string>()
{
    "Prop1",
    "Prop2"
};

if (PropertyNames.Any(p => !ModelState.IsValidField(p)))
{
    // Error
}
else
{
    // Everything is okay
}

或：

List<string> PropertyNames = new List<string>()
{
    "Prop1",
    "Prop2"
};

if (PropertyNames.All(p => ModelState.IsValidField(p)))
{
    // Everything is okay
}
else
{
    // Error
}

Answer 3

只是为了添加到现有的答案中。我不会硬编码属性名称，而是使用一个属性与其他验证属性一起添加，如下所示：

public class ValidationStageAttribute : Attribute
{
    public int StageNumber { get; private set; }
    public ValidationStageAttribute(int stageNumber)
    {
        StageNumber = stageNumber;
    }
}

现在我们可以在不了解模型本身的情况下获取属性名称，因此可以将部分验证提取到方法中（如果您经常使用它，您的基本控制器将是一个好地方）。

protected bool ValidateStage(object viewModel, int stageToValidate)
{
    var propertiesForStage = viewModel.GetType()
        .GetProperties()
        .Where(prop => prop.GetCustomAttributes(false).OfType<ValidationStageAttribute>().Any(attr => attr.StageNumber == stageToValidate))
        .Select(prop => prop.Name);

    return propertiesForStage.All(p => ModelState.IsValidField(p));
}

现在您在发布操作中需要做的就是致电ValidateStage(viewModel, 1)

Answer 4

在 MVC Core 中，这相当于：

if (ModelState.GetFieldValidationState("Name") == Microsoft.AspNetCore.Mvc.ModelBinding.ModelValidationState.Valid)
{
    // do something
}

但是，我建议在这种情况下简单地创建一个单独的视图模型。

您的局部视图模型可以被更大的视图模型继承，因此您不必在代码中重复自己（DRY 原则）。

最好避免对属性名称进行硬编码！