Spring MVC：在 tomcat 中的 @ResponseBody 异常处理程序上使用 @ResponseStatus(reason = '')

Question

有谁知道为什么我不能在 Spring MVC 中的异常处理程序上使用 @ResponseStatus(reason = "My message") 同时仍返回 @ResponseBody。似乎发生的情况是，如果我使用 reason 属性

// this exception handle works, the result is a 404 and the http body is the json serialised
// {"message", "the message"}
@ExceptionHandler
@ResponseStatus(value = HttpStatus.NOT_FOUND)
public Map<String, String> notFoundHandler(NotFoundException e){
    return Collections.singletonMap("message", e.getMessage());
}

// this doesn't... the response is a 404 and the status line reads 'Really really not found'
// but the body is actually the standard Tomcat 404 page
@ExceptionHandler
@ResponseStatus(value = HttpStatus.NOT_FOUND, reason = "Really really not found")
public Map<String, String> reallyNotFoundHandler(ReallyNotFoundException e){
    return Collections.singletonMap("message", e.getMessage());
}

此示例的代码已在 github 上完成。

Answer 1

看来这是来自 AnnotationMethodHandlerExceptionResolver 的以下代码的直接结果，

private ModelAndView getModelAndView(Method handlerMethod, Object returnValue, ServletWebRequest webRequest)
        throws Exception {

    ResponseStatus responseStatusAnn = AnnotationUtils.findAnnotation(handlerMethod, ResponseStatus.class);
    if (responseStatusAnn != null) {
        HttpStatus responseStatus = responseStatusAnn.value();
        String reason = responseStatusAnn.reason();
        if (!StringUtils.hasText(reason)) {
            // this doesn't commit the response
            webRequest.getResponse().setStatus(responseStatus.value());
        }
        else {
            // this commits the response such that any more calls to write to the 
            // response are ignored
            webRequest.getResponse().sendError(responseStatus.value(), reason);
        }
    }
    /// snip
}

这已在 SPR-8251：

Answer 2

郑重声明，自 Spring 3.2 起，情况变得更糟，因为 AnnotationMethodHandlerExceptionResolver 已被 ResponseStatusExceptionResolver 取代，而且确实如此：

protected ModelAndView resolveResponseStatus(ResponseStatus responseStatus, HttpServletRequest request,
  HttpServletResponse response, Object handler, Exception ex) throws Exception {

  int statusCode = responseStatus.value().value();
  String reason = responseStatus.reason();
  if (this.messageSource != null) {
    reason = this.messageSource.getMessage(reason, null, reason, LocaleContextHolder.getLocale());
  }
  if (!StringUtils.hasLength(reason)) {
    response.sendError(statusCode);
  }
  else {
    response.sendError(statusCode, reason);
  }
  return new ModelAndView();
}

这值得报告错误。此外，@ResponseStatus 记录在 setStatus 并且设计不当。它应该被称为@ResponseError。

我最终为此创建了两个问题： SPR-11192 和 SPR-11193。

快一年过去了，我的两个问题仍然悬而未决。我不认为 Spring WebMVC 是一流的 REST 框架，恕我直言，WebMVC 是为人类而不是机器:-(