Springboot @Validated和@Valid的区别

最新推荐文章于 2024-07-18 08:44:15 发布
最新推荐文章于 2024-07-18 08:44:15 发布
阅读量465 收藏
点赞数
分类专栏： java 文章标签： spring boot java hibernate
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_44732146/article/details/126462336
版权

概述

  • @Valid是使用Hibernate validation的时候使用

  • @Validated是只用Spring Validator校验机制使用

说明：java的JSR303声明了@Valid这类接口，而Hibernate-validator对其进行了实现

@Validation对@Valid进行了二次封装，在使用上并没有区别，但在分组、注解位置、嵌套验证等功能上有所不同，这里主要就这几种情况进行说明。

注解位置

  • @Validated：用在类型、方法和方法参数上。但不能用于成员属性（field）

  • @Valid：可以用在方法、构造函数、方法参数和成员属性（field）上

如：
在这里插入图片描述
如果@Validated注解在成员属性上，则会报不适用于field错误

分组校验

  • @Validated：提供分组功能，可以在参数验证时，根据不同的分组采用不同的验证机制

  • @Valid：没有分组功能

举例：

定义分组接口：


public interface IGroupA {
}
 
public interface IGroupB {

定义需要检验的参数bean：

public class StudentBean implements Serializable{
    @NotBlank(message = "用户名不能为空")
    private String name;
    //只在分组为IGroupB的情况下进行验证
    @Min(value = 18, message = "年龄不能小于18岁", groups = {IGroupB.class})
    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;
    @MyConstraint
    private String className;

全局异常处理通用返回结果:

public class AjaxResult {
    //是否成功
    private Boolean success;
    //状态码
    private Integer code;
    //提示信息
    private String msg;
    //数据
    private Object data;
    public AjaxResult() {

    }
    //自定义返回结果的构造方法
    public AjaxResult(Boolean success,Integer code, String msg,Object data) {
        this.success = success;
        this.code = code;
        this.msg = msg;
        this.data = data;
    }
    //自定义异常返回的结果
    public static AjaxResult defineError(BusinessException de){
        AjaxResult result = new AjaxResult();
        result.setSuccess(false);
        result.setCode(de.getErrorCode());
        result.setMsg(de.getErrorMsg());
        result.setData(null);
        return result;
    }
    //其他异常处理方法返回的结果
    public static AjaxResult otherError(ErrorEnum errorEnum){
        AjaxResult result = new AjaxResult();
        result.setMsg(errorEnum.getErrorMsg());
        result.setCode(errorEnum.getErrorCode());
        result.setSuccess(false);
        result.setData(null);
        return result;
    }
    public static AjaxResult otherError(String msg, Integer code){
        AjaxResult result = new AjaxResult();
        result.setMsg(msg);
        result.setCode(code);
        result.setSuccess(false);
        result.setData(null);
        return result;
    }
    public Boolean getSuccess() {
        return success;
    }
    public void setSuccess(Boolean success) {
        this.success = success;
    }
    public Integer getCode() {
        return code;
    }
    public void setCode(Integer code) {
        this.code = code;
    }
    public String getMsg() {
        return msg;
    }
    public void setMsg(String msg) {
        this.msg = msg;
    }
    public Object getData() {
        return data;
    }
    public void setData(Object data) {
        this.data = data;
    }

}

自定义异常

public class BusinessException extends RuntimeException{
    private static final long serialVersionUID = 1L;
    /**
     * 错误状态码
     */
    protected Integer errorCode;
    /**
     * 错误提示
     */
    protected String errorMsg;

    public BusinessException(){
    }

    public BusinessException(Integer errorCode, String errorMsg) {
        this.errorCode = errorCode;
        this.errorMsg = errorMsg;
    }

    public Integer getErrorCode() {
        return errorCode;
    }

    public void setErrorCode(Integer errorCode) {
        this.errorCode = errorCode;
    }

    public String getErrorMsg() {
        return errorMsg;
    }

    public void setErrorMsg(String errorMsg) {
        this.errorMsg = errorMsg;
    }
}

异常类枚举:

public enum ErrorEnum {
    // 数据操作错误定义
    SUCCESS(200, "成功"),
    NO_PERMISSION(403,"你没得权限"),
    NO_AUTH(401,"未登录"),
    NOT_FOUND(404, "未找到该资源!"),
    INTERNAL_SERVER_ERROR(500, "服务器异常请联系管理员"),
    ;

