Spring-@Validated-参数校验

1. 什么是 javax.validation

JSR303 是一套JavaBean参数校验的标准，它定义了很多常用的校验注解，我们可以直接将这些注解加在我们JavaBean的属性上面(面向注解编程的时代)，就可以在需要校验的时候进行校验了,在SpringBoot中已经包含在starter-web中,再其他项目中可以引用依赖,并自行调整版本:

<!--jsr 303-->
<dependency>
    <groupId>javax.validation</groupId>
    <artifactId>validation-api</artifactId>
    <version>1.1.0.Final</version>
</dependency>
<!-- hibernate validator-->
<dependency>
    <groupId>org.hibernate</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>5.2.0.Final</version>
</dependency>
<!-- 实际引用的是上面 hibernate-validator -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

常用注解：

验证注解	验证的数据类型	说明
@AssertFalse	Boolean,boolean	验证注解的元素值是false
@AssertTrue	Boolean,boolean	验证注解的元素值是true
@NotNull	任意类型	验证注解的元素值不是null
@Null	任意类型	验证注解的元素值是null
@Min(value=值)	BigDecimal，BigInteger, byte,short, int, long，等任何Number或CharSequence（存储的是数字）子类型	验证注解的元素值大于等于@Min指定的value值
@Max（value=值）	和@Min要求一样	验证注解的元素值小于等于@Max指定的value值
@DecimalMin(value=值)	和@Min要求一样	验证注解的元素值大于等于@ DecimalMin指定的value值
@DecimalMax(value=值)	和@Min要求一样	验证注解的元素值小于等于@ DecimalMax指定的value值
@Digits(integer=整数位数, fraction=小数位数)	和@Min要求一样	验证注解的元素值的整数位数和小数位数上限
@Size(min=下限, max=上限)	字符串、Collection、Map、数组等	验证注解的元素值的在min和max（包含）指定区间之内，如字符长度、集合大小
@Past	java.util.Date,java.util.Calendar;Joda Time类库的日期类型	验证注解的元素值（日期类型）比当前时间早
@Future	与@Past要求一样	验证注解的元素值（日期类型）比当前时间晚
@NotBlank	CharSequence子类型	验证注解的元素值不为空（不为null、去除首位空格后长度为0），不同于@NotEmpty，@NotBlank只应用于字符串且在比较时会去除字符串的首位空格
@Length(min=下限, max=上限)	CharSequence子类型	验证注解的元素值长度在min和max区间内
@NotEmpty	CharSequence子类型、Collection、Map、数组	验证注解的元素值不为null且不为空（字符串长度不为0、集合大小不为0）
@Range(min=最小值, max=最大值)	BigDecimal,BigInteger,CharSequence, byte, short, int, long等原子类型和包装类型	验证注解的元素值在最小值和最大值之间
@Email(regexp=正则表达式,flag=标志的模式)	CharSequence子类型（如String）	验证注解的元素值是Email，也可以通过regexp和flag指定自定义的email格式
@Pattern(regexp=正则表达式,flag=标志的模式)	String，任何CharSequence的子类型	验证注解的元素值与指定的正则表达式匹配
@Valid	任何非原子类型	指定递归验证关联的对象如用户对象中有个地址对象属性，如果想在验证用户对象时一起验证地址对象的话，在地址对象上加@Valid注解即可级联验证

2. 使用示例

1. 校验实体类参数

• 实体类：

package com.demo;
 
import lombok.Data;
import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.NotNull;
 
@Data
public class Person {
 
    @NotNull(message = "id 不能为 null")
    private int id;
 
    @NotEmpty(message = "姓名不能为空白")
    private String name;
}

• Controller 参数上使用 @Validated 开启校验

@RequestMapping("/1")
public int test(@RequestBody @Validated Person person ){
    return 1;
}

此时如果参数校验失败，抛出 org.springframework.web.bind.MethodArgumentNotValidException 异常

2. 校验基本类型参数

@RestController
@RequestMapping("/demo")
@Validated
public class DemoController {
    @RequestMapping("/2")
    public int test1(@RequestParam @Max(10) int id){
        return 1;
    }
}

此时 @Validated 需要放到类上，会对方法参数做校验。不知道为什么 @Validated 放到方法上不起作用。
如果参数校验异常，抛出 javax.validation.ConstraintViolationException 异常

3. 自定义校验

