spring boot3参数校验基本用法

⛰️个人主页:     蒾酒

🔥系列专栏:《spring boot实战》

🌊山高路远,行路漫漫,终有归途。


目录

前置条件

前言

导入依赖

使用介绍

配置检验规则

开启校验

使用注意

全局异常捕获返回友好提示信息

常用的校验规则注解

使用技巧


前置条件

已经初始化好一个spring boot项目且版本为3X,项目可正常启动。

作者版本为3.2.2

初始化教程:

新版idea(2023)创建spring boot3项目_2023年版的idea用maven创建springboot项目-CSDN博客icon-default.png?t=N7T8https://blog.csdn.net/qq_62262918/article/details/135785412?spm=1001.2014.3001.5501

前言

在spring boot应用程序开发中对于参数校验这一块我们通常使用注解的方式来完成,本文我们介绍关于spring boot注解化参数校验的初级使用。

导入依赖

pom.xml:

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

注意:spring boot2.3以后默认spring-boot-starter-web组件不包含该依赖需要单独引入

使用介绍

配置检验规则

现在有一个用户登录请求对象

import jakarta.validation.constraints.*;
import lombok.Data;/*** @author mijiupro*/
@Data
public class UserLoginDTO {@NotBlank(message = "账号不能为空")private String userAccount;// 用户账号@Size(min = 6, max = 18, message = "用户密码长度需在6-18位")private String password;// 密码@NotBlank(message = "验证码id不能为空")private String captchaId;// 验证码id@NotBlank(message = "验证码内容不能为空")private String captcha;// 验证码内容
}

我们使用@Size对字符串密码字段设置长度范围6-18位校验规则,其他字段使用@NotBlank设置非空校验。

注意事项:

此时校验并不会生效,因为我们只配置了规则,并没有开启校验。

开启校验

通常我们在控制层进行参数校验,通过对请求参数使用@Validated注解或者@Valid注解来启用校验。

@RestController
@RequestMapping("/user")
@Tag(name = "用户管理", description = "用户管理")
public class UserController {private final UserService userService;public UserController(UserService userService) {this.userService = userService;}@PostMapping("/login")@Operation(summary = "用户登录")public UserLoginVO login(@RequestBody @Validated UserLoginDTO userLoginDTO) {return userService.login(userLoginDTO);}}

注意事项:

在spring boot推荐用@Validated注解,因为它能够支持 Spring 提供的校验注解,并且具有更好的集成性。

@Validated和@Valid区别:

  • @Validated注解是 Spring 框架提供的,主要用于在 Spring MVC 中对控制器的方法参数进行校验。
  • @Valid注解是 Java 标准库提供的,用于在任何地方触发参数校验,包括 Spring MVC 的控制器方法、Spring Boot 的 REST 控制器方法、Spring Data JPA 的实体类等。

使用注意

控制器方法接收到请求参数后,会进行参数校验,对于未通过校验规则的非法参数会抛出MethodArgumentNotValidException.class异常并打印出注解中传入的message提示信息参数

如图:

可以看到参数未通过返回的信息很不友好,我们需要通过全局异常捕获来处理一下返回友好的提示信息。

全局异常捕获返回友好提示信息

请确保配置了全局异常捕获:

Spring Boot3自定义异常及全局异常捕获-CSDN博客icon-default.png?t=N7T8https://blog.csdn.net/qq_62262918/article/details/136110267?spm=1001.2014.3001.5501

我们只需要添加一个方法来捕获MethodArgumentNotValidException.class返回友好信息即可。

    // 参数校验异常@ExceptionHandler(MethodArgumentNotValidException.class)@ResponseStatus(HttpStatus.BAD_REQUEST)public Result<String> handleValidationExceptions(Exception ex) {log.error(ex.getMessage());// 从异常中获取字段错误信息FieldError fieldError = ((MethodArgumentNotValidException) ex).getBindingResult().getFieldError();if (fieldError != null) {// 获取错误提示信息String errorMessage = fieldError.getDefaultMessage();log.error(errorMessage);return Result.error(errorMessage);} else {// 如果没有字段错误,返回默认错误信息log.error(ex.getMessage());return Result.error("请求参数验证失败");}}

常用的校验规则注解

  1. @NotNull:用于标记字段或方法参数不能为空。非null
  2. @NotEmpty:用于标记集合、数组、字符串不能为空。非空集合、数组、字符串
  3. @NotBlank:用于标记字符串不能为空且长度必须大于0。非null且非空字符串
  4. @Size:用于标记集合、数组、字符串长度必须在指定范围内。
  5. @Min:用于标记数字类型的最小值。
  6. @Max:用于标记数字类型的最大值。
  7. @Email:用于标记字符串必须为邮箱格式。

