認識Fluent Vaidation.
看到NopCommerce項目中用到這個組建是如此的簡單,將數據驗證從業務實體類中分離出來,真是一個天才的想法,後來才知道這個東西是一個開源的輕量級驗證組建。
Fluent Validation 翻譯為:流暢驗證
開源Codeplex其主頁簡介:該組件是一個輕量級的.NET類庫,使用流暢的接口定義和lambda表達式為構建一個業務類的驗證規則(A small validation library for .NET that uses a fluent interface and lambda expression for building validation rules for you business objects.)
這個類庫不僅僅可以使用的asp.net mvc項目中,普通的類庫中也可以使用,當然在asp.net form項目中也支持。
怎麼使用:
是不是好用,還要看使用時是否真的像其官網建議描述一樣。我比較喜歡其官網上的例子,一眼就能看出用法上的感覺,絕對是如其名,流暢,這個也一種解釋型語言常見的的一種用法,無限的對一個類型支持無限度個屬性擴展。
業務實體類:
復制代碼 代碼如下:
public class Person
{
public string NameField;
public int Id { get; set; }
public string Surname { get; set; }
public string Forename { get; set; }
public List<Person> Children { get; set; }
public string[] NickNames { get; set; }
public DateTime DateOfBirth { get; set; }
public int? NullableInt { get; set; }
public Person()
{
Children = new List<Person>();
Orders = new List<Order>();
}
public int CalculateSalary()
{
return 20;
}
public Address Address { get; set; }
public IList<Order> Orders { get; set; }
public string Email { get; set; }
public decimal Discount { get; set; }
public double Age { get; set; }
public int AnotherInt { get; set; }
public string CreditCard { get; set; }
public int? OtherNullableInt { get; set; }
}
public interface IAddress
{
string Line1 { get; set; }
string Line2 { get; set; }
string Town { get; set; }
string County { get; set; }
string Postcode { get; set; }
Country Country { get; set; }
}
public class Address : IAddress
{
public string Line1 { get; set; }
public string Line2 { get; set; }
public string Town { get; set; }
public string County { get; set; }
public string Postcode { get; set; }
public Country Country { get; set; }
public int Id { get; set; }
}
public class Country
{
public string Name { get; set; }
}
public interface IOrder
{
decimal Amount { get; }
}
public class Order : IOrder
{
public string ProductName { get; set; }
public decimal Amount { get; set; }
}
對Person的指定驗證規則:
復制代碼 代碼如下:
using FluentValidation;
public class CustomerValidator: AbstractValidator<Customer>
{
public CustomerValidator()
{
RuleFor(customer => customer.Surname).NotEmpty();
RuleFor(customer => customer.Forename).NotEmpty().WithMessage("Please specify a first name");
RuleFor(customer => customer.Discount).NotEqual(0).When(customer => customer.HasDiscount);
RuleFor(customer => customer.Address).Length(20, 250);
RuleFor(customer => customer.Postcode).Must(BeAValidPostcode).WithMessage("Please specify a valid postcode");
}
private bool BeAValidPostcode(string postcode)
{
// custom postcode validating logic goes here
}
}
// 手動驗證規則
Customer customer = new Customer();
CustomerValidator validator = new CustomerValidator();
ValidationResult results = validator.Validate(customer);
bool validationSucceeded = results.IsValid;
IList<ValidationFailure> failures = results.Errors;
Flent validation怎麼與asp.net mvc驗證庫整合?
如果在asp.net mvc中現實中這麼用,可能會有很多人不會知道他,我們知道Asp.net MVC項目中有自己的驗證機構[企業庫VAB(Validation Application Block),基於Attribute聲明式驗證],其使用方法,也被我們都一直很認可,但其也有很多不夠靈活的,但Fluent Validation確實更靈活一點。使用起來多變性,流暢,而且驗證規則是一個單獨的類,是和業務實體對象分類的,我們不需要翔VAB一樣,需要在業務實體類上使用Attribute注冊驗證規則。
既然其不是ASP.NET MVC的默認驗證規則類庫,我們就需要注冊到ASP.NET MVC的驗證規則庫中。
復制代碼 代碼如下:
// 在Global.asax.cs中的Applicaton_Start()函數中注冊為asp.net mvc默認的驗證規則庫。
// fluent validation
FluentValidationModelValidatorProvider provider = new FluentValidationModelValidatorProvider(new AttributedValidatorFactory());
ModelValidatorProviders.Providers.Add(provider);
DataAnnotationsModelValidatorProvider.AddImplicitRequiredAttributeForValueTypes = false;
注意:
1,)作為Fluent Validation驗證規則類須繼承AbstractValidator<T>;
2,)我們也可以仿照NopCommerce的處理方法,對AttributeValidatorFactory類的Validator(Type type)函數重寫,在特殊的業務環境下支持其他驗證規則。
本文適合對.net以及MVC有所了解的讀者,這裡拋磚引玉,獻丑了