栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

@Valid与@Validated的使用和区别

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

@Valid与@Validated的使用和区别

@Valid:是标准JSR-303的一种规范,而Hibernate-validator对其进行了实现,所以要使用@Valid需要依赖Hibernate-validator组件。

如果使用springboot,可以添加如下依赖,里面包含了Hibernate-validator依赖


	org.springframework.boot
	spring-boot-starter-validation

如果非springboot,可以添加如下依赖:


    jakarta.validation
    jakarta.validation-api
    3.0.2



    org.hibernate.validator
    hibernate-validator
    7.0.4.Final

@Validated是只用Spring Validator校验机制使用,是@Valid 的一次封装。

两者最大的区别在于@Validated支持分组,@Valid支持用于成员属性上。

其次:

@Validated:可以用在类型、方法和方法参数上。但是不能用在成员属性上,不支持嵌套检测;

@Valid:可以用在方法、构造方法、方法参数和成员属性上,支持嵌套检测。

下面介绍下@Valid的使用方法:

1.在类上定义校验规则,如下

public class A implements Serializable{

    @NotBlank(message = "名称不能为空")
    private String name;

    @Min(value = 20, message = "年龄不能小于20岁")
    private Integer age;

    @Pattern(regexp = "^((13[0-9])|(14[5,7,9])|(15([0-3]|[5-9]))|(166)|(17[0,1,3,5,6,7,8])|(18[0-9])|(19[8|9]))\d{8}$", message = "手机号格式错误")
    private String phoneNum;

    @Email(message = "邮箱格式错误")
    private String email;

    @NotNull("时间不能为空")
    private Date createTime;

    ...
}

2.控制层,对请求的参数设置校验

@RestController
public class TestController {

    // 这里其实也可以使用@Validated,因为我们这里没有用到分组校验
    @PostMapping("test")
    public String test(@Valid @RequestBody A a){
        ...
        return "success";
    }
}

3.设置捕获校验失败的异常,进行友好封装返回

@RestControllerAdvice
public class GlobalExceptionHandler {

    // 校验失败抛出的异常类
    @ExceptionHandler(value = MethodArgumentNotValidException.class)
    public String handleMethodArgumentNotValidException(MethodArgumentNotValidException e) {
        List allErrors = e.getBindingResult().getAllErrors();
        String message = allErrors.get(0);
        return HttpResultVo.getFail(message);
    }
}

 到此@Valid的使用介绍完毕。

分组校验,一般用在对于不同的请求,同一个pojo参数的校验规则不一样,此时采用分组的方式来区分不同的校验。

下面简单介绍下分组校验的使用方法:

1.定义分组的注解:

public @interface GroupAdd{

}

public @interface GroupUpdate{

}

2. 在类上定义分组的校验规则

public class A implements Serializable{

    @NotBlank(message = "名称不能为空", groups={GroupAdd.class, GroupUpdate.class})
    private String name;

    @Min(value = 20, message = "年龄不能小于20岁")
    private Integer age;

    @Pattern(regexp = "^((13[0-9])|(14[5,7,9])|(15([0-3]|[5-9]))|(166)|(17[0,1,3,5,6,7,8])|(18[0-9])|(19[8|9]))\d{8}$", message = "手机号格式错误")
    private String phoneNum;

    @Email(message = "邮箱格式错误", groups={GroupAdd.class, GroupUpdate.class})
    private String email;

    @NotNull("时间不能为空", groups={GroupAdd.class})
    private Date createTime;

    ...
}

3.在控制层,对新增的请求和更新的请求方法设置分组校验规则 ,此时就需要用到@Validated

@RestController
public class TestController {

    // 新增请求,采用新增的分组校验方式
    @PostMapping("add")
    public String add(@Validated({GroupAdd.class}) @RequestBody A a){
        ...
        return "success";
    }

    // 更新请求,采用更新的分组校验方式
    @PostMapping("update")
    public String update(@Validated({GroupUpdate.class}) @RequestBody A a){
        ...
        return "success";
    }
}

至此,分组校验的方法介绍完毕。 

转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/967003.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号