(精華)2020年7月21日 ASP.NET Core 模型驗證過濾器

愚公搬程式碼發表於2020-07-21

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

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

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

第一種方法:.Net Core 禁用模型驗證過濾器

services.Configure<ApiBehaviorOptions>(options => options.SuppressModelStateInvalidFilter = true);

SuppressModelStateInvalidFilter =true時,會關閉預設模型驗證過濾器。[ApiController] 預設自帶有400模型驗證,且優先順序比較高,如果需要自定義模型驗證,則需要先關閉預設的模型驗證。
第二種方法:自動替換預設模型驗證

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

相關文章