手把手教你AspNetCore WebApi數(shù)據(jù)驗證的實現(xiàn)
更新時間：2020年10月12日 09:58:03 作者：深度碼農(nóng)
這篇文章主要介紹了手把手教你AspNetCore WebApi數(shù)據(jù)驗證的實現(xiàn)，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧
前言
小明最近又遇到麻煩了，小紅希望對接接口傳送的數(shù)據(jù)進行驗證，既然是小紅要求，那小明說什么都得滿足呀，這還不簡單嘛。
傳統(tǒng)驗證
[HttpPost]
public async Task<ActionResult<Todo>> PostTodo(Todo todo)
{
if (string.IsNullOrEmpty(todo.Name))
{
return Ok("名稱不能為空");
}
context.Todo.Add(todo);
await context.SaveChangesAsync();
return CreatedAtAction("GetTodo", new { id = todo.Id }, todo);
}
小明寫著寫著發(fā)現(xiàn)這樣寫，很多接口相同得地方都要寫，使得代碼比較臃腫。
使用模型驗證
在參數(shù)模型上打上注解
namespace App001.Models
{
/// <summary>
/// 待辦事項
/// </summary>
public class Todo
{
/// <summary>
/// ID
/// </summary>
public Guid Id { get; set; }
/// <summary>
/// 名稱
/// </summary>
[Required(ErrorMessage = "名稱不能為空")]
public string Name { get; set; }
}
}
Postman測試Name傳值未空時，則返回：
{
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"traceId": "|df184e36-4e11844dfd38a626.",
"errors": {
"Name": [
"名稱不能為空"
]
}
}
注意Web API 控制器具有 [ApiController] 特性，則它們不必檢查ModelState.IsValid。在此情況下，如果模型狀態(tài)無效，將返回包含錯誤詳細信息的自動 HTTP 400 響應。
內(nèi)置特性
- [CreditCard]：驗證屬性是否具有信用卡格式。
- [Compare]：驗證模型中的兩個屬性是否匹配。
- [EmailAddress]：驗證屬性是否具有電子郵件格式。
- [Phone]：驗證屬性是否具有電話號碼格式。
- [Range]：驗證屬性值是否在指定的范圍內(nèi)。
- [RegularExpression]：驗證屬性值是否與指定的正則表達式匹配。
- [Required]：驗證字段是否不為 null。
- [StringLength]：驗證字符串屬性值是否不超過指定長度限制。
- [Url]：驗證屬性是否具有 URL 格式。
- [Remote]：通過在服務器上調(diào)用操作方法來驗證客戶端上的輸入。
Error messages
通過驗證特性可以指定要為無效輸入顯示的錯誤消息。 例如：
[Required(ErrorMessage = "名稱不能為空")]
使用自定義返回消息格式
有兩種方式：
- 使用自定義過濾器
- 使用默認模型驗證，需要在控制器上面加上【ApiController】。
使用自定義過濾器
首先，創(chuàng)建ModelValidateActionFilterAttribute過濾器。
public class ModelValidateActionFilterAttribute : ActionFilterAttribute
{
public override void OnActionExecuting(ActionExecutingContext context)
{
if (!context.ModelState.IsValid)
{
//獲取驗證失敗的模型字段
var errors = context.ModelState
.Where(e => e.Value.Errors.Count > 0)
.Select(e => e.Value.Errors.First().ErrorMessage)
.ToList();
var str = string.Join("|", errors);
//設置返回內(nèi)容
var result = new
{
Code = 10000,
Msg = "未通過數(shù)據(jù)驗證。",
FullMsg = str
};
context.Result = new BadRequestObjectResult(result);
}
}
}
然后，Startup.ConfigureServices將過濾器添加到控制器中并關閉默認模型驗證，另外我們還添加了AddNewtonsoftJson。
//關閉默認模型驗證
services.Configure<ApiBehaviorOptions>(opt => opt.SuppressModelStateInvalidFilter = true);
services.AddControllers(opt =>
{
//添加過濾器
opt.Filters.Add(typeof(ModelValidateActionFilterAttribute));
}).AddNewtonsoftJson(opt =>
{
//json字符串大小寫原樣輸出
opt.SerializerSettings.ContractResolver = new DefaultContractResolver();
});
最后，我們看一下返回效果：
{
"Code": 10000,
"Msg": "未通過數(shù)據(jù)驗證。",
"FullMsg": "名稱不能為空。"
}
使用默認模型驗證
services.Configure<ApiBehaviorOptions>(opt =>
{
opt.InvalidModelStateResponseFactory = actionContext =>
{
//獲取驗證失敗的模型字段
var errors = actionContext.ModelState
.Where(e => e.Value.Errors.Count > 0)
.Select(e => e.Value.Errors.First().ErrorMessage)
.ToList();
var str = string.Join("|", errors);
//設置返回內(nèi)容
var result = new
{
Code = 10000,
Msg = "未通過數(shù)據(jù)驗證。",
FullMsg = str
};
return new BadRequestObjectResult(result);
};
});
小結
目前為止，小明把數(shù)據(jù)驗證也搞定了，是不是so easy！
到此這篇關于手把手教你AspNetCore WebApi數(shù)據(jù)驗證的實現(xiàn)的文章就介紹到這了,更多相關AspNetCore WebApi數(shù)據(jù)驗證內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
相關文章
.Net?core?Blazor+自定義日志提供器實現(xiàn)實時日志查看器的原理解析
我們經(jīng)常遠程連接服務器去查看日志，比較麻煩，如果直接訪問項目的某個頁面就能實時查看日志就比較奈斯了，結合blazor實現(xiàn)了基本效果，這篇文章主要介紹了.Net?core?Blazor+自定義日志提供器實現(xiàn)實時日志查看器,需要的朋友可以參考下2022-10-10
圖片/文件服務器，顧名思義就是存文件唄，有的人用阿里云的現(xiàn)有服務，有的把文件Post到文件服務器，在文件服務器一端用一個應用程序來接收并保存，方法各不相同。下面跟著小編一起來看下吧2017-01-01
這篇文章主要給大家介紹了關于.Net Core中Api版本控制的相關資料，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2018-10-10
asp.net中virtual和abstract的區(qū)別分析
這篇文章主要介紹了asp.net中virtual和abstract的區(qū)別,較為詳細的分析了virtual與abstract的概念與具體用法,并以實例的形式予以總結歸納,需要的朋友可以參考下2014-10-10
一個Asp.Net的顯示分頁方法 附加實體轉(zhuǎn)換和存儲過程 帶源碼下載
現(xiàn)在自己寫的webform都不用服務器控件了，所以自己仿照aspnetpager寫了一個精簡實用的返回分頁顯示的html方法，其他話不說了，直接上代碼2012-10-10
這篇文章主要給大家介紹了關于.NET?Core中簡單的郵箱格式校驗方式的相關資料,文中通過實例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2022-03-03
ASP.net:保持頁面中滾動條的位置，使得頁面提交后還在原來的位置,對于頁面中DIV等等的滾動條控制，我在看了別人代碼后，寫了一個，感興趣的朋友可以參考下哈2013-04-04
這篇文章主要為大家詳細介紹了MVC使用MvcPager實現(xiàn)分頁效果，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下2022-03-03
ASP.NET Core Controller與IOC結合問題整理
在本篇文章里小編給大家整理了一篇關于ASP.NET Core Controller與IOC結合問題整理內(nèi)容，有需要的朋友們可以學習下。2021-01-01
ASP.NET 2.0中預設的cookie...2006-09-09