Spring Boot接口参数校验 - 《Java 实战笔记》

需要引入依赖spring-boot-starter-validation

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

校验可以使用的部分注解

验证注解	说明
@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的简单用法

定义接口

import org.springframework.validation.BindingResult;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;
import privs.nb.demo.param.Test;
import privs.nb.demo.response.ResponseData;
import javax.validation.Valid;
import javax.validation.constraints.Max;
/**
 * @author niubi
 */
@Validated
@RestController
@RequestMapping("/valid")
public class ValidApi {
    /**
     * 校验实体属性
     * Test为一个嵌套实体
     * 校验实体时，实体后必须紧跟BindingResult
     * @param param .
     * @param bindingResult .
     * @return .
     */
    @PostMapping("/entity")
    @ResponseBody
    public ResponseData<String> validEntity(@Valid @RequestBody Test param, BindingResult bindingResult){
        return ResponseData.ok("success");
    }
    /**
     * 校验param
     * @param id .
     * @return .
     */
    @GetMapping("/params")
    @ResponseBody
    public ResponseData<String> validParams(@Max(value = 5, message = "max") @RequestParam Integer id){
        return ResponseData.ok("success");
    }
    /**
     * 校验路径参数
     * @param id .
     * @return .
     */
    @GetMapping("/pathVar/{id}")
    @ResponseBody
    public ResponseData<String> validPathVar(@Validated @Max(value = 5, message = "max") @PathVariable(name = "id") Integer id){
        return ResponseData.ok("success");
    }
    /**
     * 使用自定义校验器
     * @param name .
     * @return .
     */
    @GetMapping("/custom")
    @ResponseBody
    public ResponseData<String> validWithTest(@privs.nb.demo.ann.Test(message = "不是tom") @RequestParam(name = "name") String name){
        return ResponseData.ok("success");
    }
}

需注意：
1 .校验实体时，实体后必须紧跟BindingResult而其他的不需要
2 .@Validated注解可以位于校验参数上，方法上，类上，但校验实体需使用@Valid

下面是接口中用到的注解及校验实体的定义
定义全局异常处理类

@ControllerAdvice
@Slf4j
public class GlobalExceptionHandler {
    @ExceptionHandler(value = ConstraintViolationException.class)
    @ResponseBody
    public ResponseData<String> errorHandler(ConstraintViolationException ex) {
        for (ConstraintViolation<?> constraintViolation : ex.getConstraintViolations()) {
            return ResponseData.error(constraintViolation.getMessage());
        }
        return ResponseData.error(ex.getMessage());
    }
}

自定义校验器

// 注解
@Target({ElementType.METHOD,ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = TestValidator.class)
public @interface Test {
    String message() ;
    Class<?>[] groups() default { };
    Class<? extends Payload>[] payload() default { };
}
// 注解实现类
@Slf4j
public class TestValidator implements ConstraintValidator<Test, Object> {
    @Override
    public void initialize(Test constraintAnnotation) {
        log.info("校验器初始化");
    }
    @Override
    public boolean isValid(Object o, ConstraintValidatorContext constraintValidatorContext) {
        String name = (String)o;
        if ("tom".equals(name)) {
            return true;
        }
        System.out.println(o);
        return false;
    }
}

定义校验实体

@Data
public class Test {
    @NotNull(message = "id不能为空")
    private String id;
    @Min(message = "age必须大于0", value = 0)
    private int age;
    @Valid
    @NotNull(message = "in不能为空")
    private TestIn in;
}
@Data
public class TestIn {
    @Test(message = "不是tom")
    private String name;
}