Spring Boot请求正文验证在输入无效数据类型时添加自定义消息

Question

我使用Spring Boot创建一个POST请求，我需要根据用户输入验证请求体。但是，当用户输入无效的数据类型时，响应不显示任何内容，只显示< code>400 bad request状态。我可以添加一条消息来告诉用户哪个字段是无效的数据类型吗？

例如:这是我的控制器:

@RestController
@RequestMapping("/api/foo")
public class FooController {

  @PostMapping("/save")
  public void postFoo(@Valid @RequestBody Foo foo) {
    // do somethings
  }
}

这是我的Foo类：

public class Foo {
  @NotBlank
  private String name;
  private Integer age;

  // getter/setter
}

所以现在我发布一个请求如下：

{
  "name": "Foo Name",
  "age": "A String"
}

服务器将以状态400错误请求响应，没有任何消息。我如何将我的消息，例如age必须是整数。

到目前为止，我只有一个解决方案，可以将 Age 更改为字符串，并添加一个@Pattern验证批注。

public class Foo {
  @NotBlank
  private String name;
  @Pattern(regexp = "[0-9]*", message = "Age must be an intege")
  private String age;

  // getter/setter
}

Answer 1

在post方法签名中，您可以使用响应实体类来显示一些要返回给用户的异常消息，以及一些状态代码。

公共类FooController{

公共响应实体

{

返回新的ResponseEntity

}

}

Answer 2

谢谢大家。我找到了一种添加消息和响应用户可以意识到错误的方法，方法是使用ControllerAdvice并重写handleHttpMessageNotReadablemethod，如下所示：

@ControllerAdvice
public class ErrorHandlerConfig extends ResponseEntityExceptionHandler {
 @Override
protected ResponseEntity<Object> handleHttpMessageNotReadable(HttpMessageNotReadableException ex, HttpHeaders headers,
                                                              HttpStatus status, WebRequest request) {
    if (ex.getCause() instanceof InvalidFormatException) {
        InvalidFormatException iex = (InvalidFormatException) ex.getCause();
        List<Map<String, String>> errors = new ArrayList<>();
        iex.getPath().forEach(reference -> {
            Map<String, String> error = new HashMap<>();
            error.put(reference.getFieldName(), iex.getOriginalMessage());
            errors.add(error);
        });

        return handleExceptionInternal(ex, errors, new HttpHeaders(), apiError.getStatus(), request);
    }
    return super.handleHttpMessageNotReadable(ex, headers, status, request);
}
}

响应将是：

[
    {
        "testId": "Cannot deserialize value of type `java.lang.Long` from String \"accm\": not a valid Long value"
    }
]

Answer 3

您需要实现错误处理机制。

在错误处理程序中，您需要捕获所有异常并返回错误响应。下面是基于控制器级异常处理的示例

public class FooController{

   //...
   @ResponseStatus(value=HttpStatus.BAD_REQUEST)
   @ExceptionHandler({ CustomException1.class, CustomException2.class })
      public ErrorResponse handleException() {
      //
   }
}

在ErrorResponse模型中，您可以根据异常设置错误代码和消息，并通过ResponseStatus分配http错误代码

然而，这种方法有一个主要缺点：@ExceptionHandler注释的方法只对特定的Controller有效，而不是对整个应用程序全局有效。

要全局处理异常，可以使用ControllerAdvice。下面是一篇关于总体错误处理机制的好文章