springboot-参数校验

news2024/12/26 2:49:13

SpringBoot 中使用 @Valid 注解 + Exception 全局处理器优雅处理参数验证

  • 注解@Valid的主要作用是用于数据效验，可以在定义的实体中的属性上，添加不同的注解来完成不同的校验规则。
  • Controller类中在参数中添加@Valid注解来开启效验功能
  • @Valid配合 Spring 会抛出MethodArgumentNotValidException异常，可结合全局异常处理类处理。

示例

1. 实体类中添加 @Valid 相关注解

@Data
public class User {
    @NotBlank(message = "姓名不为空")
    private String username;
    @NotBlank(message = "密码不为空")
    private String password;

    //嵌套必须加 @Valid，否则嵌套中的验证不生效
    @Valid
    @NotNull(message = "用户信息不能为空")
    private UserInfo userInfo;
}

如果是嵌套的实体对象，则需要在最外层属性上添加@Valid注解。

@Data
public class UserInfo {
    @NotBlank(message = "年龄不为空")
    @Max(value = 18, message = "不能超过18岁")
    private String age;

    @NotBlank(message = "性别不能为空")
    private String gender;
}

2. 接口类中添加 @Valid 注解
在Controller类中添加接口，POST方法中接收设置了@Valid相关注解的实体对象，然后在参数中添加@Valid注解来开启效验功能。

@RestController
public class HelloController {
    ...

    @PostMapping(path = "/hello4")
    public String hello4(@Valid @RequestBody User user)  {
        System.out.println(user);
        return "hello spring boot";
    }
}

3. 全局异常处理类中处理 @Valid 抛出的异常

参数控制返回异常信息很多，可以结合一个全局异常处理类，然后对接口中抛出的异常进行处理，而@Valid配合 Spring 会抛出 MethodArgumentNotValidException异常，这里我们需要对该异常进行处理即可。

@RestControllerAdvice("org.example")        //指定异常处理的包名
public class GlobalExceptionHandler {

    @ResponseStatus(HttpStatus.BAD_REQUEST) //设置状态码为 400
    @ExceptionHandler({MethodArgumentNotValidException.class})
    public String paramExceptionHandler(MethodArgumentNotValidException e) {
        // 获取异常信息 BindingResult
        BindingResult exceptions = e.getBindingResult();
        // 判断异常中是否有错误信息，如果存在就使用异常中的消息，否则使用默认消息
        if (exceptions.hasErrors()) {
            List<ObjectError> allErrors = exceptions.getAllErrors();
            if (allErrors.size() > 0) {
                // 这里列出了全部错误参数，按正常逻辑，只需要第一条错误即可
                ObjectError objectError = allErrors.get(0);
                return objectError.getDefaultMessage();
            }
        }
        return "请求参数错误";
    }
}

4. 测试

1、访问 http://192.168.1.166:8080/hello4 ，请求参数：

{“username”:“”,“password”:“222”}
在这里插入图片描述

2、访问 http://192.168.1.166:8080/hello4 ，请求参数：

{“username”:“111”,“password”:“222”}

在这里插入图片描述

3、访问 http://192.168.1.166:8080/hello4 ，请求参数：

{“username”:“111”,“password”:“222”,“userInfo”:{“age”:“19”}}

在这里插入图片描述

4、访问 http://192.168.1.166:8080/hello4 ，请求参数：

{“username”:“111”,“password”:“222”,“userInfo”:{“age”:“18”,“gender”:“M”}}

在这里插入图片描述

正常访问，后台打印 User(username=111, password=222, userInfo=UserInfo(age=18, gender=M))。

@Valid和@Validated的区分

  • @Validated是@Valid的一次封装，是 Spring 提供的校验机制使用。
@Validated@Valid
分组提供分组功能，可在入参验证时，根据不同的分组采用不同的验证机制。无分组功能
可注解位置可以用在类型、方法和方法参数上。但是不能用在成员属性上可以用在方法、构造函数、方法参数和成员属性上（两者是否能用于成员属性上直接影响能否提供嵌套验证的功能）
嵌套验证无嵌套验证用在成员属性上，提示验证框架进行嵌套验证。