    /** 错误码 */
    private Integer errorCode;

    /** 错误信息 */
    private String errorMsg;

    ErrorEnum(Integer errorCode, String errorMsg) {
        this.errorCode = errorCode;
        this.errorMsg = errorMsg;
    }

    public Integer getErrorCode() {
        return errorCode;
    }

    public String getErrorMsg() {
        return errorMsg;
    }
}

全局异常处理类：

@RestControllerAdvice
public class GlobalExceptionHandler {
    private static final Logger log = LoggerFactory.getLogger(GlobalExceptionHandler.class);
    /**
     * 处理自定义异常
     *
     */
    @ExceptionHandler(value = BusinessException.class)
    public AjaxResult bizExceptionHandler(BusinessException e) {
        log.error(e.getMessage(), e);
        return AjaxResult.defineError(e);
    }
    @ExceptionHandler(value = MethodArgumentNotValidException.class)
    public AjaxResult exceptionHandler( MethodArgumentNotValidException e) {
        log.error(e.getMessage(), e);
        return AjaxResult.otherError(e.getFieldError().getDefaultMessage(),500);
    }
    /**
     *处理其他异常
     *
     */
    @ExceptionHandler(value = Exception.class)
    public AjaxResult exceptionHandler( Exception e) {
        log.error(e.getMessage(), e);
        return AjaxResult.otherError(ErrorEnum.INTERNAL_SERVER_ERROR);

    }
}

自定义校验注解MyConstraint

//定义注解可加在那些内容上
@Target({ElementType.METHOD,ElementType.FIELD})
//运行时注解
@Retention(RetentionPolicy.RUNTIME)
//校验逻辑提供类
@Constraint(validatedBy = MyConstraintValidator.class)
public @interface MyConstraint {
    //校验注解必须有的三个属性
    java.lang.String message() default "";   //校验不通过所返回的信息
    java.lang.Class<?>[] groups() default {};
    java.lang.Class<? extends javax.validation.Payload>[] payload() default {};
}

写一个类定义校验注解使用的逻辑MyConstraintValidator

//校验器逻辑，可注入spring的bean
public class MyConstraintValidator implements ConstraintValidator<MyConstraint,Object> {
    @Override
    public void initialize(MyConstraint myConstraint) {
        //初始化
        System.out.println("my validator init");
    }

    @Override
    public boolean isValid(Object value, ConstraintValidatorContext constraintValidatorContext) {
        //校验逻辑
        System.out.println(value);
        //校验通过返回true ,校验不通过返回false
        return !StringUtils.isEmpty(value);
    }
}

测试代码：

检验分组为IGroupA的情况


@RestController
public class CheckController {
    @PostMapping("stu")
    public String addStu(@Validated({IGroupA.class}) @RequestBody StudentBean studentBean){
        return "add student success";
    }


{
    "name":"zhuabyi",
    "age":15,
    "phone":"18782658571",
    "email":"511248460@qq.com",
    "claseeName":"Test"
}

在这里插入图片描述

在这里插入图片描述
这里对分组IGroupB的就没检验了

把参数改成以下email格式填错
在这里插入图片描述
添加成功了！。

再改成这样：

    @PostMapping("stu")
    public String addStu(@Validated({IGroupB.class, Default.class}) @RequestBody StudentBean studentBean){
      log.info("studentBean:{}",studentBean);
        return "add student success";
    }

在这里插入图片描述
这了就对邮箱进行了校验。

如果把测试代码改成下面这样，看看测试结果

@RestController
public class CheckController {
    @PostMapping("stu")
    public String addStu(@Validated({IGroupA.class, IGroupB.class}) @RequestBody StudentBean studentBean){
        return "add student success";
    }
}

在这里插入图片描述

说明：

  1. 不分 配groups，默认每次都要进行验证

  2. 对一个参数需要多种验证方式时，也可通过分配不同的组达到目的。

