7.13 在SpringBoot中 正确使用Validation实现参数效验

news2025/1/24 17:56:55

CSDN成就一亿技术人

文章目录

  • 前言
  • 引入Maven依赖
  • 一、POST/PUT @RequestBody参数校验
    • 1.1 Valid或Validated注解配合constraints注解
    • 1.2 测试运行
  • 二、GET/DELETE @RequestParam参数校验
    • 2.1 Validated注解配合constraints注解
    • 2.2 测试运行
  • 三、GET 无注解参数校验
    • 3.1 Valid或Validated注解配合constraints注解
    • 3.2 测试运行
  • 总结
  • 最后


前言

先说下Spring Validation参数校验,它是前后端分离项目SpringBoot后端Controller层必做的工作之一,目的是防止非法调用,Java JSR303定义了校验标准validation-api,但没有实现,Hibernate validation是规范的实现,另外还增加了一些constraints注解,最后Spring ValidationHibernate validation进行了二次封装,支持在SpringMvc中自动校验!

那么,在Restful风格流行的当下,在SpringBoot中,主流的参数校验场景包括:

  1. 对于POSTPUT请求,使用 @RequestBody传递的VO对象参数校验
  2. 对于GET、DELETE请求,使用 @RequestParam传递的url拼接参数校验
  3. 对于GET请求的无注解参数校验

接下来,我会图文结合带大家正确使用 @Valid@Validated以及constraints相关注解,工作必用,实战必会,最后有总结,Let’s Go!

Java的标准定义的constraints注解位于:javax.validation.constraints

Hibernate validation增加的constraints注解位于:org.hibernate.validator.constraints

参数校验的绝配搭档:7.11 SpringBoot实战 全局异常处理 - 深入细节详解


引入Maven依赖

springboot2.3之前,引入spring-boot-starter-web时,自动引入validation依赖,

springboot2.3之后,需要单独引入依赖spring-boot-starter-validation

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

一、POST/PUT @RequestBody参数校验

对于POSTPUT请求,首选使用@RequestBody传递VO对象参数.

1.1 Valid或Validated注解配合constraints注解

以BookAdminController的saveBook为例:

  • 在方法参数前加@Valid注解(换成@Validated注解也可以):

在这里插入图片描述

  • BookVO对象的字段上加constraints注解,例如,对bookName加一个@NotNull注解

在这里插入图片描述

1.2 测试运行

在这里插入图片描述

入参未填bookName,会被参数校验异常MethodArgumentNotValidException异常捕获,最后返回上图的结果~

在这里插入图片描述


二、GET/DELETE @RequestParam参数校验

对于GET、DELETE请求,首选使用@RequestParam传递的url拼接参数。

2.1 Validated注解配合constraints注解

以BookAdminController的getBook为例:

这时,需要在Controller上加@Validated注解, 在方法参数前加constraints注解,以@Min注解为例:

在这里插入图片描述

2.2 测试运行

在这里插入图片描述

因为@Min限制了最小值为1,所以当入参使用id=0调用时,会被参数校验异常ConstraintViolationException异常捕获:

在这里插入图片描述


三、GET 无注解参数校验

在@RequestParam前加constraints注解的方式,参数少还可以用,参数多的时侯推荐封装成VO对象,调用方式依然不变~

3.1 Valid或Validated注解配合constraints注解

以BookAdminController的getBookCommentList为例,原来是这样写的:

在这里插入图片描述

现将参数封装成一个PageVO对象,并在字段上增加了constraints注解:@Min@Max@NotNull

@Data
public class PageVO implements Serializable {
    @Min(value = 1, message = "pageNum必须大于1")
    private Integer pageNum = 1;

    @Max(value = 100, message = "pageSize不能超过100")
    private Integer pageSize = 100;

    @Min(value = 1, message = "id必须大于1")
    @NotNull
    private Integer id;
}

这时,和@RequestBody参数校验加注解的方式相同,对方法参数加@Valid注解(换成@Validated注解也可以):

在这里插入图片描述

3.2 测试运行

在这里插入图片描述

因为@Max限制了pageSize最大值为100,所以当入参使用pageSize=1000调用时,会被参数校验异常BindException异常捕获:

在这里插入图片描述


总结

  • POST/PUT @RequestBody参数校验,在方法参数VO前加@Valid@Validated,在VO字段上加constraints相关注解
  • GET/DELETE @RequestParam参数校验,在Controller上加@Validated,在方法参数前加constraints相关注解
  • GET 无注解参数校验,方法参数VO前加@Valid@Validated,在VO字段上加constraints相关注解

