如何在返回对象的 Spring MVC @RestController @ResponseBody 类中使​​用 HTTP 状态代码进行响应？

Question

我正在尝试让 @RestController 接受 @PathVariable 返回 JSON 格式的特定对象以及正确的状态代码。到目前为止，代码的方式是返回 JSON 格式的对象，因为它默认使用 Spring 4 内置的 Jackson 库。

但是我不知道如何制作它，所以它会向用户发送一条消息，说我们想要一个 api 变量，然后是 JSON 数据，然后是错误代码（或成功代码，取决于一切是否顺利）。示例输出为：

请输入 api 值作为参数（注意，如果需要，也可以是 JSON）

{"id": 2, "api": "3000105000" ... }（注意这将是 JSON 响应对象）

状态码 400（或正确的状态码）

---

带参数的url是这样的

http://localhost:8080/gotech/api/v1/api/3000105000

我目前的代码：

@RestController
@RequestMapping(value = "/api/v1")
public class ClientFetchWellDataController {

    @Autowired
    private OngardWellService ongardWellService;

    @RequestMapping(value = "/wells/{apiValue}", method = RequestMethod.GET)
    @ResponseBody
    public OngardWell fetchWellData(@PathVariable String apiValue){
        try{
            OngardWell ongardWell = new OngardWell();
            ongardWell = ongardWellService.fetchOneByApi(apiValue);
    
            return ongardWell;
        }catch(Exception ex){
            String errorMessage;
            errorMessage = ex + " <== error";
            return null;
        }
    }
}

Answer 1

@RestController 不适用于此。如果您需要返回不同类型的响应，请使用ResponseEntity<?>，您可以在其中明确设置状态代码。

ResponseEntity 中的body 的处理方式与任何@ResponseBody 注释方法的返回值相同。

@RequestMapping(value = "/wells/{apiValue}", method = RequestMethod.GET)
public ResponseEntity<?> fetchWellData(@PathVariable String apiValue){
    try{
        OngardWell ongardWell = new OngardWell();
        ongardWell = ongardWellService.fetchOneByApi(apiValue);

        return new ResponseEntity<>(ongardWell, HttpStatus.OK);
    }catch(Exception ex){
        String errorMessage;
        errorMessage = ex + " <== error";
        return new ResponseEntity<>(errorMessage, HttpStatus.BAD_REQUEST);
    }
}

---

请注意，@RestController 注释类中的 @RequestMapping 方法不需要 @ResponseBody。

Answer 2

惯用的方法是使用异常处理程序，而不是在常规请求处理方法中捕获异常。异常的类型决定了响应代码。 （403 表示安全错误，500 表示意外平台异常，随你喜欢）

@ExceptionHandler(MyApplicationException.class)
@ResponseStatus(HttpStatus.BAD_REQUEST)
public String handleAppException(MyApplicationException ex) {
  return ex.getMessage();
}

@ExceptionHandler(Exception.class)
@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
public String handleAppException(Exception ex) {
  return ex.getMessage();
}