使用技巧

@NotNull用于一般的非空校验,@NotEmpty用于集合、数组、字符串的非空校验,@NotBlank则用于字符串的非空校验且长度必须大于0。

@NotNull注解只要求不为null,无法处理空字符,空字符串在它这里是通过的。

@NotBlank注解不仅要求不为null,还会要求去除前后空格后长度大于0,也就是它要求不能是空字符串。

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

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

相关文章

Leadmium TM Green AM dye,适用于流式细胞仪、荧光显微镜成像

文章关键词&#xff1a;铅离子(镉离子)绿色荧光探针&#xff0c;Leadmium TM Green AM dye&#xff0c;镉离子绿色荧光探针 一、基本信息 产品简介&#xff1a;Leadmium TM Green AM染料是一种高度特异性和高灵敏度的检测细胞内铅离子&#xff08;lead&#xff09;和镉&#…

qt-双臂SCARA机器人动画

qt-双臂SCARA机器人动画 一、演示效果二、核心程序三、下载链接 在Qt opengl中完成的双臂SCARA机器人的简单模拟。 一、演示效果 二、核心程序 #include "glwidget.h"#include <GL/glu.h>GLWidget::GLWidget(QWidget *parent) :QGLWidget(parent),pitch(30.…

js设计模式:适配器模式

作用: 可以将某种不同格式的数据转化为自己所期待的数据格式 或者对于一些存在兼容或者特殊处理的业务逻辑,可以进行一个适配 示例: //原始数据let oldData1 [{name: 王惊涛,age: 29},{name: 孙悟空,age: 800},{name: 嘉文四世,age: 27},{name: 关羽,age: 40},{name: 伊利丹…

【天衍系列 01】深入理解Flink的 FileSource 组件:实现大规模数据文件处理

文章目录 01 基本概念02 工作原理03 数据流实现04 项目实战4.1 项目结构4.2 maven依赖4.3 StreamFormat读取文件数据4.4 BulkFormat读取文件数据4.5 使用小结 05 数据源比较06 总结 01 基本概念 Apache Flink 是一个流式处理框架&#xff0c;被广泛应用于大数据领域的实时数据…

C# GTS四轴运动控制器实例(固高科技步进电机不带编码器)

注&#xff1a;由于电机不带编码器&#xff0c;无法做home和当前位置信息读取&#xff01; 功能&#xff1a; 三个轴的点位运动&#xff1a;前进后退&#xff0c;并分别显示每个轴的移动脉冲数(可以换算为距离)&#xff01; 开发环境&#xff1a;VS2017 硬件设备&#xff1a;固…

Vue-route核心知识整理

目录 1 相关理解 1.1 对 vue-router 的理解 1.2 对 SPA 应用的理解 1.3 对路由的理解 1.3.1 什么是路由&#xff1f; 1.3.2 路由的分类 2 几个注意点 3 路由的基本使用 4 嵌套 (多级) 路由 5 路由传参 5.1 query 方式传参 5.1.1 跳转路由并携带query参数&#xff0…

【项目】HTTP服务器

HTTP服务器 【项目】HTTP服务器项目介绍背景项目描述技术特点开发环境 网络协议栈HTTP协议特点URI & URL & URNURL格式HTTP请求与响应请求响应 CGI机制CGI的实现CGI的意义 日志封装TcpServer类线程池任务类CallBack回调方法类线程池类 封装HttpServer类主函数 封装HTTP…

Python asyncio的理解与入门

asyncio是Python标准库中用于编写异步代码的模块&#xff0c;它提供了一种基于协程的方式来处理并发任务。使用asyncio可以编写高效的异步程序&#xff0c;利用事件循环在单个线程中管理多个任务的执行。 下面是asyncio的基本概念和入门示例&#xff1a; 基本概念&#xff1a…

C 编译生成静态库、动态库的方式

背景 此前编程涉及到自定义编译生成静态库或动态库&#xff0c;为了方便以后查阅&#xff0c;在此记录一下&#xff0c;同时分享给大家。 将C文件编译成静态库或动态库可以使用不同的工具和编译选项&#xff0c;取决于你的需求和平台&#xff1b;以下是使用GCC编译器的简单示例…

Linux 内存top命令详解

