Support @ResponseStatus on controller type level

Issue: SPR-13547

Author: rstoyanchev

spring-web/src/main/java/org/springframework/web/bind/annotation/ResponseStatus.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2015 the original author or authors.
+ * Copyright 2002-2016 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -44,6 +44,10 @@
  * preferable to use a {@link org.springframework.http.ResponseEntity} as
  * a return type and avoid the use of {@code @ResponseStatus} altogether.
  *
+ * <p>Note that a controller class may also be annotated with
+ * {@code @ResponseStatus} and is then inherited by all {@code @RequestMapping}
+ * methods.
+ *
  * @author Arjen Poutsma
  * @author Sam Brannen
  * @see org.springframework.web.servlet.mvc.annotation.ResponseStatusExceptionResolver

spring-webmvc/src/main/java/org/springframework/web/servlet/mvc/method/annotation/ServletInvocableHandlerMethod.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2015 the original author or authors.
+ * Copyright 2002-2016 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -24,6 +24,7 @@
 
 import org.springframework.core.MethodParameter;
 import org.springframework.core.ResolvableType;
+import org.springframework.core.annotation.AnnotatedElementUtils;
 import org.springframework.http.HttpStatus;
 import org.springframework.util.ClassUtils;
 import org.springframework.util.StringUtils;
