基於 .NET 的 FluentValidation 數據驗證

學習地址：官方文檔，更多更詳細的內容可以看官方文檔。

FluentValidation 是一個基於 .NET 開發的驗證框架，開源免費，而且優雅，支持鏈式操作，易於理解，功能完善，還是可與 MVC5、WebApi2 和 ASP.NET CORE 深度集成，組件內提供十幾種常用驗證器，可擴展性好，支持自定義驗證器，支持本地化多語言。

要使用驗證框架, 需要在項目中添加對 FluentValidation.dll 的引用，支持 netstandard2.0 庫和 .NET4.5 平台，支持.NET Core 平台，最簡單的方法是使用 NuGet 包管理器引用組件。我這裡安裝的是9.2.0版本。

Install-Package FluentValidation

若要在 ASP.NET Core 中使用 FluentValidation 擴展，可引用以下包：

Install-Package FluentValidation.AspNetCore

若要在 ASP.NET MVC 5 或 WebApi 2 項目集成, 可以使用分別使用 FluentValidation.Mvc5 和 FluentValidation.WebApi 程序包。

Install-Package FluentValidation.Mvc5
Install-Package FluentValidation.WebApi

創建第一個驗證程序

若要為特定對象定義一組驗證規則, 您需要創建一個從 AbstractValidator<T> 繼承的類, 其中泛型T參數是要驗證的類的類型。假設您有一個客戶類別:

public class Customer {
  public int Id { get; set; }
  public string Surname { get; set; }
  public string Forename { get; set; }
  public decimal Discount { get; set; }
  public string Address { get; set; }
}

接下來自定義繼承於 AbstractValidator 泛型類的驗證器，然後在構造函數中使用 LINQ 表達式編寫 RuleFor 驗證規則，使驗證在。

using FluentValidation;
using NetCoreBasicLearning.Entity;

namespace NetCoreBasicLearning
{
    public class CustomerValidator : AbstractValidator<Customer>
    {
        public CustomerValidator()
        {
            RuleFor(customer => customer.Surname).NotNull();
        }
    }
}

若要執行驗證程序，我們通過定義好的 CustomerValidator 驗證器傳入實體類 Customer 即可。

該驗證方法返回一個 ValidationResult 對象，表示驗證結果，ValidationResult 包含兩個屬性：IsValid屬性是布爾值, 它表示驗證是否成功，Errors屬性包含相關驗證失敗的詳細信息。

public IActionResult Index(string id)
{
　　Customer customer = new Customer();
　　CustomerValidator validationRules = new CustomerValidator();
　　ValidationResult validationResult = validationRules.Validate(customer);

　　if (!validationResult.IsValid)
　　{
　　　　var str = new StringBuilder();
   　　foreach(var t in validationResult.Errors)
　　　　{
　　　　　　str.AppendLine($"屬性：{t.PropertyName},錯誤信息：{t.ErrorMessage}");
　　　　}
　　　　return Content(str.ToString());
　　}
　　return View();
}

鏈接規則寫法

您可以將對象的同一屬性用多個驗證程序鏈在一起，以下代碼將驗證 Surname 屬性不為 Null 的同時且不等於foo字符串。

using FluentValidation;
using NetCoreBasicLearning.Entity;

namespace NetCoreBasicLearning
{
    public class CustomerValidator : AbstractValidator<Customer>
    {
        public CustomerValidator()
        {
            RuleFor(customer => customer.Surname).NotNull().NotEqual("foo");
        }
    }
}

引發異常

如果驗證失敗, 不想返回 ValidationResult 對象，而是想直接拋出異常，可通過調用驗證器的 ValidateAndThrow 進行驗證。

如果驗證失敗，將引發一個 ValidationException 類型的異常，這個異常可以被上層程序捕獲，並從異常中找到詳細錯誤信息。

Customer customer = new Customer();
CustomerValidator validationRules = new CustomerValidator();
validationRules.ValidateAndThrow(customer);

集合

當針對一個集合進行驗證時，只需要定義集合項類型的規則即可，以下規則將對集合中的每個元素運行 NotNull 檢查。

