如何在返回字符串的Spring MVC@ResponseBody方法中响应HTTP 400错误

Question

我使用Spring MVC作为一个简单的JSON API，使用基于@响应体的方法，如下所示。（我已经有一个直接生成JSON的服务层。）

@RequestMapping(value = "/matches/{matchId}", produces = "application/json")
@ResponseBody
public String match(@PathVariable String matchId) {
    String json = matchService.getMatchJson(matchId);
    if (json == null) {
        // TODO: how to respond with e.g. 400 "bad request"?
    }
    return json;
}

在给定的场景中，最简单、最干净的HTTP 400错误响应方式是什么？

我确实遇到了这样的方法：

return new ResponseEntity(HttpStatus.BAD_REQUEST);

...但是我不能在这里使用它，因为我的方法的返回类型是字符串，而不是响应实体。

Answer 1

这不一定是最简洁的方式，但在我看来，它相当干净：

if(json == null) {
    throw new BadThingException();
}
...

@ExceptionHandler(BadThingException.class)
@ResponseStatus(value = HttpStatus.BAD_REQUEST)
public @ResponseBody MyError handleException(BadThingException e) {
    return new MyError("That doesn’t work");
}

如果使用Spring 3.1，则可以在异常处理程序方法中使用@ResponseBody，否则可以使用ModelAndView等。

@ResponseBody不能与@ExceptionHandler[SPR-6902]#11567一起使用

Answer 2

这样的方法应该行得通，但我不确定是否有更简单的方法：

@RequestMapping(value = "/matches/{matchId}", produces = "application/json")
@ResponseBody
public String match(@PathVariable String matchId, @RequestBody String body,
            HttpServletRequest request, HttpServletResponse response) {
    String json = matchService.getMatchJson(matchId);
    if (json == null) {
        response.setStatus( HttpServletResponse.SC_BAD_REQUEST  );
    }
    return json;
}

Answer 3

将返回类型更改为响应类型

return new ResponseEntity<>(HttpStatus.BAD_REQUEST);

对于正确的请求：

return new ResponseEntity<>(json,HttpStatus.OK);

Spring 4.1之后，ResponseEntity中有一些辅助方法可以用作：

return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(null);

和

return ResponseEntity.ok(json);