【个人博客搭建】(17)使用FluentValidation 参数校验

FluentValidation 是一个用于 .NET 的开源验证库,它提供了一种流畅的接口和强类型验证规则,使得验证逻辑表达得更加清晰和简洁。(Apache-2.0)

FluentValidation 的主要作用包括:

  1. 提高代码可读性:通过使用 Fluent 接口和 lambda 表达式,FluentValidation 能够让验证逻辑更容易被阅读和理解。
  2. 简化验证逻辑编写:它允许开发者以声明式的方式构建复杂的验证规则,这样可以减少编写重复性验证代码的工作量。
  3. 易于维护:由于验证规则是强类型的,这使得维护和重构变得更加容易,因为编译器可以帮助检查类型安全。
  4. 支持 .NET 8:FluentValidation 更新迅速,与 .NET 8 保持同步,确保了在新平台上的可用性。
  5. 自定义错误消息:FluentValidation 允许开发者为每个验证规则定义自定义的错误消息,这样可以提供更具体的错误反馈给最终用户。
  6. 扩展性强:如果默认提供的验证规则不满足需求,开发者可以创建自定义的验证器来应对特定的业务逻辑。
  7. 集成灵活:FluentValidation 可以轻松地集成到现有的 .NET Core Web API 或 MVC 项目中,与模型绑定和数据注解无缝协作。

总的来说,FluentValidation 是一个功能强大且易于使用的验证库,它能够帮助 .NET 开发者构建健壮的应用程序,同时保持良好的代码质量和可维护性。

前边我们做了系统登录注册的简单接口,对于参数的处理都是通过代码去编写的,如下:

//验证
if (string.IsNullOrWhiteSpace(para.UserName) || string.IsNullOrWhiteSpace(para.PassWord))
{return ApiResultHelper.Error("请输入账号或密码!");
}

如果其他地方也需要类似的判断处理,则,需要对代码进行复制,复制的地方多了,后续维护的成本也会加大! 

所以,我们希望能有一个统一的处理方式来规划这些值,

于是,便有了对FluentValidation验证体系的使用了。

(五一结束了,也祝各位工作顺利,升职加薪!)

进入正题

1、安装nuget包:FluentValidation 

2、 配置验证规则。

        我这里是把验证模式放在Model层,创建Validation文件夹处理的,也可以放在入参那边的模型下边。

例子:

