如何在Spring MVC @RestController中响应HTTP状态码@ResponseBody类返回一个对象？

Question

我想有一个@RestController这需要一个@PathVariable返回一个特定的对象JSON格式，在适当的状态代码一起。到目前为止，代码的方式，它将返回JSON格式的对象，因为它默认使用内置于Jackson库中的Spring 4。

但是我不知道如何使它所以它会给我们说希望有一个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); 
    } 
} 

---

注意，你不需要@ResponseBody在@RestController注解类中的一个@RequestMapping方法。

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