Spring Boot Rest Controller如何返回不同的HTTP状态代码？

Question

我使用Spring Boot作为一个简单的REST API,并希望在出现故障时返回正确的HTTP状态代码.

@RequestMapping(value="/rawdata/", method = RequestMethod.PUT)
@ResponseBody
@ResponseStatus( HttpStatus.OK )
public RestModel create(@RequestBody String data) {
    // code ommitted..
    // how do i return a correct status code if something fails?
}

作为Spring和Spring Boot的新手,基本的问题是,当某些东西正常或失败时,我如何返回不同的状态代码？

Answer 1

您可以使用多种选项.相当不错的方法是使用异常和类来处理调用@ControllerAdvice:

@ControllerAdvice
class GlobalControllerExceptionHandler {
    @ResponseStatus(HttpStatus.CONFLICT)  // 409
    @ExceptionHandler(DataIntegrityViolationException.class)
    public void handleConflict() {
        // Nothing to do
    }
}

您也可以传递HttpServletResponse给控制器方法,只需设置响应代码:

public RestModel create(@RequestBody String data, HttpServletResponse response) {
    // response committed...
    response.setStatus(HttpServletResponse.SC_ACCEPTED);
}

有关详细信息,请参阅精彩博文:http://spring.io/blog/2013/11/01/exception-handling-in-spring-mvc

注意:在Spring Boot中使用@ResponseBody注释是多余的 - 它包含在@RestController

Answer 2

其中一种方法是使用ResponseEntity作为返​​回对象.

@RequestMapping(value="/rawdata/", method = RequestMethod.PUT)

public ResponseEntity<?> create(@RequestBody String data) {

if(everything_fine)
    return new ResponseEntity<>(RestModel, HttpStatus.OK);
else
    return new ResponseEntity<>(null, HttpStatus.INTERNAL_SERVER_ERROR);

}

Answer 3

一个不错的方法是使用 Spring 的ResponseStatusException

而不是返回 aResponseEntity或类似的，您只需ResponseStatusException使用HttpStatusand 原因从控制器中抛出，例如：

throw new ResponseStatusException(HttpStatus.BAD_REQUEST, "Cause description here");

这会导致对包含 HTTP 状态的客户端的响应：

{
  "timestamp": "2020-07-09T04:43:04.695+0000",
  "status": 400,
  "error": "Bad Request",
  "message": "Cause description here",
  "path": "/test-api/v1/search"
}

注意：HttpStatus为了您的方便，提供了许多不同的状态代码。

Answer 4

如果您想返回自定义定义的状态代码，您可以使用 ResponseEntity 如下：

@RequestMapping(value="/rawdata/", method = RequestMethod.PUT)
public ResponseEntity<?> create(@RequestBody String data) {
    int customHttpStatusValue = 499;
    Foo foo = bar();
    return ResponseEntity.status(customHttpStatusValue).body(foo);
}

CustomHttpStatusValue 可以是标准 HTTP 状态代码之内或之外的任何整数。

Answer 5

试试这个代码：

@RequestMapping(value = "/validate", method = RequestMethod.GET, produces = "application/json")
public ResponseEntity<ErrorBean> validateUser(@QueryParam("jsonInput") final String jsonInput) {
    int numberHTTPDesired = 400;
    ErrorBean responseBean = new ErrorBean();
    responseBean.setError("ERROR");
    responseBean.setMensaje("Error in validation!");

    return new ResponseEntity<ErrorBean>(responseBean, HttpStatus.valueOf(numberHTTPDesired));
}