如何在 ASP.NET Core MVC 中显示特定的 ModelState 错误?
How to display specific ModelState errors in ASP.NET Core MVC?
在我的一个控制器动作中,我做的第一件事是将模型传递给一个新动作,该动作基本上只是解析输入以确定用户是否输入了有效日期。然后返回模型并检查 ModelState.IsValid。
public Import ValidateUploadModel(Import Model)
{
// DO not allow future dates
if (Model.CurrMoInfo.CurrMo > DateTime.Now)
{
ModelState.AddModelError("FutureDate", "You cannot assign a future date.");
}
//Do not allow dates from the same month (we run the processing a month behind)
if (Model.CurrMoInfo.CurrMo.Month == DateTime.Now.Month)
{
ModelState.AddModelError("SameMonth", "You must process a previous month.");
}
//Ensure day is last day of a previous month
if (Model.CurrMoInfo.CurrMo.Day != DateTime.DaysInMonth(Model.CurrMoInfo.CurrMo.Year, Model.CurrMoInfo.CurrMo.Month))
{
ModelState.AddModelError("LastDay", "You must enter the last day of the month.");
}
//Do not allow dates older than 12 months back
if (Model.CurrMoInfo.CurrMo < DateTime.Now.AddMonths(-12))
{
ModelState.AddModelError("TooOld", "Date must not be older than a year.");
}
return Model;
}
当我知道我有模型状态错误时,我可以通过放置以下内容在我的 razor 视图中正确显示它们
<span class="text-danger">@Html.ValidationSummary(false)</span>
因此,由于我所有的模型状态错误都针对页面上的相同输入,因此我可以安全地执行此操作。 但是,如果我有各种错误的输入需要彼此独立显示怎么办?我该怎么做呢?此外,除了使用 @Html.ValidationSummary?
之外,还有更好(或更合适)的方法吗?
我搜索了 Microsoft 文档和几十个 Whosebug 问题,尝试将较早的答案翻译成 .Net Core 的做事方式,但不幸的是。
为清楚起见编辑:
这是剃刀视图中的整张卡片:
<div class="card-body">
@if (Model.StagingCount == 0)
{
<input asp-for="@Model.CurrMoInfo.CurrMo" type="date" required class="col-lg-12" />
}
else
{
<input asp-for="@Model.CurrMoInfo.CurrMo" type="date" disabled="disabled" required class="col-lg-12" />
}
<span class="text-danger">@Html.ValidationSummary(false)</span>
</div>
输入的是模型 属性,但没有注释。我已经编写了自己的规则,如果不遵守规则,我会手动将错误添加到模型状态。我的代码有效,但是当我开始需要验证更多字段时它不可扩展。我只是想知道更好的方法是什么。
在上面的示例中,您并没有真正遵循标准做法。
对于像这样的简单验证(您只验证一个字段中的值),您用来在 ModelState 中放置错误消息的键应该与受影响字段的名称相同该模型。在您的情况下,实际上您的所有错误都应该针对 CurrMoInfo.CurrMo
键进行记录。只有错误消息本身需要有所不同。据我所知,为每个特定的不同错误使用自定义键不会为您的应用程序增加任何价值。您没有按照预期的方式使用它。
如果您根据 CurrMoInfo.CurrMo
记录它们,那么您可以使用 asp-validation-for
标签助手创建一个字段,专门显示该字段的错误,例如
<span asp-validation-for="CurrMoInfo.CurrMo" class="text-danger"></span>
然后您可以(可选)使用 ValidationSummary 来(如标题所示)总结整个模型的所有错误 - 并显示您可能创建的与单个特定模型无关的任何额外模型错误场.
完整示例:
public Import ValidateUploadModel(Import Model)
{
// DO not allow future dates
if (Model.CurrMoInfo.CurrMo > DateTime.Now)
{
ModelState.AddModelError("CurrMoInfo.CurrMo", "You cannot assign a future date.");
}
//Do not allow dates from the same month (we run the processing a month behind)
if (Model.CurrMoInfo.CurrMo.Month == DateTime.Now.Month)
{
ModelState.AddModelError("CurrMoInfo.CurrMo", "You must process a previous month.");
}
//Ensure day is last day of a previous month
if (Model.CurrMoInfo.CurrMo.Day != DateTime.DaysInMonth(Model.CurrMoInfo.CurrMo.Year, Model.CurrMoInfo.CurrMo.Month))
{
ModelState.AddModelError("CurrMoInfo.CurrMo", "You must enter the last day of the month.");
}
//Do not allow dates older than 12 months back
if (Model.CurrMoInfo.CurrMo < DateTime.Now.AddMonths(-12))
{
ModelState.AddModelError("CurrMoInfo.CurrMo", "Date must not be older than a year.");
}
return Model;
}
<div class="card-body">
@if (Model.StagingCount == 0)
{
<input asp-for="CurrMoInfo.CurrMo" type="date" required class="col-lg-12" />
}
else
{
<input asp-for="CurrMoInfo.CurrMo" type="date" disabled="disabled" required class="col-lg-12" />
}
<span asp-validation-for="CurrMoInfo.CurrMo" class="text-danger"></span>
</div>
进一步阅读:https://docs.microsoft.com/en-us/aspnet/core/tutorials/first-mvc-app/validation?view=aspnetcore-2.2
P.S。我认为这个一般原则从 .NET Framework 到 .NET Core 没有改变。
在我的一个控制器动作中,我做的第一件事是将模型传递给一个新动作,该动作基本上只是解析输入以确定用户是否输入了有效日期。然后返回模型并检查 ModelState.IsValid。
public Import ValidateUploadModel(Import Model)
{
// DO not allow future dates
if (Model.CurrMoInfo.CurrMo > DateTime.Now)
{
ModelState.AddModelError("FutureDate", "You cannot assign a future date.");
}
//Do not allow dates from the same month (we run the processing a month behind)
if (Model.CurrMoInfo.CurrMo.Month == DateTime.Now.Month)
{
ModelState.AddModelError("SameMonth", "You must process a previous month.");
}
//Ensure day is last day of a previous month
if (Model.CurrMoInfo.CurrMo.Day != DateTime.DaysInMonth(Model.CurrMoInfo.CurrMo.Year, Model.CurrMoInfo.CurrMo.Month))
{
ModelState.AddModelError("LastDay", "You must enter the last day of the month.");
}
//Do not allow dates older than 12 months back
if (Model.CurrMoInfo.CurrMo < DateTime.Now.AddMonths(-12))
{
ModelState.AddModelError("TooOld", "Date must not be older than a year.");
}
return Model;
}
当我知道我有模型状态错误时,我可以通过放置以下内容在我的 razor 视图中正确显示它们
<span class="text-danger">@Html.ValidationSummary(false)</span>
因此,由于我所有的模型状态错误都针对页面上的相同输入,因此我可以安全地执行此操作。 但是,如果我有各种错误的输入需要彼此独立显示怎么办?我该怎么做呢?此外,除了使用 @Html.ValidationSummary?
之外,还有更好(或更合适)的方法吗?我搜索了 Microsoft 文档和几十个 Whosebug 问题,尝试将较早的答案翻译成 .Net Core 的做事方式,但不幸的是。
为清楚起见编辑:
这是剃刀视图中的整张卡片:
<div class="card-body">
@if (Model.StagingCount == 0)
{
<input asp-for="@Model.CurrMoInfo.CurrMo" type="date" required class="col-lg-12" />
}
else
{
<input asp-for="@Model.CurrMoInfo.CurrMo" type="date" disabled="disabled" required class="col-lg-12" />
}
<span class="text-danger">@Html.ValidationSummary(false)</span>
</div>
输入的是模型 属性,但没有注释。我已经编写了自己的规则,如果不遵守规则,我会手动将错误添加到模型状态。我的代码有效,但是当我开始需要验证更多字段时它不可扩展。我只是想知道更好的方法是什么。
在上面的示例中,您并没有真正遵循标准做法。
对于像这样的简单验证(您只验证一个字段中的值),您用来在 ModelState 中放置错误消息的键应该与受影响字段的名称相同该模型。在您的情况下,实际上您的所有错误都应该针对 CurrMoInfo.CurrMo
键进行记录。只有错误消息本身需要有所不同。据我所知,为每个特定的不同错误使用自定义键不会为您的应用程序增加任何价值。您没有按照预期的方式使用它。
如果您根据 CurrMoInfo.CurrMo
记录它们,那么您可以使用 asp-validation-for
标签助手创建一个字段,专门显示该字段的错误,例如
<span asp-validation-for="CurrMoInfo.CurrMo" class="text-danger"></span>
然后您可以(可选)使用 ValidationSummary 来(如标题所示)总结整个模型的所有错误 - 并显示您可能创建的与单个特定模型无关的任何额外模型错误场.
完整示例:
public Import ValidateUploadModel(Import Model)
{
// DO not allow future dates
if (Model.CurrMoInfo.CurrMo > DateTime.Now)
{
ModelState.AddModelError("CurrMoInfo.CurrMo", "You cannot assign a future date.");
}
//Do not allow dates from the same month (we run the processing a month behind)
if (Model.CurrMoInfo.CurrMo.Month == DateTime.Now.Month)
{
ModelState.AddModelError("CurrMoInfo.CurrMo", "You must process a previous month.");
}
//Ensure day is last day of a previous month
if (Model.CurrMoInfo.CurrMo.Day != DateTime.DaysInMonth(Model.CurrMoInfo.CurrMo.Year, Model.CurrMoInfo.CurrMo.Month))
{
ModelState.AddModelError("CurrMoInfo.CurrMo", "You must enter the last day of the month.");
}
//Do not allow dates older than 12 months back
if (Model.CurrMoInfo.CurrMo < DateTime.Now.AddMonths(-12))
{
ModelState.AddModelError("CurrMoInfo.CurrMo", "Date must not be older than a year.");
}
return Model;
}
<div class="card-body">
@if (Model.StagingCount == 0)
{
<input asp-for="CurrMoInfo.CurrMo" type="date" required class="col-lg-12" />
}
else
{
<input asp-for="CurrMoInfo.CurrMo" type="date" disabled="disabled" required class="col-lg-12" />
}
<span asp-validation-for="CurrMoInfo.CurrMo" class="text-danger"></span>
</div>
进一步阅读:https://docs.microsoft.com/en-us/aspnet/core/tutorials/first-mvc-app/validation?view=aspnetcore-2.2
P.S。我认为这个一般原则从 .NET Framework 到 .NET Core 没有改变。