Fix Spring Data custom repository fragment lookup.

christophstrobl · sdeleuze · commit a81386532e72 · 2021-04-01T17:40:50.000+02:00
Repository fragments following the pattern FragmentInterface | FragmentInterfaceImpl did not get discovered and registered correctly though annotated with @component. This commit introduces a Substitution for the CustomRepositoryImplementationDetector using the CandidateComponentsIndex directly. It also adds the missing type hint for the RepositoryFragment used to create the target repository and updates the data-elasticsearch example to cover the custom repository setup. The alternative setup using the heritage configuration format (used in the data-mongodb) still works.
diff --git a/samples/data-elasticsearch/src/main/java/com/example/data/elasticsearch/CLR.java b/samples/data-elasticsearch/src/main/java/com/example/data/elasticsearch/CLR.java
@@ -20,9 +20,11 @@
 
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.CommandLineRunner;
+import org.springframework.data.domain.PageRequest;
 import org.springframework.data.elasticsearch.core.ElasticsearchOperations;
 import org.springframework.data.elasticsearch.core.ReactiveElasticsearchOperations;
 import org.springframework.data.elasticsearch.core.SearchHits;
+import org.springframework.data.elasticsearch.core.SearchPage;
 import org.springframework.data.elasticsearch.core.geo.GeoPoint;
 import org.springframework.data.elasticsearch.core.mapping.IndexCoordinates;
 import org.springframework.data.elasticsearch.core.query.Criteria;
@@ -72,6 +74,13 @@ public void run(String... args) throws Exception {
 			System.out.println("repository.count(): " + repository.count());
 		}
 
