springmvc使用@Validated注解进行参数验证时,当一个实体类需要多种验证方式,指定在什么情况下使用验证规则

springmvc使用@Validated注解进行参数验证时,指定在什么情况下使用验证规则

@Validated和@Valid的区别

1.所属包不同
  • @Valid 位于 javax.validation 包下,是由 JDK 提供的
  • @Validated 位于 org.springframework.validation.annotation 包下,是由 Spring 提供的
2.是否提供分组功能
  • @Valid 不提供分组功能
  • @Validated 提供分组功能
    ps:可利用分组功能解决指定情况下使用验证规则(详情下文阐述)
3.是否提供验证排序功能
  • @Valid 不提供验证排序功能
  • @Validated 提供验证排序功能

@Validated和@Valid的基本使用

springboot已经引入了基础包,所以可以直接使用@Validated

1.在bean上声明需要被校验的字段

@Entity
@Data
@Table(name="user")
public class User implements Serializable {

    /** 用户id */
    @Id
    @Column(name = "id")
    @GeneratedValue(strategy=GenerationType.IDENTITY)
    @NotNull(message = "修改用户信息,id不可以空")
    private Long id;

    /** 用户昵称 */
    @Column(name="nickname")
    @NotBlank(message = "用户昵称不能为空")
    private String nickname;
    
}

2.在controller上声明需要对数据进行校验

	@PostMapping
    public ResponseEntity<Void> saveVisitor ( @Validated User user ) {
		//调用service层业务
        return ResponseEntity.status(HttpStatus.CREATED).build();
    }

3.如何不符合验证,会报MethodArgumentNotValidException异常,输出message中的信息

可通过BindingResult对象的bindingResult.getFieldError().getDefaultMessage()获得验证提示信息

获取参数验证异常信息

1.可通过传入BindingResult对象,用于获取校验失败情况下的反馈信息

	@PostMapping
    public ResponseEntity<Void> saveVisitor ( @Validated User user, BindingResult bindingResult ) {
    	if(bindingResult.hasErrors()){  
        	System.out.println(bindingResult.getFieldError().getDefaultMessage());  
    	} 
		//调用service层业务
        return ResponseEntity.status(HttpStatus.CREATED).build();
    }

2.可通过全局异常处理获取

@RestControllerAdvice
public class GlobalExceptionHandler {

	/**
     * 功能描述:处理所有接口数据验证异常
     * 使用:在接口的参数前使用注解 @Valid 验证参数的合法性
     *
     *  暂时不确定能否使用(需要测试)
     * @param e 接口数据验证异常 MethodArgumentNotValidException
     * @return 接口数据验证异常
     * @author RenShiWei
     * Date: 2020/4/11 20:19
     */
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public String handleMethodArgumentNotValidException( MethodArgumentNotValidException e){
        String message = Objects.requireNonNull(e.getBindingResult().getFieldError()).getDefaultMessage();
        return 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格式
@Validate 对po实体类进行校验

嵌套校验

如果一个类中包含了另外一个实体类,那么在上面加上@Validated即可实现嵌套校验

public class User{    
    @validated
    private List<Teacher> teacherList;
 }

分组验证(实现指定在什么情况下使用验证规则)

1.在实体类中使用group属性来指定在什么情况下使用哪个验证规则
@Entity
@Data
@Table(name="user")
public class User implements Serializable {

    /** 用户id */
    @Id
    @Column(name = "id")
    @GeneratedValue(strategy=GenerationType.IDENTITY)
    @NotNull(groups = UpdateGroup.class,message = "修改用户信息,id不可以空")
    private Long id;

    /** 用户昵称 */
    @Column(name="nickname")
    @NotBlank(groups = InsertGroup .class,message = "用户昵称不能为空")
    private String nickname;
    
    //定义接口,用于指明在什么情况下,使用对应的验证规则
    public interface UpdateGroup {
    }

	public interface InsertGroup {
    }
}
2.在controller中指定使用验证规则
	@PostMapping
    public ResponseEntity<Void> saveVisitor ( @Validated(User.UpdateGroup.class) User user ) {
		//调用service层业务
        return ResponseEntity.status(HttpStatus.CREATED).build();
    }

验证排序功能(有序验证)

正常在 @Validated 注解不加分组参数的情况下,@Valid 注解和 @Validated 注解会随机校验实体类中不加 groups 属性的字段,不分先后顺序;在 @Validated 注解加分组参数的情况下可以按照次序进行验证

	@PostMapping
    public ResponseEntity<Void> saveVisitor ( @Validated(value={User.UpdateGroup.class,User.InsertGroup.class}) User user ) {
		//调用service层业务
        return ResponseEntity.status(HttpStatus.CREATED).build();
    }

这里会先验证UpdateGroup的参数id,再验证InsertGroup的参数nickname。

猜你喜欢

转载自blog.csdn.net/qq_42937522/article/details/106210271