• 自定义一个注解

package com.demo.annotation;
 
import com.demo.validat.IdValidatedImpl;
 
import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;
 
@Documented
@Target({ElementType.PARAMETER, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = IdValidatedImpl.class)
public @interface IdValidated {
 
    String message() default "自定义的，得等于三！";
 
    Class<?>[] groups() default {};
 
    Class<? extends Payload>[] payload() default {};
}

• 自定义验证逻辑

package com.demo.validat;
 
import com.demo.annotation.IdValidated;
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
 
public class IdValidatedImpl implements ConstraintValidator<IdValidated, Integer> {
 
    @Override
    public void initialize(IdValidated constraintAnnotation) {
 
    }
 
    @Override
    public boolean isValid(Integer i, ConstraintValidatorContext constraintValidatorContext) {
        return i != null && i == 10;
    }
}

• 跟其他验证逻辑一样使用

package com.demo;
 
import com.demo.annotation.IdValidated;
import lombok.Data;
import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.NotNull;
 
@Data
public class Person {
 
    @NotNull(message = "id 不能为 null")
    private Integer id;
 
    @NotEmpty(message = "姓名不能为空白")
    private String name;
 
    @IdValidated
    private Integer id1;
}

4. 嵌套校验

如果对象中引用另外一个对象，内部对象的校验规则是不会生效的。我们需要通过 @Valid 来验证。

• 首先实体类

@Data
public class Person {
 
    //表示组为 Update 的时候，才会触发这个校验
    @NotNull(message = "id 不能为 null", groups = Update.class)
    private Integer id;
 
    @NotEmpty(message = "姓名不能为空白")
    private String name;
 
    @NotNull
    @Valid
    private Dog dog;
}
 
@Data
public class Dog {
    @NotNull
    private String name;
}

• @Validated 校验 Person 会捎带着 Dog 一起校验

@RequestMapping("/5")
public int test4(@RequestBody @Validated Person person){
    return 5;
}

5. 使用 groups 的校验

适用于同一个实体类，不同的接口，校验参数的标准不一样。比如新增和修改，一般新增 id 不需要，修改是必填的。

• 定义两个组

public interface Create extends Default {
}
public interface Update extends Default {
}

• 实体类的 id，只有更新才需要

@Data
public class Person {
 
    //表示组为 Update 的时候，才会触发这个校验
    @NotNull(message = "id 不能为 null", groups = Update.class)
    private Integer id;
 
    @NotEmpty(message = "姓名不能为空白")
    private String name;
 
}

• 接口验证，指明一个组

@RequestMapping("/3")
public int test2(@RequestBody @Validated(Update.class) Person person){
    return 3;
}
 
@RequestMapping("/4")
public int test3(@RequestBody @Validated(Create.class) Person person){
    return 4;
}

接口 /3 会走验证逻辑，接口 /4 直接跳过这个 Person.id 验证

6. 处理校验异常

使用 ControllerAdvice 来对异常进行处理。

package com.demo.handler;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.servlet.NoHandlerFoundException;
 
import javax.validation.ConstraintViolationException;
import javax.validation.ValidationException;
 
/**
 * @author LiJing
 * @ClassName: GlobalExceptionHandler
 * @Description: 全局异常处理器
 * @date 2019/7/30 13:57
 */
@RestControllerAdvice
public class GlobalExceptionHandler {
 
    private Logger logger = LoggerFactory.getLogger(getClass());
    private static int PARAM_FAIL_CODE = 1002;
    private static int VALIDATION_CODE = 1003;
 
 
    /**
     * 方法参数校验
     */
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public int handleMethodArgumentNotValidException(MethodArgumentNotValidException e) {
        logger.error(e.getMessage(), e);
        return PARAM_FAIL_CODE;
    }
 
    /**
     * ValidationException
     */
    @ExceptionHandler(ValidationException.class)
    public int handleValidationException(ValidationException e) {
        logger.error(e.getMessage(), e);
        return VALIDATION_CODE;
    }
 
    /**
     * ConstraintViolationException
     */
    @ExceptionHandler(ConstraintViolationException.class)
    public int handleConstraintViolationException(ConstraintViolationException e) {
        logger.error(e.getMessage(), e);
        return PARAM_FAIL_CODE;
    }
}

主要是 MethodArgumentNotValidException 和 ConstraintViolationException 两个异常。