在.NET Core 中使用 FluentValidation 進行規則驗證的方法

不用說,規則驗證很重要,無效的參數,可能會導致程序的異常。

如果使用Web API或MVC頁面,那麼可能習慣瞭自帶的規則驗證,我們的控制器很幹凈:

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

這種很常見,但是今天我想給你一個更好的替代方案:FluentValidation, 通過這個庫,您可以流暢地定義用於對象驗證的復雜規則,從而輕松構建和理解驗證規則,您可以在 Github 上找到這個項目。

安裝 FluentValidation

我新建瞭一個很簡單的.NET Core 的Web API 程序,隻有一個接口是用戶註冊,入參是一個User類, 然後在Nuget中安裝 FluentValidation

創建第一個驗證

對於要驗證的每個類,必須創建其自己的驗證器,每個驗證器類都必須繼承AbstractValidator<T>,其中T是要驗證的類,並且所有驗證規則都在構造函數中定義。

最簡單的驗證是針對空值,如果要指定FirstName和LastName都不能為空,這個驗證器是這樣:

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

就這些瞭,您已經創建瞭第一個驗證器,是不是超級簡單!

還有一些其他的規則,比如 MinimumLength,MaximumLength和Length,用於驗證長度,您可以把多個規則指定到一個字段,就像這樣:

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

驗證入參

我們之前已經定義瞭驗證規則,現在開始使用它,您隻需要new 一個UserValidator對象,然後調用Validate方法, 它會返回一個對象,其中包含瞭驗證狀態和所有沒有通過驗證的信息。

[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": "趙錢孫李周吳鄭王馮陳褚衛蔣沈韓楊朱秦尤許何呂施張",
  "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("您的名字長度已經超出瞭限制!");

流利驗證

你可以把驗證規則,改成下邊這樣:

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

然後也可以把驗證規則應用於其他的屬性,就像這樣:

public UserValidator()
{
	RuleFor(x => x.FirstName)
		.MaximumLength(20).WithMessage("您的名字長度已經超出瞭限制!")
		.NotEmpty().MinimumLength(3);

	RuleFor(x => x.LastName).NotEmpty();
}

常見的驗證規則

這個庫有很多現成的基本類型驗證規則, 對於字符串,您可以使用不同的方法,比如 EmailAddress,IsEnumName(檢查值是否在指定的Enum類型中定義)和 InclusiveBetween, 檢查該值是否在定義的范圍內。

現在,我在User類添加瞭另外兩個字段,Password 和 ConfirmPassword。

Password字段是一個字符串,有效的長度必須在5到15個字符之間,並且要符合正則,為瞭定義是否滿足安全規則,我定義瞭一個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("您的名字長度已經超出瞭限制!")
	.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.AddTransient<IValidator<User>, UserValidator>();
}

註意:這個地方的生命周期是 Transient。

這樣,在調用註冊接口的時候,會自動進行規則驗證:

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

然後,我們再嘗試傳入參數來調用接口:

{
  "FirstName": "趙錢孫李周吳鄭王馮陳褚衛蔣沈韓楊朱秦尤許何呂施張",
  "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": [
      "您的名字長度已經超出瞭限制!"
    ]
  }
}

希望對您有幫助,您可以在官方文檔中找到更多的用法。

原文鏈接: https://www.code4it.dev/blog/fluentvalidation

到此這篇關於在.NET Core 中使用 FluentValidation 進行規則驗證的文章就介紹到這瞭,更多相關.NET Core 規則驗證內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet!