Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add ConditionalOnBean support for generic bean argument types #29500

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
+479 −36
Open

Add ConditionalOnBean support for generic bean argument types #29500

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
048ad42
Add ConditionalOnBean support for generic bean argument types
VladislavSevruk Jan 20, 2022
6f9af2a
Update OnBeanCondition to auto-detect generic type arguments
VladislavSevruk Feb 3, 2022
4ee1fd3
Removed added annotation methods
VladislavSevruk Feb 3, 2022
c1c5b2e
Adjust styles
VladislavSevruk Feb 3, 2022
1298a43
Extract tests for generic return type to separate classes
VladislavSevruk Feb 4, 2022
bc2db92
Adjust styles
VladislavSevruk Feb 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
102 changes: 66 additions & 36 deletions ...igure/src/main/java/org/springframework/boot/autoconfigure/condition/OnBeanCondition.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@
* @author Jakub Kubrynski
* @author Stephane Nicoll
* @author Andy Wilkinson
* @author Uladzislau Seuruk
* @see ConditionalOnBean
* @see ConditionalOnMissingBean
* @see ConditionalOnSingleCandidate
Expand Down Expand Up @@ -163,10 +164,10 @@ protected final MatchResult getMatchingBeans(ConditionContext context, Spec<?> s
beanFactory = (ConfigurableListableBeanFactory) parent;
}
MatchResult result = new MatchResult();
Set<String> beansIgnoredByType = getNamesOfBeansIgnoredByType(classLoader, beanFactory, considerHierarchy,
Set<String> beansIgnoredByType = getNamesOfBeansIgnoredByType(beanFactory, considerHierarchy,
spec.getIgnoredTypes(), parameterizedContainers);
for (String type : spec.getTypes()) {
Collection<String> typeMatches = getBeanNamesForType(classLoader, considerHierarchy, beanFactory, type,
for (ResolvableType type : spec.getTypes()) {
Collection<String> typeMatches = getBeanNamesForType(considerHierarchy, beanFactory, type,
parameterizedContainers);
Iterator<String> iterator = typeMatches.iterator();
while (iterator.hasNext()) {
Expand All @@ -176,10 +177,10 @@ protected final MatchResult getMatchingBeans(ConditionContext context, Spec<?> s
}
}
if (typeMatches.isEmpty()) {
result.recordUnmatchedType(type);
result.recordUnmatchedType(type.toString());
}
else {
result.recordMatchedType(type, typeMatches);
result.recordMatchedType(type.toString(), typeMatches);
}
}
for (String annotation : spec.getAnnotations()) {
Expand All @@ -204,42 +205,48 @@ protected final MatchResult getMatchingBeans(ConditionContext context, Spec<?> s
return result;
}

private Set<String> getNamesOfBeansIgnoredByType(ClassLoader classLoader, ListableBeanFactory beanFactory,
boolean considerHierarchy, Set<String> ignoredTypes, Set<Class<?>> parameterizedContainers) {
private Set<String> getNamesOfBeansIgnoredByType(ListableBeanFactory beanFactory, boolean considerHierarchy,
Set<Class<?>> ignoredTypes, Set<Class<?>> parameterizedContainers) {
Set<String> result = null;
for (String ignoredType : ignoredTypes) {
Collection<String> ignoredNames = getBeanNamesForType(classLoader, considerHierarchy, beanFactory,
ignoredType, parameterizedContainers);
for (Class<?> ignoredType : ignoredTypes) {
ResolvableType ignoredResolvableType = ResolvableType.forClass(ignoredType);
Collection<String> ignoredNames = getBeanNamesForType(considerHierarchy, beanFactory, ignoredResolvableType,
parameterizedContainers);
result = addAll(result, ignoredNames);
}
return (result != null) ? result : Collections.emptySet();
}

private Set<String> getBeanNamesForType(ClassLoader classLoader, boolean considerHierarchy,
ListableBeanFactory beanFactory, String type, Set<Class<?>> parameterizedContainers) throws LinkageError {
private Set<String> getBeanNamesForType(boolean considerHierarchy, ListableBeanFactory beanFactory,
ResolvableType type, Set<Class<?>> parameterizedContainers) throws LinkageError {
try {
return getBeanNamesForType(beanFactory, considerHierarchy, resolve(type, classLoader),
parameterizedContainers);
return getBeanNamesForType(beanFactory, considerHierarchy, type, parameterizedContainers);
}
catch (ClassNotFoundException | NoClassDefFoundError ex) {
catch (NoClassDefFoundError ex) {
return Collections.emptySet();
}
}

private Set<String> getBeanNamesForType(ListableBeanFactory beanFactory, boolean considerHierarchy, Class<?> type,
Set<Class<?>> parameterizedContainers) {
private Set<String> getBeanNamesForType(ListableBeanFactory beanFactory, boolean considerHierarchy,
ResolvableType type, Set<Class<?>> parameterizedContainers) {
Set<String> result = collectBeanNamesForType(beanFactory, considerHierarchy, type, parameterizedContainers,
null);
return (result != null) ? result : Collections.emptySet();
}

private Set<String> collectBeanNamesForType(ListableBeanFactory beanFactory, boolean considerHierarchy,
Class<?> type, Set<Class<?>> parameterizedContainers, Set<String> result) {
private Set<String> collectBeanNamesForType(ListableBeanFactory beanFactory, ResolvableType type,
Set<Class<?>> parameterizedContainers, Set<String> result) {
result = addAll(result, beanFactory.getBeanNamesForType(type, true, false));
for (Class<?> container : parameterizedContainers) {
ResolvableType generic = ResolvableType.forClassWithGenerics(container, type);
result = addAll(result, beanFactory.getBeanNamesForType(generic, true, false));
}
return result;
}

private Set<String> collectBeanNamesForType(ListableBeanFactory beanFactory, boolean considerHierarchy,
ResolvableType type, Set<Class<?>> parameterizedContainers, Set<String> result) {
result = collectBeanNamesForType(beanFactory, type, parameterizedContainers, result);
if (considerHierarchy && beanFactory instanceof HierarchicalBeanFactory) {
BeanFactory parent = ((HierarchicalBeanFactory) beanFactory).getParentBeanFactory();
if (parent instanceof ListableBeanFactory) {
Expand Down Expand Up @@ -399,11 +406,11 @@ private static class Spec<A extends Annotation> {

private final Set<String> names;

private final Set<String> types;
private final Set<ResolvableType> types;

private final Set<String> annotations;

private final Set<String> ignoredTypes;
private final Set<Class<?>> ignoredTypes;

private final Set<Class<?>> parameterizedContainers;

Expand All @@ -419,10 +426,10 @@ private static class Spec<A extends Annotation> {
this.annotationType = annotationType;
this.names = extract(attributes, "name");
this.annotations = extract(attributes, "annotation");
this.ignoredTypes = extract(attributes, "ignored", "ignoredType");
this.ignoredTypes = resolveWhenPossible(extract(attributes, "ignored", "ignoredType"));
this.parameterizedContainers = resolveWhenPossible(extract(attributes, "parameterizedContainer"));
this.strategy = annotation.getValue("search", SearchStrategy.class).orElse(null);
Set<String> types = extractTypes(attributes);
Set<ResolvableType> types = resolveTypes(extractTypes(attributes));
BeanTypeDeductionException deductionException = null;
if (types.isEmpty() && this.names.isEmpty()) {
try {
Expand Down Expand Up @@ -459,6 +466,25 @@ else if (value instanceof String) {
return result.isEmpty() ? Collections.emptySet() : result;
}

private Set<ResolvableType> resolveTypes(Set<String> types) {
if (types.isEmpty()) {
return Collections.emptySet();
}
Set<ResolvableType> resolved = new LinkedHashSet<>(types.size());
for (String type : types) {
try {
Class<?> typeClass = resolve(type, this.classLoader);
ResolvableType resolvableType = (typeClass.getTypeParameters().length != 0)
? ResolvableType.forRawClass(typeClass) : ResolvableType.forClass(typeClass);
resolved.add(resolvableType);
}
catch (ClassNotFoundException | NoClassDefFoundError ex) {
resolved.add(ResolvableType.NONE);
}
}
return resolved;
}

private void merge(Set<String> result, String... additional) {
Collections.addAll(result, additional);
}
Expand Down Expand Up @@ -501,48 +527,52 @@ protected final String getAnnotationName() {
return "@" + ClassUtils.getShortName(this.annotationType);
}

private Set<String> deducedBeanType(ConditionContext context, AnnotatedTypeMetadata metadata) {
private Set<ResolvableType> deducedBeanType(ConditionContext context, AnnotatedTypeMetadata metadata) {
if (metadata instanceof MethodMetadata && metadata.isAnnotated(Bean.class.getName())) {
return deducedBeanTypeForBeanMethod(context, (MethodMetadata) metadata);
}
return Collections.emptySet();
}

private Set<String> deducedBeanTypeForBeanMethod(ConditionContext context, MethodMetadata metadata) {
private Set<ResolvableType> deducedBeanTypeForBeanMethod(ConditionContext context, MethodMetadata metadata) {
try {
Class<?> returnType = getReturnType(context, metadata);
return Collections.singleton(returnType.getName());
ResolvableType returnType = getReturnType(context, metadata);
return Collections.singleton(returnType);
}
catch (Throwable ex) {
throw new BeanTypeDeductionException(metadata.getDeclaringClassName(), metadata.getMethodName(), ex);
}
}

private Class<?> getReturnType(ConditionContext context, MethodMetadata metadata)
private ResolvableType getReturnType(ConditionContext context, MethodMetadata metadata)
throws ClassNotFoundException, LinkageError {
// Safe to load at this point since we are in the REGISTER_BEAN phase
ClassLoader classLoader = context.getClassLoader();
Class<?> returnType = resolve(metadata.getReturnTypeName(), classLoader);
ResolvableType returnType = getMethodReturnType(metadata, classLoader);
if (isParameterizedContainer(returnType)) {
returnType = getReturnTypeGeneric(metadata, classLoader);
returnType = returnType.getGeneric();
}
return returnType;
}

private boolean isParameterizedContainer(Class<?> type) {
private boolean isParameterizedContainer(ResolvableType type) {
Class<?> rawType = type.getRawClass();
if (rawType == null) {
return false;
}
for (Class<?> parameterizedContainer : this.parameterizedContainers) {
if (parameterizedContainer.isAssignableFrom(type)) {
if (parameterizedContainer.isAssignableFrom(rawType)) {
return true;
}
}
return false;
}

private Class<?> getReturnTypeGeneric(MethodMetadata metadata, ClassLoader classLoader)
private ResolvableType getMethodReturnType(MethodMetadata metadata, ClassLoader classLoader)
throws ClassNotFoundException, LinkageError {
Class<?> declaringClass = resolve(metadata.getDeclaringClassName(), classLoader);
Method beanMethod = findBeanMethod(declaringClass, metadata.getMethodName());
return ResolvableType.forMethodReturnType(beanMethod).resolveGeneric();
return ResolvableType.forMethodReturnType(beanMethod);
}

private Method findBeanMethod(Class<?> declaringClass, String methodName) {
Expand Down Expand Up @@ -572,15 +602,15 @@ Set<String> getNames() {
return this.names;
}

Set<String> getTypes() {
Set<ResolvableType> getTypes() {
return this.types;
}

Set<String> getAnnotations() {
return this.annotations;
}

Set<String> getIgnoredTypes() {
Set<Class<?>> getIgnoredTypes() {
return this.ignoredTypes;
}

Expand Down
Loading