学习.NET验证模块FluentValidation的基本用法（续2：其它常见用法）

最新推荐文章于 2024-01-25 09:50:50 发布

gc_2299

最新推荐文章于 2024-01-25 09:50:50 发布

阅读量894

点赞数 6

分类专栏： dotnet编程文章标签： C# Fluent Validation

本文链接：https://blog.csdn.net/gc_2299/article/details/134587626

版权

dotnet编程专栏收录该内容

185 篇文章 23 订阅

订阅专栏

FluentValidation模块支持调用When和Unless函数设置验证规则的执行条件，其中when函数设置的是满足条件时执行，而Unless函数则是满足条件时不执行，这两个函数的使用示例如及效果如下所示：

 public AppInfoalidator() 
 {
     RuleFor(x=>x.AppName).NotEmpty();
     RuleForEach(x => x.Roles).NotEmpty().WithMessage("角色属性第{CollectionIndex}个集合元素不能为空").MinimumLength(3).WithMessage("角色属性第{CollectionIndex}个集合元素长度不能小于3").When (x=>x.Roles.Count>4);
     RuleForEach(x => x.Users).ChildRules(r =>
     {
         r.RuleFor(r => r.UserName).NotEmpty().MinimumLength(5).WithMessage("用户属性第{CollectionIndex}个集合元素长度不能小于5").MaximumLength(10).NotEqual("test").WithMessage("用户属性第{CollectionIndex}个集合元素值不能等于test").Unless(x=>x.Sex=="男");
     });
 }

在这里插入图片描述
默认情况下When和Unless函数应用于整个验证链中的所有验证函数，如果只想在满足条件时仅影响紧邻When和Unless函数前的验证函数，则需在When和Unless函数中设置第二个参数为ApplyConditionTo.CurrentValidator，这样的话，加入验证链中有4个验证函数，前3个每次都会调用，最后一个验证函数会根据条件调用。使用时可以根据实际需要在需要加调用条件的验证函数后追加When或Unless函数。
在这里插入图片描述

如果是在相同条件下对多个属性进行验证，则可直接调用When或Unless函数，并将对多个属性的验证规则封装成函数作为输入参数，同时FluentValidation模块还提供Otherwise函数，当When或Unless函数条件不满足时，可以调用Otherwise函数中封装的验证规则进行验证。When或Unless函数，再加上Otherwise函数，类似于代码中的if else的逻辑。其使用示例及效果如下所示：

public AppInfoalidator() 
{
    RuleFor(x=>x.AppName).NotEmpty();

    When(x => x.AppState == 0, () =>
    {
        RuleForEach(x => x.Roles).NotEmpty().WithMessage("角色属性第{CollectionIndex}个集合元素不能为空").MinimumLength(3).WithMessage("角色属性第{CollectionIndex}个集合元素长度不能小于3");
    }).
    Otherwise(() =>
    {
        RuleForEach(x => x.Users).ChildRules(r =>
        {
            r.RuleFor(r => r.UserName).NotEmpty().MinimumLength(5).WithMessage("用户属性第{CollectionIndex}个集合元素长度不能小于5").MaximumLength(10).NotEqual("test").WithMessage("用户属性第{CollectionIndex}个集合元素值不能等于test");
        });
    });
}

在这里插入图片描述

如果自定义验证类中对多个属性进行验证，但在某场景下仅需针对单个属性进行验证FluentValidation模块支持在调用验证类的Validate函数时通过输入参数指定需验证的属性，忽略其它属性，使用示例及效果如下所示：

//自定义验证类的构造函数中定义规则
public AppInfoalidator() 
{
    RuleFor(x=>x.AppName).NotEmpty();
    RuleForEach(x => x.Roles).NotEmpty().WithMessage("角色属性第{CollectionIndex}个集合元素不能为空").MinimumLength(3).WithMessage("角色属性第{CollectionIndex}个集合元素长度不能小于3");
    RuleForEach(x => x.Users).ChildRules(r =>
    {
        r.RuleFor(r => r.UserName).NotEmpty().MinimumLength(5).WithMessage("用户属性第{CollectionIndex}个集合元素长度不能小于5").MaximumLength(10).NotEqual("test").WithMessage("用户属性第{CollectionIndex}个集合元素值不能等于test");
    });
}

//调用验证类时指定需验证的属性
 AppInfoalidator appValidator=new AppInfoalidator();
 FluentValidation.Results.ValidationResult result = appValidator.Validate(app, options =>
 {
     options.IncludeProperties(x => x.Roles);
 });

在这里插入图片描述

FluentValidation模块支持在自定义验证类的构造函数中分组验证规则，未分组的规则默认在default组中。调用验证类验证时，如果未指定验证组，则仅执行未分组的验证规则，支持在Validate函数的输入参数中指定单个或多个规则分组，如果要执行所有规则，则分组名称使用通配符*或者直接调用IncludeAllRuleSets函数。规则分组的使用示例及效果如下所示：

//自定义验证类的构造函数中定义规则组
public AppInfoalidator() 
{
    RuleFor(x=>x.AppName).NotEmpty();

    RuleSet("RoleCheck", () =>
    {
        RuleForEach(x => x.Roles).NotEmpty().WithMessage("角色属性第{CollectionIndex}个集合元素不能为空").MinimumLength(3).WithMessage("角色属性第{CollectionIndex}个集合元素长度不能小于3");
    });

    RuleSet("UserCheck", () =>
    {
        RuleForEach(x => x.Users).ChildRules(r =>
        {
            r.RuleFor(r => r.UserName).NotEmpty().MinimumLength(5).WithMessage("用户属性第{CollectionIndex}个集合元素长度不能小于5").MaximumLength(10).NotEqual("test").WithMessage("用户属性第{CollectionIndex}个集合元素值不能等于test");
        });
    });  
}

//调用验证类时指定规则组
//1）调用default和RoleCheck规则组
 AppInfoalidator appValidator=new AppInfoalidator();
 FluentValidation.Results.ValidationResult result = appValidator.Validate(app,options=>
 {
    options.IncludeRuleSets("default", "RoleCheck");
 });

//2) 调用UserCheck规则组
 AppInfoalidator appValidator=new AppInfoalidator();
 FluentValidation.Results.ValidationResult result = appValidator.Validate(app,options=>
 {
    options.IncludeRuleSets("UserCheck");//options.IncludeRuleSets("*")也适用
 }); 

 //3）调用所有规则
 AppInfoalidator appValidator=new AppInfoalidator();
 FluentValidation.Results.ValidationResult result = appValidator.Validate(app,options=>
 {
     options.IncludeAllRuleSets();
 });