  3. @Validated注解指定了分组，只会走该分组的校验，没有或者是其他组的校验则不会走，若要进行验证的话要加上 Default.class。

组序列：

默认情况下 不同级别的约束验证是无序的，但是在一些情况下，顺序验证却是很重要。

一个组可以定义为其他组的序列，使用它进行验证的时候必须符合该序列规定的顺序。在使用组序列验证的时候，如果序列前边的组验证失败，则后面的组将不再给予验证,

举例：

定义组序列：

@GroupSequence({Default.class, IGroupA.class, IGroupB.class})
public interface IGroup {
}

需要校验的Bean，分别定义IGroupA对age进行校验，IGroupB对className进行校验：

public class StudentBean implements Serializable{
    @NotBlank(message = "用户名不能为空")
    private String name;
    @Min(value = 18, message = "年龄不能小于18岁", groups = IGroupA.class)
    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;
    @MyConstraint(groups = IGroupB.class)
    private String className;

测试：

@RestController
public class CheckController {
    @PostMapping("stu")
    public String addStu(@Validated({IGroup.class}) @RequestBody StudentBean studentBean){
        return "add student success";
    }
}

测试发现，如果age出错，那么对组序列在IGroupA后的IGroupB不进行校验，即例子中的className不进行校验，结果如下：

在这里插入图片描述
在这里插入图片描述

嵌套校验：

一个待验证的pojo类，其中还包含了待验证的对象，需要在待验证对象上注解@Valid，才能验证待验证对象中的成员属性，这里不能使用@Validated。

举例：

需要约束校验的bean：

@Data
public class TeacherBean {
    @NotEmpty(message = "老师姓名不能为空")
    private String teacherName;
    @Min(value = 1, message = "学科类型从1开始计算")
    private int type;
    }

@Data
public class StudentBean implements Serializable {
        @NotBlank(message = "用户名不能为空")
        private String name;
        //只在分组为IGroupB的情况下进行验证
        @Min(value = 18, message = "年龄不能小于18岁", groups = {IGroupA.class})
        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;
        @MyConstraint(groups = IGroupB.class, message = "className不能为空")
        private String className;
        @NotNull(message = "任课老师不能为空")
        @Size(min = 1, message = "至少有一个老师")
        private List<TeacherBean> teacherBeans;
}

注意：

这里对teacherBeans只校验了NotNull, 和 Size，并没有对teacher信息里面的字段进行校验，具体测试如下：
在这里插入图片描述
这里teacher中的type明显是不符合约束要求的，但是能检测通过，是因为在student中并没有做 嵌套校验

可以在teacherBeans中加上 @Valid，具体如下：

