@Valid与@Validated区别详解

一、作用

日常开发过程种总避免不了对请求参数进行有效性、合规性校验，传统的校验方式一般为后端接收到参数后进行 if 判断，层层嵌套代码可读性不高。使用@Valid和@Validated可以优雅的帮我们解决参数校验问题，提升代码可读性。

二、原理分析与区别

@Valid

1）可以用在方法、字段属性、构造函数、请求参数上
2）支持嵌套检测（嵌套检测就是在一个beanA中，存在另外一个beanB属性。检测beanA同时也检测beanB。）

package javax.validation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target({ElementType.METHOD, ElementType.FIELD, ElementType.CONSTRUCTOR, ElementType.PARAMETER, ElementType.TYPE_USE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Valid {
}

@Validated

1）可以用在类、方法和请求参数上
2）支持分组（根据不同的分组采用不同的验证机制）

package org.springframework.validation.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target({ElementType.TYPE, ElementType.METHOD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Validated {
    Class<?>[] value() default {};
}

三、简单示例

接收参数实体如下：

@Data
public class LoginCondition {

    @NotBlank(message = "用户名不得为空")
    private String loginName;

    @NotBlank(message = "密码不得为空")
    private String password;

    @NotBlank(message = "验证码ID不得为空")
    private String captchaId;

    @NotBlank(message = "验证码不得为空")
    private String captcha;
}

controller层接口：

	@PostMapping(value = "/login")
    public Response login(@Valid @RequestBody LoginCondition loginCondition) throws LoginException, InvocationTargetException, IllegalAccessException {
        return ResponseUtil.success(loginService.login(loginCondition));
    }

四、常用注解

注解	说明
@Null	用于基本类型上，限制只能为null
@NotNull	用在基本类型上；不能为null，但可以为empty
@NotEmpty	用在集合类上面；不能为null，而且长度必须大于0
@NotBlank	用在String上面；只能作用在String上，不能为null，而且调用trim()后，长度必须大于0
@AssertFalse	限制必须为false
@AssertTrue	限制必须为true
@Digits	验证 Number 和 String 的构成是否合法
@DecimalMax(value)	限制必须为一个不大于指定值的数字,小数存在精度
@DecimalMin(value)	限制必须为一个不小于指定值的数字,小数存在精度
@Digits(integer,fraction)	限制必须为一个小数，且整数部分的位数不能超过integer，小数部分的位数不能超过fraction
@Size(max,min)	限制字符长度必须在min到max之间
@Max(value)	限制必须为一个不大于指定值的数字
@Min(value)	限制必须为一个不小于指定值的数字
@Past	限制必须是一个过去的日期
@Future	限制必须是一个将来的日期
@Pattern(value)	限制必须符合指定的正则表达式
@Email	验证注解的元素值是Email，也可以通过正则表达式和flag指定自定义的email

五、异常捕获

@RestControllerAdvice
public class GlobalExceptionHandler{
	/**
     * 自定义验证异常
     * MethodArgumentNotValidException 方法参数无效异常
     */
@ExceptionHandler(MethodArgumentNotValidException.class)
    public Object handleMethodArgumentNotValidException(MethodArgumentNotValidException e)
    {
        log.error(e.getMessage(), e);
        String message = e.getBindingResult().getFieldError().getDefaultMessage();
        return AjaxResult.error(message);
    }
    
}