/// <summary>
/// 用户登录 入参 校验
/// </summary>
public class LoginUserValidator : AbstractValidator<LoginUserParameters>
{public LoginUserValidator(){RuleFor(para => para.UserName).NotEmpty().WithMessage("【用户名】不能为空");RuleFor(para => para.PassWord).NotEmpty().WithMessage("【密码】不能为空");}
}/// <summary>
/// 用户注册 入参 校验
/// </summary>
public class RegisterUserValidator : AbstractValidator<RegisterUserParameters>
{public RegisterUserValidator(){//1.不为空string notEmpty = "不能为空";RuleFor(para => para.UserName).NotEmpty().WithMessage("【用户名】" + notEmpty);RuleFor(para => para.PassWord).NotEmpty().WithMessage("【密码】" + notEmpty);RuleFor(para => para.Email).NotEmpty().WithMessage("【邮箱】" + notEmpty);RuleFor(para => para.AuthCode).NotEmpty().WithMessage("【验证码】" + notEmpty);//2.数据库存储长度限制//(ps:可用sugar特性或查询数据库配置统一处理吧)string notLength = "长度有误";RuleFor(para => para.UserName).Length(1, 25).WithMessage("【用户名】" + notLength);RuleFor(para => para.PassWord).Length(6, 18).WithMessage("【密码】" + notLength);RuleFor(para => para.Email).Length(6, 30).WithMessage("【邮箱】" + notLength);//不建议限制RuleFor(user => user.AuthCode).Length(6, 8).WithMessage("【验证码】" + notLength);//3.格式(正则)string notMatches = "格式不正确";RuleFor(user => user.Email).Matches(@"^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$").WithMessage("【邮箱】" + notMatches);//可与上边拼接一起}}

        这里一个是简单方式的,一个是验证方式较多的。

        如有其他需要,可自行百度或搜索其他方式方法。

3、注入服务

builder.Services.AddTransient<IValidator<LoginUserParameters>, LoginUserValidator>();
builder.Services.AddTransient<IValidator<RegisterUserParameters>, RegisterUserValidator>();

4、使用。

        4.1、控制器层注入

 private readonly ILogger<UsersController> _logger;private readonly IUsersService _usersService;//参数验证private readonly IValidator<LoginUserParameters> _loginUserParametersValidator;private readonly IValidator<RegisterUserParameters> _registerUserParametersValidator;/// <summary>/// 构造函数/// </summary>/// <param name="logger"></param>public UsersController(ILogger<UsersController> logger, IUsersService usersService,IValidator<LoginUserParameters> loginUserParametersValidator,IValidator<RegisterUserParameters> registerUserParametersValidator){_logger = logger;_usersService = usersService;_loginUserParametersValidator = loginUserParametersValidator;_registerUserParametersValidator = registerUserParametersValidator;}

        4.2、方法Action中使用

 var validationResult = _loginUserParametersValidator.Validate(para);if (!validationResult.IsValid){//return BadRequest(validationResult.Errors);var errs = validationResult.Errors;var errsStr = string.Empty;var index = 1;validationResult.Errors.ForEach(t =>{errsStr = errsStr + index.ToString() + "、" + t.ToString() + ";";index ++;});return ApiResultHelper.Error("【参数验证失败】" + errsStr);}

5、测试:

        5.1、如图。(无账号)

        这里把所有有误的都加上来了

        然后,我们通过信息查看,其实为空的是否必然长度是不对的,也就没必要体现出来

        所以,在注入后再添加代码:

//(1)设置模型类的CascadeMode,当模型的第一个验证失败,后续验证不执行。
ValidatorOptions.Global.DefaultClassLevelCascadeMode = CascadeMode.Stop;
//(2)设置模型字段的CascadeMode,当字段的第一个验证失败,后续验证不执行。
ValidatorOptions.Global.DefaultRuleLevelCascadeMode = CascadeMode.Stop;

        这就很符合我们自己写逻辑的规则方式了。        

        继续测试的效果也就是第一个错误提示了。

        最后,在验证那一串循环代码,可以在封装一下,不然也是每次写这么多重复代码。

6、其他:

        6.1、在查询该功能实现及其他处理,可参考文章:

fluentvalidation - 简书

https://www.cnblogs.com/wenthing/p/18006465 

        6.2、拓展:自定义一个处理方式。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/pingmian/6967.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

C++基础——构造函数

当我们创建对象的时候,这个对象应该有一个初始状态&#xff0c;当对象销毁之前应该销毁自己创建的一些数据。对象的初始化和清理也是两个非常重要的安全问题&#xff0c;一个对象或者变量没有初始时&#xff0c;对其使用后果是未知&#xff0c;同样的使用完一个变量&#xff0c…

微信小程序开发实战:运动数据轻松获取,让健康生活触手可及【代码示例】

微信小程序开发实战&#xff1a;运动数据轻松获取&#xff0c;让健康生活触手可及【代码示例】 基础概念与API介绍微信运动数据接口权限申请 实战步骤1. 配置权限2. 请求用户授权3. 解密运动数据4. 后端解密逻辑 安全性与性能优化结语与讨论 在移动互联网时代&#xff0c;健康管…

AcWing 827. 双链表——算法基础课题解

AcWing 827. 双链表 题目描述 实现一个双链表&#xff0c;双链表初始为空&#xff0c;支持 5 种操作&#xff1a; 在最左侧插入一个数&#xff1b;在最右侧插入一个数&#xff1b;将第 k 个插入的数删除&#xff1b;在第 k 个插入的数左侧插入一个数&#xff1b;在第 k 个插…

【Github】直接引用Github仓库中的图片

用picgo能够上传图片、复制链接。 那如果我已经将图片通过其他方法上传到Github仓库中&#xff0c;难道还要上传一次&#xff1f; 不用&#xff01; 步骤 1.打开仓库中要访问的图片 2.复制此时浏览器链接: https://github.com/jaxhur/image/blob/main/image-2022082410480713…

Navicat连接远程服务器的MySQL(局域网)

Navicat如何连接远程服务器的MySQL_navicat远程连接mysql-CSDN博客 我的电脑上运行MySQL的服务器端 正好在我哥家&#xff0c;在他的电脑上安装Navicat 两台电脑连接他家的wifi&#xff0c;那么就是处在同一局域网中&#xff0c;把防火墙都关掉&#xff0c;可以互相ping通。…

elementUi中的el-table合计行添加点击事件

elementUi 文档中&#xff0c;合计行并没有点击事件&#xff0c;这里自己实现了合计行的点击事件。 created() {this.propertyList [{ property: order, label: 序号 },{ property: deptName, label: 单位名称 },{ property: contentPublishQuantity, label: 文章数量 },{ pro…

解锁WSL下Docker使用

简介&#xff1a;Windows Subsystem for Linux&#xff08;简称WSL&#xff09;是一个在Windows 10上能够运行原生Linux二进制可执行文件&#xff08;ELF格式&#xff09;的兼容层。正常情况下&#xff0c;WSL安装完成后直接使用docker会抛出以下报错&#xff1a; Cannot conn…

谷歌推广和seo留痕具体怎么操作?

留痕跟谷歌推广其实是一回事&#xff0c;你能在谷歌上留痕&#xff0c;其实就是推广了自己的信息&#xff0c;本质上留痕就是在各大网站留下自己的记录&#xff0c;这个记录可以是品牌信息&#xff0c;联系方式&#xff0c;看你想留下什么 如果要问自己怎么操作&#xff0c;正常…

微信公众号排名 SEO的5个策略

随着微信公众号在社交媒体领域的持续发展和普及&#xff0c;如何提升公众号的搜索排名&#xff0c;成为许多运营者关注的焦点。公众号排名SEO&#xff0c;即针对微信公众号进行搜索引擎优化&#xff0c;旨在提高公众号在搜索结果中的曝光率和点击率。下面&#xff0c;我们将深入…

数据库中虚拟表和临时表的区别?

虚拟表&#xff08;Virtual Table&#xff09;和临时表&#xff08;Temporary Table&#xff09;在数据库系统中都用于处理暂时性的数据存储需求&#xff0c;但它们的概念和用途有所不同&#xff1a; 虚拟表&#xff08;通常是视图View&#xff09;&#xff1a; 虚拟表&#…

银行电子凭证技术规范

银行电子凭证技术规范 1 范围 本文件规定了银行电子凭证的文件、数据与样式、系统逻辑框架、生成、通信传输和安全要求&#xff0c;以 及验证方法。 本文件适用于银行电子凭证数据实例与版式文件的开具、传输、接收和应用。 2 规范性引用文件 下列文件中的内容通过文中的规范…

如何复制本地docker镜像到其他主机

&#xff08;1&#xff09;打包镜像 比如我要复制的镜像是grafana的镜像 docker images 这里我把打包的镜像放在了根~目录下&#xff0c;如截图所示&#xff1a; docker save grafana/grafana:latest -o ~/grafana.jar &#xff08;2&#xff09;移动镜像 scp命令拷贝镜像到目标…

标贝数据采集标注在自动驾驶场景中落地应用实例

AI数据服务作为人工智能和机器学习的基础&#xff0c;在自动驾驶领域中有着重要地位。与其他人工智能应用场景相比&#xff0c;自动驾驶的落地场景相对复杂&#xff0c;想要让汽车本身的算法做到处理更多、更复杂的场景&#xff0c;就需要运用大量场景化高质量AI数据做支撑。标…

kafka日志存储

前言 kafka的主题(topic)可以对应多个分区(partition)&#xff0c;而每个分区(partition)可以有多个副本(replica)&#xff0c;我们提生产工单创建topic的时候也是要预设这些参数的。但是它究竟是如何存储的呢&#xff1f;我们在使用kafka发送消息时&#xff0c;实际表现是提交…

uniapp遍历数组对象的常见方法

在 UniApp 中&#xff0c;遍历数组对象的方法与在普通 JavaScript 中是相同的。UniApp 是一个使用 Vue.js 开发所有前端应用的框架&#xff0c;因此你可以使用 Vue.js 和 JavaScript 的语法来遍历数组对象。 以下是一些常见的遍历数组对象的方法&#xff1a; 使用 for 循环 …

解密MySQL之谜:为何B+树胜过跳表成为其首选索引结构?

在数据库系统中&#xff0c;索引是提高查询性能的关键因素之一。MySQL 作为最流行的关系型数据库管理系统之一&#xff0c;其底层存储引擎使用的索引结构主要是 B 树。 然而&#xff0c;跳表作为一种高效的数据结构&#xff0c;在某些情况下也能够提供较好的查询性能。 为什么…

tomcat-GC溢出

背景 一个项目需要导出大量的数据&#xff0c;导致GC但是这个项目在本地能够运行&#xff0c;但是在服务器上就不能运行本地和服务器的区别&#xff1a;NGINX和TOMCATGC和NGINX无关&#xff0c;那么就是Tomcat分配JVM的堆内存的容量不够 错误解决思路 网上教了一些查看JVM的大小…

分布式锁与秒杀

分布式锁与秒杀 1. 分布式锁1.1 常用Redis分布式锁方案三&#xff1a;使用Lua脚本(包含SETNX EXPIRE两条指令) 秒杀 1. 分布式锁 https://www.cnblogs.com/shoshana-kong/p/17519673.html 1.1 常用Redis分布式锁方案三&#xff1a;使用Lua脚本(包含SETNX EXPIRE两条指令) …

sql注入基础-2

一、sqlmap工具(kali自带) 1、官网&#xff1a;http://www.sqlmap.org 2、版本查看 python sqlmap.py --version 3、常见命令&#xff1a; -h&#xff1a;查看帮助信息-u "URL" &#xff1a;指定网站-p 参数1,参数2&#xff1a;指定参数 注&#xff1a;-p 只能跟…

力扣141.环形链表142.环形链表Ⅱ 附证明

题目链接&#xff1a; 141. 环形链表 - 力扣&#xff08;LeetCode&#xff09; 142. 环形链表 II - 力扣&#xff08;LeetCode&#xff09; 141.环形链表 方法思路&#xff1a;快慢指针 代码: class Solution { public:bool hasCycle(ListNode *head) {if(!head){return fa…