Support attribute overrides with @ResponseStatus

This commit introduces support for attribute overrides for
@ResponseStatus when @ResponseStatus is used as a meta-annotation on
a custom composed annotation.

Specifically, this commit migrates all code that looks up
@ResponseStatus from using AnnotationUtils.findAnnotation() to using
AnnotatedElementUtils.findMergedAnnotation().

Issue: SPR-13441

Author: sbrannen

spring-test/src/test/java/org/springframework/test/web/servlet/samples/standalone/resultmatchers/StatusAssertionTests.java

@@ -16,8 +16,12 @@
 
 package org.springframework.test.web.servlet.samples.standalone.resultmatchers;
 
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+
 import org.junit.Test;
 
+import org.springframework.core.annotation.AliasFor;
 import org.springframework.http.HttpStatus;
 import org.springframework.stereotype.Controller;
 import org.springframework.test.web.servlet.MockMvc;
@@ -26,6 +30,7 @@
 import org.springframework.web.bind.annotation.ResponseStatus;
 
 import static org.hamcrest.Matchers.*;
+import static org.springframework.http.HttpStatus.*;
 import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*;
 import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*;
 import static org.springframework.test.web.servlet.setup.MockMvcBuilders.*;
@@ -34,6 +39,7 @@
  * Examples of expectations on the status and the status reason found in the response.
  *
  * @author Rossen Stoyanchev
