Browse Source

Allow component name to be specified in @[Rest]ControllerAdvice

This commit builds on the recently added support for using @AliasFor to
override the `value` attribute in `@Component, and allows a custom
component name to be specified in both @ControllerAdvice and
@RestControllerAdvice via new `name` attributes.

See gh-31089
Closes gh-21108
pull/31121/head
Sam Brannen 2 years ago
parent
commit
4e2d9252e5
  1. 2
      framework-docs/modules/ROOT/pages/core/beans/classpath-scanning.adoc
  2. 4
      spring-context/src/main/java/org/springframework/stereotype/Component.java
  3. 9
      spring-web/src/main/java/org/springframework/web/bind/annotation/ControllerAdvice.java
  4. 9
      spring-web/src/main/java/org/springframework/web/bind/annotation/RestControllerAdvice.java
  5. 43
      spring-web/src/test/java/org/springframework/web/bind/annotation/ComponentScannedControllerAdviceTests.java
  6. 27
      spring-web/src/test/java/org/springframework/web/bind/annotation/scanned/ScannedControllerAdvice.java
  7. 27
      spring-web/src/test/java/org/springframework/web/bind/annotation/scanned/ScannedRestControllerAdvice.java

2
framework-docs/modules/ROOT/pages/core/beans/classpath-scanning.adoc

@ -675,7 +675,7 @@ As of Spring Framework 6.1, the name of the annotation attribute that is used to @@ -675,7 +675,7 @@ As of Spring Framework 6.1, the name of the annotation attribute that is used to
the bean name is no longer required to be `value`. Custom stereotype annotations can
declare an attribute with a different name (such as `name`) and annotate that attribute
with `@AliasFor(annotation = Component.class, attribute = "value")`. See the source code
declaration of `Repository#value()` for a concrete example.
declaration of `Repository#value()` and `ControllerAdvice#name()` for concrete examples.
====
If such an annotation contains no name `value` or for any other detected component

4
spring-context/src/main/java/org/springframework/stereotype/Component.java

@ -35,7 +35,9 @@ import java.lang.annotation.Target; @@ -35,7 +35,9 @@ import java.lang.annotation.Target;
* <p>As of Spring Framework 6.1, custom component stereotype annotations should
* use {@link org.springframework.core.annotation.AliasFor @AliasFor} to declare
* an explicit alias for this annotation's {@link #value} attribute. See the
* source code declaration of {@link Repository#value()} for a concrete example.
* source code declaration of {@link Repository#value()} and
* {@link org.springframework.web.bind.annotation.ControllerAdvice#name()
* ControllerAdvice.name()} for concrete examples.
*
* @author Mark Fisher
* @author Sam Brannen

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

@ -1,5 +1,5 @@ @@ -1,5 +1,5 @@
/*
* Copyright 2002-2019 the original author or authors.
* Copyright 2002-2023 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.
@ -78,6 +78,13 @@ import org.springframework.stereotype.Component; @@ -78,6 +78,13 @@ import org.springframework.stereotype.Component;
@Component
public @interface ControllerAdvice {
/**
* Alias for {@link Component#value}.
* @since 6.1
*/
@AliasFor(annotation = Component.class, attribute = "value")
String name() default "";
/**
* Alias for the {@link #basePackages} attribute.
* <p>Allows for more concise annotation declarations &mdash; for example,

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

@ -1,5 +1,5 @@ @@ -1,5 +1,5 @@
/*
* Copyright 2002-2019 the original author or authors.
* Copyright 2002-2023 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.
@ -52,6 +52,13 @@ import org.springframework.core.annotation.AliasFor; @@ -52,6 +52,13 @@ import org.springframework.core.annotation.AliasFor;
@ResponseBody
public @interface RestControllerAdvice {
/**
* Alias for {@link ControllerAdvice#name}.
* @since 6.1
*/
@AliasFor(annotation = ControllerAdvice.class)
String name() default "";
/**
* Alias for the {@link #basePackages} attribute.
* <p>Allows for more concise annotation declarations &mdash; for example,

43
spring-web/src/test/java/org/springframework/web/bind/annotation/ComponentScannedControllerAdviceTests.java

@ -0,0 +1,43 @@ @@ -0,0 +1,43 @@
/*
* Copyright 2002-2023 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.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.web.bind.annotation;
import org.junit.jupiter.api.Test;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import static org.assertj.core.api.Assertions.assertThat;
/**
* Integration tests that verify support for component scanning
* {@link ControllerAdvice} and {@link RestControllerAdvice} beans.
*
* @author Sam Brannen
* @since 6.1
*/
class ComponentScannedControllerAdviceTests {
@Test
void scannedAdviceHasCustomName() {
String basePackage = getClass().getPackageName() + ".scanned";
try (AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(basePackage)) {
assertThat(context.getBean("myControllerAdvice")).isNotNull();
assertThat(context.getBean("myRestControllerAdvice")).isNotNull();
}
}
}

27
spring-web/src/test/java/org/springframework/web/bind/annotation/scanned/ScannedControllerAdvice.java

@ -0,0 +1,27 @@ @@ -0,0 +1,27 @@
/*
* Copyright 2002-2023 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.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.web.bind.annotation.scanned;
import org.springframework.web.bind.annotation.ControllerAdvice;
/**
* @author Sam Brannen
* @since 6.1
*/
@ControllerAdvice(name = "myControllerAdvice", value = "org.my.pkg")
class ScannedControllerAdvice {
}

27
spring-web/src/test/java/org/springframework/web/bind/annotation/scanned/ScannedRestControllerAdvice.java

@ -0,0 +1,27 @@ @@ -0,0 +1,27 @@
/*
* Copyright 2002-2023 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.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.web.bind.annotation.scanned;
import org.springframework.web.bind.annotation.RestControllerAdvice;
/**
* @author Sam Brannen
* @since 6.1
*/
@RestControllerAdvice(name = "myRestControllerAdvice", value = "org.my.pkg")
class ScannedRestControllerAdvice {
}
Loading…
Cancel
Save