快捷導(dǎo)航

ASP.NET Core如何添加統(tǒng)一模型驗證處理機制詳解

更新時間：2018年05月06日 14:45:56 作者：曉晨Master

這篇文章主要給大家介紹了關(guān)于ASP.NET Core如何添加統(tǒng)一模型驗證處理機制的相關(guān)資料，文中通過示例代碼介紹的非常詳細(xì)，對大家學(xué)習(xí)或者使用ASP.NET Core具有一定的參考學(xué)習(xí)價值，需要的朋友可以參考下

一.前言

模型驗證自ASP.NET MVC便有提供，我們可以在Model(DTO)的屬性上加上數(shù)據(jù)注解（Data Annotations）特性，在進(jìn)入Action之前便會根據(jù)數(shù)據(jù)注解，來驗證輸入的數(shù)據(jù)是否合法，下面介紹以下如何統(tǒng)一處理驗證并返回錯誤信息。話不多說了，來一起看看詳細(xì)的介紹吧。

二.Action過濾器實現(xiàn)統(tǒng)一驗證

我們在判斷驗證狀態(tài)時一般會在Action里判斷ModelState.IsValid是否為true。

public IActionResult Create([FromBody]CreateOrderDto dto)
{
 if(ModelState.IsValid)
 {
  //TODO:...
 }
}

如果我們在每個需要驗證的Action里面都寫這個判斷豈不是太麻煩，我們是否可以在進(jìn)入所有的Action之前都進(jìn)行驗證，如果錯誤，就直接返回錯誤信息，不去執(zhí)行Action了，當(dāng)然時可以的。我們可以利用MVC的ActionFilter即Action過濾器，在執(zhí)行Action之前統(tǒng)一判斷處理。

1.首先定義一個通用的返回結(jié)果類：

public class XcHttpResult
{
 public string Msg { get; set; }
 public bool Result { get; set; }
}

2.定義一個ActionFilter

public class XcActionFilter : IActionFilter
{
 public void OnActionExecuting(ActionExecutingContext context)
 {
 if (!context.ModelState.IsValid)
 {
  XcHttpResult result = new XcHttpResult() { Result = false };
  foreach (var item in context.ModelState.Values)
  {
  foreach (var error in item.Errors)
  {
   result.Msg += error.ErrorMessage + "|";
  }
  }
  context.Result = new JsonResult(result);
 }
 }
 public void OnActionExecuted(ActionExecutedContext context)
 {
 }
}

3.配置過濾器

在Startup.cs里配置過濾器，使其生效：

public void ConfigureServices(IServiceCollection services)
{
 services.AddMvc(options =>
 {
 options.Filters.Add<XcActionFilter>();
 });
}

三.測試

定義一個DTO:

public class CreateOrderDto
{
 [Required(ErrorMessage = "商品ID不得為空")]
 public string ProductId { get; set; }
 [Required(ErrorMessage = "購買商品數(shù)量不得為空")]
 [Range(1, 999, ErrorMessage = "購買商品數(shù)量必須介于1~999之間")]
 public int Number { get; set; } = 0;
 [Required(ErrorMessage = "用戶ID不得為空")]
 public string UserId { get; set; }
}

使用Postman來測試接口：