使用Spring MVC,接受带有错误JSON的POST请求会导致返回默认的400错误代码服务器页面

时间:2013-06-19 20:51:28

标签: java rest spring-mvc

我正在研究REST api。接收带有错误JSON的POST消息(例如{sdfasdfasdf})会导致Spring返回400 Bad Request Error的默认服务器页面。我不想返回页面,我想返回一个自定义的JSON Error对象。

当使用@ExceptionHandler抛出异常时,我可以这样做。因此,如果它是一个空白请求或一个空白JSON对象(例如{}),它将抛出一个NullPointerException,我可以用我的ExceptionHandler捕获它并做任何我想做的事。

问题是,Spring只是在它只是无效语法时实际上不会抛出异常...至少不是我能看到的。它只是从服务器返回默认错误页面,无论是Tomcat,Glassfish等。

所以我的问题是如何“拦截”Spring并使其使用我的异常处理程序或以其他方式阻止显示错误页面而是返回JSON错误对象?

这是我的代码:

@RequestMapping(value = "/trackingNumbers", method = RequestMethod.POST, consumes = "application/json")
@ResponseBody
public ResponseEntity<String> setTrackingNumber(@RequestBody TrackingNumber trackingNumber) {

    HttpStatus status = null;
    ResponseStatus responseStatus = null;
    String result = null;
    ObjectMapper mapper = new ObjectMapper();

    trackingNumbersService.setTrackingNumber(trackingNumber);
    status = HttpStatus.CREATED;
    result = trackingNumber.getCompany();


    ResponseEntity<String> response = new ResponseEntity<String>(result, status);

    return response;    
}

@ExceptionHandler({NullPointerException.class, EOFException.class})
@ResponseBody
public ResponseEntity<String> resolveException()
{
    HttpStatus status = null;
    ResponseStatus responseStatus = null;
    String result = null;
    ObjectMapper mapper = new ObjectMapper();

    responseStatus = new ResponseStatus("400", "That is not a valid form for a TrackingNumber object " + 
            "({\"company\":\"EXAMPLE\",\"pro_bill_id\":\"EXAMPLE123\",\"tracking_num\":\"EXAMPLE123\"})");
    status = HttpStatus.BAD_REQUEST;

    try {
        result = mapper.writeValueAsString(responseStatus);
    } catch (IOException e1) {
        e1.printStackTrace();
    }

    ResponseEntity<String> response = new ResponseEntity<String>(result, status);

    return response;
}

1 个答案:

答案 0 :(得分:15)

这是Spring问题引发的SPR-7439 - JSON(杰克逊)@RequestBody编组引发了一个尴尬的异常 - 在Spring 3.1M2中通过弹出一个org.springframework.http.converter.HttpMessageNotReadableException来修复邮件正文丢失或无效。

在你的代码中,你不能创建一个ResponseStatus,因为它是抽象的,但我测试了在本地使用一个更简单的方法捕获此异常,并在Jetty 9.0.3.v20130506上运行Spring 3.2.0.RELEASE。

@ExceptionHandler({org.springframework.http.converter.HttpMessageNotReadableException.class})
@ResponseStatus(HttpStatus.BAD_REQUEST)
@ResponseBody
public String resolveException() {
    return "error";
}

我收到400状态“错误”字符串响应。

this Spring论坛帖子中讨论了这个缺陷。

注意:我开始使用Jetty 9.0.0.M4进行测试但是还有一些其他内部问题阻止@ExceptionHandler完成,所以取决于你的容器(Jetty,Tomcat,其他)您可能需要获得一个更新版本的版本,该版本与您正在使用的任何版本的Spring都能很好地配合使用。