Browse Source

Consistently find @⁠Lazy as a meta-annotation at arbitrary depths

Prior to this commit, AnnotationConfigUtils looked up @⁠Lazy as a
meta-annotation at arbitrary depths (e.g., when used as a
meta-meta-annotation); however,
ContextAnnotationAutowireCandidateResolver only found @Lazy as a
"directly present" meta-annotation.

For consistency, this commit revises
ContextAnnotationAutowireCandidateResolver so that it also finds @⁠Lazy
as a meta-annotation at arbitrary depths.

Closes gh-36306
pull/36325/head
Sam Brannen 1 month ago
parent
commit
282fee5c95
  1. 10
      spring-context/src/main/java/org/springframework/context/annotation/ContextAnnotationAutowireCandidateResolver.java
  2. 134
      spring-context/src/test/java/org/springframework/context/annotation/ContextAnnotationAutowireCandidateResolverTests.java

10
spring-context/src/main/java/org/springframework/context/annotation/ContextAnnotationAutowireCandidateResolver.java

@ -44,6 +44,7 @@ import org.springframework.core.annotation.AnnotationUtils; @@ -44,6 +44,7 @@ import org.springframework.core.annotation.AnnotationUtils;
* driven by the {@link Lazy} annotation in the {@code context.annotation} package.
*
* @author Juergen Hoeller
* @author Sam Brannen
* @since 4.0
*/
public class ContextAnnotationAutowireCandidateResolver extends QualifierAnnotationAutowireCandidateResolver {
@ -60,7 +61,12 @@ public class ContextAnnotationAutowireCandidateResolver extends QualifierAnnotat @@ -60,7 +61,12 @@ public class ContextAnnotationAutowireCandidateResolver extends QualifierAnnotat
protected boolean isLazy(DependencyDescriptor descriptor) {
for (Annotation ann : descriptor.getAnnotations()) {
Lazy lazy = AnnotationUtils.getAnnotation(ann, Lazy.class);
// Directly present?
if (ann instanceof Lazy lazy && lazy.value()) {
return true;
}
// Meta-present?
Lazy lazy = AnnotationUtils.findAnnotation(ann.annotationType(), Lazy.class);
if (lazy != null && lazy.value()) {
return true;
}
@ -69,7 +75,7 @@ public class ContextAnnotationAutowireCandidateResolver extends QualifierAnnotat @@ -69,7 +75,7 @@ public class ContextAnnotationAutowireCandidateResolver extends QualifierAnnotat
if (methodParam != null) {
Method method = methodParam.getMethod();
if (method == null || void.class == method.getReturnType()) {
Lazy lazy = AnnotationUtils.getAnnotation(methodParam.getAnnotatedElement(), Lazy.class);
Lazy lazy = AnnotationUtils.findAnnotation(methodParam.getAnnotatedElement(), Lazy.class);
if (lazy != null && lazy.value()) {
return true;
}

134
spring-context/src/test/java/org/springframework/context/annotation/ContextAnnotationAutowireCandidateResolverTests.java

@ -0,0 +1,134 @@ @@ -0,0 +1,134 @@
/*
* Copyright 2002-present 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.context.annotation;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.reflect.Method;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.BeforeTestExecutionCallback;
import org.junit.jupiter.api.extension.RegisterExtension;
import org.springframework.beans.factory.config.DependencyDescriptor;
import org.springframework.core.MethodParameter;
import org.springframework.util.ReflectionUtils;
import static org.assertj.core.api.Assertions.assertThat;
/**
* Unit tests for {@link ContextAnnotationAutowireCandidateResolver}.
*
* @author Sam Brannen
* @since 7.0.4
*/
class ContextAnnotationAutowireCandidateResolverTests {
final ContextAnnotationAutowireCandidateResolver resolver = new ContextAnnotationAutowireCandidateResolver();
Method testMethod;
@RegisterExtension
BeforeTestExecutionCallback extension = context -> this.testMethod = context.getRequiredTestMethod();
@Test
void isNotLazy() {
assertNotLazy();
}
@Test
void isLazy() {
assertLazy();
}
@Test
void isMetaLazy() {
assertLazy();
}
@Test // gh-36306
void isMetaMetaLazy() {
assertLazy();
}
private void assertLazy() {
assertThat(this.resolver.isLazy(getMethodDescriptor()))
.as("%sMethod() is @Lazy", this.testMethod.getName()).isTrue();
assertThat(this.resolver.isLazy(getParameterDescriptor()))
.as("parameter in %sParameter() is @Lazy", this.testMethod.getName()).isTrue();
}
private void assertNotLazy() {
assertThat(this.resolver.isLazy(getMethodDescriptor()))
.as("%sMethod() is not @Lazy", this.testMethod.getName()).isFalse();
assertThat(this.resolver.isLazy(getParameterDescriptor()))
.as("parameter in %sParameter() is not @Lazy", this.testMethod.getName()).isFalse();
}
private DependencyDescriptor getMethodDescriptor() {
var method = ReflectionUtils.findMethod(getClass(), this.testMethod.getName() + "Method");
var methodParameter = MethodParameter.forExecutable(method, -1);
return new DependencyDescriptor(methodParameter, true);
}
private DependencyDescriptor getParameterDescriptor() {
var method = ReflectionUtils.findMethod(getClass(), this.testMethod.getName() + "Parameter", String.class);
var methodParameter = MethodParameter.forExecutable(method, 0);
return new DependencyDescriptor(methodParameter, true);
}
void isNotLazyMethod() {
}
@Lazy
void isLazyMethod() {
}
@MetaLazy
void isMetaLazyMethod() {
}
@MetaMetaLazy
void isMetaMetaLazyMethod() {
}
void isNotLazyParameter(String enigma) {
}
void isLazyParameter(@Lazy String enigma) {
}
void isMetaLazyParameter(@MetaLazy String enigma) {
}
void isMetaMetaLazyParameter(@MetaMetaLazy String enigma) {
}
@Lazy
@Retention(RetentionPolicy.RUNTIME)
@interface MetaLazy {
}
@MetaLazy
@Retention(RetentionPolicy.RUNTIME)
@interface MetaMetaLazy {
}
}
Loading…
Cancel
Save