不用說(shuō)，規(guī)則驗(yàn)證很重要，無(wú)效的參數(shù)，可能會(huì)導(dǎo)致程序的異常。

如果使用Web API或MVC頁(yè)面，那么可能習(xí)慣了自帶的規(guī)則驗(yàn)證，我們的控制器很干凈：

public class User {[Required]public string FirstName { get; set; }[Required]public string LastName { get; set; } }

這種很常見(jiàn)，但是今天我想給你一個(gè)更好的替代方案：FluentValidation， 通過(guò)這個(gè)庫(kù)，您可以流暢地定義用于對(duì)象驗(yàn)證的復(fù)雜規(guī)則，從而輕松構(gòu)建和理解驗(yàn)證規(guī)則，您可以在?Github^[1]?上找到這個(gè)項(xiàng)目。

安裝 FluentValidation

我新建了一個(gè)很簡(jiǎn)單的.NET Core 的Web API 程序，只有一個(gè)接口是用戶注冊(cè)，入?yún)⑹且粋€(gè)User類, 然后在Nuget中安裝?FluentValidation。

創(chuàng)建第一個(gè)驗(yàn)證

對(duì)于要驗(yàn)證的每個(gè)類，必須創(chuàng)建其自己的驗(yàn)證器，每個(gè)驗(yàn)證器類都必須繼承AbstractValidator<T>，其中T是要驗(yàn)證的類,并且所有驗(yàn)證規(guī)則都在構(gòu)造函數(shù)中定義。

最簡(jiǎn)單的驗(yàn)證是針對(duì)空值，如果要指定FirstName和LastName都不能為空，這個(gè)驗(yàn)證器是這樣：

public class UserValidator : AbstractValidator<User> {public UserValidator(){RuleFor(x => x.FirstName).NotEmpty();RuleFor(x => x.LastName).NotEmpty();} }

就這些了，您已經(jīng)創(chuàng)建了第一個(gè)驗(yàn)證器，是不是超級(jí)簡(jiǎn)單！

還有一些其他的規(guī)則，比如 MinimumLength，MaximumLength和Length，用于驗(yàn)證長(zhǎng)度，您可以把多個(gè)規(guī)則指定到一個(gè)字段，就像這樣：

public class UserValidator : AbstractValidator<User> {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)證入?yún)?/h2>

我們之前已經(jīng)定義了驗(yàn)證規(guī)則，現(xiàn)在開(kāi)始使用它，您只需要new 一個(gè)UserValidator對(duì)象，然后調(diào)用Validate方法, 它會(huì)返回一個(gè)對(duì)象，其中包含了驗(yàn)證狀態(tài)和所有沒(méi)有通過(guò)驗(yàn)證的信息。

[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(); }

如果我運(yùn)行程序，然后輸入一個(gè)超長(zhǎng)的名字：

{"FirstName": "趙錢孫李周吳鄭王馮陳褚衛(wèi)蔣沈韓楊朱秦尤許何呂施張","LastName": "張" }

我會(huì)收到驗(yàn)證錯(cuò)誤："The length of 'First Name' must be 20 characters or fewer. You entered 24 characters"。

好吧，我不喜歡這個(gè)消息，那么你可以自定義錯(cuò)誤消息，這很簡(jiǎn)單，您可以使用 WithMessage 方法。

- RuleFor(x => x.FirstName).MaximumLength(20); + RuleFor(x => x.FirstName).MaximumLength(20).WithMessage("您的名字長(zhǎng)度已經(jīng)超出了限制!");

流利驗(yàn)證

你可以把驗(yàn)證規(guī)則，改成下邊這樣：

- RuleFor(x => x.FirstName).NotEmpty(); - RuleFor(x => x.FirstName).MinimumLength(3); + RuleFor(x => x.FirstName).NotEmpty().MinimumLength(3);

然后也可以把驗(yàn)證規(guī)則應(yīng)用于其他的屬性，就像這樣：

public UserValidator() {RuleFor(x => x.FirstName).MaximumLength(20).WithMessage("您的名字長(zhǎng)度已經(jīng)超出了限制!").NotEmpty().MinimumLength(3);RuleFor(x => x.LastName).NotEmpty(); }

常見(jiàn)的驗(yàn)證規(guī)則

這個(gè)庫(kù)有很多現(xiàn)成的基本類型驗(yàn)證規(guī)則, 對(duì)于字符串，您可以使用不同的方法，比如 EmailAddress，IsEnumName（檢查值是否在指定的Enum類型中定義）和 InclusiveBetween, 檢查該值是否在定義的范圍內(nèi)。

現(xiàn)在，我在User類添加了另外兩個(gè)字段，Password 和 ConfirmPassword。

Password字段是一個(gè)字符串，有效的長(zhǎng)度必須在5到15個(gè)字符之間，并且要符合正則，為了定義是否滿足安全規(guī)則，我定義了一個(gè)HasValidPassword方法，它會(huì)返回一個(gè)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)); }

然后在密碼驗(yàn)證中使用：

RuleFor(x => x.FirstName).MaximumLength(20).WithMessage("您的名字長(zhǎng)度已經(jīng)超出了限制!").NotEmpty().MinimumLength(3);RuleFor(x => x.LastName).NotEmpty();RuleFor(x => x.Password).Length(5, 15).Must(x => HasValidPassword(x));

還可以簡(jiǎn)化一些：

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次密碼不一致！");

注入驗(yàn)證器

修改Startup類中的ConfigureServices方法：

public void ConfigureServices(IServiceCollection services) {services.AddControllers().AddFluentValidation();services.AddTransient<IValidator<User>, UserValidator>(); }

注意：這個(gè)地方的生命周期是 Transient。

這樣，在調(diào)用注冊(cè)接口的時(shí)候，會(huì)自動(dòng)進(jìn)行規(guī)則驗(yàn)證：

[HttpPost] public IActionResult Register(User newUser) {return Ok(); }

然后，我們?cè)賴L試傳入?yún)?shù)來(lái)調(diào)用接口：

{"FirstName": "趙錢孫李周吳鄭王馮陳褚衛(wèi)蔣沈韓楊朱秦尤許何呂施張","LastName": "張" }

很明顯，驗(yàn)證不通過(guò)，接口會(huì)返回這樣的錯(cuò)誤信息：

{"type": "https://tools.ietf.org/html/rfc7231#p-6.5.1","title": "One or more validation errors occurred.","status": 400,"traceId": "|c4523c02-4899b7f3df86a629.","errors": { "FirstName": ["您的名字長(zhǎng)度已經(jīng)超出了限制!"]} }

希望對(duì)您有幫助，您可以在官方文檔中找到更多的用法。

原文鏈接：?https://www.code4it.dev/blog/fluentvalidation^[2]

最后

歡迎掃碼關(guān)注我們的公眾號(hào) 【全球技術(shù)精選】，專注國(guó)外優(yōu)秀博客的翻譯和開(kāi)源項(xiàng)目分享，也可以添加QQ群 897216102

References

[1]?Github:?"https://github.com/FluentValidation/FluentValidation"
[2]?https://www.code4it.dev/blog/fluentvalidation:?"https://www.code4it.dev/blog/fluentvalidation"

創(chuàng)作挑戰(zhàn)賽新人創(chuàng)作獎(jiǎng)勵(lì)來(lái)咯，堅(jiān)持創(chuàng)作打卡瓜分現(xiàn)金大獎(jiǎng)

總結(jié)

以上是生活随笔為你收集整理的在.NET Core 中使用 FluentValidation 进行规则验证的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。