沃梦达 / 编程问答 / Java问题 / 正文

@Valid注解的作用及@Valid注解与@Validated的区别

Java问题
2023-04-30

这篇文章主要介绍了@Valid注解的作用及@Valid注解与@Validated的区别，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教

1.@Valid注解

用于验证注解是否符合要求，直接加在变量user之前，在变量中添加验证信息的要求，当不符合要求时就会在方法中返回message 的错误提示信息。

@ApiOperation(value = "Shipping receive completion request from shiphub frontend or app client like OMS", tags = {"Completion APIs"})
    @ApiResponses(value = {
            @ApiResponse(code = 200, message = "OK"),
            @ApiResponse(code = 401, message = "You are not authorized to access to this API"),
            @ApiResponse(code = 403, message = "Accessing the resource you were trying to reach is forbidden"),
            @ApiResponse(code = 404, message = "The resource you were trying to reach is not found")
    })
    @PostMapping(value = "/completion", produces = {"application/json"}, consumes = {"application/json"})
    public ResponseEntity<ApiResponseDto> actionCompletionShippingOrder(
            @ApiParam(value = "request body", required = true) @RequestBody @Valid CompletionOrderRequestDto completionOrderRequestDto, 
            BindingResult bindingResult) throws Exception {
 
        ApiResponseDto apiResponseDto = shippingCompletionService.requestActionToOrder(bindingResult, completionOrderRequestDto);
        if (!AppClientResponse.GENERAL_SUCC.getStatus().equals(apiResponseDto.getStatus())) {
            return new ResponseEntity<>(apiResponseDto, HttpStatus.BAD_REQUEST);
        }
        return new ResponseEntity<>(apiResponseDto, HttpStatus.OK);
    }

然后在 CompletionOrderRequestDto 类中添加验证信息的要求：

public class CompletionOrderRequestDto implements Serializable, IShiphubRequestDto {
 
  private static final long serialVersionUID = -6593240841146979248L;
 
  @JsonProperty("client_name")
  @ICheckAppClientName
  private String clientName;
 
  @JsonProperty("ship_group_id")
  @NotBlank(message = "shipGroupId不能为空")
  private String shipGroupId;
}

@NotBlank 注解所指的 password 字段，表示验证密码不能为空，如果为空的话，上面 Controller 中的 create 方法会将message 中的"密码不能为空"返回。

当然也可以添加其他验证信息的要求：

限制说明
@Null限制只能为null
@NotNull限制必须不为null
@AssertFalse限制必须为false
@AssertTrue限制必须为true
@DecimalMax(value)限制必须为一个不大于指定值的数字
@DecimalMin(value)限制必须为一个不小于指定值的数字
@Digits(integer,fraction)限制必须为一个小数，且整数部分的位数不能超过integer，小数部分的位数不能超过fraction
@Future限制必须是一个将来的日期
@Max(value)限制必须为一个不大于指定值的数字
@Min(value)限制必须为一个不小于指定值的数字
@Past限制必须是一个过去的日期
@Pattern(value)限制必须符合指定的正则表达式
@Size(max,min)限制字符长度必须在min到max之间
@Past验证注解的元素值（日期类型）比当前时间早
@NotEmpty验证注解的元素值不为null且不为空（字符串长度不为0、集合大小不为0）
@NotBlank验证注解的元素值不为空（不为null、去除首位空格后长度为0），不同于@NotEmpty，@NotBlank只应用于字符串且在比较时会去除字符串的空格
@Email验证注解的元素值是Email，也可以通过正则表达式和flag指定自定义的email格式

除此之外还可以自定义验证信息的要求，例如上面的 @ICheckAppClientName：

注解的具体内容：

@Target({ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(validatedBy = {CheckActionNameCompletionOrderValidator.class})
public @interface ICheckActionNameCompletionOrder {
 
    String message() default "1102";
 
    Class<?>[] groups() default {};
 
    Class<? extends Payload>[] payload() default {};
}

这是校验器：

public class CheckActionNameCompletionOrderValidator implements ConstraintValidator<ICheckActionNameCompletionOrder, String> {
 
    private static final Logger logger = LoggerFactory.getLogger(CheckActionNameCompletionOrderValidator.class);
 
    @Value("#{'${Action.completionName}'.split(',')}")
    private List<String> actionCompletionOrderList;
 
    @Override
    public boolean isValid(String actionName, ConstraintValidatorContext context) {
 
        logger.info("Action completion order name validator: enter action name is { {} }", actionName);
        return actionName != null && actionCompletionOrderList.stream().anyMatch(x -> actionName.toLowerCase().equals(x.toLowerCase()));
    }
}

2.@Valid与@Validated的区别

  • @Valid是使用Hibernate validation的时候使用
  • @Validated是只用Spring Validator校验机制使用

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

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

注解位置

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

如：

如果@Validated注解在成员属性上，则会报  '@Validdated' not applicable to 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;

测试代码：

检验分组为IGroupA的情况

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

这里对分组IGroupB的就没检验了

如果把测试代码改成下面这样，就会检验B了

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

说明：

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

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

组序列

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

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

举例：

定义组序列：

@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：

public class TeacherBean {
    @NotEmpty(message = "老师姓名不能为空")
    private String teacherName;
    @Min(value = 1, message = "学科类型从1开始计算")
    private int type;
public class StudentBean implements Serializable{
    @NotBlank(message = "用户名不能为空")
    private String name;
    @Min(value = 18, message = "年龄不能小于18岁")
    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;
 
    @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;

这里再来测试，会发现如下结果：

 以上为个人经验，希望能给大家一个参考，也希望大家多多支持编程学习网。

本文标题为：@Valid注解的作用及@Valid注解与@Validated的区别

上一篇： 如何使用GSON解析JSON数据
下一篇： 关于后端如何解决跨域的问题说明
猜你喜欢
最新文章
热门文章
网站首页 HTML/CSS 菜单 Layui Yii2