Support @RestControllerAdvice in Standalone MockMvc again
Since Spring Framework 5.2, @RestControllerAdvice registered with MockMvc when using MockMvcBuilders.standaloneSetup() has no longer been properly supported if annotation attributes were declared in the @RestControllerAdvice annotation. Prior to 5.2, this was not an issue. The cause for this regression is two-fold. 1. Commit50c257794frefactored DefaultListableBeanFactory so that findAnnotationOnBean() supports merged annotations; however, that commit did not refactor StaticListableBeanFactory#findAnnotationOnBean() to support merged annotations. 2. Commit978adbdae7refactored ControllerAdviceBean so that a merged @ControllerAdvice annotation is only looked up via ApplicationContext#findAnnotationOnBean(). The latter relies on the fact that findAnnotationOnBean() supports merged annotations (e.g., @RestControllerAdvice as a merged instance of @ControllerAdvice). Behind the scenes, MockMvcBuilders.standaloneSetup() creates a StubWebApplicationContext which internally uses a StubBeanFactory which extends StaticListableBeanFactory. Consequently, since the implementation of findAnnotationOnBean() in StaticListableBeanFactory was not updated to support merged annotations like it was in DefaultListableBeanFactory, we only see this regression with the standalone MockMvc support and not with MockMvc support for an existing WebApplicationContext or with standard Spring applications using an ApplicationContext that uses DefaultListableBeanFactory. This commit fixes this regression by supporting merged annotations in StaticListableBeanFactory#findAnnotationOnBean() as well. Closes gh-25520
This commit is contained in:
@@ -37,7 +37,7 @@ import org.springframework.beans.factory.ObjectProvider;
|
||||
import org.springframework.beans.factory.SmartFactoryBean;
|
||||
import org.springframework.core.OrderComparator;
|
||||
import org.springframework.core.ResolvableType;
|
||||
import org.springframework.core.annotation.AnnotationUtils;
|
||||
import org.springframework.core.annotation.AnnotatedElementUtils;
|
||||
import org.springframework.lang.Nullable;
|
||||
import org.springframework.util.Assert;
|
||||
import org.springframework.util.ObjectUtils;
|
||||
@@ -450,7 +450,7 @@ public class StaticListableBeanFactory implements ListableBeanFactory {
|
||||
throws NoSuchBeanDefinitionException {
|
||||
|
||||
Class<?> beanType = getType(beanName);
|
||||
return (beanType != null ? AnnotationUtils.findAnnotation(beanType, annotationType) : null);
|
||||
return (beanType != null ? AnnotatedElementUtils.findMergedAnnotation(beanType, annotationType) : null);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@@ -16,6 +16,8 @@
|
||||
|
||||
package org.springframework.beans.factory;
|
||||
|
||||
import java.lang.annotation.Retention;
|
||||
import java.lang.annotation.RetentionPolicy;
|
||||
import java.util.Arrays;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
@@ -33,6 +35,7 @@ import org.springframework.beans.testfixture.beans.TestAnnotation;
|
||||
import org.springframework.beans.testfixture.beans.TestBean;
|
||||
import org.springframework.beans.testfixture.beans.factory.DummyFactory;
|
||||
import org.springframework.cglib.proxy.NoOp;
|
||||
import org.springframework.core.annotation.AliasFor;
|
||||
import org.springframework.core.io.Resource;
|
||||
import org.springframework.util.ObjectUtils;
|
||||
|
||||
@@ -324,6 +327,33 @@ public class BeanFactoryUtilsTests {
|
||||
assertThat(Arrays.equals(new String[] { "buffer" }, deps)).isTrue();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void findAnnotationOnBean() {
|
||||
this.listableBeanFactory.registerSingleton("controllerAdvice", new ControllerAdviceClass());
|
||||
this.listableBeanFactory.registerSingleton("restControllerAdvice", new RestControllerAdviceClass());
|
||||
testFindAnnotationOnBean(this.listableBeanFactory);
|
||||
}
|
||||
|
||||
@Test // gh-25520
|
||||
public void findAnnotationOnBeanWithStaticFactory() {
|
||||
StaticListableBeanFactory lbf = new StaticListableBeanFactory();
|
||||
lbf.addBean("controllerAdvice", new ControllerAdviceClass());
|
||||
lbf.addBean("restControllerAdvice", new RestControllerAdviceClass());
|
||||
testFindAnnotationOnBean(lbf);
|
||||
}
|
||||
|
||||
private void testFindAnnotationOnBean(ListableBeanFactory lbf) {
|
||||
assertControllerAdvice(lbf, "controllerAdvice");
|
||||
assertControllerAdvice(lbf, "restControllerAdvice");
|
||||
}
|
||||
|
||||
private void assertControllerAdvice(ListableBeanFactory lbf, String beanName) {
|
||||
ControllerAdvice controllerAdvice = lbf.findAnnotationOnBean(beanName, ControllerAdvice.class);
|
||||
assertThat(controllerAdvice).isNotNull();
|
||||
assertThat(controllerAdvice.value()).isEqualTo("com.example");
|
||||
assertThat(controllerAdvice.basePackage()).isEqualTo("com.example");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void isSingletonAndIsPrototypeWithStaticFactory() {
|
||||
StaticListableBeanFactory lbf = new StaticListableBeanFactory();
|
||||
@@ -393,6 +423,35 @@ public class BeanFactoryUtilsTests {
|
||||
}
|
||||
|
||||
|
||||
@Retention(RetentionPolicy.RUNTIME)
|
||||
@interface ControllerAdvice {
|
||||
|
||||
@AliasFor("basePackage")
|
||||
String value() default "";
|
||||
|
||||
@AliasFor("value")
|
||||
String basePackage() default "";
|
||||
}
|
||||
|
||||
@Retention(RetentionPolicy.RUNTIME)
|
||||
@ControllerAdvice
|
||||
@interface RestControllerAdvice {
|
||||
|
||||
@AliasFor(annotation = ControllerAdvice.class)
|
||||
String value() default "";
|
||||
|
||||
@AliasFor(annotation = ControllerAdvice.class)
|
||||
String basePackage() default "";
|
||||
}
|
||||
|
||||
@ControllerAdvice("com.example")
|
||||
static class ControllerAdviceClass {
|
||||
}
|
||||
|
||||
@RestControllerAdvice("com.example")
|
||||
static class RestControllerAdviceClass {
|
||||
}
|
||||
|
||||
static class TestBeanSmartFactoryBean implements SmartFactoryBean<TestBean> {
|
||||
|
||||
private final TestBean testBean = new TestBean("enigma", 42);
|
||||
|
||||
Reference in New Issue
Block a user