diff --git a/spring-web/src/main/java/org/springframework/web/method/ControllerAdviceBean.java b/spring-web/src/main/java/org/springframework/web/method/ControllerAdviceBean.java index 1ccee63b8c..4c0c7234ef 100644 --- a/spring-web/src/main/java/org/springframework/web/method/ControllerAdviceBean.java +++ b/spring-web/src/main/java/org/springframework/web/method/ControllerAdviceBean.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. @@ -13,6 +13,7 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + package org.springframework.web.method; import java.lang.annotation.Annotation; @@ -22,7 +23,9 @@ import java.util.List; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; + import org.springframework.beans.factory.BeanFactory; +import org.springframework.beans.factory.BeanFactoryUtils; import org.springframework.context.ApplicationContext; import org.springframework.core.Ordered; import org.springframework.core.annotation.AnnotationUtils; @@ -67,10 +70,10 @@ public class ControllerAdviceBean implements Ordered { * @param beanFactory a BeanFactory that can be used later to resolve the bean */ public ControllerAdviceBean(String beanName, BeanFactory beanFactory) { - Assert.hasText(beanName, "'beanName' must not be null"); - Assert.notNull(beanFactory, "'beanFactory' must not be null"); + Assert.hasText(beanName, "Bean name must not be null"); + Assert.notNull(beanFactory, "BeanFactory must not be null"); Assert.isTrue(beanFactory.containsBean(beanName), - "Bean factory [" + beanFactory + "] does not contain bean " + "with name [" + beanName + "]"); + "BeanFactory [" + beanFactory + "] does not contain bean with name '" + beanName + "'"); this.bean = beanName; this.beanFactory = beanFactory; @@ -86,52 +89,18 @@ public class ControllerAdviceBean implements Ordered { this.assignableTypes.addAll(Arrays.asList(annotation.assignableTypes())); } - private static int initOrderFromBeanType(Class beanType) { - Order annot = AnnotationUtils.findAnnotation(beanType, Order.class); - return (annot != null) ? annot.value() : Ordered.LOWEST_PRECEDENCE; - } - - private static List initBasePackagesFromBeanType(Class beanType, ControllerAdvice annotation) { - List basePackages = new ArrayList(); - List basePackageNames = new ArrayList(); - basePackageNames.addAll(Arrays.asList(annotation.value())); - basePackageNames.addAll(Arrays.asList(annotation.basePackages())); - for (String pkgName : basePackageNames) { - if (StringUtils.hasText(pkgName)) { - Package pkg = Package.getPackage(pkgName); - if(pkg != null) { - basePackages.add(pkg); - } - else { - logger.warn("Package [" + pkgName + "] was not found, see [" + beanType.getName() + "]"); - } - } - } - for (Class markerClass : annotation.basePackageClasses()) { - Package pack = markerClass.getPackage(); - if (pack != null) { - basePackages.add(pack); - } - else { - logger.warn("Package was not found for class [" + markerClass.getName() - + "], see [" + beanType.getName() + "]"); - } - } - return basePackages; - } - /** * Create an instance using the given bean instance. * @param bean the bean */ public ControllerAdviceBean(Object bean) { - Assert.notNull(bean, "'bean' must not be null"); + Assert.notNull(bean, "Bean must not be null"); this.bean = bean; this.order = initOrderFromBean(bean); - Class beanType = bean.getClass(); + Class beanType = bean.getClass(); ControllerAdvice annotation = AnnotationUtils.findAnnotation(beanType,ControllerAdvice.class); - Assert.notNull(annotation, "BeanType [" + beanType.getName() + "] is not annotated @ControllerAdvice"); + Assert.notNull(annotation, "Bean type [" + beanType.getName() + "] is not annotated @ControllerAdvice"); this.basePackages.addAll(initBasePackagesFromBeanType(beanType, annotation)); this.annotations.addAll(Arrays.asList(annotation.annotations())); @@ -139,24 +108,6 @@ public class ControllerAdviceBean implements Ordered { this.beanFactory = null; } - private static int initOrderFromBean(Object bean) { - return (bean instanceof Ordered) ? ((Ordered) bean).getOrder() : initOrderFromBeanType(bean.getClass()); - } - - /** - * Find the names of beans annotated with - * {@linkplain ControllerAdvice @ControllerAdvice} in the given - * ApplicationContext and wrap them as {@code ControllerAdviceBean} instances. - */ - public static List findAnnotatedBeans(ApplicationContext applicationContext) { - List beans = new ArrayList(); - for (String name : applicationContext.getBeanDefinitionNames()) { - if (applicationContext.findAnnotationOnBean(name, ControllerAdvice.class) != null) { - beans.add(new ControllerAdviceBean(name, applicationContext)); - } - } - return beans; - } /** * Returns the order value extracted from the {@link ControllerAdvice} @@ -172,9 +123,8 @@ public class ControllerAdviceBean implements Ordered { * If the bean type is a CGLIB-generated class, the original, user-defined class is returned. */ public Class getBeanType() { - Class clazz = (this.bean instanceof String) - ? this.beanFactory.getType((String) this.bean) : this.bean.getClass(); - + Class clazz = (this.bean instanceof String ? + this.beanFactory.getType((String) this.bean) : this.bean.getClass()); return ClassUtils.getUserClass(clazz); } @@ -241,7 +191,61 @@ public class ControllerAdviceBean implements Ordered { @Override public String toString() { - return bean.toString(); + return this.bean.toString(); + } + + + /** + * Find the names of beans annotated with + * {@linkplain ControllerAdvice @ControllerAdvice} in the given + * ApplicationContext and wrap them as {@code ControllerAdviceBean} instances. + */ + public static List findAnnotatedBeans(ApplicationContext applicationContext) { + List beans = new ArrayList(); + for (String name : BeanFactoryUtils.beanNamesForTypeIncludingAncestors(applicationContext, Object.class)) { + if (applicationContext.findAnnotationOnBean(name, ControllerAdvice.class) != null) { + beans.add(new ControllerAdviceBean(name, applicationContext)); + } + } + return beans; + } + + private static int initOrderFromBean(Object bean) { + return (bean instanceof Ordered ? ((Ordered) bean).getOrder() : initOrderFromBeanType(bean.getClass())); + } + + private static int initOrderFromBeanType(Class beanType) { + Order ann = AnnotationUtils.findAnnotation(beanType, Order.class); + return (ann != null ? ann.value() : Ordered.LOWEST_PRECEDENCE); + } + + private static List initBasePackagesFromBeanType(Class beanType, ControllerAdvice annotation) { + List basePackages = new ArrayList(); + List basePackageNames = new ArrayList(); + basePackageNames.addAll(Arrays.asList(annotation.value())); + basePackageNames.addAll(Arrays.asList(annotation.basePackages())); + for (String pkgName : basePackageNames) { + if (StringUtils.hasText(pkgName)) { + Package pkg = Package.getPackage(pkgName); + if(pkg != null) { + basePackages.add(pkg); + } + else { + logger.warn("Package [" + pkgName + "] was not found, see [" + beanType.getName() + "]"); + } + } + } + for (Class markerClass : annotation.basePackageClasses()) { + Package pack = markerClass.getPackage(); + if (pack != null) { + basePackages.add(pack); + } + else { + logger.warn("Package was not found for class [" + markerClass.getName() + + "], see [" + beanType.getName() + "]"); + } + } + return basePackages; } } diff --git a/spring-web/src/test/java/org/springframework/web/method/ControllerAdviceBeanTests.java b/spring-web/src/test/java/org/springframework/web/method/ControllerAdviceBeanTests.java index 25f0ccefde..1088df8eb4 100644 --- a/spring-web/src/test/java/org/springframework/web/method/ControllerAdviceBeanTests.java +++ b/spring-web/src/test/java/org/springframework/web/method/ControllerAdviceBeanTests.java @@ -1,9 +1,26 @@ +/* + * 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. + * You may obtain a copy of the License at + * + * http://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.method; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import org.junit.Test; + import org.springframework.web.bind.annotation.ControllerAdvice; import org.springframework.web.bind.annotation.RestController; @@ -83,18 +100,17 @@ public class ControllerAdviceBeanTests { assertNotApplicable("should not match", bean, InheritanceController.class); } - private void assertApplicable(String message, ControllerAdviceBean controllerAdvice, - Class controllerBeanType) { + private void assertApplicable(String message, ControllerAdviceBean controllerAdvice, Class controllerBeanType) { assertNotNull(controllerAdvice); assertTrue(message,controllerAdvice.isApplicableToBeanType(controllerBeanType)); } - private void assertNotApplicable(String message, ControllerAdviceBean controllerAdvice, - Class controllerBeanType) { + private void assertNotApplicable(String message, ControllerAdviceBean controllerAdvice, Class controllerBeanType) { assertNotNull(controllerAdvice); assertFalse(message,controllerAdvice.isApplicableToBeanType(controllerBeanType)); } + // ControllerAdvice classes @ControllerAdvice @@ -139,4 +155,5 @@ public class ControllerAdviceBeanTests { static abstract class AbstractController {} static class InheritanceController extends AbstractController {} + } diff --git a/spring-webmvc/src/test/java/org/springframework/web/servlet/mvc/method/annotation/RequestMappingHandlerAdapterTests.java b/spring-webmvc/src/test/java/org/springframework/web/servlet/mvc/method/annotation/RequestMappingHandlerAdapterTests.java index c9a213db66..3ab95b344c 100644 --- a/spring-webmvc/src/test/java/org/springframework/web/servlet/mvc/method/annotation/RequestMappingHandlerAdapterTests.java +++ b/spring-webmvc/src/test/java/org/springframework/web/servlet/mvc/method/annotation/RequestMappingHandlerAdapterTests.java @@ -45,7 +45,6 @@ import static org.junit.Assert.*; * Unit tests for {@link RequestMappingHandlerAdapter}. * * @author Rossen Stoyanchev - * * @see ServletAnnotationControllerHandlerMethodTests * @see HandlerMethodAnnotationDetectionTests * @see RequestMappingHandlerAdapterIntegrationTests @@ -187,6 +186,22 @@ public class RequestMappingHandlerAdapterTests { assertEquals("gAttr2", mav.getModel().get("attr2")); } + @Test + public void modelAttributeAdviceInParentContext() throws Exception { + StaticWebApplicationContext parent = new StaticWebApplicationContext(); + parent.registerSingleton("maa", ModelAttributeAdvice.class); + parent.refresh(); + this.webAppContext.setParent(parent); + this.webAppContext.refresh(); + + HandlerMethod handlerMethod = handlerMethod(new SimpleController(), "handle"); + this.handlerAdapter.afterPropertiesSet(); + ModelAndView mav = this.handlerAdapter.handle(this.request, this.response, handlerMethod); + + assertEquals("lAttr1", mav.getModel().get("attr1")); + assertEquals("gAttr2", mav.getModel().get("attr2")); + } + @Test public void modelAttributePackageNameAdvice() throws Exception { this.webAppContext.registerSingleton("mapa", ModelAttributePackageAdvice.class);