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 = "手机号格式不正确")
@URL URL格式校验 @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 {
   
   

    @PostMapping
    public 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.validation.FieldError
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值