【.Net Core/.Net8教程】(三)如何优雅地校验参数

2024-05-03 09:44
文章标签 参数 校验 教程 优雅 core net net8

本文主要是介绍【.Net Core/.Net8教程】(三)如何优雅地校验参数，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

FluentValidation是一个流行的开源验证库，用于在.NET应用程序中验证输入数据。
它有如下特点

  • 语法简洁
  • 强大的验证功能
  • 支持多语言和本地化
  • 可重用性和模块化
  • 易于集成
  • 详细的错误消息
  • 扩展性高
    借助FluentValidation，我们可以达到优雅地校验参数的目的。

环境准备：Install-Package FluentValidation -version 11.9.1

目标框架：.Net8

  1. 创建验证器类： 创建一个继承自AbstractValidator<T>的类，其中T是要验证的模型类型。

        public class AccountModel{public string Name { get; set; }}public class AccountModelValidator : AbstractValidator<AccountModel>{public AccountModelValidator(){RuleFor(e => e.Name).NotNull();}}

  2. 在应用程序中使用验证器： 在需要验证输入的地方，实例化验证器类并调用Validate方法。

            [HttpPost]public dynamic GetData(AccountModel dto){AccountModelValidator validator = new AccountModelValidator();ValidationResult result = validator.Validate(dto);return Ok(result);}

    完成这两步，就可以创建第一个简单例子了。

    当AccountModel.Name=null时，查看最终ValidationResult结果。FluentValidation会根据规则校验参数不能为空,并返回多项校验信息

    {"isValid": false,"errors": [{"propertyName": "Name","errorMessage": "'Name' must not be empty.","attemptedValue": null,"customState": null,"severity": 0,"errorCode": "NotNullValidator","formattedMessagePlaceholderValues": {"PropertyName": "Name","PropertyValue": null,"PropertyPath": "Name"}}],"ruleSetsExecuted": ["default"]
}

  3. 注册：手动new validator不是一个好思想，可以注册后使用依赖注入

    手动注册

    builder.Services.AddTransient<IValidator<AccountModel>, AccountModelValidator>();
//或
builder.Services.AddValidatorsFromAssemblyContaining<AccountModelValidator>();
//或
builder.Services.AddValidatorsFromAssemblyContaining(typeof(AccountModelValidator));

    或自动注册

    需要引入nuget包FluentValidation.AspNetCore

    Install-Package FluentValidation.AspNetCore

    builder.Services.AddValidatorsFromAssembly(Assembly.Load("SomeAssembly"));
//或
builder.Services.AddValidatorsFromAssembly(Assembly.GetExecutingAssembly());

  4. 依赖注入

            private readonly IValidator<AccountModel> _validator;public ExampleController(IValidator<AccountModel> validator){this._validator = validator;}[HttpPost]public dynamic GetData(AccountModel dto){ValidationResult result = _validator.Validate(dto);return Ok(result);}

  5. 自定义验证错误消息： 使用WithMessage方法指定自定义错误消息。

    自定义错误消息

    RuleFor(e => e.Name).NotNull().WithMessage("名字不能为空");

    使用占位符

    RuleFor(address => address.Postcode).NotEmpty().WithMessage(address => string.Format("国家:{0},城市：{1}的邮编不能为空", address.Country, address.City));
//或
RuleFor(address => address.Postcode).NotEmpty().WithMessage(address => $"国家:{address.Country},城市：{address.City}的邮编不能为空");
//"errorMessage": "国家:China,城市：深圳的邮编不能为空",

    重写属性名

    RuleFor(address => address.Postcode).NotEmpty().WithName("邮编");
//"errorMessage": "'邮编' must not be empty."

    全局重写属性名

    //全部被验证的类Country属性名都会被替换
