ASP.NET Core實(shí)現(xiàn)自定義WebApi模型驗(yàn)證詳解
Framework時(shí)代
在Framework時(shí)代,我們一般進(jìn)行參數(shù)驗(yàn)證的時(shí)候,以下代碼是非常常見的
[HttpPost] public async Task<JsonResult> SaveNewCustomerAsnyc(AddCustomerInput input) { if (!ModelState.IsValid) { return Json(Result.FromCode(ResultCode.InvalidParams)); } ..... }
或者高級(jí)一點(diǎn)是實(shí)現(xiàn)IActionFilter進(jìn)行攔截,如下:
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($"參數(shù)驗(yàn)證不通過:{error}", ResultCode.InvalidParams); return actionContext.Request.CreateResponse(result); } return await continuation(); } }
public static class ModelStateExtensions { /// <summary> /// 獲取驗(yàn)證消息提示并格式化提示 /// </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(); } }
然后在啟動(dòng)項(xiàng)把這個(gè)攔截注冊(cè)進(jìn)來使用即可
.Net Core時(shí)代
自動(dòng)模型狀態(tài)驗(yàn)證
在.Net Core的時(shí)代中,框架會(huì)幫你自動(dòng)驗(yàn)證model的state,也就是ModelState??蚣軙?huì)為你自動(dòng)注冊(cè)ModelStateInvalidFilter,這個(gè)會(huì)運(yùn)行在OnActionExecuting事件里面。
基于現(xiàn)有框架的代碼編寫的話,所以我們不再需要在業(yè)務(wù)中耦合這樣的模型判斷代碼,系統(tǒng)內(nèi)部會(huì)檢查ModelState是否為Valid,如果為InValid會(huì)直接返回400 BadRequest,這樣就沒有必要執(zhí)行后面的代碼,提高效率。因此,操作方法中不再需要以下代碼:
if (!ModelState.IsValid) { return BadRequest(ModelState); }
問題引入
在我們的真實(shí)開發(fā)中,當(dāng)我們碰到參數(shù)驗(yàn)證沒通過400錯(cuò)誤時(shí),我們希望的是后臺(tái)返回一個(gè)可理解的Json結(jié)果返回,而不是直接在頁面返回400錯(cuò)誤。所以我們需要替換掉默認(rèn)的BadRequest響應(yīng)結(jié)果,把結(jié)果換成我們想要的Json結(jié)果返回。
自定義 BadRequest 響應(yīng)
我們?nèi)绾胃淖?ASP.NET Core WEB API 模型驗(yàn)證的默認(rèn)行為呢?具體的做法是在通過Startup的ConfigureServices方法配置ApiBehaviorOptions來實(shí)現(xiàn),先來看一下這個(gè)類?!?/p>
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類型的屬性默認(rèn)都是false。
方案一
當(dāng) SuppressModelStateInvalidFilter 屬性設(shè)置為 true 時(shí),會(huì)禁用默認(rèn)行為
public void ConfigureServices(IServiceCollection services) { services .AddMvc() .AddXmlSerializerFormatters() //設(shè)置支持XML格式輸入輸出 .SetCompatibilityVersion(CompatibilityVersion.Version_2_1); //禁用默認(rèn)行為 services.Configure<ApiBehaviorOptions>(options => { options.SuppressModelStateInvalidFilter = true; }); }
當(dāng)我們禁用完之后,需要我們自定義的返回結(jié)果了,我們使用上面的定義的ApiValidationFilter進(jìn)行攔截和返回。需要在ConfigureServices方法里面把這個(gè)攔截器注冊(cè)進(jìn)來
public void ConfigureServices(IServiceCollection services) { ..... services .AddMvc(options => { options.Filters.Add<ApiValidationFilter>(); }) .AddXmlSerializerFormatters() //設(shè)置支持XML格式輸入輸出 .SetCompatibilityVersion(CompatibilityVersion.Version_2_1); }
方案二
這也是官網(wǎng)的推薦的做法是,若要自定義驗(yàn)證錯(cuò)誤引發(fā)的響應(yīng),請(qǐng)使用InvalidModelStateResponseFactory。這個(gè)InvalidModelStateResponseFactory是一個(gè)參數(shù)為ActionContext,返回值為IActionResult的委托,具體實(shí)現(xiàn)如下:
public void ConfigureServices(IServiceCollection services) { services .AddMvc() .AddXmlSerializerFormatters() //設(shè)置支持XML格式輸入輸出 .SetCompatibilityVersion(CompatibilityVersion.Version_2_1); //參數(shù)驗(yàn)證 services.Configure<ApiBehaviorOptions>(options => { options.InvalidModelStateResponseFactory = (context) => { var error = context.ModelState.GetValidationSummary(); return new JsonResult(Result.FromError($"參數(shù)驗(yàn)證不通過:{error.ToString()}", ResultCode.InvalidParams)); }; }); }
上面的代碼是覆蓋ModelState管理的默認(rèn)行為(ApiBehaviorOptions),當(dāng)數(shù)據(jù)模型驗(yàn)證失敗時(shí),程序會(huì)執(zhí)行這段代碼。沒通過驗(yàn)證的ModelState,把它拋出的錯(cuò)誤信息通過格式化利用JsonResult返回給客戶端。
總結(jié)
我們?cè)趯?shí)際應(yīng)用過程中,針對(duì)WebApi的開發(fā)基本上對(duì)于所有的請(qǐng)求都是要返回自定義結(jié)果的,所以我們需要覆蓋默認(rèn)的覆蓋默認(rèn)的模型認(rèn)證行為,上面給出了兩種方案:
第一種方案:符合Framework時(shí)代的風(fēng)格,需要額外在指定覆蓋原有的模型驗(yàn)證(SuppressModelStateInvalidFilter = true)
第二種方案:官方建議做法,符合Core時(shí)代的風(fēng)格,只需復(fù)寫InvalidModelStateResponseFactory委托即可,個(gè)人也推薦第二種方案。
好了,以上就是這篇文章的全部內(nèi)容了,希望本文的內(nèi)容對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,謝謝大家對(duì)腳本之家的支持。
- ASP.NET?Core?模型驗(yàn)證消息的本地化新姿勢(shì)詳解
- ASP.NET?Core?6.0?基于模型驗(yàn)證的數(shù)據(jù)驗(yàn)證功能
- ASP.NET?Core中Cookie驗(yàn)證身份用法詳解
- asp.net core3.1cookie和jwt混合認(rèn)證授權(quán)實(shí)現(xiàn)多種身份驗(yàn)證方案
- asp.net core配合vue實(shí)現(xiàn)后端驗(yàn)證碼邏輯
- [Asp.Net Core]用Blazor Server Side實(shí)現(xiàn)圖片驗(yàn)證碼
- asp.net core系列之模型綁定和驗(yàn)證方法
- ASP.NET Core WebApi中使用FluentValidation驗(yàn)證數(shù)據(jù)模型的方法
相關(guān)文章
asp.net運(yùn)行提示未將對(duì)象引用設(shè)置到對(duì)象的實(shí)例錯(cuò)誤解決方法
asp.net運(yùn)行提示未將對(duì)象引用設(shè)置到對(duì)象的實(shí)例錯(cuò)誤解決方法,需要的朋友可以參考下2012-03-03如何將asp.net core程序部署到Linux服務(wù)器
這篇文章主要介紹了將asp.net core程序部署到Linux服務(wù)器上的詳細(xì)過程,本文給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2022-09-09The remote procedure call failed and did not execute的解決辦法
打開IIS隨便訪問一個(gè).asp文件,提示The remote procedure call failed and did not execute2009-11-11.NET6創(chuàng)建Windows服務(wù)的實(shí)現(xiàn)步驟
本文主要介紹了.NET6創(chuàng)建Windows服務(wù)的實(shí)現(xiàn)步驟,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2023-06-06asp.net Application_AcquireRequestState事件,導(dǎo)致Ajax客戶端不能加載
項(xiàng)目中使用Application_AcquireRequestState事件,來做一些用戶信息的驗(yàn)證工作.2010-03-03.net core如何利用ConcurrentTest組件對(duì)方法進(jìn)行壓力測(cè)試詳解
這篇文章主要給大家介紹了關(guān)于.net core如何利用ConcurrentTest組件對(duì)方法進(jìn)行壓力測(cè)試的相關(guān)資料,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面來一起看看吧2018-11-11簡單使用BackgroundWorker創(chuàng)建多個(gè)線程的教程
簡單使用BackgroundWorker創(chuàng)建多個(gè)線程的教程,需要的朋友可以參考一下2013-03-03Asp.net使用SignalR實(shí)現(xiàn)聊天室的功能
這篇文章主要介紹了Asp.net使用SignalR實(shí)現(xiàn)聊天室的功能的相關(guān)資料,需要的朋友可以參考下2016-04-04