SPR-6008 - @ResponseStatus on @ExceptionHandler method is ignored

Author: poutsma

org.springframework.web.servlet/src/main/java/org/springframework/web/servlet/mvc/annotation/AnnotationMethodHandlerExceptionResolver.java

@@ -44,6 +44,7 @@
 import org.springframework.util.ObjectUtils;
 import org.springframework.util.ReflectionUtils;
 import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.bind.annotation.ResponseStatus;
 import org.springframework.web.bind.support.WebArgumentResolver;
 import org.springframework.web.context.request.NativeWebRequest;
 import org.springframework.web.context.request.ServletWebRequest;
@@ -89,14 +90,14 @@ protected ModelAndView doResolveException(HttpServletRequest request,
 		if (handler != null) {
 			Method handlerMethod = findBestExceptionHandlerMethod(handler, ex);
 			if (handlerMethod != null) {
-				NativeWebRequest webRequest = new ServletWebRequest(request, response);
+				ServletWebRequest webRequest = new ServletWebRequest(request, response);
 				try {
 					Object[] args = resolveHandlerArguments(handlerMethod, handler, webRequest, ex);
 					if (logger.isDebugEnabled()) {
 						logger.debug("Invoking request handler method: " + handlerMethod);
 					}
 					Object retVal = doInvokeMethod(handlerMethod, handler, args);
-					return getModelAndView(retVal);
+					return getModelAndView(handlerMethod, handler.getClass(), retVal, webRequest);
 				}
 				catch (Exception invocationEx) {
 					logger.error("Invoking request method resulted in exception : " + handlerMethod, invocationEx);
@@ -109,7 +110,7 @@ protected ModelAndView doResolveException(HttpServletRequest request,
 	/**
 	 * Finds the handler method that matches the thrown exception best.
 	 *
-	 * @param handler the handler object
+	 * @param handler		 the handler object
 	 * @param thrownException the exception to be handled
 	 * @return the best matching method; or <code>null</code> if none is found
 	 */
@@ -171,7 +172,9 @@ protected List<Class<? extends Throwable>> getHandledExceptions(Method method) {
 		return result;
 	}
 
-	/** Returns the best matching method. Uses the {@link DepthComparator}. */
+	/**
+	 * Returns the best matching method. Uses the {@link DepthComparator}.
+	 */
 	private Method getBestMatchingMethod(Exception thrownException,
 			Map<Class<? extends Throwable>, Method> resolverMethods) {
 		if (!resolverMethods.isEmpty()) {
@@ -186,7 +189,9 @@ private Method getBestMatchingMethod(Exception thrownException,
 		}
 	}
 
-	/** Resolves the arguments for the given method. Delegates to {@link #resolveCommonArgument}. */
+	/**
+	 * Resolves the arguments for the given method. Delegates to {@link #resolveCommonArgument}.
+	 */
 	private Object[] resolveHandlerArguments(Method handlerMethod,
 			Object handler,
 			NativeWebRequest webRequest,
@@ -221,7 +226,7 @@ private Object[] resolveHandlerArguments(Method handlerMethod,
 	 * then checking {@link #resolveStandardArgument}.
 	 *
 	 * @param methodParameter the method parameter
-	 * @param webRequest the request
+	 * @param webRequest	  the request
 	 * @param thrownException the exception thrown
 	 * @return the argument value, or {@link WebArgumentResolver#UNRESOLVED}
 	 */
@@ -256,8 +261,8 @@ protected Object resolveCommonArgument(MethodParameter methodParameter,
 	 * request {@link InputStream}, request {@link Reader}, response {@link OutputStream}, response {@link Writer},
 	 * and the given {@code thrownException}.
 	 *
-	 * @param parameterType the method parameter type
-	 * @param webRequest the request
+	 * @param parameterType   the method parameter type
+	 * @param webRequest	  the request
 	 * @param thrownException the exception thrown
 	 * @return the argument value, or {@link WebArgumentResolver#UNRESOLVED}
 	 */
@@ -319,7 +324,16 @@ private Object doInvokeMethod(Method method, Object target, Object[] args) throw
 	}
 
 	@SuppressWarnings("unchecked")
-	private ModelAndView getModelAndView(Object returnValue) {
+	private ModelAndView getModelAndView(Method handlerMethod,
+			Class handlerType,
+			Object returnValue,
+			ServletWebRequest webRequest) throws Exception {
+
+		if (handlerMethod.isAnnotationPresent(ResponseStatus.class)) {
+			ResponseStatus responseStatus = handlerMethod.getAnnotation(ResponseStatus.class);
+			HttpServletResponse response = webRequest.getResponse();
+			response.setStatus(responseStatus.value().value());
+		}
 		if (returnValue instanceof ModelAndView) {
 			return (ModelAndView) returnValue;
 		}
@@ -343,7 +357,9 @@ else if (returnValue == null) {
 		}
 	}
 
-	/** Comparator capable of sorting exceptions based on their depth from the thrown exception type. */
+	/**
+	 * Comparator capable of sorting exceptions based on their depth from the thrown exception type.
+	 */
 	private static class DepthComparator implements Comparator<Class<? extends Throwable>> {
 
 		private final Class<? extends Throwable> handlerExceptionType;

org.springframework.web.servlet/src/test/java/org/springframework/web/servlet/mvc/annotation/AnnotationMethodHandlerExceptionResolverTests.java

@@ -30,7 +30,9 @@
 import org.springframework.stereotype.Controller;
 import org.springframework.util.ClassUtils;
 import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.bind.annotation.ResponseStatus;
 import org.springframework.web.servlet.ModelAndView;
+import org.springframework.http.HttpStatus;
 
 /** @author Arjen Poutsma */
 public class AnnotationMethodHandlerExceptionResolverTests {
@@ -56,6 +58,8 @@ public void simple() {
 		ModelAndView mav = exceptionResolver.resolveException(request, response, controller, ex);
 		assertNotNull("No ModelAndView returned", mav);
 		assertEquals("Invalid view name returned", "BindException", mav.getViewName());
+		assertEquals("Invalid status code returned", 406, response.getStatus());
+
 	}
 
 	@Test(expected = IllegalStateException.class)
@@ -74,6 +78,7 @@ public String handleIOException(IOException ex, HttpServletRequest request) {
 		}
 
 		@ExceptionHandler(BindException.class)
+		@ResponseStatus(HttpStatus.NOT_ACCEPTABLE)
 		public String handleBindException(Exception ex, HttpServletResponse response) {
 			return ClassUtils.getShortName(ex.getClass());
 		}

org.springframework.web/src/main/java/org/springframework/web/bind/annotation/ExceptionHandler.java

@@ -83,6 +83,10 @@
  * only applicable in a Servlet environment).
  * </ul>
  *
+ * <p>In Servlet environments, you can combine the {@code ExceptionHandler} annotation
+ * with {@link ResponseStatus @ResponseStatus}, to define the response status
+ * for the HTTP response.
+ *
  * <p><b>NOTE: <code>@RequestMapping</code> will only be processed if a
  * corresponding <code>HandlerMapping</code> (for type level annotations)
  * and/or <code>HandlerAdapter</code> (for method level annotations) is