对于constraints相关注解具体细节,我找了两篇供大家参考:

强悍的Spring之spring validation

Hibernate Validator详解


最后

看到这,觉得有帮助的,刷波666,感谢大家的支持~

想要看更多实战好文章,还是给大家推荐我的实战专栏–>《基于SpringBoot+SpringCloud+Vue前后端分离项目实战》,由我和 前端狗哥 合力打造的一款专栏,可以让你从0到1快速拥有企业级规范的项目实战经验!

具体的优势、规划、技术选型都可以在《开篇》试读!

订阅专栏后可以添加我的微信,我会为每一位用户进行针对性指导!

另外,别忘了关注我:天罡gg ,怕你找不到我,发布新文不容易错过: https://blog.csdn.net/scm_2008

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

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

相关文章

【OpenCV • c++】直方图计算 | 绘制 H-S 直方图 | 绘制一维直方图 | 绘制 RGB 三色直方图

文章目录 一、什么是直方图二、直方图的相关函数1、计算直方图 calcHist()2、找寻最值 minMaxLoc() 三、程序演示1、色调 —— 饱和度直方图2、一维直方图3、RGB 三色直方图 一、什么是直方图 直方图广泛应用于很多计算机视觉处理当中。通过标记帧与帧之间显著的边缘和颜色的变…

【数据结构】 二叉搜索树的实现

文章目录 &#x1f340;二叉搜索树的概念&#x1f6ec;二叉搜索树功能实现&#x1f6a9;查找关键字key&#x1f4cc;代码实现&#xff1a; &#x1f6a9;插入关键字key&#x1f4cc;代码实现&#xff1a; &#x1f6a9;删除关键字key&#x1f4cc;代码实现&#xff1a; &#x…

OpenCV(三十四):轮廓外接最大、最小矩形和多边形拟合

目录 1.轮廓外接最大矩形boundingRect() 2.轮廓外接最小矩形minAreaRect() 3.轮廓外接多边形approxPolyDP() 1.轮廓外接最大矩形boundingRect() Rect cv::boundingRect ( InputArray array ) array:输入的灰度图像或者2D点集&#xff0c;数据类型为vector<Point>或者M…

OpenCV实现图像的混合

原理 这其实也是加法&#xff0c;但是不同的是两幅图像的权重不同&#xff0c;这就会给人一种混合或者透明的感觉。 图像混合的计算公式如下: g(x)(1-a)f0(x) af1(x) 通过修改α的值(0→1) &#xff0c;可以实现非常炫酷的混合。 现在我们把两幅图混合在一起。 第一幅图…

C 风格文件输入/输出---无格式输入/输出---(std::fputc,std::putc,std::fputs)

C 标准库的 C I/O 子集实现 C 风格流输入/输出操作。 <cstdio> 头文件提供通用文件支持并提供有窄和多字节字符输入/输出能力的函数&#xff0c;而 <cwchar>头文件提供有宽字符输入/输出能力的函数。 无格式输入/输出 写字符到文件流 std::fputc, std::putc in…

软件测试面试遇到之redis要怎么测试?

软件测试面试遇到&#xff1a;redis要怎么测试&#xff1f; 首先我们需要知道&#xff0c;redis是什么&#xff1f;它能做什么&#xff1f; redis是一个 key-value 类型的高速存储数据库。redis常被用做&#xff1a;缓存、队列、发布订阅等。 所以&#xff0c;“redis要怎么…

第18章_瑞萨MCU零基础入门系列教程之GPT

本教程基于韦东山百问网出的 DShanMCU-RA6M5开发板 进行编写&#xff0c;需要的同学可以在这里获取&#xff1a; https://item.taobao.com/item.htm?id728461040949 配套资料获取&#xff1a;https://renesas-docs.100ask.net 瑞萨MCU零基础入门系列教程汇总&#xff1a; ht…

基于SSM的学生管理系统

末尾获取源码 开发语言&#xff1a;Java Java开发工具&#xff1a;JDK1.8 后端框架&#xff1a;SSM 前端&#xff1a;采用JSP技术开发 数据库&#xff1a;MySQL5.7和Navicat管理工具结合 服务器&#xff1a;Tomcat8.5 开发软件&#xff1a;IDEA / Eclipse 是否Maven项目&#x…

日志平台搭建第一章:Linux 安装elasticsearch-7.5.1

相关链接 官⽹&#xff1a; https://www.elastic.co/cn/downloads/elasticsearch 下载&#xff1a; wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-7.5.1-linux-x86_64.tar.gz 分词器&#xff1a; https://github.com/medcl/elasticsearch-an…

