不用說,規(guī)則驗證很重要,無效的參數(shù),可能會導致程序的異常。
如果使用Web API或MVC頁面,那么可能習慣了自帶的規(guī)則驗證,我們的控制器很干凈:
public class User
{
[Required]
public string FirstName { get; set; }
[Required]
public string LastName { get; set; }
}
這種很常見,但是今天我想給你一個更好的替代方案:FluentValidation, 通過這個庫,您可以流暢地定義用于對象驗證的復雜規(guī)則,從而輕松構建和理解驗證規(guī)則,您可以在 Github 上找到這個項目。
安裝 FluentValidation
我新建了一個很簡單的.NET Core 的Web API 程序,只有一個接口是用戶注冊,入?yún)⑹且粋€User類, 然后在Nuget中安裝 FluentValidation
。
創(chuàng)建第一個驗證
對于要驗證的每個類,必須創(chuàng)建其自己的驗證器,每個驗證器類都必須繼承AbstractValidatorT>
,其中T是要驗證的類,并且所有驗證規(guī)則都在構造函數(shù)中定義。
最簡單的驗證是針對空值,如果要指定FirstName和LastName都不能為空,這個驗證器是這樣:
public class UserValidator : AbstractValidatorUser>
{
public UserValidator()
{
RuleFor(x => x.FirstName).NotEmpty();
RuleFor(x => x.LastName).NotEmpty();
}
}
就這些了,您已經(jīng)創(chuàng)建了第一個驗證器,是不是超級簡單!
還有一些其他的規(guī)則,比如 MinimumLength,MaximumLength和Length,用于驗證長度,您可以把多個規(guī)則指定到一個字段,就像這樣:
public class UserValidator : AbstractValidatorUser>
{
public UserValidator()
{
RuleFor(x => x.FirstName).NotEmpty();
RuleFor(x => x.FirstName).MinimumLength(3);
RuleFor(x => x.FirstName).MaximumLength(20);
RuleFor(x => x.LastName).NotEmpty();
}
}
驗證入?yún)?/h2>
我們之前已經(jīng)定義了驗證規(guī)則,現(xiàn)在開始使用它,您只需要new 一個UserValidator對象,然后調(diào)用Validate方法, 它會返回一個對象,其中包含了驗證狀態(tài)和所有沒有通過驗證的信息。
[HttpPost]
public IActionResult Register(User newUser)
{
var validator = new UserValidator();
var validationResult = validator.Validate(newUser);
if (!validationResult.IsValid)
{
return BadRequest(validationResult.Errors.First().ErrorMessage);
}
return Ok();
}
如果我運行程序,然后輸入一個超長的名字:
{
"FirstName": "趙錢孫李周吳鄭王馮陳褚衛(wèi)蔣沈韓楊朱秦尤許何呂施張",
"LastName": "張"
}
我會收到驗證錯誤:"The length of 'First Name' must be 20 characters or fewer. You entered 24 characters"。
好吧,我不喜歡這個消息,那么你可以自定義錯誤消息,這很簡單,您可以使用 WithMessage 方法。
- RuleFor(x => x.FirstName).MaximumLength(20);
+ RuleFor(x => x.FirstName).MaximumLength(20).WithMessage("您的名字長度已經(jīng)超出了限制!");
流利驗證
你可以把驗證規(guī)則,改成下邊這樣:
- RuleFor(x => x.FirstName).NotEmpty();
- RuleFor(x => x.FirstName).MinimumLength(3);
+ RuleFor(x => x.FirstName).NotEmpty().MinimumLength(3);
然后也可以把驗證規(guī)則應用于其他的屬性,就像這樣:
public UserValidator()
{
RuleFor(x => x.FirstName)
.MaximumLength(20).WithMessage("您的名字長度已經(jīng)超出了限制!")
.NotEmpty().MinimumLength(3);
RuleFor(x => x.LastName).NotEmpty();
}
常見的驗證規(guī)則
這個庫有很多現(xiàn)成的基本類型驗證規(guī)則, 對于字符串,您可以使用不同的方法,比如 EmailAddress,IsEnumName(檢查值是否在指定的Enum類型中定義)和 InclusiveBetween, 檢查該值是否在定義的范圍內(nèi)。
現(xiàn)在,我在User類添加了另外兩個字段,Password 和 ConfirmPassword。
Password字段是一個字符串,有效的長度必須在5到15個字符之間,并且要符合正則,為了定義是否滿足安全規(guī)則,我定義了一個HasValidPassword方法,它會返回一個bool值。
private bool HasValidPassword(string pw)
{
var lowercase = new Regex("[a-z]+");
var uppercase = new Regex("[A-Z]+");
var digit = new Regex("(\\d)+");
var symbol = new Regex("(\\W)+");
return (lowercase.IsMatch(pw) uppercase.IsMatch(pw) digit.IsMatch(pw) symbol.IsMatch(pw));
}
然后在密碼驗證中使用:
RuleFor(x => x.FirstName)
.MaximumLength(20).WithMessage("您的名字長度已經(jīng)超出了限制!")
.NotEmpty().MinimumLength(3);
RuleFor(x => x.LastName).NotEmpty();
RuleFor(x => x.Password)
.Length(5, 15)
.Must(x => HasValidPassword(x));
還可以簡化一些:
RuleFor(x => x.Password)
.Length(5, 15)
- .Must(x => HasValidPassword(x));
+ .Must(HasValidPassword);
}
ConfirmPassword字段的唯一要求是等于Password字段:
RuleFor(x => x.ConfirmPassword)
.Equal(x => x.Password)
.WithMessage("2次密碼不一致!");
注入驗證器
修改Startup類中的ConfigureServices方法:
public void ConfigureServices(IServiceCollection services)
{
services.AddControllers().AddFluentValidation();
services.AddTransientIValidatorUser>, UserValidator>();
}
注意:這個地方的生命周期是 Transient。
這樣,在調(diào)用注冊接口的時候,會自動進行規(guī)則驗證:
[HttpPost]
public IActionResult Register(User newUser)
{
return Ok();
}
然后,我們再嘗試傳入?yún)?shù)來調(diào)用接口:
{
"FirstName": "趙錢孫李周吳鄭王馮陳褚衛(wèi)蔣沈韓楊朱秦尤許何呂施張",
"LastName": "張"
}
很明顯,驗證不通過,接口會返回這樣的錯誤信息:
{
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"traceId": "|c4523c02-4899b7f3df86a629.",
"errors": {
"FirstName": [
"您的名字長度已經(jīng)超出了限制!"
]
}
}
希望對您有幫助,您可以在官方文檔中找到更多的用法。
原文鏈接: https://www.code4it.dev/blog/fluentvalidation
到此這篇關于在.NET Core 中使用 FluentValidation 進行規(guī)則驗證的文章就介紹到這了,更多相關.NET Core 規(guī)則驗證內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家!
您可能感興趣的文章:- .Net Core3.0 WEB API中使用FluentValidation驗證(批量注入)
- ASP.NET Core WebApi中使用FluentValidation驗證數(shù)據(jù)模型的方法
- ASP.NET Core使用自定義驗證屬性控制訪問權限詳解
- Asp.Net Core中基于Session的身份驗證的實現(xiàn)
- .NET Core 2.0如何生成圖片驗證碼完整實例