AspNetCore WebApi如何實現數據驗證？相信很多沒有經驗的人對此束手無策，為此本文總結了問題出現的原因和解決方法，通過這篇文章希望你能解決這個問題。
傳統驗證
[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);
}小明寫著寫著發現這樣寫，很多接口相同得地方都要寫，使得代碼比較臃腫。
使用模型驗證
在參數模型上打上注解
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。在此情況下，如果模型狀態無效，將返回包含錯誤詳細信息的自動 HTTP 400 響應。
內置特性
Error messages
通過驗證特性可以指定要為無效輸入顯示的錯誤消息。 例如：
[Required(ErrorMessage = "名稱不能為空")]
使用自定義返回消息格式
有兩種方式：
使用自定義過濾器
首先，創建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);
//設置返回內容
var result = new
{
Code = 10000,
Msg = "未通過數據驗證。",
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": "未通過數據驗證。",
"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);
//設置返回內容
var result = new
{
Code = 10000,
Msg = "未通過數據驗證。",
FullMsg = str
};
return new BadRequestObjectResult(result);
};
});看完上述內容，你們掌握AspNetCore WebApi如何實現數據驗證的方法了嗎？如果還想學到更多技能或想了解更多相關內容，歡迎關注億速云行業資訊頻道，感謝各位的閱讀！
免責聲明：本站發布的內容（圖片、視頻和文字）以原創、轉載和分享為主，文章觀點不代表本網站立場，如果涉及侵權請聯系站長郵箱：is@yisu.com進行舉報，并提供相關證據，一經查實，將立刻刪除涉嫌侵權內容。
