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

Fix Add Multiple DeferredRepositoryInitializationListener in RepositoryConfigurationDelegate #3219

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fix Add Multiple DeferredRepositoryInitializationListener in RepositoryConfigurationDelegate #3219

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9ca3acf
Fix Add Multiple DeferredRepositoryInitializationListener in `Reposit…
xeounxzxu Dec 9, 2024
8f49485
Style Apply Formatting
xeounxzxu Dec 14, 2024
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
37 changes: 14 additions & 23 deletions ...main/java/org/springframework/data/repository/config/RepositoryConfigurationDelegate.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,28 +15,13 @@
*/
package org.springframework.data.repository.config;

import java.lang.reflect.TypeVariable;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.config.ConfigurableBeanFactory;
import org.springframework.beans.factory.config.DependencyDescriptor;
import org.springframework.beans.factory.parsing.BeanComponentDefinition;
import org.springframework.beans.factory.support.AutowireCandidateResolver;
import org.springframework.beans.factory.support.BeanDefinitionBuilder;
import org.springframework.beans.factory.support.BeanDefinitionReaderUtils;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.beans.factory.support.DefaultListableBeanFactory;
import org.springframework.beans.factory.support.RootBeanDefinition;
import org.springframework.beans.factory.support.*;
import org.springframework.context.annotation.ContextAnnotationAutowireCandidateResolver;
import org.springframework.context.support.GenericApplicationContext;
import org.springframework.core.ResolvableType;
Expand All @@ -57,6 +42,10 @@
import org.springframework.util.Assert;
import org.springframework.util.StopWatch;

import java.lang.reflect.TypeVariable;
import java.util.*;
import java.util.stream.Collectors;

/**
* Delegate for configuration integration to reuse the general way of detecting repositories. Customization is done by
* providing a configuration format specific {@link RepositoryConfigurationSource} (currently either XML or annotations
Expand Down Expand Up @@ -92,7 +81,7 @@ public class RepositoryConfigurationDelegate {
* @param environment must not be {@literal null}.
*/
public RepositoryConfigurationDelegate(RepositoryConfigurationSource configurationSource,
ResourceLoader resourceLoader, Environment environment) {
ResourceLoader resourceLoader, Environment environment) {

this.isXml = configurationSource instanceof XmlRepositoryConfigurationSource;
boolean isAnnotation = configurationSource instanceof AnnotationRepositoryConfigurationSource;
Expand All @@ -117,7 +106,7 @@ public RepositoryConfigurationDelegate(RepositoryConfigurationSource configurati
* {@link Environment}.
*/
private static Environment defaultEnvironment(@Nullable Environment environment,
@Nullable ResourceLoader resourceLoader) {
@Nullable ResourceLoader resourceLoader) {

if (environment != null) {
return environment;
Expand All @@ -136,7 +125,7 @@ private static Environment defaultEnvironment(@Nullable Environment environment,
* @see org.springframework.beans.factory.support.BeanDefinitionRegistry
*/
public List<BeanComponentDefinition> registerRepositoriesIn(BeanDefinitionRegistry registry,
RepositoryConfigurationExtension extension) {
RepositoryConfigurationExtension extension) {

if (logger.isInfoEnabled()) {
logger.info(LogMessage.format("Bootstrapping Spring Data %s repositories in %s mode.", //
Expand Down Expand Up @@ -222,7 +211,7 @@ public List<BeanComponentDefinition> registerRepositoriesIn(BeanDefinitionRegist
}

private void registerAotComponents(BeanDefinitionRegistry registry, RepositoryConfigurationExtension extension,
Map<String, RepositoryConfigurationAdapter<?>> metadataByRepositoryBeanName) {
Map<String, RepositoryConfigurationAdapter<?>> metadataByRepositoryBeanName) {

BeanDefinitionBuilder repositoryAotProcessor = BeanDefinitionBuilder
.rootBeanDefinition(extension.getRepositoryAotProcessor()).setRole(BeanDefinition.ROLE_INFRASTRUCTURE);
Expand All @@ -245,7 +234,7 @@ private void registerAotComponents(BeanDefinitionRegistry registry, RepositoryCo
* @param registry must not be {@literal null}.
*/
private static void potentiallyLazifyRepositories(Map<String, RepositoryConfiguration<?>> configurations,
BeanDefinitionRegistry registry, BootstrapMode mode) {
BeanDefinitionRegistry registry, BootstrapMode mode) {

if (!DefaultListableBeanFactory.class.isInstance(registry) || BootstrapMode.DEFAULT.equals(mode)) {
return;
Expand All @@ -272,8 +261,10 @@ private static void potentiallyLazifyRepositories(Map<String, RepositoryConfigur

logger.debug("Registering deferred repository initialization listener.");

beanFactory.registerSingleton(DeferredRepositoryInitializationListener.class.getName(),
new DeferredRepositoryInitializationListener(beanFactory));
if (!beanFactory.containsBean(DeferredRepositoryInitializationListener.class.getName())) {
beanFactory.registerSingleton(DeferredRepositoryInitializationListener.class.getName(),
new DeferredRepositoryInitializationListener(beanFactory));
}
}
}

Expand Down
34 changes: 25 additions & 9 deletions .../org/springframework/data/repository/config/RepositoryConfigurationDelegateUnitTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,6 @@
*/
package org.springframework.data.repository.config;

import static org.assertj.core.api.Assertions.*;

import java.lang.reflect.TypeVariable;
import java.util.List;
import java.util.Optional;
import java.util.UUID;

import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.Mockito;
Expand Down Expand Up @@ -59,11 +52,19 @@
import org.springframework.data.repository.sample.AddressRepositoryClient;
import org.springframework.data.repository.sample.ProductRepository;

import java.lang.reflect.TypeVariable;
import java.util.List;
import java.util.Optional;
import java.util.UUID;

import static org.assertj.core.api.Assertions.assertThat;

/**
* Unit tests for {@link RepositoryConfigurationDelegate}.
*
* @author Oliver Gierke
* @author Mark Paluch
* @author xeounxzxu
* @soundtrack Richard Spaven - Tribute (Whole Other*)
*/
@ExtendWith(MockitoExtension.class)
Expand Down Expand Up @@ -109,7 +110,16 @@ void registersDeferredRepositoryInitializationListener() {
var beanFactory = assertLazyRepositoryBeanSetup(DeferredConfig.class);

assertThat(beanFactory.getBeanNamesForType(DeferredRepositoryInitializationListener.class)).isNotEmpty();
}

@Test
void registersMultiDeferredRepositoryInitializationListener() {

var beanFactory = assertLazyRepositoryBeanSetup(DeferredConfig.class, OtherDeferredConfig.class);

assertThat(beanFactory.getBeanNamesForType(DeferredRepositoryInitializationListener.class)).isNotEmpty();
assertThat(beanFactory.getBeanNamesForType(AddressRepository.class)).isNotEmpty();
assertThat(beanFactory.getBeanNamesForType(ProductRepository.class)).isNotEmpty();
}

@Test // DATACMNS-1832
Expand Down Expand Up @@ -276,9 +286,9 @@ void considersGenericLength() {
assertThat(it.getGeneric(1).resolve()).isEqualTo(Person.class);
}

private static ListableBeanFactory assertLazyRepositoryBeanSetup(Class<?> configClass) {
private static ListableBeanFactory assertLazyRepositoryBeanSetup(Class<?>... componentClasses) {

var context = new AnnotationConfigApplicationContext(configClass);
var context = new AnnotationConfigApplicationContext(componentClasses);

assertThat(context.getDefaultListableBeanFactory().getAutowireCandidateResolver())
.isInstanceOf(LazyRepositoryInjectionPointResolver.class);
Expand Down Expand Up @@ -309,6 +319,12 @@ static class LazyConfig {}
bootstrapMode = BootstrapMode.DEFERRED)
static class DeferredConfig {}

@ComponentScan(basePackageClasses = ProductRepository.class)
@EnableRepositories(basePackageClasses = ProductRepository.class,
includeFilters = @Filter(type = FilterType.ASSIGNABLE_TYPE, classes = AddressRepository.class),
bootstrapMode = BootstrapMode.DEFERRED)
static class OtherDeferredConfig {}

@EnableRepositories(basePackageClasses = MyOtherRepository.class,
includeFilters = @Filter(type = FilterType.ASSIGNABLE_TYPE, classes = MyOtherRepository.class),
excludeFilters = @Filter(type = FilterType.ASSIGNABLE_TYPE, classes = MyOtherRepositoryImpl.class))
Expand Down