@Valid介绍及使用

主要用途

主要用于表单验证,减轻了代码量

相关依赖

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

在Springboot启动器的web包下包含了javax.validation.Valid所以无需添加多余的依赖

---

Valid相关注解的使用方式

1.在相关的实体类的相关字段添加用于充当验证条件的注解

示例:

• 字段:
  (ps:这里只是为了演示,大家要注意命名规范)

 

    @NotNull(message = "用户名不能为空")
    @Email(message = "邮箱不正确")
    private String username;

• 实体类

 

@Data
@AllArgsConstructor
@NoArgsConstructor
public class RegisterUser {

    @Min(value = 1000000)
    @NotNull(message = "ID不能为空")
    private Long userId;

    @NotNull(message = "用户名不能为空")
    @Email(message = "邮箱不正确")
    private String username;

    /**
     * 教师职称
     */
    private String position;

    /**
     * 教师所属教研室
     */
    private String office;

    @Size(min = 1,message = "至少一条数据")
    @Valid //列表必须再次增加 @Valid
    private List<User> userList;
}

2.在controller层的方法的要校验的参数上添加@Valid注解

 

@PostMapping("/action/register")
    public Result registerByForm(@Valid @RequestBody RegisterUser registerUser){
        return userService.register(registerUser);
    }

注：如果参数为list是无法校验的。需要单独写个包装类

@Data
public class ListWrapper<E> {

    @NotEmpty
    @Valid
    private List<E> list;

    public ListWrapper() {
        list = new ArrayList<>();
    }

    public ListWrapper(List<E> list) {
        this.list = list;
    }
}

 

3.编写全局异常捕捉类

 

@Slf4j
@ControllerAdvice
public class GlobalExceptionHandler {

    private final static String EXCEPTION_MSG_KEY = "Exception message : ";

    @ResponseBody
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public Result handleValidException(MethodArgumentNotValidException e){
                //日志记录错误信息
                log.error(Objects.requireNonNull(e.getBindingResult().getFieldError()).getDefaultMessage());
                //将错误信息返回给前台
                return Result.error(103, Objects.requireNonNull(e.getBindingResult().getFieldError()).getDefaultMessage());
    }
}

相关代码类

• Result类

 

@Data
@JsonInclude(JsonInclude.Include.NON_NULL)
public class Result<T> {
    private Integer code;
    private String message;
    private T data;

    public Result() {
        this.code = 200;
        this.message = "操作成功";
    }

    /**
     * 用于错误处理
     * @param code 错误码 
     * @param message 错误提示信息
     */
    public Result(Integer code,String message){
        this.code = code;
        this.message = message;
    }

    public static  Result<String> error(Integer code,String msg){
        return new Result<>(code,msg);
    }
}

非法字段验证结果

相关注解

@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格式
需要注意每个注解对应的数据类型

---

总结
在表单验证的时候,要注意Validation的相关注解要和表单类的字段相对应,还是会抛出500的异常(因为这个异常不是MethodArgumentNotValidException异常,里面的信息对用户也没有实际的作用)

参考博客:https://www.jianshu.com/p/c8686fa5ef63