ASP.NET Core實現自定義WebApi模型驗證詳解

這篇文章主要給大家介紹了關於ASP.NET Core實現自定義WebApi模型驗證的相關資料，文中通過示例代碼介紹的非常詳細，對大家學習或者使用ASP.NET Core具有一定的參考學習價值，需要的朋友們下面來一起學習學習吧

Framework時代　　

在Framework時代，我們一般進行參數驗證的時候，以下代碼是非常常見的

[HttpPost]
  public async Task<JsonResult> SaveNewCustomerAsnyc(AddCustomerInput input)
  {
   if (!ModelState.IsValid)
   {
    return Json(Result.FromCode(ResultCode.InvalidParams));
   }

   .....
  }

　　或者高級一點是實現IActionFilter進行攔截，如下：　　

public class ApiValidationFilter : IActionFilter
 {
  public bool AllowMultiple => false;

  public async Task<HttpResponseMessage> ExecuteActionFilterAsync(HttpActionContext actionContext, CancellationToken cancellationToken, Func<Task<HttpResponseMessage>> continuation)
  {
   var method = actionContext.ActionDescriptor.GetMethodInfoOrNull();
   if (method == null)
   {
    return await continuation();
   }   

   if (!actionContext.ModelState.IsValid)
   {
    var error = actionContext.ModelState.GetValidationSummary();
    var result = Result.FromError($"參數驗證不通過：{error}", ResultCode.InvalidParams);
    return actionContext.Request.CreateResponse(result);
   }

   return await continuation();
  }
}

public static class ModelStateExtensions
 {
  /// <summary>
  /// 獲取驗證消息提示並格式化提示
  /// </summary>
  public static string GetValidationSummary(this ModelStateDictionary modelState, string separator = "\r\n")
  {
   if (modelState.IsValid) return null;

   var error = new StringBuilder();

   foreach (var item in modelState)
   {
    var state = item.Value;
    var message = state.Errors.FirstOrDefault(p => !string.IsNullOrWhiteSpace(p.ErrorMessage))?.ErrorMessage;
    if (string.IsNullOrWhiteSpace(message))
    {
     message = state.Errors.FirstOrDefault(o => o.Exception != null)?.Exception.Message;
    }
    if (string.IsNullOrWhiteSpace(message)) continue;

    if (error.Length > 0)
    {
     error.Append(separator);
    }

    error.Append(message);
   }

   return error.ToString();
  }
 }

然後在啓動項把這個攔截註冊進來使用即可　

.Net Core時代　　

自動模型狀態驗證

在.Net Core的時代中，框架會幫你自動驗證model的state，也就是ModelState。框架會爲你自動註冊ModelStateInvalidFilter，這個會運行在OnActionExecuting事件裏面。

基於現有框架的代碼編寫的話，所以我們不再需要在業務中耦合這樣的模型判斷代碼，系統內部會檢查ModelState是否爲Valid，如果爲InValid會直接返回400 BadRequest，這樣就沒有必要執行後面的代碼，提高效率。因此，操作方法中不再需要以下代碼：　

if (!ModelState.IsValid)
{
  return BadRequest(ModelState);
}

問題引入　　

在我們的真實開發中，當我們碰到參數驗證沒通過400錯誤時，我們希望的是後臺返回一個可理解的Json結果返回，而不是直接在頁面返回400錯誤。所以我們需要替換掉默認的BadRequest響應結果，把結果換成我們想要的Json結果返回。

自定義 BadRequest 響應

我們如何改變 ASP.NET Core WEB API 模型驗證的默認行爲呢？具體的做法是在通過Startup的ConfigureServices方法配置ApiBehaviorOptions來實現，先來看一下這個類。　

public class ApiBehaviorOptions
  {
    public Func<ActionContext, IActionResult> InvalidModelStateResponseFactory { get; set; }

    public bool SuppressModelStateInvalidFilter { get; set; }

    public bool SuppressInferBindingSourcesForParameters { get; set; }

    public bool SuppressConsumesConstraintForFormFileParameters { get; set; }
  }

所有bool類型的屬性默認都是false。

方案一

當 SuppressModelStateInvalidFilter 屬性設置爲 true 時，會禁用默認行爲　　

public void ConfigureServices(IServiceCollection services)
    {      
      services
         .AddMvc()
        .AddXmlSerializerFormatters() //設置支持XML格式輸入輸出
        .SetCompatibilityVersion(CompatibilityVersion.Version_2_1);

      //禁用默認行爲
      services.Configure<ApiBehaviorOptions>(options =>
      {
        options.SuppressModelStateInvalidFilter = true;
      });
    }

當我們禁用完之後，需要我們自定義的返回結果了，我們使用上面的定義的ApiValidationFilter進行攔截和返回。需要在ConfigureServices方法裏面把這個攔截器註冊進來

public void ConfigureServices(IServiceCollection services)
    {
      .....
      services
         .AddMvc(options =>
         {
           options.Filters.Add<ApiValidationFilter>();
         })
        .AddXmlSerializerFormatters() //設置支持XML格式輸入輸出
        .SetCompatibilityVersion(CompatibilityVersion.Version_2_1);

    }

方案二　　

這也是官網的推薦的做法是，若要自定義驗證錯誤引發的響應，請使用InvalidModelStateResponseFactory。這個InvalidModelStateResponseFactory是一個參數爲ActionContext，返回值爲IActionResult的委託，具體實現如下：　　

public void ConfigureServices(IServiceCollection services)
    {      
      services
         .AddMvc()
        .AddXmlSerializerFormatters() //設置支持XML格式輸入輸出
        .SetCompatibilityVersion(CompatibilityVersion.Version_2_1);

      //參數驗證
      services.Configure<ApiBehaviorOptions>(options =>
      {
        options.InvalidModelStateResponseFactory = (context) =>
        {
          var error = context.ModelState.GetValidationSummary();
          
          return new JsonResult(Result.FromError($"參數驗證不通過：{error.ToString()}", ResultCode.InvalidParams));
        };
      });
    }

上面的代碼是覆蓋ModelState管理的默認行爲（ApiBehaviorOptions），當數據模型驗證失敗時，程序會執行這段代碼。沒通過驗證的ModelState，把它拋出的錯誤信息通過格式化利用JsonResult返回給客戶端。

總結

我們在實際應用過程中，針對WebApi的開發基本上對於所有的請求都是要返回自定義結果的，所以我們需要覆蓋默認的覆蓋默認的模型認證行爲，上面給出了兩種方案：

第一種方案：符合Framework時代的風格，需要額外在指定覆蓋原有的模型驗證（SuppressModelStateInvalidFilter = true）

第二種方案：官方建議做法，符合Core時代的風格，只需複寫InvalidModelStateResponseFactory委託即可，個人也推薦第二種方案。

好了，以上就是這篇文章的全部內容了，希望本文的內容對大家的學習或者工作具有一定的參考學習價值，謝謝大家對神馬文庫的支持。