public class Customer
{
    public List<string> OtherAddress { get; set; }
}
public class CustomerValidator : AbstractValidator<Customer>
{
　　public CustomerValidator()
　　{
　　　　RuleForEach(customer => customer.OtherAddress).NotEmpty();
　　}
}

如果要對list進行進行非空判斷可以如下：

public class CustomerValidator : AbstractValidator<Customer>
{
　　public CustomerValidator()
　　{
　　　　RuleFor(customer => customer.OtherAddress).NotEmpty();
　　}
}

複雜屬性

 驗證程序可以用於複雜屬性，假設您有兩個類：客戶和地址

public class Customer
{
    public Adress Address { get; set; }
}
public class Adress
{
    public string City { get; set; }
    public string Province { get; set; }
}

然後定義一個基於地址的 AddressValidator 驗證器件：

public class AdressValidator : AbstractValidator<Adress>
{
    public AdressValidator()
    {
        RuleFor(t => t.City).NotEmpty();
        RuleFor(t => t.Province).NotEmpty();
    }
}

然後定義一個基於客戶的 CustomerValidator 驗證器件，對地址驗證時使用地址驗證器。

public class CustomerValidator : AbstractValidator<Customer>
{
    public CustomerValidator()
    {
        RuleFor(t => t.Address).SetValidator(new AdressValidator());
    }
}

 如果不想要創建另一個驗證器可以直接內聯定義子規則：

RuleFor(t => t.Address.City).NotEmpty();

另外，還可以在集合屬性上使用驗證程序，假設客戶對象包含地址集合屬性：

public class Customer
{
    public List<Adress> Address { get; set; }
 }

此驗證程序可在 CustomerValidator 中通過 SetCollectionValidator（在8.0版本以前） 方法使用，在8.0版本以及之後被棄用需要使用RuleForEach來驗證:

public class CustomerValidator : AbstractValidator<Customer>
{
     public CustomerValidator()
    {
        RuleForEach(t => t.Address).SetValidator(new AdressValidator());
        //RuleFor(x => x.Address).SetCollectionValidator(new AdressValidator());在8.0版本及以後棄用
    }
}

在編寫驗證規則時，可以通過 Where 關鍵字排除或者篩選不需要驗證的對象。

public class CustomerValidator : AbstractValidator<Customer>
{
    public CustomerValidator()
    {
        RuleForEach(t => t.Address).Where(t => !string.IsNullOrEmpty(t.City)).SetValidator(new AdressValidator());
        //RuleFor(x => x.Address).SetCollectionValidator(new AdressValidator()).Where(t => !string.IsNullOrEmpty(t.City));在8.0版本及以後棄用
    }
}

從FluentValidation 8.5開始，您還可以使用以下ChildRules方法在線定義子集合元素的規則，從而不用再定義另一個驗證器：

RuleForEach(t => t.Address).ChildRules(adderss => {
    adderss.RuleFor(t => t.City).NotEmpty();
    adderss.RuleFor(t => t.Province).NotEmpty();
}).NotEmpty();

 支持規則集

規則集允許您將驗證規則分組在一起，這些規則可以作為一個組一起執行，而忽略其他規則：

我們可以把「姓」和「名」統一加在一個姓名規則集中。

public class CustomerValidator : AbstractValidator<Customer>
{
    public CustomerValidator()
    {
        RuleSet("Name", () =>
        {
            RuleFor(t => t.Surname).NotEmpty();
            RuleFor(t => t.Forename).NotEmpty();
        });
    }
}

規則集通過一般的 Validate 方法是不會執行驗證的，需要用如下方法進行單獨的驗證，這將複雜的驗證器定義分解為較小的部分進行驗證，IncludeRuleSets 中可以傳入多個規則集名稱來執行多個規則集的驗證：

Customer customer = new Customer();
CustomerValidator validationRules = new CustomerValidator();
ValidationResult validationResult = validationRules.Validate(customer, options => options.IncludeRuleSets("Name"));