为什么验证需要分组？

当一个实体类需要多种验证方式时，例：对于一个实体类的id来说，新增的时候是不需要的，对于更新时是必须的。可以通过groups对验证进行分组。

分组接口类（通过向groups分配不同类的 class 对象，达到分组目的）：

public interface IGroupA {
}

示例

1. 定义分组接口

public interface IGroupA {
}

2. 实体类

@Data
public class User {
    //在 IGroupA 分组时，判断不能为空  
    @NotBlank(message = "姓名不为空", groups = {IGroupA.class})
    private String username;
    @NotBlank(message = "密码不为空")
    private String password;

    @Valid
    @NotNull(message = "用户信息不能为空")
    private UserInfo userInfo;
}

3. 接口类中添加 @Validated 注解

@RestController
public class HelloController {
    ...

    @PostMapping(path = "/add")
    //不需验证ID
    public String add(@Validated @RequestBody User user)  {
        System.out.println(user);
        return "hello spring boot";
    }

    @PostMapping(path = "/delete")
    //需要验证ID
    public String delete(@Validated({IGroupA.class}) @RequestBody User user)  {
        System.out.println(user);
        return "hello spring boot";
    }
}

4. 测试

add请求：
1、访问 http://192.168.1.166:8080/add，请求参数：

{“username”:“”,“password”:“222”,“userInfo”:{“age”:“18”,“gender”:“M”}}

在这里插入图片描述

正常访问，后台打印，User(username=, password=222, userInfo=UserInfo(age=18, gender=M))

2、访问 http://192.168.1.166:8080/add，请求参数：

{“username”:“111”,“password”:“”,“userInfo”:{“age”:“18”,“gender”:“M”}}

在这里插入图片描述

  • 结果可见，字段 username 分配groups=IGroupA，Controller类接口 add 访问参数不指定验证组@Validated @RequestBody User user时，就不会进行该字段的验证。其他没分配 groups 的字段，默认都要进行验证。

注：Controller类接口访问参数不指定验证组时，@Valid @RequestBody User user 和 @Validated @RequestBody User user 效果一样。

delete请求：
1、访问 http://192.168.1.166:8080/delete，请求参数：

{“username”:“”,“password”:“222”,“userInfo”:{“age”:“18”,“gender”:“M”}}

在这里插入图片描述

2、访问 http://192.168.1.166:8080/delete，请求参数：

{“username”:“111”,“password”:“”,“userInfo”:{“age”:“18”,“gender”:“M”}}

在这里插入图片描述

正常访问，后台打印，User(username=111, password=, userInfo=UserInfo(age=18, gender=M))

  • 结果可见，Controller类接口 delete 访问参数指定验证组@Validated({IGroupA.class}) @RequestBody User user时，只会对字段 username 进行校验，但其他没有分配 IGroupA 组的字段，不会校验。

在这里插入图片描述

正常访问，后台打印，User(username=111, password=, userInfo=null)

spring注解之@Valid和@Validated的区分总结

组序列

思考：我们初衷是：新增的时候不需要校验；更新的时候校验，但其他字段也需要校验。

通过组序列 @GroupSequence 解决。

默认情况下，不同组别的约束验证是无序的，然而在某些情况下，约束验证的顺序却很重要。比如，某个组的验证比较耗时，CPU 和内存的使用率相对比较大，最优的选择是将其放在最后进行验证。因此，在进行组验证的时候尚需提供一种有序的验证方式，这就提出了组序列的概念。

在使用组序列验证的时候，如果序列前边的组验证失败，则后面的组将不再给予验证。 对一个参数需要多种验证方式时，也可通过分配不同的组达到目的。

1. 分组接口类 （通过@GroupSequence注解对组进行排序）

@GroupSequence({IGroupA.class, Default.class})
public interface IGroup {
}

