Allow injection of "row mapper," and "result set extractor" beans.

Until now, only classes without injection had support. This commit will add two new params at the `@Query` annotation. In these new params will be possible to add Spring Beans allowing the user to use Spring Beans.

Author: uaihebert

spring-data-jdbc/src/main/java/org/springframework/data/jdbc/repository/query/JdbcQueryMethod.java

@@ -163,7 +163,7 @@ private String getQueryName() {
 return StringUtils.hasText(annotatedName) ? annotatedName : getNamedQueryName();
 }
 
-/*
+/**
  * Returns the class to be used as {@link org.springframework.jdbc.core.RowMapper}
  *
  * @return May be {@code null}.
@@ -173,6 +173,17 @@ Class<? extends RowMapper> getRowMapperClass() {
 return getMergedAnnotationAttribute("rowMapperClass");
 }
 
+
+/**
+ * Returns the bean to be used as {@link org.springframework.jdbc.core.RowMapper}
+ *
+ * @return May be {@code null}.
+ */
+@Nullable
+Class<? extends RowMapper> getRowMapperBean() {
+return getMergedAnnotationAttribute("rowMapperBean");
+}
+
 /**
  * Returns the class to be used as {@link org.springframework.jdbc.core.ResultSetExtractor}
  *
@@ -183,6 +194,16 @@ Class<? extends ResultSetExtractor> getResultSetExtractorClass() {
 return getMergedAnnotationAttribute("resultSetExtractorClass");
 }
 
+/**
+ * Returns the bean to be used as {@link org.springframework.jdbc.core.ResultSetExtractor}
+ *
+ * @return May be {@code null}.
+ */
+@Nullable
+Class<? extends ResultSetExtractor> getResultSetExtractorBean() {
+return getMergedAnnotationAttribute("resultSetExtractorBean");
+}
+
 /**
  * Returns whether the query method is a modifying one.
  *

spring-data-jdbc/src/main/java/org/springframework/data/jdbc/repository/query/Query.java

@@ -56,9 +56,21 @@
  */
 Class<? extends RowMapper> rowMapperClass() default RowMapper.class;
 
+/**
+ * Optional bean of type {@link RowMapper} to use to convert the result of the query to domain class instances. Cannot be used
+ * along with {@link #resultSetExtractorClass()} only one of the two can be set.
+ */
+Class<? extends RowMapper> rowMapperBean() default RowMapper.class;
+
 /**
  * Optional {@link ResultSetExtractor} to use to convert the result of the query to domain class instances. Cannot be
  * used along with {@link #rowMapperClass()} only one of the two can be set.
  */
 Class<? extends ResultSetExtractor> resultSetExtractorClass() default ResultSetExtractor.class;
+
+/**
+ * Optional bean of type {@link ResultSetExtractor} to use to convert the result of the query to domain class instances. Cannot be
+ * used along with {@link #rowMapperClass()} only one of the two can be set.
+ */
+Class<? extends ResultSetExtractor> resultSetExtractorBean() default ResultSetExtractor.class;
 }

spring-data-jdbc/src/main/java/org/springframework/data/jdbc/repository/query/StringBasedJdbcQuery.java

@@ -19,6 +19,7 @@
 import java.sql.JDBCType;
 
 import org.springframework.beans.BeanUtils;
+import org.springframework.beans.factory.BeanFactory;
 import org.springframework.data.jdbc.core.convert.JdbcColumnTypes;
 import org.springframework.data.jdbc.core.convert.JdbcConverter;
 import org.springframework.data.jdbc.core.convert.JdbcValue;
