欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

.NET业务实体类验证组件Fluent Validation

程序员文章站 2022-07-02 20:11:31
认识Fluent Vaidation.   看到NopCommerce项目中用到这个组建是如此的简单,将数据验证从业务实体类中分离出来,真是一个天才的想法,后来才知道这个东西是一...
认识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项目中也支持。

 

怎么使用:  

  是不是好用,还要看使用时是否真的像其官网建议描述一样。我比较喜欢其官网上的例子,一眼就能看出用法上的感觉,绝对是如其名,流畅,这个也一种解释型语言常见的的一种用法,无限的对一个类型支持无限度个属性扩展。

 

     业务实体类:

 

复制代码

 1 public class Person 

 2 {

 3     public string NameField;

 4     public int Id { get; set; }

 5     public string Surname { get; set; }

 6     public string Forename { get; set; }

 7 

 8     public List<Person> Children { get; set; }

 9     public string[] NickNames { get; set; }

10         

11     public DateTime DateOfBirth { get; set; }

12 

13     public int? NullableInt { get; set; }

14 

15     public Person() 

16     {

17         Children = new List<Person>();

18         Orders = new List<Order>();

19     }

20     

21     public int CalculateSalary()

22     {

23         return 20;

24     }

25 

26     public Address Address { get; set; }

27     public IList<Order> Orders { get; set; }

28 

29     public string Email { get; set; }

30     public decimal Discount { get; set; }

31     public double Age { get; set; }

32     public int AnotherInt { get; set; }

33 

34     public string CreditCard { get; set; }

35 

36     public int? OtherNullableInt { get; set; }

37 }

38 

39 public interface IAddress 

40 {

41     string Line1 { get; set; }

42     string Line2 { get; set; }

43     string Town { get; set; }

44     string County { get; set; }

45     string Postcode { get; set; }

46     Country Country { get; set; }

47 }

48 

49 public class Address : IAddress 

50 {

51     public string Line1 { get; set; }

52     public string Line2 { get; set; }

53     public string Town { get; set; }

54     public string County { get; set; }

55     public string Postcode { get; set; }

56     public Country Country { get; set; }

57     public int Id { get; set; }

58 }

59 

60 public class Country

61 {

62     public string Name { get; set; }

63 }

64 

65 public interface IOrder 

66 {

67     decimal Amount { get; }

68 }

69 

70 public class Order : IOrder 

71 {

72     public string ProductName { get; set; }

73     public decimal Amount { get; set; }

74 }

复制代码

  对Person的指定验证规则:  

 

复制代码

 1 using FluentValidation;

 2 

 3 public class CustomerValidator: AbstractValidator<Customer>

 4 {

 5   public CustomerValidator() 

 6   {

 7     RuleFor(customer => customer.Surname).NotEmpty();

 8     RuleFor(customer => customer.Forename).NotEmpty().WithMessage("Please specify a first name");

 9     RuleFor(customer => customer.Discount).NotEqual(0).When(customer => customer.HasDiscount);

10     RuleFor(customer => customer.Address).Length(20, 250);

11     RuleFor(customer => customer.Postcode).Must(BeAValidPostcode).WithMessage("Please specify a valid postcode");

12   }

13 

14   private bool BeAValidPostcode(string postcode) 

15   {

16     // custom postcode validating logic goes here

17   }

18 }

19 

20 // 手动验证规则

21 Customer customer = new Customer();

22 CustomerValidator validator = new CustomerValidator();

23 ValidationResult results = validator.Validate(customer);

24 

25 bool validationSucceeded = results.IsValid;

26 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的验证规则库中。

 

    

 

复制代码

1 // 在Global.asax.cs中的Applicaton_Start()函数中注册为asp.net mvc默认的验证规则库。

3 // fluent validation

4 FluentValidationModelValidatorProvider provider = new FluentValidationModelValidatorProvider(new AttributedValidatorFactory());

5 ModelValidatorProviders.Providers.Add(provider);

7 DataAnnotationsModelValidatorProvider.AddImplicitRequiredAttributeForValueTypes = false;

复制代码

注意:

  1,)作为Fluent Validation验证规则类须继承AbstractValidator<T>;

 

  2,)我们也可以仿照NopCommerce的处理方法,对AttributeValidatorFactory类的Validator(Type type)函数重写,在特殊的业务环境下支持其他验证规则。