ASP.NET Core 添加统一模型验证处理机制
生活随笔
收集整理的這篇文章主要介紹了
ASP.NET Core 添加统一模型验证处理机制
小編覺得挺不錯的,現在分享給大家,幫大家做個參考.
一.前言
模型驗證自ASP.NET MVC便有提供,我們可以在Model(DTO)的屬性上加上數據注解(Data Annotations)特性,在進入Action之前便會根據數據注解,來驗證輸入的數據是否合法,下面介紹以下如何統一處理驗證并返回錯誤信息。
二.Action過濾器實現統一驗證
我們在判斷驗證狀態時一般會在Action里判斷ModelState.IsValid是否為true。
public IActionResult Create([FromBody]CreateOrderDto dto){ ? ? ? ?if(ModelState.IsValid){ ? ? ? ? ? ?//TODO:...} }如果我們在每個需要驗證的Action里面都寫這個判斷豈不是太麻煩,我們是否可以在進入所有的Action之前都進行驗證,如果錯誤,就直接返回錯誤信息,不去執行Action了,當然時可以的。我們可以利用MVC的ActionFilter即Action過濾器,在執行Action之前統一判斷處理。
1.首先定義一個通用的返回結果類:
public class XcHttpResult{ ?? ?public string Msg { get; set; } ?
? ?public bool Result { get; set; } }
2.定義一個ActionFilter
public class XcActionFilter : IActionFilter{ ??public void OnActionExecuting(ActionExecutingContext context) ? ?{ ? ? ? ?if (!context.ModelState.IsValid){XcHttpResult result = new XcHttpResult() {
?Result = false }; ? ? ? ? ?
? ? ? ? ? ?foreach (var item in context.ModelState.Values){ ? ? ? ? ? ? ?
? ? ? ? ? ? ??foreach (var error in item.Errors){result.Msg += error.ErrorMessage + "|";}}context.Result = new JsonResult(result);}} ? ?public void OnActionExecuted(ActionExecutedContext context) ? ?{} }
3.配置過濾器
在Startup.cs里配置過濾器,使其生效:
public void ConfigureServices(IServiceCollection services){services.AddMvc(options =>{options.Filters.Add<XcActionFilter>();}); }三.測試
定義一個DTO:
public class CreateOrderDto{[Required(ErrorMessage = "商品ID不得為空")]? ?public string ProductId { get; set; }[Required(ErrorMessage = "購買商品數量不得為空")][Range(1, 999, ErrorMessage = "購買商品數量必須介于1~999之間")] ? ?
? ?public int Number { get; set; } = 0;
? ?[Required(ErrorMessage = "用戶ID不得為空")] ? public string UserId { get; set; } }
使用Postman來測試接口:
可以看出已經成功驗證!設置了商品數量的取值范圍為1~999之間,而我輸入了9999被成功攔截并返
原文地址:https://www.cnblogs.com/stulzq/p/8962018.html
.NET社區新聞,深度好文,歡迎訪問公眾號文章匯總 http://www.csharpkit.com
總結
以上是生活随笔為你收集整理的ASP.NET Core 添加统一模型验证处理机制的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 浅谈Log4net在项目中如何记录日志
- 下一篇: 发现 ASP.NET Core Sign