如何优雅地响应 Spring MVC `@ResponseBody` 方法中的 HTTP 400 错误？

2024-03-01 19:10:13

如何优雅地在 Spring MVC @ResponseBody 方法中响应 HTTP 400 错误

问题

在使用 Spring MVC 构建 JSON API 时，我们经常遇到这样的场景：使用 @ResponseBody 注释的方法返回一个 String，当需要响应 HTTP 400 错误时，我们该怎么办？

解决方法

方法一：@ResponseStatus 注解

Spring MVC 提供了 @ResponseStatus 注解，用于将异常映射到 HTTP 状态代码。我们可以通过在方法上使用此注解指定 HTTP 400 错误，如下所示：

@RequestMapping(value = "/matches/{matchId}", produces = "application/json")
@ResponseBody
@ResponseStatus(HttpStatus.BAD_REQUEST)
public String match(@PathVariable String matchId) {
    String json = matchService.getMatchJson(matchId);
    if (json == null) {
        return "错误响应信息";
    }
    return json;
}

当 json 为 null 时，Spring MVC 将自动向客户端发送 HTTP 400 错误。

方法二：ResponseEntity

虽然 @ResponseStatus 注解简单直接，但使用 ResponseEntity 可以提供更灵活的响应。我们可以手动构建一个 ResponseEntity 对象，如下所示：

@RequestMapping(value = "/matches/{matchId}", produces = "application/json")
@ResponseBody
public ResponseEntity<String> match(@PathVariable String matchId) {
    String json = matchService.getMatchJson(matchId);
    if (json == null) {
        return ResponseEntity.badRequest().body("错误响应信息");
    }
    return ResponseEntity.ok(json);
}