SpringBoot中使用Validation进行参数校验

Spring Boot中使用Validation进行参数校验的代码示范，包含常用校验规则及使用方式：
 
1. 引入依赖（Maven）
 
在 pom.xml 中添加Validation依赖：
 
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>
 
 
2. 实体类添加校验注解
 
在需要校验的实体类字段上使用 javax.validation 或 jakarta.validation 包下的注解：
 
import jakarta.validation.constraints.*;
import lombok.Data;

@Data // Lombok注解，简化getter/setter
public class User {
    // 主键非空
    @NotNull(message = "ID不能为空")
    private Long id;

    // 用户名不为空且长度在2-10之间
    @NotBlank(message = "用户名不能为空")
    @Size(min = 2, max = 10, message = "用户名长度必须在2-10之间")
    private String username;

    // 年龄必须在18-60之间
    @Min(value = 18, message = "年龄不能小于18岁")
    @Max(value = 60, message = "年龄不能大于60岁")
    private Integer age;

    // 邮箱格式校验
    @Email(message = "邮箱格式不正确")
    private String email;

    // 密码不为空且必须包含数字和字母（自定义正则）
    @NotBlank(message = "密码不能为空")
    @Pattern(regexp = "^(?=.*[0-9])(?=.*[a-zA-Z])(.{6,16})$", message = "密码必须包含数字和字母，长度6-16位")
    private String password;
}
 
 
3. 控制器中开启校验
 
在Controller的方法参数前添加 @Valid 或 @Validated 注解触发校验：
 
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class UserController {

    // 新增用户时校验参数
    @PostMapping("/user")
    public String addUser(@Valid @RequestBody User user) {
        // 校验通过则执行业务逻辑
        return "用户添加成功：" + user.getUsername();
    }
}
 
 
4. 全局异常处理（捕获校验失败信息）
 
通过 @ControllerAdvice 统一处理校验失败的异常：
 
import org.springframework.validation.BindingResult;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

import java.util.HashMap;
import java.util.Map;

@ControllerAdvice
public class GlobalExceptionHandler {

    // 处理参数校验失败异常
    @ExceptionHandler(MethodArgumentNotValidException.class)
    @ResponseBody
    public Map<String, String> handleValidationExceptions(MethodArgumentNotValidException e) {
        Map<String, String> errors = new HashMap<>();
        // 获取所有校验失败的字段和信息
        e.getBindingResult().getAllErrors().forEach(error -> {
            String fieldName = ((org.springframework.validation.FieldError) error).getField();
            String errorMessage = error.getDefaultMessage();
            errors.put(fieldName, errorMessage);
        });
        return errors;
    }
}
 
 
常用校验注解说明
 
-  @NotNull ：对象不能为 null （适用于基本类型包装类、对象）
-  @NotBlank ：字符串不能为 null 且去除空格后长度>0（仅适用于字符串）
-  @Size(min, max) ：字符串/集合长度在指定范围内
-  @Min(value) / @Max(value) ：数字最小值/最大值
-  @Email ：字符串符合邮箱格式
-  @Pattern(regexp) ：字符串匹配指定正则表达式
 
当请求参数不符合校验规则时，会返回包含错误字段和信息的JSON，例如：
 
{
  "username": "用户名长度必须在2-10之间",
  "email": "邮箱格式不正确"
}