?2016-2026 Matools All rights reserved,
粵ICP備17059708號
Framework時代
在Framework時代，我們一般進行參數(shù)驗證的時候，以下代碼是非常常見的
[HttpPost] public async Task<JsonResult>
SaveNewCustomerAsnyc(AddCustomerInput input) {if (!ModelState.IsValid) { return
Json(Result.FromCode(ResultCode.InvalidParams)); } ..... }
或者高級一點是實現(xiàn)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($"參數(shù)驗證不通過：{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時代
自動模型狀態(tài)驗證
在.Net
Core的時代中，框架會幫你自動驗證model的state，也就是ModelState?？蚣軙槟阕詣幼訫odelStateInvalidFilter，這個會運行在OnActionExecuting事件里面。
基于現(xiàn)有框架的代碼編寫的話，所以我們不再需要在業(yè)務(wù)中耦合這樣的模型判斷代碼，系統(tǒng)內(nèi)部會檢查ModelState是否為Valid，如果為InValid會直接返回400
BadRequest，這樣就沒有必要執(zhí)行后面的代碼，提高效率。因此，操作方法中不再需要以下代碼：
if (!ModelState.IsValid) { return BadRequest(ModelState); }
問題引入
在我們的真實開發(fā)中，當我們碰到參數(shù)驗證沒通過400錯誤時，我們希望的是后臺返回一個可理解的Json結(jié)果返回，而不是直接在頁面返回400錯誤。所以我們需要替換掉默認的BadRequest響應(yīng)結(jié)果，把結(jié)果換成我們想要的Json結(jié)果返回。
自定義 BadRequest 響應(yīng)
我們?nèi)绾胃淖?ASP.NET Core WEB API
模型驗證的默認行為呢？具體的做法是在通過Startup的ConfigureServices方法配置ApiBehaviorOptions來實現(xiàn)，先來看一下這個類?！?br> 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 屬性設(shè)置為 true 時，會禁用默認行為
public void ConfigureServices(IServiceCollection services) { services
.AddMvc() .AddXmlSerializerFormatters()//設(shè)置支持XML格式輸入輸出
.SetCompatibilityVersion(CompatibilityVersion.Version_2_1);//禁用默認行為
services.Configure<ApiBehaviorOptions>(options => { options.
SuppressModelStateInvalidFilter = true; }); }
當我們禁用完之后，需要我們自定義的返回結(jié)果了，我們使用上面的定義的ApiValidationFilter
進行攔截和返回。需要在ConfigureServices方法里面把這個攔截器注冊進來
public void ConfigureServices(IServiceCollection services) { ..... services
.AddMvc(options=> { options.Filters.Add<ApiValidationFilter>(); })
.AddXmlSerializerFormatters()//設(shè)置支持XML格式輸入輸出
.SetCompatibilityVersion(CompatibilityVersion.Version_2_1); }
方案二
這也是官網(wǎng)的推薦的做法是，若要自定義驗證錯誤引發(fā)的響應(yīng)，請使用InvalidModelStateResponseFactory。
這個InvalidModelStateResponseFactory是一個參數(shù)為ActionContext，返回值為IActionResult的委托，具體實現(xiàn)如下：
public void ConfigureServices(IServiceCollection services) { services
.AddMvc() .AddXmlSerializerFormatters()//設(shè)置支持XML格式輸入輸出
.SetCompatibilityVersion(CompatibilityVersion.Version_2_1);//參數(shù)驗證
services.Configure<ApiBehaviorOptions>(options => { options.
InvalidModelStateResponseFactory = (context) => { var error =
context.ModelState.GetValidationSummary(); return new
JsonResult(Result.FromError($"參數(shù)驗證不通過：{error.ToString()}",
ResultCode.InvalidParams)); }; }); }
? 上面的代碼是覆蓋ModelState管理的默認行為（ApiBehaviorOptions），當數(shù)據(jù)模型驗證失敗時，程序會執(zhí)行這段代碼。沒通過驗證的ModelState，把它拋出的錯誤信息通過格式化利用JsonResult返回給客戶端。
總結(jié)
我們在實際應(yīng)用過程中，針對WebApi的開發(fā)基本上對于所有的請求都是要返回自定義結(jié)果的，所以我們需要覆蓋默認的覆蓋默認的模型認證行為，上面給出了兩種方案：
第一種方案：符合Framework時代的風格，需要額外在指定覆蓋原有的模型驗證（SuppressModelStateInvalidFilter =
true）
第二種方案：官方建議做法，符合Core時代的風格，只需復寫InvalidModelStateResponseFactory委托即可，個人也推薦第二種方案。
?
如果你有更好的想法，歡迎給我留言交流。
熱門工具 換一換