還可以通過 IncludeRulesNotInRuleSet 方法或使用特殊名稱「默認」（不區分大小寫）來執行驗證所有不屬於規則集的規則：

ValidationResult validationResult = validationRules.Validate(customer, options =>{ options.IncludeRulesNotInRuleSet(); options.IncludeRuleSets("Name"); } );

可以通過調用強制執行所有規則，而不管它們是否在規則集中 IncludeAllRuleSets（這等效於using IncludeRuleSets("*")）。

同個類型的多個驗證器

一個驗證器可以包含多個其他的驗證器，只要這些驗證器都是驗證統一類型的即可。這樣就可以拆分驗證器，通過不同的需求組合在一起：

public class CustomerValidator : AbstractValidator<Customer>
{
    public CustomerValidator()
    {
        Include(new CustomerSurnameValidator());
        Include(new CustomerForenameValidator());
    }
}
public class CustomerSurnameValidator : AbstractValidator<Customer>
{
    public CustomerSurnameValidator()
    {
        RuleFor(t => t.Surname).NotEmpty();
    }
}
public class CustomerForenameValidator : AbstractValidator<Customer>
{
    public CustomerForenameValidator()
    {
        RuleFor(t => t.Forename).NotEmpty();
    }
}

 繼承驗證

從FluentValidation 9.2開始，如果您的對象屬性作為其他類的基類或接口，則可以為各個子類/實現器設置特定的子驗證器，來驗證這個屬性。我們的類設置如下：

public class Store
{
    public People Peoples { get; set; }
}
public class Customer : People
{
    public string Address { get; set; }
}
public class People
{
    public string Name { get; set; }
}

驗證器如下：

public class StoreValidator : AbstractValidator<Store>
{
    public StoreValidator()
    {
        RuleFor(t => t.Peoples).NotNull().SetInheritanceValidator(t =>
        {
             t.Add<Customer>(new CustomerValidator());
        });
    }
}
 public class CustomerValidator : AbstractValidator<Customer>
{
    public CustomerValidator()
    {
        RuleFor(t => t.Address).NotEmpty();
    }
}

覆蓋消息

通過在驗證程序上調用 WithMessage 方法, 可以覆蓋驗證程序的默認驗證錯誤消息。錯誤提示中，可以通過 {PropertyName} 佔位符替換屬性名。除了 {PropertyName} 佔位符，框架還內置了：{PropertyValue}、{ComparisonValue}、{MinLength}、{MaxLength}和{TotalLength} 佔位符，關於更多內置佔位符，可以參閱官方文檔。

RuleFor(customer => customer.Surname).NotNull().WithMessage("Please ensure you have entered your {PropertyName}");

驗證程序支持通過 WithName 方法來指定屬性別名，以下代碼輸出姓名不能為空。請注意，這僅替換錯誤消息中屬性的名稱。當您檢查上的Errors集合時ValidationResult，此錯誤仍將與一個名為的屬性相關聯Surname。如果要完全重命名該屬性，則可以使用OverridePropertyName方法。

RuleFor(customer => customer.Surname).NotNull().WithName("姓名");

 條件

When 和 Unless方法可用於執行滿足指定條件情況下的規則，例如只當Surname屬性不為空的時候，才執行前面的Name屬性的非空驗證（Unless和When是相反的所以這邊只講When就行啦！）：

RuleFor(t => t.Name).NotEmpty().When(t => !string.IsNullOrEmpty(t.Surname));

如果需要指定多個規則在相同的條件下才執行驗證，可以直接用頂級的When方法：