+ * @author Sam Brannen
  */
 public class StatusAssertionTests {
 
@@ -42,12 +48,14 @@ public class StatusAssertionTests {
 	@Test
 	public void testStatusInt() throws Exception {
 		this.mockMvc.perform(get("/created")).andExpect(status().is(201));
+		this.mockMvc.perform(get("/createdWithComposedAnnotation")).andExpect(status().is(201));
 		this.mockMvc.perform(get("/badRequest")).andExpect(status().is(400));
 	}
 
 	@Test
 	public void testHttpStatus() throws Exception {
 		this.mockMvc.perform(get("/created")).andExpect(status().isCreated());
+		this.mockMvc.perform(get("/createdWithComposedAnnotation")).andExpect(status().isCreated());
 		this.mockMvc.perform(get("/badRequest")).andExpect(status().isBadRequest());
 	}
 
@@ -66,27 +74,43 @@ public void testReasonEqualTo() throws Exception {
 
 	@Test
 	public void testReasonMatcher() throws Exception {
-		this.mockMvc.perform(get("/badRequest"))
-			.andExpect(status().reason(endsWith("token")));
+		this.mockMvc.perform(get("/badRequest")).andExpect(status().reason(endsWith("token")));
 	}
 
 
+	@RequestMapping
+	@ResponseStatus
+	@Retention(RetentionPolicy.RUNTIME)
+	@interface Get {
+
+		@AliasFor(annotation = RequestMapping.class, attribute = "path")
+		String[] path() default {};
+
+		@AliasFor(annotation = ResponseStatus.class, attribute = "code")
+		HttpStatus status() default INTERNAL_SERVER_ERROR;
+	}
+
 	@Controller
 	private static class StatusController {
 
 		@RequestMapping("/created")
-		@ResponseStatus(HttpStatus.CREATED)
+		@ResponseStatus(CREATED)
 		public @ResponseBody void created(){
 		}
 
+		@Get(path = "/createdWithComposedAnnotation", status = CREATED)
+		public @ResponseBody void createdWithComposedAnnotation() {
+		}
+
 		@RequestMapping("/badRequest")
-		@ResponseStatus(code = HttpStatus.BAD_REQUEST, reason = "Expired token")
+		@ResponseStatus(code = BAD_REQUEST, reason = "Expired token")
 		public @ResponseBody void badRequest(){
 		}
 
 		@RequestMapping("/notImplemented")
-		@ResponseStatus(HttpStatus.NOT_IMPLEMENTED)
+		@ResponseStatus(NOT_IMPLEMENTED)
 		public @ResponseBody void notImplemented(){
 		}
 	}
+
 }

spring-web/src/main/java/org/springframework/web/method/HandlerMethod.java

@@ -25,23 +25,25 @@
 import org.springframework.beans.factory.BeanFactory;
 import org.springframework.core.BridgeMethodResolver;
 import org.springframework.core.MethodParameter;
-import org.springframework.core.annotation.AnnotationUtils;
+import org.springframework.core.annotation.AnnotatedElementUtils;
 import org.springframework.core.annotation.SynthesizingMethodParameter;
 import org.springframework.util.Assert;
 import org.springframework.util.ClassUtils;
 
 /**
  * Encapsulates information about a handler method consisting of a
  * {@linkplain #getMethod() method} and a {@linkplain #getBean() bean}.
- * Provides convenient access to method parameters, method return value, method annotations.
+ * Provides convenient access to method parameters, the method return value,
+ * method annotations, etc.
  *
  * <p>The class may be created with a bean instance or with a bean name (e.g. lazy-init bean,
- * prototype bean). Use {@link #createWithResolvedBean()} to obtain a {@link HandlerMethod}
+ * prototype bean). Use {@link #createWithResolvedBean()} to obtain a {@code HandlerMethod}
  * instance with a bean instance resolved through the associated {@link BeanFactory}.
  *
  * @author Arjen Poutsma
  * @author Rossen Stoyanchev
  * @author Juergen Hoeller
+ * @author Sam Brannen
  * @since 3.1
  */
 public class HandlerMethod {
@@ -98,7 +100,7 @@ public HandlerMethod(Object bean, String methodName, Class<?>... parameterTypes)
 	/**
 	 * Create an instance from a bean name, a method, and a {@code BeanFactory}.
 	 * The method {@link #createWithResolvedBean()} may be used later to
-	 * re-create the {@code HandlerMethod} with an initialized the bean.
+	 * re-create the {@code HandlerMethod} with an initialized bean.
 	 */
 	public HandlerMethod(String beanName, BeanFactory beanFactory, Method method) {
 		Assert.hasText(beanName, "Bean name is required");
@@ -222,11 +224,14 @@ public boolean isVoid() {
 	/**
 	 * Returns a single annotation on the underlying method traversing its super methods
 	 * if no annotation can be found on the given method itself.
+	 * <p>Also supports <em>merged</em> composed annotations with attribute
+	 * overrides as of Spring Framework 4.2.2.
 	 * @param annotationType the type of annotation to introspect the method for.
 	 * @return the annotation, or {@code null} if none found
+	 * @see AnnotatedElementUtils#findMergedAnnotation
 	 */
 	public <A extends Annotation> A getMethodAnnotation(Class<A> annotationType) {
-		return AnnotationUtils.findAnnotation(this.method, annotationType);
+		return AnnotatedElementUtils.findMergedAnnotation(this.method, annotationType);
 	}
 
 	/**

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

@@ -56,6 +56,7 @@
 import org.springframework.core.DefaultParameterNameDiscoverer;
 import org.springframework.core.Ordered;
 import org.springframework.core.ParameterNameDiscoverer;
+import org.springframework.core.annotation.AnnotatedElementUtils;
 import org.springframework.core.annotation.AnnotationUtils;
 import org.springframework.http.HttpEntity;
 import org.springframework.http.HttpHeaders;
@@ -119,7 +120,7 @@
 
 /**
  * Implementation of the {@link org.springframework.web.servlet.HandlerAdapter} interface
- * that maps handler methods based on HTTP paths, HTTP methods and request parameters
+ * that maps handler methods based on HTTP paths, HTTP methods, and request parameters
  * expressed through the {@link RequestMapping} annotation.
  *
  * <p>Supports request parameter binding through the {@link RequestParam} annotation.
@@ -133,6 +134,7 @@
  *
  * @author Juergen Hoeller
  * @author Arjen Poutsma
+ * @author Sam Brannen
  * @since 2.5
  * @see #setPathMatcher
  * @see #setMethodNameResolver
@@ -911,19 +913,19 @@ else if (Writer.class.isAssignableFrom(parameterType)) {
 		public ModelAndView getModelAndView(Method handlerMethod, Class<?> handlerType, Object returnValue,
 				ExtendedModelMap implicitModel, ServletWebRequest webRequest) throws Exception {
 
-			ResponseStatus responseStatusAnn = AnnotationUtils.findAnnotation(handlerMethod, ResponseStatus.class);
-			if (responseStatusAnn != null) {
-				HttpStatus responseStatus = responseStatusAnn.code();
-				String reason = responseStatusAnn.reason();
+			ResponseStatus responseStatus = AnnotatedElementUtils.findMergedAnnotation(handlerMethod, ResponseStatus.class);
+			if (responseStatus != null) {
+				HttpStatus statusCode = responseStatus.code();
+				String reason = responseStatus.reason();
 				if (!StringUtils.hasText(reason)) {
-					webRequest.getResponse().setStatus(responseStatus.value());
+					webRequest.getResponse().setStatus(statusCode.value());
 				}
 				else {
-					webRequest.getResponse().sendError(responseStatus.value(), reason);
+					webRequest.getResponse().sendError(statusCode.value(), reason);
 				}
 
 				// to be picked up by the RedirectView
-				webRequest.getRequest().setAttribute(View.RESPONSE_STATUS_ATTRIBUTE, responseStatus);
+				webRequest.getRequest().setAttribute(View.RESPONSE_STATUS_ATTRIBUTE, statusCode);
 
 				this.responseArgumentUsed = true;
 			}

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

@@ -43,6 +43,7 @@
 import org.springframework.core.ExceptionDepthComparator;
 import org.springframework.core.GenericTypeResolver;
 import org.springframework.core.MethodParameter;
+import org.springframework.core.annotation.AnnotatedElementUtils;
 import org.springframework.core.annotation.AnnotationUtils;
 import org.springframework.core.annotation.SynthesizingMethodParameter;
 import org.springframework.http.HttpInputMessage;
@@ -377,15 +378,15 @@ private Object doInvokeMethod(Method method, Object target, Object[] args) throw
 	private ModelAndView getModelAndView(Method handlerMethod, Object returnValue, ServletWebRequest webRequest)
 			throws Exception {
 
-		ResponseStatus responseStatusAnn = AnnotationUtils.findAnnotation(handlerMethod, ResponseStatus.class);
-		if (responseStatusAnn != null) {
-			HttpStatus responseStatus = responseStatusAnn.code();
-			String reason = responseStatusAnn.reason();
+		ResponseStatus responseStatus = AnnotatedElementUtils.findMergedAnnotation(handlerMethod, ResponseStatus.class);
+		if (responseStatus != null) {
+			HttpStatus statusCode = responseStatus.code();
+			String reason = responseStatus.reason();
 			if (!StringUtils.hasText(reason)) {
-				webRequest.getResponse().setStatus(responseStatus.value());
+				webRequest.getResponse().setStatus(statusCode.value());
 			}
 			else {
-				webRequest.getResponse().sendError(responseStatus.value(), reason);
+				webRequest.getResponse().sendError(statusCode.value(), reason);
 			}
 		}
 

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

@@ -22,7 +22,7 @@
 import org.springframework.context.MessageSource;
 import org.springframework.context.MessageSourceAware;
 import org.springframework.context.i18n.LocaleContextHolder;
-import org.springframework.core.annotation.AnnotationUtils;
+import org.springframework.core.annotation.AnnotatedElementUtils;
 import org.springframework.util.StringUtils;
 import org.springframework.web.bind.annotation.ResponseStatus;
 import org.springframework.web.servlet.ModelAndView;
@@ -38,11 +38,14 @@
  * and the MVC Java config and the MVC namespace.
  *
  * <p>As of 4.2 this resolver also looks recursively for {@code @ResponseStatus}
- * present on cause exceptions.
+ * present on cause exceptions, and as of 4.2.2 this resolver supports
+ * attribute overrides for {@code @ResponseStatus} in custom composed annotations.
  *
  * @author Arjen Poutsma
  * @author Rossen Stoyanchev
+ * @author Sam Brannen
  * @since 3.0
+ * @see AnnotatedElementUtils#findMergedAnnotation
  */
 public class ResponseStatusExceptionResolver extends AbstractHandlerExceptionResolver implements MessageSourceAware {
 
@@ -59,7 +62,7 @@ public void setMessageSource(MessageSource messageSource) {
 	protected ModelAndView doResolveException(HttpServletRequest request, HttpServletResponse response,
 			Object handler, Exception ex) {
 
-		ResponseStatus responseStatus = AnnotationUtils.findAnnotation(ex.getClass(), ResponseStatus.class);
+		ResponseStatus responseStatus = AnnotatedElementUtils.findMergedAnnotation(ex.getClass(), ResponseStatus.class);
 		if (responseStatus != null) {
 			try {
 				return resolveResponseStatus(responseStatus, request, response, handler, ex);