10:@Validated和@Valid-Java Spring

138 阅读2分钟

持续创作,加速成长!这是我参与「掘金日新计划 · 10 月更文挑战」的第26天,点击查看活动详情

10.1 @Valid

@Valid 是 Hibernate validation 提供的注解,表示开启Hibernate validation 的校验机制,所属包为javax.validation.Valid

作为标准JSR-303规范,用来标记验证属性和方法返回值,进行级联和递归校验,没有分组功能

@Valid注解对数据模型实现验证,可在方法参数中自动注入BindingResult对象,用于接收校验结果,如果有不合法的参数,从中取出结果信息并返回给前端页面

10.2 @Validated

@Validated是Spring Validator提供的注解,表示开启Spring的校验机制

作为标准JSR-303的补充,提供了groups属性分组功能,可根据不同的分组采用不同的校验机制

@Validation是对@Valid的二次封装,在使用上没有区别,但两者功能不一样

10.2 区别

注解位置

  • @Valid 可用于方法、字段、枚举、构造器、方法参数上
  • @Validated 可用于接口、类、枚举、注解、方法、方法参数上

分组校验

  • @Valid 没有分组功能
  • @Validated 提供分组功能

方法级别

  • @Valid 可用在属性级别约束,表示级联校验。
  • @Validated 可用于类级别约束,表示Spring进行方法级别的参数校验

嵌套验证

  • @Valid 作用于成员属性上,嵌套验证功能
  • @Validated 不能作用于成员属性上,无嵌套验证功能,需配合@Valid注解进行嵌套验证

10.2 Controller参数校验

在Spring Mvc中可以使用@Validated和@Valid两个注解来校验Controller方法参数,校验的顺序是随机的,程序不能依赖校验的顺序去做相关的逻辑处理

@Valid注解表示开启Hibernate的校验机制,@Validated注解表示开启Spring的校验机制。

@RestController
public class Controller {
    @RequestMapping("/test")
    public User test(@Validated User user, BindingResult result) {
        if (result.hasErrors()) {
            List<ObjectError> errors = result.getAllErrors();
            for (ObjectError error : errors) {
                System.out.println(error.getDefaultMessage());
            }
        }
        return user;
    }
}

Controller层的方法的要校验的参数上添加@Validated/@Valid注解注解,并且需要传入BindingResult对象,当参数不符时,该对象用于获取校验失败情况下的反馈信息

如果没有BindingResult对象,当参数不符时,将返回400 Bad Request状态码

校验注解

注解说明
@NotNull/@Null验证注解的元素值不是/是null
@AssertFalse/@AssertTrue验证注解的元素值是false/true
@Max(value)/@Min(value)验证注解的元素大于/小于值(value)
@Past/@Future验证注解的元素比当前日期早/晚
@Email验证注解的元素必须是Email
@NotEmpty验证注解的元素值不为null,但长度不能为0
@NotBlank验证注解的元素值不为null,但去除字符串的空格后长度不能为0,只应用于字符串