当前位置: 首页 > news >正文

Spring Boot 数据校验: Bean Validation 注解、分组校验与全局异常处理

Spring Boot Validation 概念及常用校验注解

Spring Boot Validation 的核心目的是确保输入数据符合业务规则,防止无效数据进入系统导致异常或错误。主要作用包括:

  1. 数据完整性:确保必填字段不为空、数字在合理范围、字符串格式合法等
  2. 安全性:防止SQL注入、XSS攻击等(通过格式校验)
  3. 减少冗余代码:避免在Service层编写大量重复的参数校验逻辑
  4. 提高可维护性:校验规则集中在实体类,与业务逻辑分离
  5. 统一错误处理:校验失败自动返回标准错误格式,前端易于处理
常用校验注解汇总
1. 空值校验
注解作用示例
@NotNull字段不能为null@NotNull(message = "ID不能为空")
@Null字段必须为null@Null(message = "创建时ID必须为空")
@NotEmpty字符串不为空(长度>0)、集合不为空@NotEmpty(message = "列表不能为空")
@NotBlank字符串不为空且去除空格后长度>0@NotBlank(message = "姓名不能为空")
2. 数值校验
注解作用示例
@Min(value)数值最小值@Min(value = 18, message = "年龄不能小于18")
@Max(value)数值最大值@Max(value = 100, message = "年龄不能大于100")
@DecimalMin(value)小数值最小值(字符串形式,避免精度问题)@DecimalMin(value = "0.01", message = "金额不能小于0.01")
@DecimalMax(value)小数值最大值(字符串形式)@DecimalMax(value = "9999.99", message = "金额不能超过9999.99")
@Digits(integer=, fraction=)数值精度限制(整数位和小数位)@Digits(integer = 10, fraction = 2, message = "金额格式错误")
3. 长度校验
注解作用示例
@Size(min=, max=)字符串/集合长度范围@Size(min = 2, max = 20, message = "姓名长度必须在2-20之间")
@Length(min=, max=)字符串长度范围(Hibernate Validator提供)@Length(min = 6, max = 20, message = "密码长度必须在6-20之间")
4. 格式校验
注解作用示例
@Email邮箱格式校验@Email(message = "邮箱格式不正确")
@Pattern(regexp=)正则表达式校验@Pattern(regexp = "^1[3-9]\\d{9}$", message = "手机号格式不正确")
@URLURL格式校验@URL(message = "URL格式不正确")
5. 逻辑校验
注解作用示例
@AssertTrue布尔值必须为true@AssertTrue(message = "必须同意条款")
@AssertFalse布尔值必须为false@AssertFalse(message = "该字段必须为false")
@Future日期必须是未来时间@Future(message = "预约时间必须是未来日期")
@Past日期必须是过去时间@Past(message = "出生日期必须是过去日期")
6. 自定义校验
注解作用示例
@Constraint(validatedBy=)自定义校验器@Constraint(validatedBy = PasswordValidator.class)

在 Spring Boot 2.3.x 版本中,Bean Validation 参数校验的使用方式与之前版本略有不同,尤其是在错误处理和响应格式的自定义上。

  • 从 Spring Boot 2.3 开始,spring-boot-starter-validation 不再默认包含,需要手动添加依赖
  • 错误属性的获取方式略有变化,推荐使用 ErrorAttributeOptions

Spring Boot Validation 的使用方法

一、基础配置

添加依赖:

<!-- Bean Validation 依赖 -->
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-validation</artifactId>
</dependency>

二、实体类校验注解

在实体类字段上添加校验注解:

import javax.validation.constraints.*;public class User {@NotNull(message = "ID不能为空")private Long id;@NotBlank(message = "姓名不能为空")@Size(min = 2, max = 20, message = "姓名长度必须在2-20之间")private String name;@Min(value = 18, message = "年龄不能小于18")@Max(value = 100, message = "年龄不能大于100")private Integer age;@Email(message = "邮箱格式不正确")private String email;
}

三、控制器参数校验

在控制器方法参数前添加 @Valid 注解触发校验:

import org.springframework.web.bind.annotation.*;
import javax.validation.Valid;@RestController
@RequestMapping("/api/users")
public class UserController {@PostMappingpublic ResponseEntity<User> createUser(@Valid @RequestBody User user) {// 处理业务逻辑return ResponseEntity.ok(user);}
}

四、自定义全局异常处理器

1.示例

Spring Boot 2.3.x 中推荐使用 @RestControllerAdvice 处理校验异常:

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework
http://www.lryc.cn/news/571334.html

相关文章:

  • SSRF3 任意文件读取
  • 游戏引擎学习路径与技术栈指南
  • 基于Qt的配置管理界面实现:保存与加载配置文件
  • SpringCloud + Zookeeper + Feign整合及Feign原理
  • JSON-RPC 2.0 与 1.0 对比总结
  • java面试总结-20250616
  • 字符操作函数续上
  • 图扑 HT 3D 场景视频嵌入应用功能
  • cuda编程笔记(4)--纹理内存
  • OpenCV——图像形态学
  • Docker 快速搭建一个基于 GPT-Vis 组件的统计图表生成服务
  • 【超详细】讯飞智能车PC电脑烧录指南(高级系统部署与恢复)
  • 系统思考:越用力推系统,系统反弹性越大
  • Flask入门指南:从零构建Python微服务
  • Appium环境安装
  • 关于人工智能未来的趋势
  • B站PWN教程笔记-12
  • 计算机视觉| 分割大模型Segment Anything(SAM)从0到1使用
  • Muon:神经网络隐藏层的革命性优化器
  • 从零到一:C语言基础入门学习路线与核心知识点全解析
  • 香橙派3B学习笔记12:C语言操作GPIO_<wiringPi.h>_点灯通用输入输出
  • FPGA 44 ,SDC 时序约束标准( 深度解析 SDC 标准 )
  • 期末作业swing水果店管理系统
  • 二分算法深度解析
  • 简说 python
  • C++ vector(2)
  • 【编译工具】CodeRider 2.0:驭码 CodeRider 2.0 全流程智能研发协作平台深度技术测评报告
  • Java在IDEA中终端窗口输出正常,但打包成JAR后中文乱码问题
  • 『大模型笔记』第3篇:多长的 Prompt 会阻塞其他请求?优化策略解析
  • Java线程池全面解析:原理、实现与最佳实践