@Validated和@Valid校验参数、级联属性校验，对象参数校验

Tdercode

已于 2022-10-13 16:48:15 修改

阅读量2.4k

点赞数

文章标签： hibernate java spring

于 2022-10-13 11:01:58 首次发布

本文链接：https://blog.csdn.net/tuc1997/article/details/127296686

版权

@Valid与@Validated作用

@Valid与@Validated都是用来校验接收参数的，如果不使用注解校验参数，那么就需要在业务代码中对各个参数进行校验，这样会增加很多的工作量并且代码不优美。

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

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

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

@Validated与@Valid区别：

@Validated：可以用在类型、方法和方法参数上。但是不能用在成员属性（字段）上，不支持嵌套检测
@Valid：可以用在方法、构造函数、方法参数和成员属性（字段）上，支持嵌套检测

注意:SpringBoot使用@Valid注解需要引入如下POM

<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

示例代码：

Controller接口

    @PostMapping("/cancelOrder")
    public String apiCancelOrder(@Valid @RequestBody CancelRequest request) {
        return "成功";
    }

CancelRequest 类

@Data
public class CancelRequest {
    /**
     * 账号名
     */
    @NotBlank(message = "用户名不能为空")
    private String username;

    /**
     * 时间戳
     */
    @NotNull(message = "时间戳不能为空")
    private Long timestamp;

    /**
     * 签名
     */
    @NotBlank(message = "签名不能为空")
    private String sign;


    /**
     * 业务参数
     */
    @NotNull(message = "业务参数不能为空")
    private CancelParam params;
}

CancelParam 类

@Data
public class CancelParam {
    /**
     * 订单号 必填
     */
    @NotBlank(message = "订单号不能为空")
    private String orderNo;

}

嵌套检测

对于以上代码，只能校验到CancelRequest中的3个参数：username，timestamp，sign，而对于params里面的orderNo 则不会进行检检测，假如orderNo 传入一个空字符串，依旧会返回成功,这显然不是我们想要的结果，那么此时则需要改造一下CancelRequest类的代码，在params上加上 @Vaild注解，对params开启嵌套检测：

@Data
public class CancelRequest {
    /**
     * 账号名
     */
    @NotBlank(message = "用户名不能为空")
    @
    private String username;

    /**
     * 时间戳
     */
    @NotNull(message = "时间戳不能为空")
    private Long timestamp;

    /**
     * 签名
     */
    @NotBlank(message = "签名不能为空")
    private String sign;


    /**
     * 业务参数
     */
    @Vaild
    @NotNull(message = "业务参数不能为空")
    private CancelParam params;
}

此时如果params的orderNo再传入一个空字符串，则会返回“订单号不能为空”。

常用注解说明

@AssertFalse：

所注解的元素必须是Boolean类型，并且值为false

@AssertTrue：

所注解的元素必须是Boolean类型，并且值为true

@DecimalMax：

所注解的元素必须是数字，并且值要小于或等于给定的BigDecimalString值

@DecimalMin：

所注解的元素必须是数字，并且值要小于或等于给定的BigDecimalString值

@Digits：

所注解的元素必须是数字，并且它的值必须有指定的位数

@Email：

所注解的元素要匹配指定的正则表达式

@Max：

所注解的元素必须是数字，并且值要小于或等于给定的值。注意如果@Max所注解的元素是null，则@Max注解
会返回true，所以应该把@Max注解和@NotNull注解结合使用

@Min：

所注解的元素必须是数字，并且值要大于或等于给定的值。注意如果@Min所注解的元素是null，则@Min注解
会返回true，即也会通过校验，所以应该把@Min注解和@NotNull注解结合使用。

@NotBlank：

所注解的元素不能为null且不能为空白，用于校验CharSequence(含String、StringBuilder和StringBuffer)

@NotEmpty：

所注解的元素不能为null且长度大于0，可以是空白，用于校验CharSequence、数组、Collection和Map

@NotNull：

所注解的元素不能为null

@Null：

所注解的元素必须为null

@Pattern：

所注解的元素必须匹配指定的正则表达式。注意如果@Pattern所注解的元素是null，则@Pattern注解会返回
true，即也会通过校验，所以应该把@Pattern注解和@NotNull注解结合使用

@Size：

所注解的元素必须符合指定的大小,该注解可用于数组，CharSequence(含String、StringBuilder和
StringBuffer)，Collection和Map。注意如果@Size所注解的元素是null，则@Size注解会返回true，即也
会通过校验，所以应该把@Size注解和@NotNull注解结合使用