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) {
    // code ommitted..
    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

您无需返回ResponseEntity或类似的命令，而只需使用ResponseStatusException从控制器中抛出HttpStatus并引起例如：

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

或：

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

这会导致对客户端的响应包含HTTP状态（例如400错误的请求），其正文如下：

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

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));
}

Answer 6

有多种方法返回状态码， 1：RestController类应该扩展BaseRest类，在BaseRest类中，我们可以处理异常并返回预期的错误代码。例如：

@RestController
@RequestMapping
class RestController extends BaseRest{

}

@ControllerAdvice
public class BaseRest {
@ExceptionHandler({Exception.class,...})
    @ResponseStatus(value=HttpStatus.INTERNAL_SERVER_ERROR)
    public ErrorModel genericError(HttpServletRequest request, 
            HttpServletResponse response, Exception exception) {
        
        ErrorModel error = new ErrorModel();
        resource.addError("error code", exception.getLocalizedMessage());
        return error;
    }

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

6 个答案: