如何从 Validated Spring RestController 获取多个缺失请求参数的详细信息？

Question

我正在尝试使用 Spring 对两个@RequestParam的验证，使用@ControllerAdvice捕获缺少参数时框架抛出的异常，并返回缺少参数的 400 错误。

所以，我的代码看起来像：

@RestController
@Validated
public class FooController {
  @RequestMapping(value = "/foo", method = RequestMethod.GET)
  @ResponseBody
  public Foo getFoo(@RequestParam LocalDate dateFrom, @RequestParam LocalDate dateTo) {
    // Do stuff
  }
}

@ControllerAdvice
public class ExceptionController {
  @ExceptionHandler(value = {MissingServletRequestParameterException.class})
  @ResponseStatus(value = HttpStatus.BAD_REQUEST)
  @ResponseBody
  public ErrorResponse handleMissingParameterException(MissingServletRequestParameterException ex) {
    return new ErrorResponse(ex.getMessage());
  }
}

如果我错过了一个参数，这将非常有效——我得到一个很好的 JSON 响应，如下所示：

{
  "reason": "Required LocalDate parameter 'dateFrom' is not present"
}

状态为 400。

然而，如果我错过了这两个参数，我会得到与上面相同的错误响应——即它只报告第一个缺少的参数，如果我能列出所有参数，我会更喜欢它。

查看异常的方法，它似乎只打算处理单个参数 - 它具有单数形式的方法getParameterName()和getParameterType() 。

有什么方法可以让 Spring 在单个异常中报告所有验证错误以改善客户端的体验？

Answer 1

取而代之的是引入一个带有验证注解的 POJO 过滤器

public class Filter {
    @NotNull
    private LocalDate dateFrom;
    @NotNull
    private LocalDate dateTo;
}

然后在控制器中使用它

public Foo getFoo(@Valid Filter filter) {
  // Do stuff
}

BindingResult 将提供所有验证错误

Answer 2

您可以设置@RequestParam(required = false)然后使用@NotNull 。

如果参数为null ，则将抛出ConstraintViolationException 。 要处理它，只需声明一个@ExceptionHandler方法。 检查下面的代码片段

@RestController
@Validated
public class FooController {
  @RequestMapping(value = "/foo", method = RequestMethod.GET)
  @ResponseBody
  public Foo getFoo(
      @RequestParam (required = false) 
      @NotNull(message = "Required LocalDate parameter dateFrom is not present") 
      LocalDate dateFrom,
      @RequestParam (required = false) 
      @NotNull(message = "Required LocalDate parameter dateTo is not present") 
      LocalDate dateTo) 
  ) {
    // Do stuff
  }
}

@ControllerAdvice
public class ExceptionController {
    @ExceptionHandler({ConstraintViolationException.class})
    public ResponseEntity<List<ErrorResponseDTO>> exceptionHandler(ConstraintViolationException e) {
        List<ErrorResponseDTO> errors = new ArrayList<>(e.getConstraintViolations().size());
        e.getConstraintViolations().forEach(violation -> errors.add(new ErrorResponseDTO(violation.getMessage())));
        return new ResponseEntity<>(errors, HttpStatus.BAD_REQUEST);
    }
}

结果会是这样的：

[
    {
        "reason": "Required LocalDate parameter dateFrom is not present"
    },
    {
        "reason": "Required LocalDate parameter dateTo is not present"
    }
]