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

Polish OverrideMetadata

This commit is contained in:
Sam Brannen 2024-09-29 17:46:56 +02:00
parent ba1d01d9b7
commit 4e9b503055
1 changed files with 19 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
spring-test/src/main/java/org/springframework/test/context/bean/override/OverrideMetadata.java
View File

@ -44,13 +44,14 @@ import static org.springframework.core.annotation.MergedAnnotations.SearchStrate
* <p><strong>WARNING</strong>: implementations are used as a cache key and * <p><strong>WARNING</strong>: implementations are used as a cache key and
* must implement proper {@code equals()} and {@code hashCode()} methods. * must implement proper {@code equals()} and {@code hashCode()} methods.
* *
* <p>Specific implementations of metadata can have state to be used during * <p>Concrete implementations of {@code OverrideMetadata} can store state to use
* override {@linkplain #createOverride(String, BeanDefinition, Object) * during override {@linkplain #createOverride(String, BeanDefinition, Object)
* instance creation} &mdash; for example, based on further parsing of the * instance creation} &mdash; for example, based on further processing of the
* annotation or the annotated field. * annotation or the annotated field.
* *
* @author Simon Baslé * @author Simon Baslé
* @author Stephane Nicoll * @author Stephane Nicoll
* @author Sam Brannen
* @since 6.2 * @since 6.2
*/ */
public abstract class OverrideMetadata { public abstract class OverrideMetadata {
@ -67,6 +68,7 @@ public abstract class OverrideMetadata {
protected OverrideMetadata(Field field, ResolvableType beanType, @Nullable String beanName, protected OverrideMetadata(Field field, ResolvableType beanType, @Nullable String beanName,
BeanOverrideStrategy strategy) { BeanOverrideStrategy strategy) {
this.field = field; this.field = field;
this.beanType = beanType; this.beanType = beanType;
this.beanName = beanName; this.beanName = beanName;
@ -74,18 +76,19 @@ public abstract class OverrideMetadata {
} }
/** /**
* Parse the given {@code testClass} and build the corresponding list of * Process the given {@code testClass} and build the corresponding list of
* bean {@code OverrideMetadata}. * {@code OverrideMetadata} derived from {@link BeanOverride @BeanOverride}
* @param testClass the class to parse * fields in the test class and its type hierarchy.
* @param testClass the test class to process
* @return a list of {@code OverrideMetadata} * @return a list of {@code OverrideMetadata}
*/ */
public static List<OverrideMetadata> forTestClass(Class<?> testClass) { public static List<OverrideMetadata> forTestClass(Class<?> testClass) {
List<OverrideMetadata> metadata = new LinkedList<>(); List<OverrideMetadata> metadata = new LinkedList<>();
ReflectionUtils.doWithFields(testClass, field -> parseField(field, testClass, metadata)); ReflectionUtils.doWithFields(testClass, field -> processField(field, testClass, metadata));
return metadata; return metadata;
} }
private static void parseField(Field field, Class<?> testClass, List<OverrideMetadata> metadataList) { private static void processField(Field field, Class<?> testClass, List<OverrideMetadata> metadataList) {
AtomicBoolean overrideAnnotationFound = new AtomicBoolean(); AtomicBoolean overrideAnnotationFound = new AtomicBoolean();
MergedAnnotations.from(field, DIRECT).stream(BeanOverride.class).forEach(mergedAnnotation -> { MergedAnnotations.from(field, DIRECT).stream(BeanOverride.class).forEach(mergedAnnotation -> {
MergedAnnotation<?> metaSource = mergedAnnotation.getMetaSource(); MergedAnnotation<?> metaSource = mergedAnnotation.getMetaSource();
@ -127,20 +130,20 @@ public abstract class OverrideMetadata {
} }
/** /**
* Get the {@link BeanOverrideStrategy} for this instance, as a hint on * Get the {@link BeanOverrideStrategy} for this {@code OverrideMetadata},
* how and when the override instance should be created. * which influences how and when the bean override instance should be created.
*/ */
public final BeanOverrideStrategy getStrategy() { public final BeanOverrideStrategy getStrategy() {
return this.strategy; return this.strategy;
} }
/** /**
* Create an override instance from this {@link OverrideMetadata}, * Create a bean override instance for this {@code OverrideMetadata},
* optionally provided with an existing {@link BeanDefinition} and/or an * optionally based on an existing {@link BeanDefinition} and/or an
* original instance, that is a singleton or an early wrapped instance. * original instance, that is a singleton or an early wrapped instance.
* @param beanName the name of the bean being overridden * @param beanName the name of the bean being overridden
* @param existingBeanDefinition an existing bean definition for the supplied * @param existingBeanDefinition an existing bean definition for the supplied
* bean name, or {@code null} if not relevant * bean name, or {@code null} if irrelevant
* @param existingBeanInstance an existing instance for the supplied bean name * @param existingBeanInstance an existing instance for the supplied bean name
* for wrapping purposes, or {@code null} if irrelevant * for wrapping purposes, or {@code null} if irrelevant
* @return the instance with which to override the bean * @return the instance with which to override the bean
@ -149,8 +152,9 @@ public abstract class OverrideMetadata {
@Nullable Object existingBeanInstance); @Nullable Object existingBeanInstance);
/** /**
* Optionally track objects created by this {@link OverrideMetadata}. * Optionally track objects created by this {@code OverrideMetadata}.
* <p>The default is not to track, but this can be overridden in subclasses. * <p>The default implementation does not track the supplied instance, but
* this can be overridden in subclasses as appropriate.
* @param override the bean override instance to track * @param override the bean override instance to track
* @param trackingBeanRegistry the registry in which trackers can * @param trackingBeanRegistry the registry in which trackers can
* optionally be registered * optionally be registered