来看看Sublime Text运行Python程序(包含下载和安装)

py Sublime Text 是一款流行的文本编辑器&#xff0c;它体积小、运行速度快、文本功能强大、可以运行在 Windows、Linux 和 Mac OS X 平台上。 在程序员眼里&#xff0c;Sublime Text 还是一款非常好用的代码编辑器&#xff0c;它支持运行 C/C、Python、Java 等多种语言编写的程…

PyCharm集成开发环境安装、启动与设置

作为非开发工程师职业,大家多多少少都会对编程有抵触,其实没有必要对Python有太大的“戒心" ,把Python当做你的一个工具就可以了。——扎克伯格 一、Python的定义&#xff1a; Python是一个高层次的结合了解释性、编译性、互动性和面向对象的脚本语言。Python的设计具有…

21.添加websocket模块

这里默认读者了解websocket协议&#xff0c;若是还不了解可以看下这篇文章wesocket协议。 websocket主要有三个步骤&#xff0c;1通过HTTP进行握手连接&#xff0c;2进行双向通信&#xff0c;3.协商断开连接 第一步的握手连接需要HTTP&#xff0c;所以还需要使用到上一节讲解…

《C++ primer plus》精炼(OOP部分)——对象和类(2)

“学习是人类成长的喷泉。” - 亚里士多德 文章目录 内联函数对象的方法和属性构造函数和析构函数构造函数的种类使用构造函数析构函数列表初始化 const成员函数this指针对象数组类作用域作用域为类的常量类作用域内的枚举 内联函数 定义位于类声明中的函数自动成为内联函数。…

代码随想录第46天|139.单词拆分,了解多重背包,背包总结

139.单词拆分 动规五部曲 1.确定valid数组以及下标的含义 valid[i] : 字符串长度为i的话&#xff0c;valid[i]为true&#xff0c;表示可以拆分为一个或多个在字典中出现的单词。 2.valid初始化 valid[0]一定要为true&#xff0c;否则递推下去后面都都是false了 3.递推公式…

TDesign WXS语法

目录 一、输出函数返回值如何获取&#xff1f; 二、WXS语法 三、WXS案例 一、输出函数返回值如何获取&#xff1f; 写在js的方法中 wxml中{{方法名()}}输出&#xff1a; 发现不显示&#xff1f;&#xff1f; 所以不能使用这种方式&#xff01;&#xff01; 二、WXS语法 1.…

idea启动缓慢解决办法

idea启动缓慢解决办法 文章目录 idea启动缓慢解决办法前言一、修改内存大小二、虚拟机运行大小三、插件禁用1、安卓相关2、构建工具3、Code Coverage 代码覆盖率4、数据库5、部署工具6、html和xml7、ide settings8、JavaScript框架和工具9、jvm框架10、Keymap快捷键映射11、kot…

c语言练习43:深入理解strcmp

深入理解strcmp strcmp的主要功能是用来比较两个字符串 模拟实现strcmp 比较两个字符串对应位置上的大小 按字典序进行比较 例如&#xff1a; 输入&#xff1a;abc abc 输出&#xff1a;0 输入&#xff1a;abc ab 输出&#xff1a;>0的数 输入&#xff1a;ab abc …

BUUCTF ciscn_2019_n_1 1

分析 使用file命令查看文件信息 使用IDA64打开文件 进入func函数 如果 v2 等于 11.28125 就可以拿到flag 可以看到v1有栈溢出&#xff0c;并且v1在v2的上面&#xff0c;可以通过溢出v2来覆盖v1的值从而获取flag 首先v1是浮点数 11.28125 的二进制是 0x413480 exp from…

【FPGA零基础学习之旅#13】串口发送模块设计与验证

&#x1f389;欢迎来到FPGA专栏~串口发送模块 ☆* o(≧▽≦)o *☆嗨~我是小夏与酒&#x1f379; ✨博客主页&#xff1a;小夏与酒的博客 &#x1f388;该系列文章专栏&#xff1a;FPGA学习之旅 文章作者技术和水平有限&#xff0c;如果文中出现错误&#xff0c;希望大家能指正&…

Redis 十大核心数据类型解析

一、Redis 简述 redis是一个开源的使用C语言编写的一个kv存储系统&#xff0c;是一个速度非常快的非关系远程内存数据库。它支持包括String、List、Set、Zset、hash五种数据结构。 除此之外&#xff0c;通过复制、持久化和客户端分片等特性&#xff0c;用户可以很方便地将red…