@@ -51,6 +52,7 @@ public class StringBasedJdbcQuery extends AbstractJdbcQuery {
 private final JdbcQueryMethod queryMethod;
 private final JdbcQueryExecution<?> executor;
 private final JdbcConverter converter;
+private BeanFactory beanfactory;
 
 /**
  * Creates a new {@link StringBasedJdbcQuery} for the given {@link JdbcQueryMethod}, {@link RelationalMappingContext}
@@ -61,12 +63,13 @@ public class StringBasedJdbcQuery extends AbstractJdbcQuery {
  * @param defaultRowMapper can be {@literal null} (only in case of a modifying query).
  */
 public StringBasedJdbcQuery(JdbcQueryMethod queryMethod, NamedParameterJdbcOperations operations,
-@Nullable RowMapper<?> defaultRowMapper, JdbcConverter converter) {
+@Nullable RowMapper<?> defaultRowMapper, JdbcConverter converter, BeanFactory beanfactory) {
 
 super(queryMethod, operations, defaultRowMapper);
 
 this.queryMethod = queryMethod;
 this.converter = converter;
+this.beanfactory = beanfactory;
 
 RowMapper<Object> rowMapper = determineRowMapper(defaultRowMapper);
 executor = getQueryExecution( //
@@ -137,6 +140,11 @@ private String determineQuery() {
 @Nullable
 @SuppressWarnings({ "rawtypes", "unchecked" })
 ResultSetExtractor<Object> determineResultSetExtractor(@Nullable RowMapper<Object> rowMapper) {
+Class<? extends ResultSetExtractor> resultSetExtractorBean = queryMethod.getResultSetExtractorBean();
+
+if (!isUnconfigured(resultSetExtractorBean, ResultSetExtractor.class)) {
+return beanfactory.getBean(resultSetExtractorBean);
+}
 
 Class<? extends ResultSetExtractor> resultSetExtractorClass = queryMethod.getResultSetExtractorClass();
 
@@ -157,6 +165,12 @@ ResultSetExtractor<Object> determineResultSetExtractor(@Nullable RowMapper<Objec
 @SuppressWarnings("unchecked")
 RowMapper<Object> determineRowMapper(@Nullable RowMapper<?> defaultMapper) {
 
+Class<? extends RowMapper> rowMapperBean = queryMethod.getRowMapperBean();
+
+if (!isUnconfigured(rowMapperBean, RowMapper.class)) {
+return beanfactory.getBean(rowMapperBean);
+}
+
 Class<?> rowMapperClass = queryMethod.getRowMapperClass();
 
 if (isUnconfigured(rowMapperClass, RowMapper.class)) {

spring-data-jdbc/src/main/java/org/springframework/data/jdbc/repository/support/JdbcQueryLookupStrategy.java

@@ -19,6 +19,7 @@
 import java.sql.ResultSet;
 import java.sql.SQLException;
 
+import org.springframework.beans.factory.BeanFactory;
 import org.springframework.context.ApplicationEventPublisher;
 import org.springframework.data.jdbc.core.convert.EntityRowMapper;
 import org.springframework.data.jdbc.core.convert.JdbcConverter;
@@ -63,10 +64,12 @@ class JdbcQueryLookupStrategy implements QueryLookupStrategy {
 private final Dialect dialect;
 private final QueryMappingConfiguration queryMappingConfiguration;
 private final NamedParameterJdbcOperations operations;
+private BeanFactory beanfactory;
 
 public JdbcQueryLookupStrategy(ApplicationEventPublisher publisher, @Nullable EntityCallbacks callbacks,
 RelationalMappingContext context, JdbcConverter converter, Dialect dialect,
-QueryMappingConfiguration queryMappingConfiguration, NamedParameterJdbcOperations operations) {
+QueryMappingConfiguration queryMappingConfiguration, NamedParameterJdbcOperations operations,
+ BeanFactory beanfactory) {
 
 Assert.notNull(publisher, "ApplicationEventPublisher must not be null");
 Assert.notNull(context, "RelationalMappingContextPublisher must not be null");
@@ -82,6 +85,7 @@ public JdbcQueryLookupStrategy(ApplicationEventPublisher publisher, @Nullable En
 this.dialect = dialect;
 this.queryMappingConfiguration = queryMappingConfiguration;
 this.operations = operations;
+this.beanfactory = beanfactory;
 }
 
 /*
@@ -99,7 +103,7 @@ public RepositoryQuery resolveQuery(Method method, RepositoryMetadata repository
 if (namedQueries.hasQuery(queryMethod.getNamedQueryName()) || queryMethod.hasAnnotatedQuery()) {
 
 RowMapper<?> mapper = queryMethod.isModifyingQuery() ? null : createMapper(queryMethod);
-return new StringBasedJdbcQuery(queryMethod, operations, mapper, converter);
+return new StringBasedJdbcQuery(queryMethod, operations, mapper, converter, beanfactory);
 } else {
 return new PartTreeJdbcQuery(context, queryMethod, dialect, converter, operations, createMapper(queryMethod));
 }

spring-data-jdbc/src/main/java/org/springframework/data/jdbc/repository/support/JdbcRepositoryFactory.java

@@ -17,6 +17,7 @@
 
 import java.util.Optional;
 
+import org.springframework.beans.factory.BeanFactory;
 import org.springframework.context.ApplicationEventPublisher;
 import org.springframework.data.jdbc.core.JdbcAggregateTemplate;
 import org.springframework.data.jdbc.core.convert.DataAccessStrategy;
@@ -53,6 +54,7 @@ public class JdbcRepositoryFactory extends RepositoryFactorySupport {
 private final DataAccessStrategy accessStrategy;
 private final NamedParameterJdbcOperations operations;
 private final Dialect dialect;
+private BeanFactory beanfactory;
 
 private QueryMappingConfiguration queryMappingConfiguration = QueryMappingConfiguration.EMPTY;
 private EntityCallbacks entityCallbacks;
@@ -70,7 +72,7 @@ public class JdbcRepositoryFactory extends RepositoryFactorySupport {
  */
 public JdbcRepositoryFactory(DataAccessStrategy dataAccessStrategy, RelationalMappingContext context,
 JdbcConverter converter, Dialect dialect, ApplicationEventPublisher publisher,
-NamedParameterJdbcOperations operations) {
+NamedParameterJdbcOperations operations, BeanFactory beanfactory) {
 
 Assert.notNull(dataAccessStrategy, "DataAccessStrategy must not be null!");
 Assert.notNull(context, "RelationalMappingContext must not be null!");
@@ -84,6 +86,7 @@ public JdbcRepositoryFactory(DataAccessStrategy dataAccessStrategy, RelationalMa
 this.dialect = dialect;
 this.accessStrategy = dataAccessStrategy;
 this.operations = operations;
+this.beanfactory = beanfactory;
 }
 
 /**
@@ -142,7 +145,7 @@ protected Optional<QueryLookupStrategy> getQueryLookupStrategy(@Nullable QueryLo
 QueryMethodEvaluationContextProvider evaluationContextProvider) {
 
 return Optional.of(new JdbcQueryLookupStrategy(publisher, entityCallbacks, context, converter, dialect,
-queryMappingConfiguration, operations));
+queryMappingConfiguration, operations, beanfactory));
 }
 
 /**

spring-data-jdbc/src/main/java/org/springframework/data/jdbc/repository/support/JdbcRepositoryFactoryBean.java

@@ -86,7 +86,7 @@ public void setApplicationEventPublisher(ApplicationEventPublisher publisher) {
 protected RepositoryFactorySupport doCreateRepositoryFactory() {
 
 JdbcRepositoryFactory jdbcRepositoryFactory = new JdbcRepositoryFactory(dataAccessStrategy, mappingContext,
-converter, dialect, publisher, operations);
+converter, dialect, publisher, operations, beanFactory);
 jdbcRepositoryFactory.setQueryMappingConfiguration(queryMappingConfiguration);
 jdbcRepositoryFactory.setEntityCallbacks(entityCallbacks);
 

spring-data-jdbc/src/test/java/org/springframework/data/jdbc/repository/SimpleJdbcRepositoryEventsUnitTests.java

@@ -32,6 +32,7 @@
 import org.junit.Before;
 import org.junit.Test;
 import org.mockito.stubbing.Answer;
+import org.springframework.beans.factory.BeanFactory;
 import org.springframework.context.ApplicationEventPublisher;
 import org.springframework.data.annotation.Id;
 import org.springframework.data.domain.PageRequest;
@@ -82,6 +83,7 @@ public class SimpleJdbcRepositoryEventsUnitTests {
 
 DummyEntityRepository repository;
 DefaultDataAccessStrategy dataAccessStrategy;
+BeanFactory beanFactory = mock(BeanFactory.class);
 
 @Before
 public void before() {
@@ -99,7 +101,7 @@ public void before() {
 doReturn(true).when(dataAccessStrategy).update(any(), any());
 
 JdbcRepositoryFactory factory = new JdbcRepositoryFactory(dataAccessStrategy, context, converter,
-H2Dialect.INSTANCE, publisher, operations);
+H2Dialect.INSTANCE, publisher, operations, beanFactory);
 
 this.repository = factory.getRepository(DummyEntityRepository.class);
 }

spring-data-jdbc/src/test/java/org/springframework/data/jdbc/repository/StringBasedJdbcQueryMappingConfigurationIntegrationTests.java

@@ -15,10 +15,8 @@
  */
 package org.springframework.data.jdbc.repository;
 
-import static org.assertj.core.api.Assertions.*;
-
-import lombok.AllArgsConstructor;
-import lombok.Data;
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.springframework.data.jdbc.testing.SingleBaseMappingTestConfiguration.VALUE_PROCESSED_BY_SERVICE;
 
 import java.sql.ResultSet;
 import java.sql.SQLException;
@@ -33,10 +31,12 @@
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Import;
 import org.springframework.dao.DataAccessException;
-import org.springframework.data.annotation.Id;
 import org.springframework.data.jdbc.repository.config.DefaultQueryMappingConfiguration;
 import org.springframework.data.jdbc.repository.config.EnableJdbcRepositories;
 import org.springframework.data.jdbc.repository.query.Query;
+import org.springframework.data.jdbc.testing.SingleBaseMappingTestConfiguration.Car;
+import org.springframework.data.jdbc.testing.SingleBaseMappingTestConfiguration.CarResultSetExtractorBean;
+import org.springframework.data.jdbc.testing.SingleBaseMappingTestConfiguration.CustomRowMapperBean;
 import org.springframework.data.jdbc.testing.TestConfiguration;
 import org.springframework.data.repository.CrudRepository;
 import org.springframework.jdbc.core.ResultSetExtractor;
@@ -55,7 +55,7 @@
 @Transactional
 public class StringBasedJdbcQueryMappingConfigurationIntegrationTests {
 
-private static String CAR_MODEL = "ResultSetExtractor Car";
+private final static String CAR_MODEL = "ResultSetExtractor Car";
 
 @Configuration
 @Import(TestConfiguration.class)
@@ -89,18 +89,22 @@ public void customFindAllCarsUsesConfiguredResultSetExtractor() {
 assertThat(cars).allMatch(car -> CAR_MODEL.equals(car.getModel()));
 }
 
-interface CarRepository extends CrudRepository<Car, Long> {
+@Test // DATAJDBC-430
+public void customFindWithRowMapperSupportingInjection() {
+carRepository.save(new Car(null, "Some model"));
+List<String> names = carRepository.findByNameWithRowMapperBean();
 
-@Query(value = "select * from car", resultSetExtractorClass = CarResultSetExtractor.class)
-List<Car> customFindAll();
+assertThat(names).hasSize(1);
+assertThat(names).allMatch(name -> VALUE_PROCESSED_BY_SERVICE.equals(name));
 }
 
-@Data
-@AllArgsConstructor
-static class Car {
+@Test // DATAJDBC-430
+public void customFindWithResultSetExtractorSupportingInjection() {
+carRepository.save(new Car(null, "Some model"));
+Iterable<Car> cars = carRepository.findByNameWithResultSetExtractor();
 
-@Id private Long id;
-private String model;
+assertThat(cars).hasSize(1);
+assertThat(cars).allMatch(car -> VALUE_PROCESSED_BY_SERVICE.equals(car.getModel()));
 }
 
 static class CarResultSetExtractor implements ResultSetExtractor<List<Car>> {
@@ -109,6 +113,16 @@ static class CarResultSetExtractor implements ResultSetExtractor<List<Car>> {
 public List<Car> extractData(ResultSet rs) throws SQLException, DataAccessException {
 return Arrays.asList(new Car(1L, CAR_MODEL));
 }
+}
+
+private interface CarRepository extends CrudRepository<Car, Long> {
+@Query(value = "select * from car", resultSetExtractorClass = CarResultSetExtractor.class)
+List<Car> customFindAll();
+
+@Query(value = "select * from car", resultSetExtractorBean = CarResultSetExtractorBean.class)
+List<Car> findByNameWithResultSetExtractor();
 
+@Query(value = "select model from car", rowMapperBean = CustomRowMapperBean.class)
+List<String> findByNameWithRowMapperBean();
 }
 }