ASP.NET Core實(shí)現(xiàn)自定義WebApi模型驗(yàn)證詳解
Framework時(shí)代
在Framework時(shí)代,我們一般進(jìn)行參數(shù)驗(yàn)證的時(shí)候,以下代碼是非常常見(jiàn)的
[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)證不通過(guò):{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)來(lái)使用即可
.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,這樣就沒(méi)有必要執(zhí)行后面的代碼,提高效率。因此,操作方法中不再需要以下代碼:
if (!ModelState.IsValid) { return BadRequest(ModelState); }
問(wèn)題引入
在我們的真實(shí)開(kāi)發(fā)中,當(dāng)我們碰到參數(shù)驗(yàn)證沒(méi)通過(guò)400錯(cuò)誤時(shí),我們希望的是后臺(tái)返回一個(gè)可理解的Json結(jié)果返回,而不是直接在頁(yè)面返回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)行為呢?具體的做法是在通過(guò)Startup的ConfigureServices方法配置ApiBehaviorOptions來(lái)實(shí)現(xiàn),先來(lái)看一下這個(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)來(lái)
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)證不通過(guò):{error.ToString()}", ResultCode.InvalidParams)); }; }); }
上面的代碼是覆蓋ModelState管理的默認(rèn)行為(ApiBehaviorOptions),當(dāng)數(shù)據(jù)模型驗(yàn)證失敗時(shí),程序會(huì)執(zhí)行這段代碼。沒(méi)通過(guò)驗(yàn)證的ModelState,把它拋出的錯(cuò)誤信息通過(guò)格式化利用JsonResult返回給客戶端。
總結(jié)
我們?cè)趯?shí)際應(yīng)用過(guò)程中,針對(duì)WebApi的開(kāi)發(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è)人也推薦第二種方案。
好了,以上就是這篇文章的全部?jī)?nèi)容了,希望本文的內(nèi)容對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,謝謝大家對(duì)我們的支持。
上一篇:Linux服務(wù)器下利用Docker部署.net Core項(xiàng)目的全過(guò)程
欄 目:ASP.NET
下一篇:VS2015+Qt5+OpenCV3開(kāi)發(fā)環(huán)境配置
本文標(biāo)題:ASP.NET Core實(shí)現(xiàn)自定義WebApi模型驗(yàn)證詳解
本文地址:http://mengdiqiu.com.cn/a1/ASP_NET/10900.html
您可能感興趣的文章
- 01-11如何給asp.net core寫個(gè)簡(jiǎn)單的健康檢查
- 01-11淺析.Net Core中Json配置的自動(dòng)更新
- 01-11.net core高吞吐遠(yuǎn)程方法如何調(diào)用組件XRPC詳解
- 01-11.NET Core 遷移躺坑記續(xù)集之Win下莫名其妙的超時(shí)
- 01-11docker部署Asp.net core應(yīng)用的完整步驟
- 01-11.net core webapi jwt 更為清爽的認(rèn)證詳解
- 01-11ASP.NET Core靜態(tài)文件的使用方法
- 01-11.NET Core 3.0之創(chuàng)建基于Consul的Configuration擴(kuò)展組件
- 01-11.net core EF Core調(diào)用存儲(chǔ)過(guò)程的方式
- 01-11asp.net Core3.0區(qū)域與路由配置的方法


閱讀排行
- 1C語(yǔ)言 while語(yǔ)句的用法詳解
- 2java 實(shí)現(xiàn)簡(jiǎn)單圣誕樹(shù)的示例代碼(圣誕
- 3利用C語(yǔ)言實(shí)現(xiàn)“百馬百擔(dān)”問(wèn)題方法
- 4C語(yǔ)言中計(jì)算正弦的相關(guān)函數(shù)總結(jié)
- 5c語(yǔ)言計(jì)算三角形面積代碼
- 6什么是 WSH(腳本宿主)的詳細(xì)解釋
- 7C++ 中隨機(jī)函數(shù)random函數(shù)的使用方法
- 8正則表達(dá)式匹配各種特殊字符
- 9C語(yǔ)言十進(jìn)制轉(zhuǎn)二進(jìn)制代碼實(shí)例
- 10C語(yǔ)言查找數(shù)組里數(shù)字重復(fù)次數(shù)的方法
本欄相關(guān)
- 01-11vscode extension插件開(kāi)發(fā)詳解
- 01-11VsCode插件開(kāi)發(fā)之插件初步通信的方法
- 01-11如何給asp.net core寫個(gè)簡(jiǎn)單的健康檢查
- 01-11.net core高吞吐遠(yuǎn)程方法如何調(diào)用組件
- 01-11淺析.Net Core中Json配置的自動(dòng)更新
- 01-11.NET開(kāi)發(fā)人員關(guān)于ML.NET的入門學(xué)習(xí)
- 01-11.NET Core 遷移躺坑記續(xù)集之Win下莫名其
- 01-11.net core webapi jwt 更為清爽的認(rèn)證詳解
- 01-11docker部署Asp.net core應(yīng)用的完整步驟
- 01-11ASP.NET Core靜態(tài)文件的使用方法
隨機(jī)閱讀
- 08-05織夢(mèng)dedecms什么時(shí)候用欄目交叉功能?
- 01-10C#中split用法實(shí)例總結(jié)
- 08-05DEDE織夢(mèng)data目錄下的sessions文件夾有什
- 01-10delphi制作wav文件的方法
- 04-02jquery與jsp,用jquery
- 01-10使用C語(yǔ)言求解撲克牌的順子及n個(gè)骰子
- 01-11Mac OSX 打開(kāi)原生自帶讀寫NTFS功能(圖文
- 01-11ajax實(shí)現(xiàn)頁(yè)面的局部加載
- 01-10SublimeText編譯C開(kāi)發(fā)環(huán)境設(shè)置
- 08-05dedecms(織夢(mèng))副欄目數(shù)量限制代碼修改