Default.class会执行默认验证。

2. 接口类中使用分组 IGroup

@RestController
public class HelloController {
    ...

    @PostMapping(path = "/delete")
    //需要验证ID
    public String delete(@Validated({IGroup.class}) @RequestBody User user)  {
        System.out.println(user);
        return "hello spring boot";
    }
}

3. 测试

1、访问 http://192.168.1.166:8080/delete，请求参数：

{“username”:“”,“password”:“222”,“userInfo”:{“age”:“18”,“gender”:“M”}}

在这里插入图片描述

2、访问 http://192.168.1.166:8080/delete，请求参数：

{“username”:“111”,“password”:“”,“userInfo”:{“age”:“18”,“gender”:“M”}}

在这里插入图片描述

  • 结果可见，先会对字段 username 进行校验，再对其他没有分配 IGroupA 组的字段校验。

多字段顺序验证

1. 分组接口类

public interface IGroupB {
}

@GroupSequence({IGroupB.class, IGroupA.class, Default.class})
public interface IGroup {
}

新增分组IGroupB，修改分组IGroup的顺序。

2. 实体类

@Data
public class User {
    @NotBlank(message = "姓名不为空", groups = {IGroupA.class})
    private String username;

    @NotBlank(message = "密码不为空")
    @Size(min = 3, max = 8, message = "密码必须在3和8之间", groups = {IGroupB.class})
    private String password;

    @Valid
    @NotNull(message = "用户信息不能为空")
    private UserInfo userInfo;
}

增加对字段 password 的分组校验。

3. 测试

1、访问 http://192.168.1.166:8080/delete，请求参数：

{“username”:“”,“password”:“22”,“userInfo”:{“age”:“20”,“gender”:“M”}}

在这里插入图片描述

  • 结果可见，先会对字段 password 进行校验，如果序列前边的组验证失败，则后面的组将不再给予验证。

2、访问 http://192.168.1.166:8080/delete，请求参数：

{“username”:“”,“password”:“222”,“userInfo”:{“age”:“20”,“gender”:“M”}}

在这里插入图片描述

3、访问 http://192.168.1.166:8080/delete，请求参数：

{“username”:“11”,“password”:“222”,“userInfo”:{“age”:“20”,“gender”:“M”}}

在这里插入图片描述

  • 结果可见，会按照分组 IGroup 设定的顺序IGroupB -> IGroupA -> Default进行验证。

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

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

相关文章

2023年4月10日下午总结和近日感悟

2023年4月10日下午总结和近日感悟

技术和钱 人生&#xff0c;活到现阶段&#xff0c;已于一月前&#xff0c;深感技术就是这么回事&#xff0c;不再像以前那样为学习某样东西而不问来由&#xff0c;闷头去学&#xff08;也许是因为即将步入下一个人生阶段&#xff09;。虽然&#xff0c;乐于也想去接受新技术&a…
阅读更多...
centos7下基于nginx+uwsgi部署Django项目

centos7下基于nginx+uwsgi部署Django项目

文章目录一&#xff1a;基础环境介绍&#xff1a;二&#xff1a;部署环境安装配置&#xff1a;1.基础依赖环境安装2.安装wegt&#xff0c;vim&#xff0c;unzip等必须命令3.安装python与pip&#xff08;或者python多版本管理工具pyenv等&#xff09;4.安装nginx5.安装uwsgi三&a…
阅读更多...
json和CMake简单入门

json和CMake简单入门

Json 介绍 Json是一种轻量级的数据交换格式&#xff08;也叫数据序列化方式&#xff09;。Json采用完全独立于编程语言的文本格式来存储和表示数据。简洁和清晰的层次结构使得 Json 成为理想的数据交换语言。 易于人阅读和编写&#xff0c;同时也易于机器解析和生成&#xff…
阅读更多...
Binder基本知识

Binder基本知识

