root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions 6 Packages Projects Releases Wiki Activity

Revised ControllerAdvice basePackages handling (based on package names instead of java.lang.Package) 

Issue: SPR-12506
This commit is contained in:
Juergen Hoeller 2014-12-04 17:56:01 +01:00
parent ad65119a2c
commit 4013fe03a5
1 changed files with 73 additions and 79 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

152
spring-web/src/main/java/org/springframework/web/method/ControllerAdviceBean.java
View File

@ -19,10 +19,9 @@ package org.springframework.web.method;
import java.lang.annotation.Annotation; import java.lang.annotation.Annotation;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.Arrays; import java.util.Arrays;
import java.util.LinkedHashSet;
import java.util.List; import java.util.List;
import java.util.Set;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.beans.factory.BeanFactory; import org.springframework.beans.factory.BeanFactory;
import org.springframework.beans.factory.BeanFactoryUtils; import org.springframework.beans.factory.BeanFactoryUtils;
@ -39,76 +38,77 @@ import org.springframework.web.bind.annotation.ControllerAdvice;
* Encapsulates information about an {@linkplain ControllerAdvice @ControllerAdvice} * Encapsulates information about an {@linkplain ControllerAdvice @ControllerAdvice}
* Spring-managed bean without necessarily requiring it to be instantiated. * Spring-managed bean without necessarily requiring it to be instantiated.
* *
* <p>The {@link #findAnnotatedBeans(ApplicationContext)} method can be used to discover * <p>The {@link #findAnnotatedBeans(ApplicationContext)} method can be used to
* such beans. However, an {@code ControllerAdviceBean} may be created from * discover such beans. However, a {@code ControllerAdviceBean} may be created
* any object, including ones without an {@code @ControllerAdvice}. * from any object, including ones without an {@code @ControllerAdvice}.
* *
* @author Rossen Stoyanchev * @author Rossen Stoyanchev
* @author Brian Clozel * @author Brian Clozel
* @author Juergen Hoeller
* @since 3.2 * @since 3.2
*/ */
public class ControllerAdviceBean implements Ordered { public class ControllerAdviceBean implements Ordered {
private static final Log logger = LogFactory.getLog(ControllerAdviceBean.class);
private final Object bean; private final Object bean;
private final int order;
private final BeanFactory beanFactory; private final BeanFactory beanFactory;
private final List<Package> basePackages = new ArrayList<Package>(); private final int order;
private final List<Class<? extends Annotation>> annotations = new ArrayList<Class<? extends Annotation>>(); private final Set<String> basePackages;
private final List<Class<?>> assignableTypes = new ArrayList<Class<?>>(); private final List<Class<?>> assignableTypes;
private final List<Class<? extends Annotation>> annotations;
/** /**
* Create an instance using the given bean name. * Create a {@code ControllerAdviceBean} using the given bean instance.
* @param bean the bean instance
*/
public ControllerAdviceBean(Object bean) {
this(bean, null);
}
/**
* Create a {@code ControllerAdviceBean} using the given bean name.
* @param beanName the name of the bean * @param beanName the name of the bean
* @param beanFactory a BeanFactory that can be used later to resolve the bean * @param beanFactory a BeanFactory that can be used later to resolve the bean
*/ */
public ControllerAdviceBean(String beanName, BeanFactory beanFactory) { public ControllerAdviceBean(String beanName, BeanFactory beanFactory) {
Assert.hasText(beanName, "Bean name must not be null"); this((Object) beanName, beanFactory);
Assert.notNull(beanFactory, "BeanFactory must not be null");
if (!beanFactory.containsBean(beanName)) {
throw new IllegalArgumentException(
"BeanFactory [" + beanFactory + "] does not contain bean with name '" + beanName + "'");
}
this.bean = beanName;
this.beanFactory = beanFactory;
Class<?> beanType = this.beanFactory.getType(beanName);
this.order = initOrderFromBeanType(beanType);
ControllerAdvice annotation = AnnotationUtils.findAnnotation(beanType,ControllerAdvice.class);
Assert.notNull(annotation, "BeanType [" + beanType.getName() + "] is not annotated @ControllerAdvice");
this.basePackages.addAll(initBasePackagesFromBeanType(beanType, annotation));
this.annotations.addAll(Arrays.asList(annotation.annotations()));
this.assignableTypes.addAll(Arrays.asList(annotation.assignableTypes()));
} }
/** private ControllerAdviceBean(Object bean, BeanFactory beanFactory) {
* Create an instance using the given bean instance.
* @param bean the bean
*/
public ControllerAdviceBean(Object bean) {
Assert.notNull(bean, "Bean must not be null");
this.bean = bean; this.bean = bean;
this.order = initOrderFromBean(bean); this.beanFactory = beanFactory;
Class<?> beanType;
Class<?> beanType = bean.getClass(); if (bean instanceof String) {
ControllerAdvice annotation = AnnotationUtils.findAnnotation(beanType,ControllerAdvice.class); String beanName = (String) bean;
Assert.notNull(annotation, "Bean type [" + beanType.getName() + "] is not annotated @ControllerAdvice"); Assert.hasText(beanName, "Bean name must not be null");
Assert.notNull(beanFactory, "BeanFactory must not be null");
if (!beanFactory.containsBean(beanName)) {
throw new IllegalArgumentException("BeanFactory [" + beanFactory +
"] does not contain specified controller advice bean '" + beanName + "'");
}
beanType = this.beanFactory.getType(beanName);
this.order = initOrderFromBeanType(beanType);
}
else {
Assert.notNull(bean, "Bean must not be null");
beanType = bean.getClass();
this.order = initOrderFromBean(bean);
}
this.basePackages.addAll(initBasePackagesFromBeanType(beanType, annotation)); ControllerAdvice annotation = AnnotationUtils.findAnnotation(beanType, ControllerAdvice.class);
this.annotations.addAll(Arrays.asList(annotation.annotations())); if (annotation == null) {
this.assignableTypes.addAll(Arrays.asList(annotation.assignableTypes())); throw new IllegalArgumentException(
this.beanFactory = null; "Bean type [" + beanType.getName() + "] is not annotated as @ControllerAdvice");
}
this.basePackages = initBasePackages(annotation);
this.assignableTypes = Arrays.asList(annotation.assignableTypes());
this.annotations = Arrays.asList(annotation.annotations());
} }
@ -150,6 +150,11 @@ public class ControllerAdviceBean implements Ordered {
return true; return true;
} }
else if (beanType != null) { else if (beanType != null) {
for (String basePackage : this.basePackages) {
if (ClassUtils.getPackageName(beanType).startsWith(basePackage)) {
return true;
}
}
for (Class<?> clazz : this.assignableTypes) { for (Class<?> clazz : this.assignableTypes) {
if (ClassUtils.isAssignable(clazz, beanType)) { if (ClassUtils.isAssignable(clazz, beanType)) {
return true; return true;
@ -160,25 +165,25 @@ public class ControllerAdviceBean implements Ordered {
return true; return true;
} }
} }
String packageName = beanType.getPackage().getName();
for (Package basePackage : this.basePackages) {
if (packageName.startsWith(basePackage.getName())) {
return true;
}
}
} }
return false; return false;
} }
private boolean hasSelectors() { private boolean hasSelectors() {
return (!this.basePackages.isEmpty() || !this.annotations.isEmpty() || !this.assignableTypes.isEmpty()); return (!this.basePackages.isEmpty() || !this.assignableTypes.isEmpty() || !this.annotations.isEmpty());
} }
@Override @Override
public boolean equals(Object other) { public boolean equals(Object other) {
return (this == other || if (this == other) {
(other instanceof ControllerAdviceBean && this.bean.equals(((ControllerAdviceBean) other).bean))); return true;
}
if (!(other instanceof ControllerAdviceBean)) {
return false;
}
ControllerAdviceBean otherAdvice = (ControllerAdviceBean) other;
return (this.bean.equals(otherAdvice.bean) && this.beanFactory == otherAdvice.beanFactory);
} }
@Override @Override
@ -215,31 +220,20 @@ public class ControllerAdviceBean implements Ordered {
return OrderUtils.getOrder(beanType, Ordered.LOWEST_PRECEDENCE); return OrderUtils.getOrder(beanType, Ordered.LOWEST_PRECEDENCE);
} }
private static List<Package> initBasePackagesFromBeanType(Class<?> beanType, ControllerAdvice annotation) { private static Set<String> initBasePackages(ControllerAdvice annotation) {
List<Package> basePackages = new ArrayList<Package>(); Set<String> basePackages = new LinkedHashSet<String>();
List<String> basePackageNames = new ArrayList<String>(); for (String basePackage : annotation.value()) {
basePackageNames.addAll(Arrays.asList(annotation.value())); if (StringUtils.hasText(basePackage)) {
basePackageNames.addAll(Arrays.asList(annotation.basePackages())); basePackages.add(basePackage);
for (String pkgName : basePackageNames) { }
if (StringUtils.hasText(pkgName)) { }
Package pkg = Package.getPackage(pkgName); for (String basePackage : annotation.basePackages()) {
if (pkg != null) { if (StringUtils.hasText(basePackage)) {
basePackages.add(pkg); basePackages.add(basePackage);
}
else {
logger.warn("Package [" + pkgName + "] was not found, see [" + beanType.getName() + "]");
}
} }
} }
for (Class<?> markerClass : annotation.basePackageClasses()) { for (Class<?> markerClass : annotation.basePackageClasses()) {
Package pack = markerClass.getPackage(); basePackages.add(ClassUtils.getPackageName(markerClass));
if (pack != null) {
basePackages.add(pack);
}
else {
logger.warn("Package was not found for class [" + markerClass.getName() +
"], see [" + beanType.getName() + "]");
}
} }
return basePackages; return basePackages;
} }