ASP.NET Core WebApi中使用FluentValidation验证数据模型的方法
介绍
验证用户输入是一个Web应用中的基本功能。对于生产系统,开发人员通常需要花费大量时间,编写大量的代码来完成这一功能。如果我们使用FluentValidation构建ASP.NET Core Web API,输入验证的任务将比以前容易的多。
FluentValidation是一个非常流行的构建强类型验证规则的.NET库。
配置项目
第一步:下载FluentValidation
我们可以使用Nuget下载最新的 FluentValidation
库
PM> Install-Package FluentValidation.AspNetCore
第二步:添加FluentValidation服务
我们需要在 Startup.cs
文件中添加FluentValidation服务
public void ConfigureServices(IServiceCollection services) { // mvc + validating services.AddMvc() .SetCompatibilityVersion(CompatibilityVersion.Version_2_1) .AddFluentValidation(); }
添加校验器
FluentValidation
提供了多种内置的校验器。在下面的例子中,我们可以看到其中的2种
- NotNull 校验器
- NotEmpty 校验器
第一步: 添加一个需要验证的数据模型
下面我们添加一个 User
类。
public class User { public string Gender { get; set; } public string FirstName { get; set; } public string LastName { get; set; } public string SIN { get; set; } }
第二步: 添加校验器类
使用 FluentValidation
创建校验器类,校验器类都需要继承自一个抽象类 AbstractValidator
public class UserValidator : AbstractValidator<User> { public UserValidator() { // 在这里添加规则 } }
第三步: 添加验证规则
在这个例子中,我们需要验证FirstName, LastName, SIN不能为null, 不能为空。我们也需要验证工卡SIN(Social Insurance Number)编号是合法的
public static class Utilities { public static bool IsValidSIN(int sin) { if (sin < 0 || sin > 999999998) return false; int checksum = 0; for (int i = 4; i != 0; i--) { checksum += sin % 10; sin /= 10; int addend = 2 * (sin % 10); if (addend >= 10) addend -= 9; checksum += addend; sin /= 10; } return (checksum + sin) % 10 == 0; } }
下面我们在 UserValidator
类的构造函数中,添加验证规则
public class UserValidator : AbstractValidator<User> { public UserValidator() { RuleFor(x => x.FirstName) .NotEmpty() .WithMessage("FirstName is mandatory."); RuleFor(x => x.LastName) .NotEmpty() .WithMessage("LastName is mandatory."); RuleFor(x => x.SIN) .NotEmpty() .WithMessage("SIN is mandatory.") .Must((o, list, context) => { if (null != o.SIN) { context.MessageFormatter.AppendArgument("SIN", o.SIN); return Utilities.IsValidSIN(int.Parse(o.SIN)); } return true; }) .WithMessage("SIN ({SIN}) is not valid."); } }
第四步: 注入验证服务
public void ConfigureServices(IServiceCollection services) { // 添加验证器 services.AddSingleton<IValidator<User>, UserValidator>(); // mvc + validating services .AddMvc() .SetCompatibilityVersion(CompatibilityVersion.Version_2_1) .AddFluentValidation(); }
第五步:在 Startup.cs
中管理你的验证错误
ASP.NET Core 2.1及以上版本中,你可以覆盖ModelState管理的默认行为(ApiBehaviorOptions)
public void ConfigureServices(IServiceCollection services) { // Validators services.AddSingleton<IValidator<User>, UserValidator>(); // mvc + validating services .AddMvc() .SetCompatibilityVersion(CompatibilityVersion.Version_2_1) .AddFluentValidation(); // override modelstate services.Configure<ApiBehaviorOptions>(options => { options.InvalidModelStateResponseFactory = (context) => { var errors = context.ModelState .Values .SelectMany(x => x.Errors .Select(p => p.ErrorMessage)) .ToList(); var result = new { Code = "00009", Message = "Validation errors", Errors = errors }; return new BadRequestObjectResult(result); }; }); }
当数据模型验证失败时,程序会执行这段代码。
在这个例子,我设置了如何向客户端显示错误。这里返回结果中,我只是包含了一个错误代码,错误消息以及错误对象列表。
下面让我们看一下最终效果。
使用验证器
这里验证器使用起来非常容易。
你只需要创建一个action, 并将需要验证的数据模型放到action的参数中。
由于验证服务已在配置中添加,因此当请求这个action时, FluentValidation
将自动验证你的数据模型!
第一步:创建一个使用待验证数据模型的action
[Route("api/[controller]")] [ApiController] public class DemoValidationController : ControllerBase { [HttpPost] public IActionResult Post(User user) { return NoContent(); } }
第二步:使用POSTMAN测试你的action
总结
在本篇博客中,我讲解了如何使用 FluentValidation
进行数据模型验证。
本篇源代码 https://github.com/lamondlu/FluentValidationExample
原文链接:Common features in ASP.NET Core 2.1 WebApi: Validation
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持猪先飞。
相关文章
- 这篇文章主要为大家详细介绍了ASP.NET购物车的实现过程,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下...2021-09-22
- 这篇文章主要介绍了.NET Core下使用Kafka的方法步骤,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2021-09-22
- 在开发过程中,使用Visual Studio的断点调试功能可以很方便帮我们调试发现程序存在的错误,同样Visual Studio也支持对SQL Server里面的存储过程进行调试,下面就让我们看看具体的调试方法。...2021-09-22
- 这篇文章主要介绍了Win10 IIS 安装及.net 4.5及Win10安装IIS并配置ASP.NET 4.0的方法,本文给大家介绍的非常详细,具有一定的参考借鉴价值,需要的朋友可以参考下...2021-09-22
- 这篇文章主要介绍了详解.NET Core 3.0 里新的JSON API,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2021-09-22
- 这篇文章主要介绍了.net数据库操作框架SqlSugar的简单入门,帮助大家更好的理解和学习使用.net技术,感兴趣的朋友可以了解下...2021-09-22
ASP.NET Core根据环境变量支持多个 appsettings.json配置文件
这篇文章主要介绍了ASP.NET Core根据环境变量支持多个 appsettings.json配置文件,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2021-09-22- 这篇文章主要介绍了记一次EFCore类型转换错误及解决方案,帮助大家更好的理解和学习使用asp.net core,感兴趣的朋友可以了解下...2021-09-22
- ZXing是一个开放源码的,用Java实现的多种格式的1D/2D条码图像处理库,它包含了联系到其他语言的端口。这篇文章主要给大家介绍了.NET C#利用ZXing生成、识别二维码/条形码的方法,文中给出了详细的示例代码,有需要的朋友们可以参考借鉴。...2020-06-25
详解ASP.NET Core 中基于工厂的中间件激活的实现方法
这篇文章主要介绍了ASP.NET Core 中基于工厂的中间件激活的实现方法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下...2021-09-22- 这篇文章主要介绍了C#使用Ado.Net更新和添加数据到Excel表格的方法,较为详细的分析了OLEDB的原理与使用技巧,可实现较为方便的操作Excel数据,需要的朋友可以参考下...2020-06-25
asp.net通过消息队列处理高并发请求(以抢小米手机为例)
这篇文章主要介绍了asp.net通过消息队列处理高并发请求(以抢小米手机为例),文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2021-09-22- Underscore 是一个 JavaScript 工具库,它提供了一整套函数式编程的实用功能,但是没有扩展任何 JavaScript 内置对象。这篇文章主要介绍了underscore源码分析相关知识,感兴趣的朋友一起学习吧...2016-01-02
ASP.NET单选按钮控件RadioButton常用属性和方法介绍
RadioButton又称单选按钮,其在工具箱中的图标为 ,单选按钮通常成组出现,用于提供两个或多个互斥选项,即在一组单选钮中只能选择一个...2021-09-22ASP.NET 2.0中的数据操作:使用两个DropDownList过滤的主/从报表
在前面的指南中我们研究了如何显示一个简单的主/从报表, 该报表使用DropDownList和GridView控件, DropDownList填充类别,GridView显示选定类别的产品. 这类报表用于显示具有...2016-05-19详解.NET Core 使用HttpClient SSL请求出错的解决办法
这篇文章主要介绍了.NET Core 使用HttpClient SSL请求出错的解决办法,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧...2021-09-22- 这篇文章主要介绍了Python调用.NET库的方法步骤,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2020-05-09
ASP.NET中iframe框架点击左边页面链接 右边显示链接页面内容
这篇文章主要介绍了ASP.NET中iframe框架点击左边页面链接,右边显示链接页面内容的实现代码,感兴趣的小伙伴们可以参考一下...2021-09-22- ASP.NET Web API具有与ASP.NET MVC类似的编程方式,ASP.NET Web API不仅仅具有一个完全独立的消息处理管道,而且这个管道比为ASP.NET MVC设计的管道更为复杂,功能也更为强大。下面创建一个简单的Web API项目,需要的朋友可以参考下...2021-09-22
- 这篇文章主要介绍了c# webapi 配置swagger的方法,文中示例代码非常详细,帮助大家更好的理解和学习,感兴趣的朋友可以了解下...2020-07-09