1&#xff1a;IPC 原理 从进程角度来看 IPC 机制 每个 Android 的进程&#xff0c;只能运行在自己进程所拥有的虚拟地址空间。对应一个4GB 的虚拟地址空间&#xff0c;其中 3GB 是用户空间&#xff0c;1GB 是内核空间&#xff0c;当然内核空间的大小是可以通过参数配置调整的…
阅读更多...
网络安全之密码学

网络安全之密码学

目录 密码学 定义 密码的分类 对称加密 非对称加密 对称算法与非对称算法的优缺点 最佳解决办法 --- 用非对称加密算法加密对称加密算法的密钥 非对称加密如何解决对称加密的困境 密钥传输风险 密码管理难 常见算法 对称算法 非对称算法 完整性与身份认证最佳解决…
阅读更多...
优维低代码：定制构件的打包及部署

优维低代码：定制构件的打包及部署

优维低代码技术专栏&#xff0c;是一个全新的、技术为主的专栏&#xff0c;由优维技术委员会成员执笔&#xff0c;基于优维7年低代码技术研发及运维成果&#xff0c;主要介绍低代码相关的技术原理及架构逻辑&#xff0c;目的是给广大运维人提供一个技术交流与学习的平台。 连载…
阅读更多...
用Python写一个BMI计算代码

用Python写一个BMI计算代码

有粉丝问我怎么写一个BMI算法&#xff0c;安排 height float(input("请输入身高&#xff08;米&#xff09;: ")) weight float(input("请输入体重&#xff08;千克&#xff09;: ")) 计算BMI bmi weight / (height ** 2) 显示结果 print("您的…
阅读更多...
MySQL8.0.32安装以及环境配置

MySQL8.0.32安装以及环境配置

文章目录一、安装MySQL二、错误集1. 如果操作失误&#xff0c;可以重新安装一、安装MySQL 下载MySQL的社区版的压缩包&#xff1a;https://dev.mysql.com/get/Downloads/MySQL-8.0/mysql-8.0.32-winx64.zip 将压缩包解压到你要安装的目录中 将对应的安装路径添加到环境变量中…
阅读更多...
Java面试核心知识点梳理（二）——Java集合

Java面试核心知识点梳理（二）——Java集合

文章目录前言1. List1.1 ArrayList&#xff08;数组&#xff09;1.2 Vector&#xff08;数组、线程安全&#xff09;1.3 LinkedList&#xff08;链表&#xff09;2. Set2.1 HashSet&#xff08;Hash表&#xff09;2.2 TreeSet&#xff08;二叉树&#xff09;2.3 LinkHashSet&am…
阅读更多...
3分钟通过日志定位bug，这个技能测试人必须会

3分钟通过日志定位bug，这个技能测试人必须会

♥ 前 言 软件开发中通过日志记录程序的运行情况是一个开发的好习惯&#xff0c;对于错误排查和系统运维都有很大帮助。 Python 标准库自带了强大的 logging 日志模块&#xff0c;在各种 python 模块中得到广泛应用。 一、简单使用 1. 入门小案例 import logging logging.ba…
阅读更多...
国内Google翻译失效的解决方法(MAC/WIN)

国内Google翻译失效的解决方法(MAC/WIN)

Google宣布停止在中国大陆的翻译服务&#xff0c;原因是&#xff1a;使用率低&#xff1f;&#xff1f;&#xff0c;这导致Chrome浏览器网页翻译失效。对于一些使用Chrome&#xff0c;经常鼠标下一秒就在大洋彼岸扒拉资料&#xff0c;且英语不太好的同学来说变得非常难受。为此…
阅读更多...
【软考中级·网络工程师】校验码差错控制

【软考中级·网络工程师】校验码差错控制

差错控制&#x1f349; 无论通信系统如何可靠&#xff0c;都不能做到完美无缺。因此&#xff0c;必须考虑怎样发现和纠正信号传输重的差错。通信过程中出现的差错大致可以分为两类&#xff1a; 一类是由热噪声引起的随机错误&#xff1b;热噪声&#xff1a;一种由电子的热运动…
阅读更多...
基于ArcGIS、ENVI、InVEST、FRAGSTATS等多技术融合提升