通过top命令可以监控当前机器的内存实时使用情况&#xff0c;该命令的参数解释如下&#xff1a; 第一行 15:30:14 —— 当前系统时间 up 1167 days, 5:02 —— 系统已经运行的时长&#xff0c;格式为时:分 1 users ——当前有1个用户登录系统 load average: 0.00, 0.01, 0.05…

【ArcGIS微课1000例】0105:三维模型转体模型(导入sketchup转多面体为例)

文章目录 一、实验概述二、三维模型转多面体三、加载多面体数据四、注意事项一、实验概述 ArcGIS可以借助【导入3D文件】工具支持主流的三维模型导入。支持 3D Studio Max (.3ds)、VRML and GeoVRML 2.0 (.wrl)、SketchUp 6.0 (.skp)、OpenFlight 15.8 (.flt)、Collaborative …

【Web】没人比我更懂SSRF之入门必须要懂的知识汇总

目录 SSRF速览 伪协议 总览 file伪协议 dict伪协议 http协议 gopher伪协议 绕过 127限制绕过 302重定向绕过 DNS重绑定绕过 利用 gopher模拟请求打内网其他漏洞 Gopherus乱杀打组件 先看这篇文章&#xff1a;https://z3r4y.blog.csdn.net/article/details/135458…

算法——排序算法

目录 1、冒泡排序 2、插入排序 3、选择排序 4、归并排序 5、快速排序 6、堆排序 7、计数排序 8、桶排序 9、基数排序 常见的排序算法包括&#xff1a; 冒泡排序&#xff08;Bubble Sort&#xff09;插入排序&#xff08;Insertion Sort&#xff09;选择排序&#xff08;Se…

Oracle12cR2之Job定时作业调度器详解

Oracle12cR2之Job定时作业调度器详解 文章目录 Oracle12cR2之Job定时作业调度器详解1.Oracle Job1. 关于Job2. 使用方法 2. Job详细说明1. 查看Job的相关视图2.SYS.DBA_JOBS视图字段详细说明 3. 创建及查看Job1. 创建Job2. 查看运行中的Job 1.Oracle Job 1. 关于Job 在 Oracle…

关于open3d的 kdtree模块的 查询偶发性崩溃问题

主要问题还是open3d的 kdtree模块的 query相关的算法引起的。没来得及在github提issue也查不到相关issue&#xff0c;因为是偶发性崩溃。所以需要记录一下&#xff0c;防止后人踩坑。 初始化kdtree的方式如下。 sample_pcd_data o3d.data.PCDPointCloud() pcd o3d.io.read_p…

面向对象分析和设计

面向对象分析与设计 面向对象的基本概念 软件工程学家Coad和Yourdon给出了一个定义&#xff1a;面向对象&#xff08;Object-Oriented&#xff09;对象&#xff08;Object&#xff09;继承&#xff08;Inheritance&#xff09;通信&#xff08;Communication&#xff09;。如…

设计模式: 策略模式

文章目录 一、什么是策略模式二、策略模式结构三、使用场景案例分析1、使用场景2、案例分析&#xff08;1&#xff09;消除条件分支 一、什么是策略模式 策略模式是一种行为型设计模式&#xff0c;它允许定义一组算法&#xff0c;并将每个算法封装在独立的类中&#xff0c;使它…

如何设计出用于喜欢的界面

要设计出用户喜欢的界面&#xff0c;你可以考虑以下几个方面&#xff1a; 用户研究&#xff1a;首先要了解用户的需求和偏好。你可以通过用户调研、用户访谈和数据分析来获取这些信息。了解用户的行为模式、喜好和痛点&#xff0c;有助于设计出更吸引人的界面。 直观的布局&am…

LeetCode 2656.K个元素的最大和

给你一个下标从 0 开始的整数数组 nums 和一个整数 k 。你需要执行以下操作 恰好 k 次&#xff0c;最大化你的得分&#xff1a; 从 nums 中选择一个元素 m 。 将选中的元素 m 从数组中删除。 将新元素 m 1 添加到数组中。 你的得分增加 m 。 请你返回执行以上操作恰好 k 次后…

easyx 枪声模拟器

作品介绍:枪声模拟器 简介: “枪声模拟器”是一个基于Windows平台的简单程序,它使用C++编写,主要目的是通过模拟枪声来增强用户的体验。程序使用了图形库来展示一个蓝色的背景屏幕,并提示用户等待片刻后按空格键模拟开枪。当用户按下空格键时,程序会播放预先设定的枪声音…