Spring Boot参数验证,基于Hibernate Validator

(1)、maven地址

<dependency>
    <groupId>org.hibernate</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>6.0.1.Final</version>
</dependency>

(2)、控制器定义

@RestController
@RequestMapping("/api/panManage")
@Validated
public class PanManage extends Base {

    /**
     * 获取网盘数据
     *
     * @param request
     * @return
     */
    @GetMapping("/get")
    public ResponseJson get(@Valid @RequestBody PanGetRequest request) {
        return new ResponseJson(null, 200, "success");
    }

    /**
     * 上传网盘数据
     *
     * @param request
     * @return
     * @throws BusinessException
     */
    @PostMapping("/set")
    public ResponseJson set(@Valid @RequestBody PanSetRequest request) {
        return new ResponseJson(null, 200, "success");
    }
}

(3)、实参定义

public class PanGetRequest {
    @NotNull(message = "文件编号不能为null")
    @NotBlank(message = "文件编号不能为空")
    String id;

    public String getId() {
        return id;
    }

    public void setId(String id) {
        this.id = id;
    }
}

(4)、定义全局异常（校验失败会抛出异常）

@ExceptionHandler({MethodArgumentNotValidException.class})
public ResponseJson handleMethodArgumentNotValidException(MethodArgumentNotValidException ex) {
    BindingResult bindingResult = ex.getBindingResult();
    StringBuilder sb = new StringBuilder("校验失败的参数");
    for (FieldError fieldError : bindingResult.getFieldErrors()) {
        sb.append(fieldError.getField()).append("：").append(fieldError.getDefaultMessage()).append(", ");
    }
    String msg = sb.toString();
    return new ResponseJson(null, 0, msg);
}

@ExceptionHandler({ConstraintViolationException.class})
@ResponseBody
public ResponseJson handleConstraintViolationException(ConstraintViolationException ex) {
    return new ResponseJson(null, 0, ex.getMessage());
}