基于ArcGIS、ENVI、InVEST、FRAGSTATS等多技术融合提升

专题一 空间数据获取与制图 1.1 软件安装与应用讲解 1.2 空间数据介绍 1.3海量空间数据下载 1.4 ArcGIS软件快速入门 1.5 Geodatabase地理数据库 ​ 专题二 ArcGIS专题地图制作 2.1专题地图制作规范 2.2 空间数据的准备与处理 2.3 空间数据可视化&#xff1a;地图符号…
阅读更多...
无头盔PICO-unity开发日记3（UI按钮点击）

无头盔PICO-unity开发日记3（UI按钮点击）

目录 1.UI界面加入组件 2.加入xr输入模块 3.设置光线投射遮罩 结果&#xff1a; 前提&#xff1a;做好一个ui界面 1.UI界面加入组件 画布加跟踪设备图形光线投射仪&#xff08;tracked device graphic raycaster&#xff09; 允许画布被追踪设备操纵 2.加入xr输入模块 sys…
阅读更多...
C++ --模拟实现搜索二叉树

C++ --模拟实现搜索二叉树

文章目录#搜索二叉树1. 搜索二叉树特点2. 操作分析2.0 结点结构2.1 插入2.2 升序查看2.3 查找2.4 删除2.5 前序拷贝构造3. 完整代码4. 时间复杂度分析5. 简单应用5.1 字典搜索5.2 统计次数#搜索二叉树 1. 搜索二叉树特点 若它的左子树不为空&#xff0c;则左子树上所有节点的…
阅读更多...
Dockerfile及新型容器镜像构建技术

Dockerfile及新型容器镜像构建技术

文章目录一、容器镜像分类1、操作系统类2、应用类二、容器镜像获取方法1、在dockerhub直接下载2、把操作系统中文件系统打包为容器镜像3、把正在运行的容器打包为容器镜像&#xff0c;即docker commit4、通过dockerfile实现容器镜像的自定义以及生成三、dockerfile1、dockerfil…
阅读更多...
数据库管理系统PostgreSQL部署安装完整教程

数据库管理系统PostgreSQL部署安装完整教程

PostgreSQL是一个开源的关系型数据库管理系统&#xff0c;它支持大量的数据类型和复杂的查询语言&#xff0c;可以用于各种应用程序。它是一个高性能的数据库&#xff0c;可以处理大量的数据&#xff0c;并且具有良好的可扩展性和可靠性。 目录 一.Linux系统安装PostgresSQL&a…
阅读更多...
机器学习——线性模型之Softmax回归

机器学习——线性模型之Softmax回归

问&#xff1a;Softmax回归模型是一种典型处理多分类任务的非线性分类模型 答&#xff1a;错误。Softmax回归是线性分类模型。实际上是逻辑回归的拓展&#xff0c;它将逻辑回归的二分类推广到了多分类&#xff0c;用逻辑回归的方法解决多分类问题。 线性模型——Softmax回归 …
阅读更多...
Linux之基础IO

Linux之基础IO

文章目录一.关于文件的共识二.复习C语言的文件操作1.打开文件2.向文件中写入数据3.向文件中追加数据三.有关文件的系统调用1.open&#xff08;文件打开&#xff09;2.write&#xff08;向文件写入&#xff09;3.read(读文件)四.文件描述符1.进程如何找到自己的文件2.为什么文件…
阅读更多...
leetcode刷题（3）

leetcode刷题（3）

各位朋友们大家好&#xff0c;今天是我leedcode刷题系列的第三篇&#xff0c;废话不多说&#xff0c;直接进入主题。 文章目录分割链表题目要求用例输入提示做题思路c语言代码实现Java代码实现相交链表题目要求用例输入提示做题思路c语言实现代码Java代码实现分割链表 leetcod…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023