Spring Boot 参数检验

在日常的接口开发中，为了防止非法参数对业务造成影响，经常需要对接口的参数做校验。例如登录的时候需要校验用户名密码是否为空，创建用户的时候需要校验邮件、手机号码格式是否准确。靠代码对接口参数一个个校验的话就太繁琐了，代码可读性极差。

Validator 框架就是为了解决开发人员在开发的时候少写代码，提升开发效率；Validator 专门用来进行接口参数校验，例如常见的必填校验，email 格式校验，用户名必须位于 6 到 12 之间等等…

依赖

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

实体类

import java.util.Date;
import javax.validation.constraints.Email;
import javax.validation.constraints.Max;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.Past;
import javax.validation.constraints.Pattern;
import javax.validation.constraints.PositiveOrZero;
import javax.validation.constraints.Size;

import lombok.Data;

@Data
public class Student {
   @NotBlank(message = "主键不能为空")
   private String id;
   @NotBlank(message = "名字不能为空")
   @Size(min = 2, max = 10, message = "名字字符长度必须为 2~10个")
   private String name;
   @Pattern(regexp = "^1(3\d|4[5-9]|5[0-35-9]|6[567]|7[0-8]|8\d|9[0-35-9])\d{8}$", message = "手机号格式错误")
   private String phone;
   @Email(message = "邮箱格式错误")
   private String email;
   @Past(message = "生日必须早于当前时间")
   private Date birth;
   @Min(value = 0, message = "年龄必须为 0~100")
   @Max(value = 100, message = "年龄必须为 0~100")
   private Integer age;
   @PositiveOrZero
   private Double score;
}

空值检查

注解	说明
@NotBlank	用于字符串，字符串不能为 null 也不能为空字符串
@NotEmpty	字符串同上，对于集合（Map,List,Set）不能为空，必须有元素
@NotNull	不能为 null
@Null	必须为 null

数值检查

注解	说明
@DecimalMax(value)@DecimalMin(value)	被注释的元素必须为数字，其值必须小于等于指定的值被注释的元素必须为数字，其值必须大于等于指定的值
@Digits(integer, fraction)	被注释的元素必须为数字，其值的整数部分精度为 integer，小数部分精度为 fraction
@Max(value)@Min(value)	被注释的元素必须小于等于指定的值被注释的元素必须大于等于指定的值
@Positive@PositiveOrZero	被注释的元素必须为正数被注释的元素必须为正数或 0
@Negative@NegativeOrZero	被注释的元素必须为负数被注释的元素必须为负数或 0

布尔检查

注解	说明
@AssertFalse @AssertTrue	被注释的元素必须值为 false被注释的元素必须值为 true

长度检查

注解	说明
@Size(min, max)	被注释的元素长度必须在 min 和 max 之间，可以是 String、Collection、Map、数组

日期检查

注解	说明
@Future@FutureOrPresent	被注释的元素必须是一个将来的日期被注释的元素必须是现在或者将来的日期
@Past@PastOrPresent	被注释的元素必须是一个过去的日期被注释的元素必须是现在或者过去的日期

其它检查

注解	说明
@Email	被注释的元素必须是电子邮箱地址
@Pattern(regexp)	被注释的元素必须符合正则表达式

全局异常处理

import java.util.HashMap;
import java.util.Map;
import javax.servlet.http.HttpServletRequest;

import lombok.extern.slf4j.Slf4j;
import org.springframework.http.ResponseEntity;
import org.springframework.validation.BindingResult;
import org.springframework.validation.FieldError;
import org.springframework.validation.ObjectError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

@Slf4j
@ControllerAdvice
public class GlobalExceptionHandler {
   @ExceptionHandler(MethodArgumentNotValidException.class)
   @ResponseBody
   public ResponseEntity<Object> exception(MethodArgumentNotValidException e, HttpServletRequest request) {
       Map<String, String> result = new HashMap<>();
       BindingResult bindingResult = e.getBindingResult();
       log.error("请求[ {} ] {} 的参数校验发生错误", request.getMethod(), request.getRequestURL());
       for (ObjectError objectError : bindingResult.getAllErrors()) {
           FieldError fieldError = (FieldError) objectError;
           log.error("参数 {} = {} 校验错误：{}", fieldError.getField(), fieldError.getRejectedValue(), fieldError.getDefaultMessage());
           result.put(fieldError.getField(), fieldError.getDefaultMessage());
       }
       // 一般项目都会有自己定义的公共返回实体类，这里直接使用现成的 ResponseEntity 进行返回，同时设置 Http 状态码为 400
       return ResponseEntity.badRequest().body(result);
   }
}

Controller

在 controller 的接口参数上加上 @Validated 注解，参数就需要根据你定义的规则来校验：

import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class TestController {
   @GetMapping("/test")
   public Student test(@RequestBody @Validated Student student) {
       return student;
   }
}