    @Valid
    @NotNull(message = "任课老师不能为空")
    @Size(min = 1, message = "至少有一个老师")
    private List<TeacherBean> teacherBeans;

在这里插入图片描述

胡八一、
关注
专栏目录
SpringBoot @Validated参数校验与@Aspect切面的兼容处理（参数解密加密示例）
一碗清深的博客
07-18 421
本文主要讲解@Validated参数校验与@Aspect切面的兼容处理，自定义注解和注解切面的实现，以及代码中对切面的前置通知、环绕通知、后置通知、返回后通知、异常后通知进行了讲解。
springboot中注解校验@Valid@Validated使用详细说明
rqj的专栏
07-20 503
场景要求多条件查询,开始时间与结束时间为空时不校验,不为空时校验是否是yyyy-MM-dd格式.实现步骤1.自定义校验时间格式校验注解@Constraint(validatedBy={PersonalPatternValidator.class})//约定自定义的校验注解校验逻辑的实现类//约束异常模板消息//约束指定可指定的分组Class...
@Validated和@Valid区别
06-16 1102
Spring Validation验证框架对参数的验证机制提供了@Validated（Spring’s JSR-303规范，是标准JSR-303的一个变种），javax提供了@Valid（标准JSR-303规范），配合BindingResult可以直接提供参数验证结果。 JSR303定义的校验类型 空检查 @Null 验证对象是否为null @NotNull 验证对象是否不为null, 无法查检长度为0的字符串 @NotBlank 检查约束字符串是不是...
Springboot @Validated和@Valid的区别 及使用
大菠萝一号
01-07 4万+
概述： @Valid是使用Hibernate validation的时候使用 @Validated是只用Spring Validator校验机制使用 说明：java的JSR303声明了@Valid这类接口，而Hibernate-validator对其进行了实现 @Validation对@Valid进行了二次封装，在使用上并没有区别，但在分组、注解位置、嵌套验证等功能上有所不同，这里主要就这...
@Validated和@Valid
m0_37829277的博客
05-08 1377
@Validated和@Valid的区别，@Validated使用方法。
别再混淆了！一文带你搞懂@Valid和@Validated的区别
做一个有思想的技术人
03-25 5908
本文介绍了@Valid注解和@Validated注解的不同，同时也进一步介绍了Springboot 参数校验的使用。
Springboot @Validated与@Valid深度解析
`@Validated` 和 `@Valid` 是两个常用的校验注解，它们在不同的场景下有不同的应用。下面将详细介绍这两个注解的区别以及如何使用。 首先，`@Valid` 是基于 Java 的 JSR303 规范，由 Hibernate Validator 实现的。...
Springboot参数校验@Validated和@Valid区别源码
11-22
Springboot参数校验@Validated和@Valid区别源码
详解Spring 参数验证@Validated和@Valid的区别
08-26
主要介绍了详解参数验证 @Validated 和 @Valid 的区别，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
@Validated和@Valid区别：Spring validation验证框架对入参实体进行嵌套验证必须在相应属性（字段）加上@Valid而不是@Validated
热门推荐
花郎徒结的博客
04-17 14万+
Spring Validation验证框架对参数的验证机制提供了@Validated（Spring's JSR-303规范，是标准JSR-303的一个变种），javax提供了@Valid（标准JSR-303规范），配合BindingResult可以直接提供参数验证结果。其中对于字段的特定验证注解比如@NotNull等网上到处都有，这里不详述在检验Controller的入参是否符合规范时，使用@Va...
@Validated 和@Valid 区别
最新发布
suk_java的博客
07-18 419
@Validated 和@Valid 区别
@Validated和@Valid校验参数、级联属性、List
Hello World
10-20 4780
@Validated和@Valid的区别 在Controller中校验方法参数时，使用@Valid和@Validated并无特殊差异（若不需要分组校验的话）:@Valid：标准JSR-303规范的标记型注解，用来标记验证属性和方法返回值，进行级联和递归校验@Validated：Spring的注解，是标准JSR-303的一个变种（补充），提供了一个分组功能，可以在入参验证时，根据不同的分组采用不同的...
@Valid与@Validated区别
wounler的博客
06-11 1万+
1.@Valid与@Validated作用
@Validated 和 @Valid 的真正区别和使用方式
weixin_47316183的博客
06-10 1174
@Validated 和 @Valid 的区别主要在三个地方：分组、嵌套校验、注解位置@Validation对@Valid进行了二次封装，在使用上并没有区别，但在分组、注解位置、嵌套验证等功能上有所不同，这里主要就这几种情况进行说明。如果@Validated注解在成员属性上，则会报不适用于field错误一个待验证的pojo类，其中还包含了待验证的对象，需要在待验证对象上注解@Valid，才能验证待验证对象中的成员属性，这里不能使用@Validated。举例： 需要约束校验的bean： 注意：这里对tea
浅谈@validated 和@valid的区别：
Syntacticsugar's blog
12-26 1144
@validated参考： https://blog.csdn.net/weixin_42323802/article/details/84147234 @validated 和@valid 都支持对数据进行验证 1、作用位置区别： @Validated：可以用在类型、方法和方法参数上。但是不能用在成员属性（字段）上 @Valid：可以用在方法、构造函数、方法参数和成员属性（字段）上 ...
@Validated注解和@Valid注解区别
m0_53157173的博客
12-06 5623
@Validated注解和@Valid注解详解引入依赖@Validated注解和@Valid注解区别@Valid注解使用场景演示嵌套校验和controller层请求参数校验@Valid注解校验不通过会抛出MethodArgumentNotValidException异常@Valid注解的请求参数后面紧跟一个BindingResult对象，来封装校验结果全局处理异常MethodArgumentNotValidException@Validated使用场景演示controller请求参数校验对配置文件的装配进行
后端validated校验
loliDapao的博客
07-01 675
Validated校验
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值