ValidatorOptions.Global.DisplayNameResolver = (type, member, expression) =>
{if (member?.Name=="Country")return "国家";return null;
};//'国家' must not be empty.

  6. 校验失败时抛异常：异常需要捕捉

    _validator.ValidateAndThrow(dto);

  7. 级联验证： 在一个属性的验证规则中调用其他属性的验证规则。

    RuleFor(x => x.EndDate).GreaterThan(x => x.StartDate).WithMessage("结束日期必须大于开始日期.");

    默认情况下，验证规则会执行所有验证规则，如果失败时要停止执行后续的验证，则可使用CascadeMode.Stop模式

    RuleFor(x => x.Country).Cascade(CascadeMode.Stop).NotNull().NotEqual("China");//任何失败都会停止执行，只会返回第一个失败结果

  8. 自定义规则集：规则集允许将验证规则组合在一起

    假设，如果同时有两个接口需要校验同一个类，但规则不同怎么办呢。

    举例，A接口要求Name参数长度必须大于5小于20，B接口要求Name长度在2-10之间。

    这时可以定义两套规则集，分别指定不同命名。在不同接口使用不同规则集时，根据名称指定使用。

        public class AccountModelValidator : AbstractValidator<AccountModel>{public AccountModelValidator(){RuleSet("short", () =>{RuleFor(e => e.Name).NotEmpty().Must(x => x.Length >= 2 && x.Length <= 10).WithMessage("名字长度必须在2-10之间");});RuleSet("long", () =>{RuleFor(e => e.Name).NotEmpty().Must(x => x.Length > 5 && x.Length < 20).WithMessage("名字长度必须大于5小于20");});RuleFor(e => e.Age).NotEmpty().LessThan(18);//规则集外的}}

    具体使用时可以指定规则集：

    只执行指定规则集，非指定规则集、和规则集外的均不执行

    var result = _validator.Validate(dto, options =>options.IncludeRuleSets("short");//A接口
var result = _validator.Validate(dto, options =>options.IncludeRuleSets("long");//B接口

    多个规则集一起执行

    var result = _validator.Validate(dto, options =>options.IncludeRuleSets("short", "long"));

    执行涉及某个属性的所有规则集

    var result = _validator.Validate(dto, options => options.IncludeProperties(e=>e.Name);//只要规则集内有对Name的约束，这些规则都会执行校验

    执行所有规则集合

    var result = _validator.Validate(dto, options => options.IncludeAllRuleSets();

    执行指定规则集和规则集外的验证规则

    var result = _validator.Validate(dto, options => options.IncludeRuleSets("short").IncludeRulesNotInRuleSet());

  9. 条件验证：

    使用顶级语句When

    When(e => e.Country == "China", () => RuleFor(addr => addr.Postcode).Must(addr => addr.Length == 6).WithMessage(address => "中国的邮编长度须为6"));
When(e => e.Country == "America", () => RuleFor(addr => addr.Postcode).Must(addr => addr.Length == 9).WithMessage(address => "美国的邮编长度须为9"));//其他例子
RuleFor(customer => customer.Address.Postcode).NotNull().When(customer => customer.Address != null);
RuleFor(x => x.Age).GreaterThan(18).When(x => x.IsAdult);

    使用Otherwise表示否则条件

    When(e => e.Country == "China", () => RuleFor(addr => addr.Postcode).NotEmpty().Must(addr => addr.Length == 6).WithMessage(address => "中国的邮编长度须为6")).Otherwise(()=> RuleFor(addr => addr.Postcode).NotEmpty().WithName("邮编"));

    仅将条件应用与前述验证器，则要添加ApplyConditionTo.CurrentValidator，否则条件的执行顺序和最终结果，会与意想中不一致

    RuleFor(address => address.Postcode).NotEmpty()//, ApplyConditionTo.CurrentValidator.Must(e => e.Length == 6).When(e => e.Country == "China", ApplyConditionTo.CurrentValidator).WithMessage(address => "中国的邮编长度须为6").Must(e => e.Length == 9).When(e => e.Country == "America", ApplyConditionTo.CurrentValidator).WithMessage(address => "美国的邮编长度须为9");

  10. 复合属性验证：当出现复合的类属性，且类属性自定义了验证器，一个验证器中可以复用另一个验证器

        public class Address{public string City { get; set; }public string Town { get; set; }public string Postcode { get; set; }//邮编}public class AddressValidator : AbstractValidator<Address>{public AddressValidator(){RuleFor(address => address.Postcode).NotNull();}}public class AccountModel{public string Name { get; set; }public Address Address { get; set; }//地址}public class AccountModelValidator : AbstractValidator<AccountModel>{public AccountModelValidator(){RuleFor(e => e.Name).NotNull();//RuleFor(e => e.Address).NotNull();//如需先校验Address是否为空，则需添加此句RuleFor(e => e.Address).SetValidator(new AddressValidator());//相当于RuleFor(e => e.Address.Postcode).NotNull().When(e => e.Address != null);}}

  11. 集合元素验证：可以对集合中每个元素进行验证

        public class AccountModel{public string Name { get; set; }public int? Age { get; set;}public List<string> PhoneNumbers { get; set; }}

        public class AccountModelValidator : AbstractValidator<AccountModel>{public AccountModelValidator(){RuleForEach(x => x.PhoneNumbers).NotEmpty().WithMessage("手机号码不能为空");}}

    也可以配合复合属性，复用验证器；同时也可以使用where条件过滤筛选需要验证的元素

        public class Address{public string Country { get; set; }public string City { get; set; }public string Town { get; set; }public string Postcode { get; set; }//邮编}public class AccountModel{public List<Address> Address { get; set; }}public class AccountModelValidator : AbstractValidator<AccountModel>{public AccountModelValidator(){	//筛选集合中国家为China的元素，验证邮编长度必须为6位RuleForEach(x => x.Address).Where(x => x.Country == "China").SetValidator(new AddressValidator());}}

  12. 相等验证：

    相等或不等判断

    RuleFor(address => address.Country).Equal("China");
RuleFor(address => address.Country).NotEqual("China");

    忽略大小写

    RuleFor(address => address.Country).NotEqual("China", StringComparer.OrdinalIgnoreCase);

  13. 长度验证：

    //长度限制
RuleFor(address => address.Country).Length(1, 250);
//最大长度
RuleFor(address => address.Country).MaximumLength(250); 
//最小长度
RuleFor(address => address.Country).MinimumLength(1);

  14. 大小验证：

    RuleFor(product => product.Price).LessThan(100);//小于
RuleFor(product => product.Price).GreaterThan(0);//大于
RuleFor(product => product.Price).LessThanOrEqualTo(100);//小于等于
RuleFor(product => product.Price).GreaterThanOrEqualTo(0);//大于等于RuleFor(product => product.Price).GreaterThan(product => product.MinPriceLimit);//与其他属性比较大小

  15. 正则表达式：

    RuleFor(address => address.Country).Matches(@"^[A-Za-z]+$").WithMessage("国家必须为纯英文字母");

  16. 自带邮箱验证：

    RuleFor(address => address.Email).EmailAddress();

  17. 枚举验证：

    RuleFor(x => x.ConsumerLevel).IsInEnum();//如果值在非枚举之外，则抛错

  18. 区间验证：

    //不含边界值，即大于1、小于100
RuleFor(x => x.Id).ExclusiveBetween(1,100);//'Id' must be between 1 and 100 (exclusive). You entered 100.
//含边界值，即大于等于1、小于等于100
RuleFor(x => x.Id).InclusiveBetween(1,100);//‘Id’ must be between 1 and 10. You entered 0.

  19. 小数位数验证：

    RuleFor(x => x.Price).PrecisionScale(4, 2, false).WithMessage("“单价”的位数不得超过 4 位，允许小数点后 2 位。不允许出现5个及以上数字，不允许出现3位及以上小数");//ignoreTrailingZeros 为false时，小数 123.4500 将被视为具有 7 的精度和 4 的刻度
//ignoreTrailingZeros 为true时，小数 123.4500 将被视为具有 5 的精度和 2 的刻度。

  20. 扩展方法自定义占位符

        public static class ValidatorExtension{public static IRuleBuilderOptions<T, IList<TElement>> ListCountMustFewerThan<T, TElement>(this IRuleBuilder<T, IList<TElement>> ruleBuilder, int num){return ruleBuilder.Must((rootObject, list, context) => {context.MessageFormatter.AppendArgument("MaxCount", num);return list.Count < num;}).WithMessage("{PropertyName}的元素数量必须少于{MaxCount}个.");}}//使用时就方便很多
RuleFor(x => x.PhoneNumbers).ListCountMustFewerThan(3);

  21. 更高控制度的自定义验证器：

                RuleFor(x => x.Country).Custom((element, context) => {if (element != "中国" && element != "美国"){context.AddFailure("其他国家不支持");}});

  22. 组合验证器：使用Include组合多个验证器

        public class Address{public int Id { get; set; } public string Country { get; set; }public string Postcode { get; set; }//邮编}

    public class PostcodeValidator : AbstractValidator<Address>//注意继承自同一个AbstractValidator
{public PostcodeValidator(){RuleFor(address => address.Postcode).NotEmpty().WithMessage("邮编不能为空");RuleFor(address => address.Postcode).MaximumLength(10).WithMessage("邮编长度不能超过10");}
}
public class CountryValidator : AbstractValidator<Address>//注意继承自同一个AbstractValidator
{public CountryValidator(){RuleFor(address => address.Country).NotEmpty().WithMessage("国家不能为空");}
}
public class AddressValidator : AbstractValidator<Address>
{public AddressValidator(){Include(new PostcodeValidator());Include(new CountryValidator());}
}

  23. 验证指定属性：验证与指定属性有关的规则，其他的不验证

    var result = _addressValidator.Validate(addr, opt => opt.IncludeProperties(x => x.Country));

    验证集合中的指定元素的规则：使用通配符索引器 （ [] ） 来指定集合中的元素项

    //验证每个订单的 Cost 属性
_validator.Validate(customer, options => options.IncludeProperties("Orders[].Cost"));

  24. 异步：调用 ValidateAsync 将同时运行同步和异步规则。

    如果验证程序包含异步验证程序或异步条件，请务必始终在验证程序上调用 ValidateAsync，而切勿调用 Validate。如果调用 Validate，则会引发异常。

    var result = await validator.ValidateAsync(customer);

    建议：不要使用异步规则，因为 ASP.NET 的验证管道不是异步的。如果将异步规则与 ASP.NET 的自动验证一起使用，则它们将始终同步运行（FluentValidation 10.x 及更早版本）或引发异常（FluentValidation 11.x 及更高版本）。

  25. 设置严重性级别：

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

    全局设置严重性级别

    ValidatorOptions.Global.Severity = Severity.Info;

  26. 设置错误码：

    RuleFor(product => product.Price).NotNull().WithErrorCode("502");

  27. 自定义状态：

    RuleFor(person => person.Name).NotNull().WithState(person => 1);

  28. 本地化多语言：

    public class ProductValidator : AbstractValidator<Product> 
{public ProductValidator(IStringLocalizer<Product> localizer){//根据key值以特定语言显示RuleFor(product => product.Price).NotNull().WithMessage(x => localizer["PriceNotNullKey"]);}
}public class CustomLanguageManager : FluentValidation.Resources.LanguageManager
{public CustomLanguageManager() {AddTranslation("en", "PriceNotNullKey", "'{PropertyName}' is required.");AddTranslation("zh", "PriceNotNullKey", "'{PropertyName}' 是必填项.");}
}

    //通过设置 LanguageManager 属性来替换默认的 LanguageManager
ValidatorOptions.Global.LanguageManager = new CustomLanguageManager();
//是否禁用本地化
ValidatorOptions.Global.LanguageManager.Enabled = false;
//强制默认消息始终以特定语言显示
ValidatorOptions.Global.LanguageManager.Culture = new CultureInfo("zh");

  29. 依赖规则：

    默认情况下，FluentValidation 中的所有规则都是独立的，不能相互影响。这是异步验证工作的有意和必要条件。但是，在某些情况下，我们希望确保某些规则仅在另一个规则完成后执行。

    这时可以使用 DependentRules 来执行此操作

    RuleFor(x => x.Name).NotNull().DependentRules(() => {RuleFor(x => x.Id).NotNull();
});

    在许多情况下，结合使用 When 条件 CascadeMode 来防止规则运行可能更简单

  30. 自定义异常：

    public class AddressValidator : AbstractValidator<Address>
{public AddressValidator(){RuleFor(address => address.Postcode).NotEmpty().WithMessage("邮编不能为空");}//自定义异常protected override void RaiseValidationException(ValidationContext<Address> context, ValidationResult result){var ex = new ValidationException(result.Errors);throw new CustomException(ex.Message);}
}

    捕捉异常

                try{_addressValidator.ValidateAndThrow(addr);}catch (CustomException ex){//验证不通过时，就会捕捉到自定义异常}

总结：

  1. 在我们的编程习惯中，往往把校验逻辑嵌入到业务代码中，这样其实违背了单一原则。
  2. 在设计项目框架时，应考虑把校验逻辑分离核心业务，虽然校验也是业务的一环，但项目的焦点应该放在核心业务代码上 ，校验逻辑不应干扰到核心业务。
  3. 借助FluentValidation，我们可以很方便地分离校验逻辑，同时由于校验逻辑的分离，可以自由组合、复用模块。因为很多校验逻辑其实是重复的。
  4. 而且模块的复用，也达到了统一校验标准的目的。

这篇关于【.Net Core/.Net8教程】(三)如何优雅地校验参数的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/956444。

相关文章

Linux卸载自带jdk并安装新jdk版本的图文教程

Linux卸载自带jdk并安装新jdk版本的图文教程

《Linux卸载自带jdk并安装新jdk版本的图文教程》在Linux系统中,有时需要卸载预装的OpenJDK并安装特定版本的JDK,例如JDK1.8,所以本文给大家详细介绍了Linux卸载自带jdk并... 目录Ⅰ、卸载自带jdkⅡ、安装新版jdkⅠ、卸载自带jdk1、输入命令查看旧jdkrpm -qa
阅读更多...
Java进行文件格式校验的方案详解

Java进行文件格式校验的方案详解

《Java进行文件格式校验的方案详解》这篇文章主要为大家详细介绍了Java中进行文件格式校验的相关方案,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录一、背景异常现象原因排查用户的无心之过二、解决方案Magandroidic Number判断主流检测库对比Tika的使用区分zip
阅读更多...
Java使用Curator进行ZooKeeper操作的详细教程

Java使用Curator进行ZooKeeper操作的详细教程

《Java使用Curator进行ZooKeeper操作的详细教程》ApacheCurator是一个基于ZooKeeper的Java客户端库,它极大地简化了使用ZooKeeper的开发工作,在分布式系统... 目录1、简述2、核心功能2.1 CuratorFramework2.2 Recipes3、示例实践3
阅读更多...
springboot简单集成Security配置的教程

springboot简单集成Security配置的教程

《springboot简单集成Security配置的教程》：本文主要介绍springboot简单集成Security配置的教程,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,... 目录集成Security安全框架引入依赖编写配置类WebSecurityConfig（自定义资源权限规则
阅读更多...
MySQL Workbench 安装教程(保姆级)

MySQL Workbench 安装教程(保姆级)

《MySQLWorkbench安装教程(保姆级)》MySQLWorkbench是一款强大的数据库设计和管理工具,本文主要介绍了MySQLWorkbench安装教程,文中通过图文介绍的非常详细,对大... 目录前言：详细步骤：一、检查安装的数据库版本二、在官网下载对应的mysql Workbench版本，要是
阅读更多...
通过Docker Compose部署MySQL的详细教程

通过Docker Compose部署MySQL的详细教程

《通过DockerCompose部署MySQL的详细教程》DockerCompose作为Docker官方的容器编排工具,为MySQL数据库部署带来了显著优势,下面小编就来为大家详细介绍一... 目录一、docker Compose 部署 mysql 的优势二、环境准备与基础配置2.1 项目目录结构2.2 基
阅读更多...
Linux安装MySQL的教程

Linux安装MySQL的教程

《Linux安装MySQL的教程》：本文主要介绍Linux安装MySQL的教程,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录linux安装mysql1.Mysql官网2.我的存放路径3.解压mysql文件到当前目录4.重命名一下5.创建mysql用户组和用户并修
阅读更多...
一文带你了解SpringBoot中启动参数的各种用法

一文带你了解SpringBoot中启动参数的各种用法

《一文带你了解SpringBoot中启动参数的各种用法》在使用SpringBoot开发应用时,我们通常需要根据不同的环境或特定需求调整启动参数,那么,SpringBoot提供了哪些方式来配置这些启动参... 目录一、启动参数的常见传递方式二、通过命令行参数传递启动参数三、使用 application.pro
阅读更多...
基于@RequestParam注解之Spring MVC参数绑定的利器

基于@RequestParam注解之Spring MVC参数绑定的利器

《基于@RequestParam注解之SpringMVC参数绑定的利器》：本文主要介绍基于@RequestParam注解之SpringMVC参数绑定的利器,具有很好的参考价值,希望对大家有所帮助... 目录@RequestParam注解：Spring MVC参数绑定的利器什么是@RequestParam？@
阅读更多...
最新Spring Security实战教程之Spring Security安全框架指南

最新Spring Security实战教程之Spring Security安全框架指南

《最新SpringSecurity实战教程之SpringSecurity安全框架指南》SpringSecurity是Spring生态系统中的核心组件,提供认证、授权和防护机制,以保护应用免受各种安... 目录前言什么是Spring Security？同类框架对比Spring Security典型应用场景传统
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2