+		{
+			System.out.println("\n--- CUSTOM REPOSITORY ---");
+
+			SearchPage<Conference> searchPage = repository.findBySomeCustomImplementation("eXchange", PageRequest.of(0, 10));
+			System.out.println("custom implementation finder.size(): " + searchPage.getSearchHits().getTotalHits());
+		}
+
 		String expectedDate = "2014-10-29";
 		String expectedWord = "java";
 		CriteriaQuery query = new CriteriaQuery(
diff --git a/samples/data-elasticsearch/src/main/java/com/example/data/elasticsearch/ConferenceCustomRepository.java b/samples/data-elasticsearch/src/main/java/com/example/data/elasticsearch/ConferenceCustomRepository.java
@@ -0,0 +1,24 @@
+/*
+ * Copyright 2021 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 com.example.data.elasticsearch;
+
+import org.springframework.data.domain.Pageable;
+import org.springframework.data.elasticsearch.core.SearchPage;
+
+public interface ConferenceCustomRepository {
+
+	SearchPage<Conference> findBySomeCustomImplementation(String name, Pageable page);
+}
diff --git a/samples/data-elasticsearch/src/main/java/com/example/data/elasticsearch/ConferenceCustomRepositoryImpl.java b/samples/data-elasticsearch/src/main/java/com/example/data/elasticsearch/ConferenceCustomRepositoryImpl.java
@@ -0,0 +1,49 @@
+/*
+ * Copyright 2021 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 com.example.data.elasticsearch;
+
+import org.elasticsearch.index.query.QueryBuilders;
+import org.springframework.data.domain.Pageable;
+import org.springframework.data.elasticsearch.core.ElasticsearchOperations;
+import org.springframework.data.elasticsearch.core.SearchHitSupport;
+import org.springframework.data.elasticsearch.core.SearchHits;
+import org.springframework.data.elasticsearch.core.SearchPage;
+import org.springframework.data.elasticsearch.core.query.NativeSearchQueryBuilder;
+import org.springframework.data.elasticsearch.core.query.Query;
+import org.springframework.stereotype.Component;
+import org.springframework.stereotype.Indexed;
+
+@Indexed
+@Component // required for spring.components
+public class ConferenceCustomRepositoryImpl implements ConferenceCustomRepository {
+
+	private final ElasticsearchOperations operations;
+
+	public ConferenceCustomRepositoryImpl(ElasticsearchOperations operations) {
+		this.operations = operations;
+	}
+
+	@Override
+	public SearchPage<Conference> findBySomeCustomImplementation(String name, Pageable page) {
+
+		Query query = new NativeSearchQueryBuilder()
+				.withQuery(QueryBuilders.matchQuery("name", name))
+				.build();
+
+		SearchHits<Conference> searchHits = operations.search(query, Conference.class);
+		return SearchHitSupport.searchPageFor(searchHits, page);
+	}
+}
diff --git a/samples/data-elasticsearch/src/main/java/com/example/data/elasticsearch/ConferenceRepository.java b/samples/data-elasticsearch/src/main/java/com/example/data/elasticsearch/ConferenceRepository.java
@@ -19,7 +19,7 @@
 
 import org.springframework.data.elasticsearch.repository.ElasticsearchRepository;
 
-interface ConferenceRepository extends ElasticsearchRepository<Conference, String> {
+interface ConferenceRepository extends ElasticsearchRepository<Conference, String>, ConferenceCustomRepository {
 
 	List<Conference> findByKeywordsContaining(String keyword);
 }
diff --git a/spring-native-configuration/src/main/java/org/springframework/data/SpringDataCommonsHints.java b/spring-native-configuration/src/main/java/org/springframework/data/SpringDataCommonsHints.java
@@ -27,6 +27,7 @@
 import org.springframework.data.repository.core.RepositoryMetadata;
 import org.springframework.data.repository.core.support.PropertiesBasedNamedQueries;
 import org.springframework.data.repository.core.support.RepositoryFactoryBeanSupport;
+import org.springframework.data.repository.core.support.RepositoryFragment;
 import org.springframework.data.repository.core.support.RepositoryFragmentsFactoryBean;
 import org.springframework.data.repository.core.support.TransactionalRepositoryFactoryBeanSupport;
 import org.springframework.data.repository.query.QueryByExampleExecutor;
@@ -43,6 +44,7 @@
 				@TypeHint(types = {
 						RepositoryFactoryBeanSupport.class,
 						RepositoryFragmentsFactoryBean.class,
+						RepositoryFragment.class,
 						TransactionalRepositoryFactoryBeanSupport.class,
 						QueryByExampleExecutor.class,
 						MappingContext.class,
diff --git a/spring-native/src/main/java/org/springframework/nativex/substitutions/data/Target_CustomRepositoryImplementationDetector.java b/spring-native/src/main/java/org/springframework/nativex/substitutions/data/Target_CustomRepositoryImplementationDetector.java
@@ -0,0 +1,90 @@
+/*
+ * Copyright 2021 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.nativex.substitutions.data;
+
+import java.io.IOException;
+import java.util.LinkedHashSet;
+import java.util.Set;
+import java.util.function.Function;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
+
+import com.oracle.svm.core.annotate.Substitute;
+import com.oracle.svm.core.annotate.TargetClass;
+import org.springframework.beans.factory.BeanDefinitionStoreException;
+import org.springframework.beans.factory.config.BeanDefinition;
+import org.springframework.context.annotation.ScannedGenericBeanDefinition;
+import org.springframework.context.index.CandidateComponentsIndex;
+import org.springframework.context.index.CandidateComponentsIndexLoader;
+import org.springframework.core.type.classreading.MetadataReader;
+import org.springframework.data.repository.config.ImplementationDetectionConfiguration;
+import org.springframework.nativex.substitutions.OnlyIfPresent;
+import org.springframework.stereotype.Component;
+
+
+@TargetClass(className = "org.springframework.data.repository.config.CustomRepositoryImplementationDetector", onlyWith = {OnlyIfPresent.class})
+public final class Target_CustomRepositoryImplementationDetector {
+
+	@Substitute
+	private Set<BeanDefinition> findCandidateBeanDefinitions(ImplementationDetectionConfiguration config) {
+
+		/* Using the index instead of ClassPathScanningCandidateComponentProvider with pattern.
+		 * Not sure why components are not found via the index as it should be configured on
+		 * `setResourceLoader` within ClassPathScanningCandidateComponentProvider.
+		 *
+		 * ClassPathScanningCandidateComponentProvider provider = new ClassPathScanningCandidateComponentProvider(false, environment);
+		 *
+		 * provider.setResourceLoader(resourceLoader);
+		 * provider.setResourcePattern(String.format(CUSTOM_IMPLEMENTATION_RESOURCE_PATTERN, postfix));
+		 * provider.setMetadataReaderFactory(config.getMetadataReaderFactory());
+		 * provider.addIncludeFilter((reader, factory) -> true);
+		 */
+		CandidateComponentsIndex index = CandidateComponentsIndexLoader.loadIndex(config.getClass().getClassLoader());
+
+		return config.getBasePackages().stream()
+
+				.flatMap(new Function<String, Stream<? extends BeanDefinition>>() { // see oracle/graal#2479
+
+							 @Override
+							 public Stream<? extends BeanDefinition> apply(String basePackage) {
+
+								 Set<String> candidateTypes = index.getCandidateTypes(basePackage, Component.class.getName());
+								 if (candidateTypes.isEmpty()) {
+									 return Stream.empty();
+								 }
+
+								 Set<BeanDefinition> beanDefinitions = new LinkedHashSet<>();
+								 for (String candidate : candidateTypes) {
+									 if (candidate.endsWith(config.getImplementationPostfix())) {
+
+										 try {
+
+											 MetadataReader metadataReader = config.getMetadataReaderFactory().getMetadataReader(candidate);
+											 ScannedGenericBeanDefinition sbd = new ScannedGenericBeanDefinition(metadataReader);
+											 sbd.setResource(metadataReader.getResource());
+											 beanDefinitions.add(sbd);
+										 } catch (IOException ex) {
+											 throw new BeanDefinitionStoreException(String.format("Failure while reading metadata for %s.", candidate), ex);
+										 }
+									 }
+								 }
+
+								 return beanDefinitions.stream();
+							 }
+						 }
+				).collect(Collectors.toSet());
+	}
+}

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@`
`19`	`19`
`20`	`20`	`import org.springframework.data.elasticsearch.repository.ElasticsearchRepository;`
`21`	`21`
`22`		`-interface ConferenceRepository extends ElasticsearchRepository<Conference, String> {`
	`22`	`+interface ConferenceRepository extends ElasticsearchRepository<Conference, String>, ConferenceCustomRepository {`
`23`	`23`
`24`	`24`	`List<Conference> findByKeywordsContaining(String keyword);`
`25`	`25`	`}`