Spring/spring-data-commons
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

DATACMNS-1172 - Extracted fragment setup into value object.

Browse Source 
We now use FragmentMetadata to control the way fragement interfaces and base packages to scan are calculated. Refactored RepositoryConfiguration.getImplementationBasePackages() to not take a parameter.

Original pull request: #248.
This commit is contained in:
Oliver Gierke
2017-09-27 16:04:21 +02:00
parent 3bae636e2f
commit da88163141
5 changed files with 109 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/main/java/org/springframework/data/repository/config/CustomRepositoryImplementationDetector.java
View File

@@ -72,7 +72,7 @@ public class CustomRepositoryImplementationDetector {
return detectCustomImplementation( //
configuration.getImplementationClassName(), //
configuration.getImplementationBeanName(), //
configuration.getImplementationBasePackages(configuration.getImplementationClassName()), //
configuration.getImplementationBasePackages(), //
configuration.getExcludeFilters(), //
bd -> configuration.getConfigurationSource().generateBeanName(bd));
}

6
src/main/java/org/springframework/data/repository/config/DefaultRepositoryConfiguration.java
View File

@@ -74,13 +74,13 @@ public class DefaultRepositoryConfiguration<T extends RepositoryConfigurationSou
/*
* (non-Javadoc)
* @see org.springframework.data.repository.config.RepositoryConfiguration#getBasePackages(String)
* @see org.springframework.data.repository.config.RepositoryConfiguration#getImplementationBasePackages()
*/
@Override
public Streamable<String> getImplementationBasePackages(String interfaceClassName) {
public Streamable<String> getImplementationBasePackages() {
return configurationSource.shouldLimitRepositoryImplementationBasePackages()
? Streamable.of(ClassUtils.getPackageName(interfaceClassName))
? Streamable.of(ClassUtils.getPackageName(getRepositoryInterface()))
: getBasePackages();
}

128
src/main/java/org/springframework/data/repository/config/RepositoryBeanDefinitionBuilder.java
View File

@@ -15,16 +15,21 @@
*/
package org.springframework.data.repository.config;
import lombok.Value;
import java.io.IOException;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.BeanDefinitionStoreException;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.support.AbstractBeanDefinition;
import org.springframework.beans.factory.support.BeanDefinitionBuilder;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
@@ -42,6 +47,7 @@ import org.springframework.data.repository.NoRepositoryBean;
import org.springframework.data.repository.core.support.RepositoryFragment;
import org.springframework.data.repository.core.support.RepositoryFragmentsFactoryBean;
import org.springframework.data.repository.query.ExtensionAwareEvaluationContextProvider;
import org.springframework.data.util.Optionals;
import org.springframework.data.util.StreamUtils;
import org.springframework.util.Assert;
import org.springframework.util.ClassUtils;
@@ -127,7 +133,6 @@ class RepositoryBeanDefinitionBuilder {
.rootBeanDefinition(RepositoryFragmentsFactoryBean.class);
List<String> fragmentBeanNames = registerRepositoryFragmentsImplementation(configuration) //
.stream() //
.map(RepositoryFragmentConfiguration::getFragmentBeanName) //
.collect(Collectors.toList());
@@ -171,41 +176,29 @@ class RepositoryBeanDefinitionBuilder {
});
}
private List<RepositoryFragmentConfiguration> registerRepositoryFragmentsImplementation(
private Stream<RepositoryFragmentConfiguration> registerRepositoryFragmentsImplementation(
RepositoryConfiguration<?> configuration) {
ClassMetadata classMetadata = getClassMetadata(configuration.getRepositoryInterface());
return Arrays.stream(classMetadata.getInterfaceNames()) //
.filter(this::isFragmentInterfaceCandidate) //
.map(it -> detectRepositoryFragmentConfiguration(configuration, it)) //
.filter(Optional::isPresent) //
.map(Optional::get) //
.filter(it -> FragmentMetadata.isCandidate(it, metadataReaderFactory)) //
.map(it -> FragmentMetadata.of(it, configuration)) //
.map(it -> detectRepositoryFragmentConfiguration(it)) //
.flatMap(it -> Optionals.toStream(it)) //
.peek(it -> potentiallyRegisterFragmentImplementation(configuration, it)) //
.peek(it -> potentiallyRegisterRepositoryFragment(configuration, it)) //
.collect(Collectors.toList());
}
private boolean isFragmentInterfaceCandidate(String interfaceName) {
AnnotationMetadata metadata = getAnnotationMetadata(interfaceName);
return !metadata.hasAnnotation(NoRepositoryBean.class.getName());
.peek(it -> potentiallyRegisterRepositoryFragment(configuration, it));
}
private Optional<RepositoryFragmentConfiguration> detectRepositoryFragmentConfiguration(
RepositoryConfiguration<?> configuration, String fragmentInterfaceName) {
FragmentMetadata configuration) {
List<TypeFilter> exclusions = getExclusions(configuration);
String className = ClassUtils.getShortName(fragmentInterfaceName)
.concat(configuration.getConfigurationSource().getRepositoryImplementationPostfix().orElse("Impl"));
String className = configuration.getFragmentImplementationClassName();
Optional<AbstractBeanDefinition> beanDefinition = implementationDetector.detectCustomImplementation(className, null,
configuration.getImplementationBasePackages(fragmentInterfaceName), exclusions,
bd -> configuration.getConfigurationSource().generateBeanName(bd));
configuration.getBasePackages(), configuration.getExclusions(), configuration.getBeanNameGenerator());
return beanDefinition.map(bd -> new RepositoryFragmentConfiguration(fragmentInterfaceName, bd));
return beanDefinition.map(bd -> new RepositoryFragmentConfiguration(configuration.getFragmentInterfaceName(), bd));
}
private void potentiallyRegisterFragmentImplementation(RepositoryConfiguration<?> repositoryConfiguration,
@@ -263,19 +256,84 @@ class RepositoryBeanDefinitionBuilder {
}
}
private AnnotationMetadata getAnnotationMetadata(String className) {
@Value(staticConstructor = "of")
static class FragmentMetadata {
try {
return metadataReaderFactory.getMetadataReader(className).getAnnotationMetadata();
} catch (IOException e) {
throw new BeanDefinitionStoreException(String.format("Cannot parse %s metadata.", className), e);
String fragmentInterfaceName;
RepositoryConfiguration<?> configuration;
/**
* Returns whether the given interface is a fragment candidate.
*
* @param interfaceName must not be {@literal null} or empty.
* @param factory must not be {@literal null}.
* @return
*/
public static boolean isCandidate(String interfaceName, MetadataReaderFactory factory) {
Assert.hasText(interfaceName, "Interface name must not be null or empty!");
Assert.notNull(factory, "MetadataReaderFactory must not be null!");
AnnotationMetadata metadata = getAnnotationMetadata(interfaceName, factory);
return !metadata.hasAnnotation(NoRepositoryBean.class.getName());
}
/**
* Returns the exclusions to be used when scanning for fragment implementations.
*
* @return
*/
public List<TypeFilter> getExclusions() {
Stream<TypeFilter> configurationExcludes = configuration.getExcludeFilters().stream();
Stream<AnnotationTypeFilter> noRepositoryBeans = Stream.of(new AnnotationTypeFilter(NoRepositoryBean.class));
return Stream.concat(configurationExcludes, noRepositoryBeans).collect(StreamUtils.toUnmodifiableList());
}
/**
* Returns the name of the implementation class to be detected for the fragment interface.
*
* @return
*/
public String getFragmentImplementationClassName() {
RepositoryConfigurationSource configurationSource = configuration.getConfigurationSource();
String postfix = configurationSource.getRepositoryImplementationPostfix().orElse("Impl");
return ClassUtils.getShortName(fragmentInterfaceName).concat(postfix);
}
/**
* Returns the base packages to be scanned to find implementations of the current fragment interface.
*
* @return
*/
public Iterable<String> getBasePackages() {
return configuration.getConfigurationSource().shouldLimitRepositoryImplementationBasePackages() ? //
Collections.singleton(ClassUtils.getPackageName(fragmentInterfaceName)) : //
configuration.getImplementationBasePackages();
}
/**
* Returns the bean name generating function to be used for the fragment.
*
* @return
*/
public Function<BeanDefinition, String> getBeanNameGenerator() {
return definition -> configuration.getConfigurationSource().generateBeanName(definition);
}
private static AnnotationMetadata getAnnotationMetadata(String className,
MetadataReaderFactory metadataReaderFactory) {
try {
return metadataReaderFactory.getMetadataReader(className).getAnnotationMetadata();
} catch (IOException e) {
throw new BeanDefinitionStoreException(String.format("Cannot parse %s metadata.", className), e);
}
}
}
private static List<TypeFilter> getExclusions(RepositoryConfiguration<?> configuration) {
return Stream
.concat(configuration.getExcludeFilters().stream(), Stream.of(new AnnotationTypeFilter(NoRepositoryBean.class)))//
.collect(StreamUtils.toUnmodifiableList());
}
}

3
src/main/java/org/springframework/data/repository/config/RepositoryConfiguration.java
View File

@@ -40,11 +40,10 @@ public interface RepositoryConfiguration<T extends RepositoryConfigurationSource
/**
* Returns the base packages to scan for repository implementations.
*
* @param interfaceClassName class name of the interface.
* @return
* @since 2.0
*/
Streamable<String> getImplementationBasePackages(String interfaceClassName);
Streamable<String> getImplementationBasePackages();
/**
* Returns the interface name of the repository.

17
src/test/java/org/springframework/data/repository/config/DefaultRepositoryConfigurationUnitTests.java
View File

@@ -89,7 +89,7 @@ public class DefaultRepositoryConfigurationUnitTests {
when(source.shouldLimitRepositoryImplementationBasePackages()).thenReturn(true);
assertThat(getConfiguration(source).getImplementationBasePackages("com.acme.MyRepository"))
assertThat(getConfiguration(source, "com.acme.MyRepository").getImplementationBasePackages())
.containsOnly("com.acme");
}
@@ -98,7 +98,7 @@ public class DefaultRepositoryConfigurationUnitTests {
when(source.shouldLimitRepositoryImplementationBasePackages()).thenReturn(true);
assertThat(getConfiguration(source).getImplementationBasePackages(NestedInterface.class.getName()))
assertThat(getConfiguration(source, NestedInterface.class.getName()).getImplementationBasePackages())
.containsOnly("org.springframework.data.repository.config");
}
@@ -107,13 +107,18 @@ public class DefaultRepositoryConfigurationUnitTests {
when(source.getBasePackages()).thenReturn(Streamable.of("com", "org.coyote"));
assertThat(getConfiguration(source).getImplementationBasePackages("com.acme.MyRepository")).contains("com",
assertThat(getConfiguration(source, "com.acme.MyRepository").getImplementationBasePackages()).contains("com",
"org.coyote");
}
private DefaultRepositoryConfiguration<RepositoryConfigurationSource> getConfiguration(
RepositoryConfigurationSource source) {
RootBeanDefinition beanDefinition = createBeanDefinition();
return getConfiguration(source, "com.acme.MyRepository");
}
private DefaultRepositoryConfiguration<RepositoryConfigurationSource> getConfiguration(
RepositoryConfigurationSource source, String repositoryInterfaceName) {
RootBeanDefinition beanDefinition = createBeanDefinition(repositoryInterfaceName);
return new DefaultRepositoryConfiguration<>(source, beanDefinition, extension);
}
@@ -123,9 +128,9 @@ public class DefaultRepositoryConfigurationUnitTests {
String repositoryFactoryBeanClassName, modulePrefix;
}
private static RootBeanDefinition createBeanDefinition() {
private static RootBeanDefinition createBeanDefinition(String repositoryInterfaceName) {
RootBeanDefinition beanDefinition = new RootBeanDefinition("com.acme.MyRepository");
RootBeanDefinition beanDefinition = new RootBeanDefinition(repositoryInterfaceName);
ConstructorArgumentValues constructorArgumentValues = new ConstructorArgumentValues();
constructorArgumentValues.addGenericArgumentValue(MyRepository.class);