@@ -82,6 +83,9 @@ public ServletInvocableHandlerMethod(HandlerMethod handlerMethod) {
 
 	private void initResponseStatus() {
 		ResponseStatus annotation = getMethodAnnotation(ResponseStatus.class);
+		if (annotation == null) {
+			annotation = AnnotatedElementUtils.findMergedAnnotation(getBeanType(), ResponseStatus.class);
+		}
 		if (annotation != null) {
 			this.responseStatus = annotation.code();
 			this.responseReason = annotation.reason();

spring-webmvc/src/test/java/org/springframework/web/servlet/mvc/method/annotation/ServletInvocableHandlerMethodTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2015 the original author or authors.
+ * Copyright 2002-2016 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -92,6 +92,15 @@ public void invokeAndHandle_VoidWithComposedResponseStatus() throws Exception {
 		assertEquals(HttpStatus.BAD_REQUEST.value(), this.response.getStatus());
 	}
 
+	@Test
+	public void invokeAndHandle_VoidWithTypeLevelResponseStatus() throws Exception {
+		ServletInvocableHandlerMethod handlerMethod = getHandlerMethod(new ResponseStatusHandler(), "handle");
+		handlerMethod.invokeAndHandle(this.webRequest, this.mavContainer);
+
+		assertTrue(this.mavContainer.isRequestHandled());
+		assertEquals(HttpStatus.BAD_REQUEST.value(), this.response.getStatus());
+	}
+
 	@Test
 	public void invokeAndHandle_VoidWithHttpServletResponseArgument() throws Exception {
 		this.argumentResolvers.addResolver(new ServletResponseMethodArgumentResolver());
@@ -169,7 +178,7 @@ public void wrapConcurrentResult_TypeLevelResponseBody() throws Exception {
 	}
 
 	private void wrapConcurrentResult_ResponseBody(Object handler) throws Exception {
-		List<HttpMessageConverter<?>> converters = new ArrayList<HttpMessageConverter<?>>();
+		List<HttpMessageConverter<?>> converters = new ArrayList<>();
 		converters.add(new StringHttpMessageConverter());
 		this.returnValueHandlers.addHandler(new RequestResponseBodyMethodProcessor(converters));
 		ServletInvocableHandlerMethod handlerMethod = getHandlerMethod(handler, "handle");
@@ -181,7 +190,7 @@ private void wrapConcurrentResult_ResponseBody(Object handler) throws Exception
 
 	@Test
 	public void wrapConcurrentResult_ResponseEntity() throws Exception {
-		List<HttpMessageConverter<?>> converters = new ArrayList<HttpMessageConverter<?>>();
+		List<HttpMessageConverter<?>> converters = new ArrayList<>();
 		converters.add(new StringHttpMessageConverter());
 		this.returnValueHandlers.addHandler(new HttpEntityMethodProcessor(converters));
 		ServletInvocableHandlerMethod handlerMethod = getHandlerMethod(new ResponseEntityHandler(), "handleDeferred");
@@ -195,7 +204,7 @@ public void wrapConcurrentResult_ResponseEntity() throws Exception {
 
 	@Test
 	public void wrapConcurrentResult_ResponseEntityNullBody() throws Exception {
-		List<HttpMessageConverter<?>> converters = new ArrayList<HttpMessageConverter<?>>();
+		List<HttpMessageConverter<?>> converters = new ArrayList<>();
 		converters.add(new StringHttpMessageConverter());
 		List<Object> advice = Collections.singletonList(mock(ResponseBodyAdvice.class));
 		HttpEntityMethodProcessor processor = new HttpEntityMethodProcessor(converters, null, advice);
@@ -210,7 +219,7 @@ public void wrapConcurrentResult_ResponseEntityNullBody() throws Exception {
 
 	@Test
 	public void wrapConcurrentResult_ResponseEntityNullReturnValue() throws Exception {
-		List<HttpMessageConverter<?>> converters = new ArrayList<HttpMessageConverter<?>>();
+		List<HttpMessageConverter<?>> converters = new ArrayList<>();
 		converters.add(new StringHttpMessageConverter());
 		List<Object> advice = Collections.singletonList(mock(ResponseBodyAdvice.class));
 		HttpEntityMethodProcessor processor = new HttpEntityMethodProcessor(converters, null, advice);
@@ -225,7 +234,7 @@ public void wrapConcurrentResult_ResponseEntityNullReturnValue() throws Exceptio
 
 	@Test
 	public void wrapConcurrentResult_ResponseBodyEmitter() throws Exception {
-		List<HttpMessageConverter<?>> converters = new ArrayList<HttpMessageConverter<?>>();
+		List<HttpMessageConverter<?>> converters = new ArrayList<>();
 		converters.add(new StringHttpMessageConverter());
 		this.returnValueHandlers.addHandler(new ResponseBodyEmitterReturnValueHandler(converters));
 		ServletInvocableHandlerMethod handlerMethod = getHandlerMethod(new AsyncHandler(), "handleWithEmitter");
@@ -272,6 +281,7 @@ private ServletInvocableHandlerMethod getHandlerMethod(Object controller,
 		return handlerMethod;
 	}
 
+	@SuppressWarnings("unused")
 	@ResponseStatus
 	@Retention(RetentionPolicy.RUNTIME)
 	@interface ComposedResponseStatus {
@@ -311,6 +321,14 @@ public Object dynamicReturnValue(@RequestParam(required=false) String param) {
 		}
 	}
 
+	@SuppressWarnings("unused")
+	@ResponseStatus(HttpStatus.BAD_REQUEST)
+	private static class ResponseStatusHandler {
+
+		public void handle() {
+		}
+	}
+
 	private static class MethodLevelResponseBodyHandler {
 
 		@ResponseBody
@@ -324,7 +342,7 @@ public DeferredResult<String> handle() {
 	private static class TypeLevelResponseBodyHandler {
 
 		public DeferredResult<String> handle() {
-			return new DeferredResult<String>();
+			return new DeferredResult<>();
 		}
 	}
 

src/asciidoc/whats-new.adoc

@@ -653,6 +653,7 @@ Spring 4.3 also improves the caching abstraction as follows:
 === Web Improvements
 
 * New `@RestControllerAdvice` annotation combines `@ControllerAdvice` with `@ResponseBody`.
+* `@ResponseStatus` can be used on a controller type is inherited for all method.
 * `AsyncRestTemplate` supports request interception.
 
 === Testing Improvements