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

102

我将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的新手，基本问题是当出现问题或失败时如何返回不同的状态代码？

spring rest spring-boot

— 马可
source

117

您可以使用几个选项。很好的方法是使用异常和类进行处理@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);
}

有关详细信息，请参阅此出色的博客文章：Spring MVC中的异常处理

注意

在Spring MVC中，使用@ResponseBody注释是多余的-它已经包含在@RestController注释中。

— 雅库布·库布林斯基（Jakub Kubrynski）
source

就像评论一样，我在15分钟前进行了测试，在他的方法上没有'@ResponseBody'注释的'@RestController'将返回的字符串放在主体内，而不是ForwardedURL。我对自己的spring / springboot相当

— 陌生，

@Anearion答案中有一个错字-我们实际上需要'@RestControllerAdvice'，而不是'@RestController'。

— yoliho

这不是错字。这部分与控制器上的问题和注释相关

— Jakub Kubrynski '17

1

注意，这javax.servlet.http.HttpServletResponse似乎并没有所有的StatusCodes org.springframework.http.HttpStatus。因此，您可以HttpStatus.UNPROCESSABLE_ENTITY.value()用来将int值传递给response.setStatus。这对于使用进行错误处理也非常有效@ExceptionHandler。

— 伊戈尔（Igor）

43

一种方法是将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);

}

— 安吉·巴萨卡（Ankit Basarkar）
source

3

无需在更高版本的Spring中使用null：new ResponseEntity <>（HttpStatus.NOT_FOUND）

— Kong

4

试试这个代码：

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

— 罗德里戈·埃尔南德斯（Rodrigo Hernandez）
source

由于这是一个比较老的问题，因此您应该添加要参考的软件包和版本信息。

— ZF007 '18

您可以提供一个示例实现ErrorBean吗？

— 布伦特·布拉德本

3

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

无需返回a ResponseEntity或类似内容，您只需ResponseStatusException使用HttpStatusand原因从控制器中抛出the即可，例如：

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

要么：

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

这会导致对客户端的响应包含以下内容，例如HTTP状态（例如400 Bad请求）：

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

— 连续性8
source

2

如果您想返回自定义的状态码，可以使用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状态代码之内或之外的任何整数。

— 韦丹·冈卡（Vedant Goenka）
source

我喜欢这种流利的API方法。

— v.ladynev

0

返回状态代码的方法有多种，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;
    }

— 文殊D
source