public class CustomerValidator : AbstractValidator<Customer>
{
    public CustomerValidator()
    {
        When(t => !string.IsNullOrEmpty(t.Surname), () => { RuleFor(t => t.Name).NotEmpty();//其他驗證規則 });
    }
}

通過在When方法後面追加一個Otherwise方法，可以執行不滿足When中調整的驗證規則，如下:

When(t => !string.IsNullOrEmpty(t.Surname), () => { RuleFor(t => t.Name).NotEmpty(); }).Otherwise(() => { RuleFor(t => t.Name).Equal("哈哈"); });

默認情況下，FluentValidation會將條件應用於對的同一調用中的所有先前的驗證器RuleFor。比如下面這條代碼，如果Surname不為空，則對Name進行非空和是否等於11的驗證，否則不會對Name執行這兩個驗證：

RuleFor(t => t.Name).NotEmpty().Equal("11").When(t => !string.IsNullOrEmpty(t.Surname));

如果僅希望將條件應用於緊接條件之前的驗證器，則必須明確參數ApplyConditionTo.CurrentValidator，如下，只有Equal受到When方法的限制，NotEmpty不管When是否為true都會執行的。

RuleFor(t => t.Name).NotEmpty().Equal("11").When(t => !string.IsNullOrEmpty(t.Surname), ApplyConditionTo.CurrentValidator);

設置級聯模式

有兩種聯級模式：

  • Continue （默認設置）-始終調用規則定義中的所有驗證器
  • Stop -驗證程序失敗後立即停止執行規則（僅在FluentValidation 9.1和更高版本中可用，在舊版本中，您可以改用StopOnFirstFailure）

通過如下代碼，可以在NotNull驗證不通過的時候就停止驗證，不再執行NotEqual的驗證。默認是驗證不通過，也繼續驗證下去。

RuleFor(x => x.Surname).Cascade(CascadeMode.Stop).NotNull().NotEqual("foo");

設置嚴重性級別

默認情況下，如果這些規則失敗，則嚴重性為「錯誤」。可以通過調用WithSeverity方法來更改。例如，如果我們希望將缺少的姓氏標識為警告而不是錯誤，則可以將上面的行修改為：

RuleFor(x => x.Surname).NotNull().WithSeverity(Severity.Warning);

在9.0及更高版本中，可以改用回調，這也使您可以訪問正在驗證的項目：

RuleFor(person => person.Surname).NotNull().WithSeverity(person => Severity.Warning);

定製驗證器

之前我們都是使用內置的驗證器，如Equal、NotNull等等。

我們也可以自己定義驗證器，實現自定義驗證器的最簡單方法是使用Must方法，該方法在內部使用PredicateValidator。假設我們有以下課程：

public class Person {
  public IList<Pet> Pets {get;set;} = new List<Pet>();
}

為了確保我們的list屬性包含少於10個項目，我們可以這樣做：

public class PersonValidator : AbstractValidator<Person> {
  public PersonValidator() {
    RuleFor(x => x.Pets).Must(list => list.Count < 10)
      .WithMessage("The list must contain fewer than 10 items");
  }
}

為了使我們自己定義的驗證器可以重用，我們可以將其包裝為可作用於任何List<T>類型的擴展方法。

public static class MyCustomValidators {
  public static IRuleBuilderOptions<T, IList<TElement>> ListMustContainFewerThan<T, TElement>(this IRuleBuilder<T, IList<TElement>> ruleBuilder, int num) {
    return ruleBuilder.Must(list => list.Count < num).WithMessage("The list contains too many items");
  }
}

在這裡，我們在上創建一個擴展方法IRuleBuilder<T,TProperty>，並使用通用類型約束來確保此方法僅出現在對列表類型的智能感知中。在方法內部，我們以與以前相同的方式調用Must方法，但是這次我們在傳入的RuleBuilder實例上調用它。我們還將要比較的項目數作為參數傳遞。現在，我們的規則定義可以重寫為使用以下方法：

RuleFor(x => x.Pets).ListMustContainFewerThan(10);

我們還可以通過Custom方法來自定義驗證器，它相比於Must的好處是允許針對同一規則返回多個錯誤（通過context.AddFailure多次調用該方法）。

public class PersonValidator : AbstractValidator<Person> {
  public PersonValidator() {
   RuleFor(x => x.Pets).Custom((list, context) => {
     if(list.Count > 10) {
       context.AddFailure("The list must contain 10 items or fewer");
     }
   });
  }
}

 

Tags:

VirMach 便宜 VPS

QNews

QNews