spring常用注解（六）@Valid和@Validated校验

2025-07-28 12:26:31

一、@Valid注解

1、介绍

@Valid注解可以作用于：方法、属性（包括枚举中的常量）、构造函数、方法的形参上。

import javax.validation.Valid;

@Target({ElementType.METHOD, ElementType.FIELD, ElementType.CONSTRUCTOR, ElementType.PARAMETER, ElementType.TYPE_USE})

@Retention(RetentionPolicy.RUNTIME)

@Documented

public @interface Valid {

}

2、参数校验使用注解

（1）空校验

注解应用@Null用于基本类型上，限制只能为null@NotNull用在基本类型上；不能为null，但可以为empty,没有Size的约束@NotEmpty用在集合类上面；不能为null，而且长度必须大于0@NotBlank只能作用在String上，不能为null，而且调用trim()后，长度必须大于0

注意：null和empty的区别

String a = new String

String b = ""

String c = null

此时a是分配了内存空间，但值为空，是绝对的空，是一种有值（值存在为空而已）此时b是分配了内存空间，值为空字符串，是相对的空，是一种有值（值存在为空字串）此时c是未分配内存空间，无值，是一种无值(值不存在)

（2）Boolean校验

注解应用@AssertFalse限制必须为false@AssertTrue限制必须为true

（3）长度校验

注解应用@Size(max,min)验证对象（Array,Collection,Map,String）长度是否在给定的范围之内@Length(min=, max=)验证字符串长度是否在给定的范围之内

（4）日期校验

注解应用@Past限制必须是一个过去的日期,并且类型为java.util.Date@Future限制必须是一个将来的日期,并且类型为java.util.Date@Pattern(value)限制必须符合指定的正则表达式

（5）数值校验

建议使用在Stirng,Integer类型，不建议使用在int类型上，因为表单值为“”时无法转换为int，但可以转换为Stirng为"",Integer为null。

注解应用@Min(value)验证 Number 和 String 对象必须为一个不小于指定值的数字@Max(value)验证 Number 和 String 对象必须为一个不大于指定值的数字@DecimalMax(value)限制必须为一个不大于指定值的数字,小数存在精度@DecimalMin(value)限制必须为一个不小于指定值的数字,小数存在精度@Digits(integer,fraction)限制必须为一个小数，且整数部分的位数不能超过integer，小数部分的位数不能超过fraction@Digits验证 Number 和 String 的构成是否合法@Range(max =3 , min =1 , message = " ")Checks whether the annotated value lies between (inclusive) the specified minimum and maximum

注意：Max和Min是对你填的“数字”是否大于或小于指定值，这个“数字”可以是number或者string类型。长度限制用length。

（6）其他校验

注解应用@Email验证注解的元素值是Email，也可以通过正则表达式和flag指定自定义的email

3、集成方法

3.1、添加依赖：

三种方式添加依赖

javax.validation

validation-api

版本号

org.springframework.boot

spring-boot-starter-web

2.0.5.RELEASE

org.springframework.boot

spring-boot-starter-validation

3.2、实体类中添加相关校验注解

3.3、接口类中添加 @Valid 注解

（1）对象参数

直接在对象前面加@Valid，相关校验注解加在DTO里面

import jakarta.validation.constraints.Max;

import jakarta.validation.constraints.NotBlank;

import lombok.Data;

import org.hibernate.validator.constraints.Length;

import org.springframework.validation.annotation.Validated;

@Data

public class UrlDTO {

@NotBlank(message = "name不能为空")

private String urlName;

@Length(min = 1, max = 10)

private String urlCode;

@Max(5)

private Integer urlType;

}

@RequestMapping("/insert")

public String insert(@Valid UrlDTO urlDTO) {

return "insert OK";

}

@RequestMapping("/add")

public String add(@RequestBody @Valid UrlDTO urlDTO) {

return "add OK";

}

@RequestMapping("/batchAdd")

public String batchAdd( @RequestBody @Valid List urlDTOs) {

return "batch add OK";

}

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

public class User {

@NotBlank(message = "姓名不为空")

private String username;

@NotBlank(message = "密码不为空")

private String password;

//嵌套必须加 @Valid，否则嵌套中的验证不生效

@Valid

@NotNull(message = "用户信息不能为空")

private UserInfo userInfo;

}

（2）非对象参数

直接在参数前面加相关校验注解

（3）集合

在Controller上添加@Validated注解，方法上添加@Valid注解。

3.4、全局异常处理类中处理 @Valid 抛出的异常

全局异常类的处理方式有很多种：

（1）方式一

//异常处理类

@Slf4j

@RestControllerAdvice("com.cbj.db_work.controller") //表明需要处理异常的范围

public class GlobalExceptionHandler {

@ExceptionHandler(value = MethodArgumentNotValidException.class) // 参数异常抛出的异常类型为MethodArgumentNotValidException，这里捕获这个异常

// R为统一返回的处理类

public R validExceptionHandler(MethodArgumentNotValidException e){

System.out.println("数据异常处理");

log.error("数据校验出现问题，异常类型:{}",e.getMessage(),e.getClass());

BindingResult bindingResult = e.getBindingResult();

Map map = new HashMap<>();

bindingResult.getFieldErrors().forEach((item)->{

String message = item.getDefaultMessage();

// 获取错误的属性字段名

String field = item.getField();

map.put(field,message);

});

return R.error().code(CodeEnum.VALID_EXCETIPON.getCode()).message(CodeEnum.VALID_EXCETIPON.getMsg()).data("errorData",map);

}

}

（2）方式二

@ControllerAdvice

@RestControllerAdvice

@Slf4j

public class ValidExceptionHandler extends GlobalExceptionHandler {

// GET请求参数异常处理

@ExceptionHandler(value = ConstraintViolationException.class)

public Result