Introduce value attribute in @RestController

Stereotype annotations should support a 'value' attribute for
specifying the name of the Spring-managed component; however,
@RestController currently does not provide such an attribute.

This commit introduces a 'value' attribute in @RestController so that
developers can provide custom names for components annotated with
@RestController.

Issue: SPR-11360

spring-context/src/test/java/org/springframework/context/annotation/AnnotationBeanNameGeneratorTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2013 the original author or authors.
+ * Copyright 2002-2014 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.
@@ -27,6 +27,7 @@ import org.springframework.beans.factory.annotation.AnnotatedGenericBeanDefiniti
 import org.springframework.beans.factory.support.BeanDefinitionRegistry;
 import org.springframework.beans.factory.support.SimpleBeanDefinitionRegistry;
 import org.springframework.stereotype.Component;
+import org.springframework.stereotype.Controller;
 import org.springframework.stereotype.Service;
 import org.springframework.util.StringUtils;
 
@@ -34,10 +35,13 @@ import example.scannable.DefaultNamedComponent;
 import static org.junit.Assert.*;
 
 /**
+ * Unit tests for {@link AnnotationBeanNameGenerator}.
+ *
  * @author Rick Evans
  * @author Juergen Hoeller
  * @author Mark Fisher
  * @author Chris Beams
+ * @author Sam Brannen
  */
 public class AnnotationBeanNameGeneratorTests {
 
@@ -45,7 +49,7 @@ public class AnnotationBeanNameGeneratorTests {
 
 
 	@Test
-	public void testGenerateBeanNameWithNamedComponent() {
+	public void generateBeanNameWithNamedComponent() {
 		BeanDefinitionRegistry registry = new SimpleBeanDefinitionRegistry();
 		AnnotatedBeanDefinition bd = new AnnotatedGenericBeanDefinition(ComponentWithName.class);
 		String beanName = this.beanNameGenerator.generateBeanName(bd, registry);
@@ -55,7 +59,7 @@ public class AnnotationBeanNameGeneratorTests {
 	}
 
 	@Test
-	public void testGenerateBeanNameWithDefaultNamedComponent() {
+	public void generateBeanNameWithDefaultNamedComponent() {
 		BeanDefinitionRegistry registry = new SimpleBeanDefinitionRegistry();
 		AnnotatedBeanDefinition bd = new AnnotatedGenericBeanDefinition(DefaultNamedComponent.class);
 		String beanName = this.beanNameGenerator.generateBeanName(bd, registry);
@@ -65,7 +69,7 @@ public class AnnotationBeanNameGeneratorTests {
 	}
 
 	@Test
-	public void testGenerateBeanNameWithNamedComponentWhereTheNameIsBlank() {
+	public void generateBeanNameWithNamedComponentWhereTheNameIsBlank() {
 		BeanDefinitionRegistry registry = new SimpleBeanDefinitionRegistry();
 		AnnotatedBeanDefinition bd = new AnnotatedGenericBeanDefinition(ComponentWithBlankName.class);
 		String beanName = this.beanNameGenerator.generateBeanName(bd, registry);
@@ -76,7 +80,7 @@ public class AnnotationBeanNameGeneratorTests {
 	}
 
 	@Test
-	public void testGenerateBeanNameWithAnonymousComponentYieldsGeneratedBeanName() {
+	public void generateBeanNameWithAnonymousComponentYieldsGeneratedBeanName() {
 		BeanDefinitionRegistry registry = new SimpleBeanDefinitionRegistry();
 		AnnotatedBeanDefinition bd = new AnnotatedGenericBeanDefinition(AnonymousComponent.class);
 		String beanName = this.beanNameGenerator.generateBeanName(bd, registry);
@@ -87,7 +91,7 @@ public class AnnotationBeanNameGeneratorTests {
 	}
 
 	@Test
-	public void testGenerateBeanNameFromMetaComponentWithStringValue() {
+	public void generateBeanNameFromMetaComponentWithStringValue() {
 		BeanDefinitionRegistry registry = new SimpleBeanDefinitionRegistry();
 		AnnotatedBeanDefinition bd = new AnnotatedGenericBeanDefinition(ComponentFromStringMeta.class);
 		String beanName = this.beanNameGenerator.generateBeanName(bd, registry);
@@ -95,24 +99,61 @@ public class AnnotationBeanNameGeneratorTests {
 	}
 
 	@Test
-	public void testGenerateBeanNameFromMetaComponentWithNonStringValue() {
+	public void generateBeanNameFromMetaComponentWithNonStringValue() {
 		BeanDefinitionRegistry registry = new SimpleBeanDefinitionRegistry();
 		AnnotatedBeanDefinition bd = new AnnotatedGenericBeanDefinition(ComponentFromNonStringMeta.class);
 		String beanName = this.beanNameGenerator.generateBeanName(bd, registry);
 		assertEquals("annotationBeanNameGeneratorTests.ComponentFromNonStringMeta", beanName);
 	}
 
+	/**
+	 * @since 4.0.1
+	 * @see https://jira.springsource.org/browse/SPR-11360
+	 */
+	@Test
+	public void generateBeanNameFromComposedControllerAnnotationWithoutName() {
+		BeanDefinitionRegistry registry = new SimpleBeanDefinitionRegistry();
+		AnnotatedBeanDefinition bd = new AnnotatedGenericBeanDefinition(ComposedControllerAnnotationWithoutName.class);
+		String beanName = this.beanNameGenerator.generateBeanName(bd, registry);
+		String expectedGeneratedBeanName = this.beanNameGenerator.buildDefaultBeanName(bd);
+		assertEquals(expectedGeneratedBeanName, beanName);
+	}
+
+	/**
+	 * @since 4.0.1
+	 * @see https://jira.springsource.org/browse/SPR-11360
+	 */
+	@Test
+	public void generateBeanNameFromComposedControllerAnnotationWithBlankName() {
+		BeanDefinitionRegistry registry = new SimpleBeanDefinitionRegistry();
+		AnnotatedBeanDefinition bd = new AnnotatedGenericBeanDefinition(ComposedControllerAnnotationWithBlankName.class);
+		String beanName = this.beanNameGenerator.generateBeanName(bd, registry);
+		String expectedGeneratedBeanName = this.beanNameGenerator.buildDefaultBeanName(bd);
+		assertEquals(expectedGeneratedBeanName, beanName);
+	}
+
+	/**
+	 * @since 4.0.1
+	 * @see https://jira.springsource.org/browse/SPR-11360
+	 */
+	@Test
+	public void generateBeanNameFromComposedControllerAnnotationWithStringValue() {
+		BeanDefinitionRegistry registry = new SimpleBeanDefinitionRegistry();
+		AnnotatedBeanDefinition bd = new AnnotatedGenericBeanDefinition(
+			ComposedControllerAnnotationWithStringValue.class);
+		String beanName = this.beanNameGenerator.generateBeanName(bd, registry);
+		assertEquals("restController", beanName);
+	}
+
 
 	@Component("walden")
 	private static class ComponentWithName {
 	}
 
-
 	@Component(" ")
 	private static class ComponentWithBlankName {
 	}
 
-
 	@Component
 	private static class AnonymousComponent {
 	}
@@ -125,6 +166,7 @@ public class AnnotationBeanNameGeneratorTests {
 	@Target(ElementType.TYPE)
 	@Component
 	public @interface NonStringMetaComponent {
+
 		long value();
 	}
 
@@ -132,4 +174,27 @@ public class AnnotationBeanNameGeneratorTests {
 	private static class ComponentFromNonStringMeta {
 	}
 
+	/**
+	 * @see org.springframework.web.bind.annotation.RestController
+	 */
+	@Retention(RetentionPolicy.RUNTIME)
+	@Target(ElementType.TYPE)
+	@Controller
+	public static @interface TestRestController {
+
+		String value() default "";
+	}
+
+	@TestRestController
+	public static class ComposedControllerAnnotationWithoutName {
+	}
+
+	@TestRestController(" ")
+	public static class ComposedControllerAnnotationWithBlankName {
+	}
+
+	@TestRestController("restController")
+	public static class ComposedControllerAnnotationWithStringValue {
+	}
+
 }

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2012 the original author or authors.
+ * Copyright 2002-2014 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.
@@ -28,11 +28,12 @@ import org.springframework.stereotype.Controller;
  * A convenience annotation that is itself annotated with {@link Controller @Controller}
  * and {@link ResponseBody @ResponseBody}.
  * <p>
- * Types that carry this annotation are treated as
- * controllers where {@link RequestMapping @RequestMapping} methods assume
+ * Types that carry this annotation are treated as controllers where
+ * {@link RequestMapping @RequestMapping} methods assume
  * {@link ResponseBody @ResponseBody} semantics by default.
  *
  * @author Rossen Stoyanchev
+ * @author Sam Brannen
  * @since 4.0
  */
 @Target(ElementType.TYPE)
@@ -42,4 +43,12 @@ import org.springframework.stereotype.Controller;
 @ResponseBody
 public @interface RestController {
 
+	/**
+	 * The value may indicate a suggestion for a logical component name,
+	 * to be turned into a Spring bean in case of an autodetected component.
+	 * @return the suggested component name, if any
+	 * @since 4.0.1
+	 */
+	String value() default "";
+
 }