GH-1006 included QueryMappingConfiguration for all part tree queries

spring-projects · Oct 19, 2024 · 97a625c · 97a625c
1 parent b3040a1
commit 97a625c
Show file tree

Hide file tree

Showing 29 changed files with 222 additions and 40 deletions.
diff --git a/...c/src/main/java/org/springframework/data/jdbc/core/convert/DataAccessStrategyFactory.java b/...c/src/main/java/org/springframework/data/jdbc/core/convert/DataAccessStrategyFactory.java
@@ -25,6 +25,7 @@
  * {@link DataAccessStrategy} for consistent access strategy creation.
  *
  * @author Mark Paluch
+ * @author Mikhail Polivakha
  * @since 3.2
  */
 public class DataAccessStrategyFactory {
@@ -34,6 +35,7 @@ public class DataAccessStrategyFactory {
 	private final NamedParameterJdbcOperations operations;
 	private final SqlParametersFactory sqlParametersFactory;
 	private final InsertStrategyFactory insertStrategyFactory;
+	private final QueryMappingConfiguration queryMappingConfiguration;
 
 	/**
 	 * Creates a new {@link DataAccessStrategyFactory}.
@@ -46,7 +48,7 @@ public class DataAccessStrategyFactory {
 	 */
 	public DataAccessStrategyFactory(SqlGeneratorSource sqlGeneratorSource, JdbcConverter converter,
 			NamedParameterJdbcOperations operations, SqlParametersFactory sqlParametersFactory,
-			InsertStrategyFactory insertStrategyFactory) {
+			InsertStrategyFactory insertStrategyFactory, QueryMappingConfiguration queryMappingConfiguration) {
 
 		Assert.notNull(sqlGeneratorSource, "SqlGeneratorSource must not be null");
 		Assert.notNull(converter, "JdbcConverter must not be null");
@@ -59,6 +61,7 @@ public DataAccessStrategyFactory(SqlGeneratorSource sqlGeneratorSource, JdbcConv
 		this.operations = operations;
 		this.sqlParametersFactory = sqlParametersFactory;
 		this.insertStrategyFactory = insertStrategyFactory;
+		this.queryMappingConfiguration = queryMappingConfiguration;
 	}
 
 	/**
@@ -70,7 +73,7 @@ public DataAccessStrategy create() {
 
 		DefaultDataAccessStrategy defaultDataAccessStrategy = new DefaultDataAccessStrategy(sqlGeneratorSource,
 				this.converter.getMappingContext(), this.converter, this.operations, sqlParametersFactory,
-				insertStrategyFactory);
+				insertStrategyFactory, queryMappingConfiguration);
 
 		if (this.converter.getMappingContext().isSingleQueryLoadingEnabled()) {
 			return new SingleQueryFallbackDataAccessStrategy(sqlGeneratorSource, converter, operations,

diff --git a/...c/src/main/java/org/springframework/data/jdbc/core/convert/DefaultDataAccessStrategy.java b/...c/src/main/java/org/springframework/data/jdbc/core/convert/DefaultDataAccessStrategy.java
@@ -60,6 +60,7 @@
  * @author Radim Tlusty
  * @author Chirag Tailor
  * @author Diego Krupitza
+ * @author Mikhail Polivakha
  * @since 1.1
  */
 public class DefaultDataAccessStrategy implements DataAccessStrategy {
@@ -71,6 +72,8 @@ public class DefaultDataAccessStrategy implements DataAccessStrategy {
 	private final SqlParametersFactory sqlParametersFactory;
 	private final InsertStrategyFactory insertStrategyFactory;
 
+	private final QueryMappingConfiguration queryMappingConfiguration;
+
 	/**
 	 * Creates a {@link DefaultDataAccessStrategy}
 	 *
@@ -82,21 +85,23 @@ public class DefaultDataAccessStrategy implements DataAccessStrategy {
 	 */
 	public DefaultDataAccessStrategy(SqlGeneratorSource sqlGeneratorSource, RelationalMappingContext context,
 			JdbcConverter converter, NamedParameterJdbcOperations operations, SqlParametersFactory sqlParametersFactory,
-			InsertStrategyFactory insertStrategyFactory) {
+			InsertStrategyFactory insertStrategyFactory, QueryMappingConfiguration queryMappingConfiguration) {
 
 		Assert.notNull(sqlGeneratorSource, "SqlGeneratorSource must not be null");
 		Assert.notNull(context, "RelationalMappingContext must not be null");
 		Assert.notNull(converter, "JdbcConverter must not be null");
 		Assert.notNull(operations, "NamedParameterJdbcOperations must not be null");
 		Assert.notNull(sqlParametersFactory, "SqlParametersFactory must not be null");
 		Assert.notNull(insertStrategyFactory, "InsertStrategyFactory must not be null");
+		Assert.notNull(queryMappingConfiguration, "InsertStrategyFactory must not be null");
 
 		this.sqlGeneratorSource = sqlGeneratorSource;
 		this.context = context;
 		this.converter = converter;
 		this.operations = operations;
 		this.sqlParametersFactory = sqlParametersFactory;
 		this.insertStrategyFactory = insertStrategyFactory;
+		this.queryMappingConfiguration = queryMappingConfiguration;
 	}
 
 	@Override
@@ -265,15 +270,15 @@ public <T> T findById(Object id, Class<T> domainType) {
 		SqlIdentifierParameterSource parameter = sqlParametersFactory.forQueryById(id, domainType, ID_SQL_PARAMETER);
 
 		try {
-			return operations.queryForObject(findOneSql, parameter, getEntityRowMapper(domainType));
+			return operations.queryForObject(findOneSql, parameter, getRowMapper(domainType));
 		} catch (EmptyResultDataAccessException e) {
 			return null;
 		}
 	}
 
 	@Override
 	public <T> List<T> findAll(Class<T> domainType) {
-		return operations.query(sql(domainType).getFindAll(), getEntityRowMapper(domainType));
+		return operations.query(sql(domainType).getFindAll(), getRowMapper(domainType));
 	}
 
 	@Override
@@ -285,7 +290,7 @@ public <T> List<T> findAllById(Iterable<?> ids, Class<T> domainType) {
 
 		SqlParameterSource parameterSource = sqlParametersFactory.forQueryByIds(ids, domainType);
 		String findAllInListSql = sql(domainType).getFindAllInList();
-		return operations.query(findAllInListSql, parameterSource, getEntityRowMapper(domainType));
+		return operations.query(findAllInListSql, parameterSource, getRowMapper(domainType));
 	}
 
 	@Override
@@ -339,12 +344,12 @@ public <T> boolean existsById(Object id, Class<T> domainType) {
 
 	@Override
 	public <T> List<T> findAll(Class<T> domainType, Sort sort) {
-		return operations.query(sql(domainType).getFindAll(sort), getEntityRowMapper(domainType));
+		return operations.query(sql(domainType).getFindAll(sort), getRowMapper(domainType));
 	}
 
 	@Override
 	public <T> List<T> findAll(Class<T> domainType, Pageable pageable) {
-		return operations.query(sql(domainType).getFindAll(pageable), getEntityRowMapper(domainType));
+		return operations.query(sql(domainType).getFindAll(pageable), getRowMapper(domainType));
 	}
 
 	@Override
@@ -354,7 +359,7 @@ public <T> Optional<T> findOne(Query query, Class<T> domainType) {
 		String sqlQuery = sql(domainType).selectByQuery(query, parameterSource);
 
 		try {
-			return Optional.ofNullable(operations.queryForObject(sqlQuery, parameterSource, getEntityRowMapper(domainType)));
+			return Optional.ofNullable(operations.queryForObject(sqlQuery, parameterSource, getRowMapper(domainType)));
 		} catch (EmptyResultDataAccessException e) {
 			return Optional.empty();
 		}
@@ -366,7 +371,7 @@ public <T> List<T> findAll(Query query, Class<T> domainType) {
 		MapSqlParameterSource parameterSource = new MapSqlParameterSource();
 		String sqlQuery = sql(domainType).selectByQuery(query, parameterSource);
 
-		return operations.query(sqlQuery, parameterSource, getEntityRowMapper(domainType));
+		return operations.query(sqlQuery, parameterSource, getRowMapper(domainType));
 	}
 
 	@Override
@@ -375,7 +380,7 @@ public <T> List<T> findAll(Query query, Class<T> domainType, Pageable pageable)
 		MapSqlParameterSource parameterSource = new MapSqlParameterSource();
 		String sqlQuery = sql(domainType).selectByQuery(query, parameterSource, pageable);
 
-		return operations.query(sqlQuery, parameterSource, getEntityRowMapper(domainType));
+		return operations.query(sqlQuery, parameterSource, getRowMapper(domainType));
 	}
 
 	@Override
@@ -404,7 +409,13 @@ public <T> long count(Query query, Class<T> domainType) {
 		return result;
 	}
 
-	private <T> EntityRowMapper<T> getEntityRowMapper(Class<T> domainType) {
+	private <T> RowMapper<? extends T> getRowMapper(Class<T> domainType) {
+		RowMapper<? extends T> targetRowMapper;
+
+		if ((targetRowMapper = queryMappingConfiguration.getRowMapper(domainType)) != null) {
+			return targetRowMapper;
+		}
+
 		return new EntityRowMapper<>(getRequiredPersistentEntity(domainType), converter);
 	}
 

diff --git a/...repository/QueryMappingConfiguration.java → ...re/convert/QueryMappingConfiguration.java b/...repository/QueryMappingConfiguration.java → ...re/convert/QueryMappingConfiguration.java
@@ -1,4 +1,4 @@
-package org.springframework.data.jdbc.repository;
+package org.springframework.data.jdbc.core.convert;
 
 import org.springframework.jdbc.core.RowMapper;
 import org.springframework.lang.Nullable;

diff --git a/...a-jdbc/src/main/java/org/springframework/data/jdbc/mybatis/MyBatisDataAccessStrategy.java b/...a-jdbc/src/main/java/org/springframework/data/jdbc/mybatis/MyBatisDataAccessStrategy.java
@@ -29,6 +29,7 @@
 import org.springframework.data.domain.Pageable;
 import org.springframework.data.domain.Sort;
 import org.springframework.data.jdbc.core.convert.*;
+import org.springframework.data.jdbc.core.convert.QueryMappingConfiguration;
 import org.springframework.data.mapping.PersistentPropertyPath;
 import org.springframework.data.mapping.PropertyPath;
 import org.springframework.data.relational.core.conversion.IdValueSource;
@@ -72,9 +73,10 @@ public class MyBatisDataAccessStrategy implements DataAccessStrategy {
 	 * uses a {@link DefaultDataAccessStrategy}
 	 */
 	public static DataAccessStrategy createCombinedAccessStrategy(RelationalMappingContext context,
-			JdbcConverter converter, NamedParameterJdbcOperations operations, SqlSession sqlSession, Dialect dialect) {
+			JdbcConverter converter, NamedParameterJdbcOperations operations, SqlSession sqlSession,
+			Dialect dialect, QueryMappingConfiguration queryMappingConfiguration) {
 		return createCombinedAccessStrategy(context, converter, operations, sqlSession, NamespaceStrategy.DEFAULT_INSTANCE,
-				dialect);
+				dialect, queryMappingConfiguration);
 	}
 
 	/**
@@ -83,7 +85,7 @@ public static DataAccessStrategy createCombinedAccessStrategy(RelationalMappingC
 	 */
 	public static DataAccessStrategy createCombinedAccessStrategy(RelationalMappingContext context,
 			JdbcConverter converter, NamedParameterJdbcOperations operations, SqlSession sqlSession,
-			NamespaceStrategy namespaceStrategy, Dialect dialect) {
+			NamespaceStrategy namespaceStrategy, Dialect dialect, QueryMappingConfiguration queryMappingConfiguration) {
 
 		SqlGeneratorSource sqlGeneratorSource = new SqlGeneratorSource(context, converter, dialect);
 		SqlParametersFactory sqlParametersFactory = new SqlParametersFactory(context, converter);
@@ -94,7 +96,8 @@ public static DataAccessStrategy createCombinedAccessStrategy(RelationalMappingC
 				converter, //
 				operations, //
 				sqlParametersFactory, //
-				insertStrategyFactory //
+				insertStrategyFactory, //
+				queryMappingConfiguration //
 		).create();
 
 		// the DefaultDataAccessStrategy needs a reference to the returned DataAccessStrategy. This creates a dependency

diff --git a/.../main/java/org/springframework/data/jdbc/repository/config/AbstractJdbcConfiguration.java b/.../main/java/org/springframework/data/jdbc/repository/config/AbstractJdbcConfiguration.java
@@ -40,6 +40,7 @@
 import org.springframework.data.jdbc.core.dialect.JdbcDialect;
 import org.springframework.data.jdbc.core.mapping.JdbcMappingContext;
 import org.springframework.data.jdbc.core.mapping.JdbcSimpleTypes;
+import org.springframework.data.jdbc.core.convert.QueryMappingConfiguration;
 import org.springframework.data.mapping.model.SimpleTypeHolder;
 import org.springframework.data.relational.RelationalManagedTypes;
 import org.springframework.data.relational.core.conversion.RelationalConverter;
@@ -61,6 +62,7 @@
  * @author Christoph Strobl
  * @author Myeonghyeon Lee
  * @author Chirag Tailor
+ * @author Mikhail Polivakha
  * @since 1.1
  */
 @Configuration(proxyBeanMethods = false)
@@ -70,6 +72,8 @@ public class AbstractJdbcConfiguration implements ApplicationContextAware {
 
 	private ApplicationContext applicationContext;
 
+	private QueryMappingConfiguration queryMappingConfiguration;
+
 	/**
 	 * Returns the base packages to scan for JDBC mapped entities at startup. Returns the package name of the
 	 * configuration class' (the concrete class, not this one here) by default. So if you have a
@@ -208,7 +212,9 @@ public DataAccessStrategy dataAccessStrategyBean(NamedParameterJdbcOperations op
 		SqlGeneratorSource sqlGeneratorSource = new SqlGeneratorSource(context, jdbcConverter, dialect);
 		DataAccessStrategyFactory factory = new DataAccessStrategyFactory(sqlGeneratorSource, jdbcConverter, operations,
 				new SqlParametersFactory(context, jdbcConverter),
-				new InsertStrategyFactory(operations, dialect));
+				new InsertStrategyFactory(operations, dialect),
+				this.queryMappingConfiguration
+		);
 
 		return factory.create();
 	}
@@ -232,6 +238,10 @@ public void setApplicationContext(ApplicationContext applicationContext) throws
 		this.applicationContext = applicationContext;
 	}
 
+	public void setQueryMappingConfiguration(Optional<QueryMappingConfiguration> queryMappingConfiguration) throws BeansException {
+		this.queryMappingConfiguration = queryMappingConfiguration.orElse(QueryMappingConfiguration.EMPTY);
+	}
+
 	/**
 	 * Scans the mapping base package for classes annotated with {@link Table}. By default, it scans for entities in all
 	 * packages returned by {@link #getMappingBasePackages()}.

diff --git a/...ava/org/springframework/data/jdbc/repository/config/DefaultQueryMappingConfiguration.java b/...ava/org/springframework/data/jdbc/repository/config/DefaultQueryMappingConfiguration.java
@@ -3,7 +3,7 @@
 import java.util.LinkedHashMap;
 import java.util.Map;
 
-import org.springframework.data.jdbc.repository.QueryMappingConfiguration;
+import org.springframework.data.jdbc.core.convert.QueryMappingConfiguration;
 import org.springframework.jdbc.core.ResultSetExtractor;
 import org.springframework.jdbc.core.RowMapper;
 import org.springframework.lang.Nullable;

diff --git a/...c/main/java/org/springframework/data/jdbc/repository/config/MyBatisJdbcConfiguration.java b/...c/main/java/org/springframework/data/jdbc/repository/config/MyBatisJdbcConfiguration.java
@@ -15,6 +15,8 @@
  */
 package org.springframework.data.jdbc.repository.config;
 
+import java.util.Optional;
+
 import org.apache.ibatis.session.SqlSession;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.context.annotation.Bean;
@@ -23,25 +25,29 @@
 import org.springframework.data.jdbc.core.convert.JdbcConverter;
 import org.springframework.data.jdbc.core.mapping.JdbcMappingContext;
 import org.springframework.data.jdbc.mybatis.MyBatisDataAccessStrategy;
+import org.springframework.data.jdbc.core.convert.QueryMappingConfiguration;
 import org.springframework.data.relational.core.dialect.Dialect;
 import org.springframework.jdbc.core.namedparam.NamedParameterJdbcOperations;
 
 /**
  * Configuration class tweaking Spring Data JDBC to use a {@link MyBatisDataAccessStrategy} instead of the default one.
  *
  * @author Oliver Drotbohm
+ * @author Mikhail Polivakha
  * @since 1.1
  */
 @Configuration(proxyBeanMethods = false)
 public class MyBatisJdbcConfiguration extends AbstractJdbcConfiguration {
 
 	private @Autowired SqlSession session;
 
+	private @Autowired Optional<QueryMappingConfiguration> queryMappingConfiguration;
+
 	@Bean
 	@Override
 	public DataAccessStrategy dataAccessStrategyBean(NamedParameterJdbcOperations operations, JdbcConverter jdbcConverter,
 			JdbcMappingContext context, Dialect dialect) {
 
-		return MyBatisDataAccessStrategy.createCombinedAccessStrategy(context, jdbcConverter, operations, session, dialect);
+		return MyBatisDataAccessStrategy.createCombinedAccessStrategy(context, jdbcConverter, operations, session, dialect, queryMappingConfiguration.orElse(QueryMappingConfiguration.EMPTY));
 	}
 }
diff --git a/...c/main/java/org/springframework/data/jdbc/repository/support/JdbcQueryLookupStrategy.java b/...c/main/java/org/springframework/data/jdbc/repository/support/JdbcQueryLookupStrategy.java
@@ -25,7 +25,7 @@
 import org.springframework.context.ApplicationEventPublisher;
 import org.springframework.data.jdbc.core.convert.EntityRowMapper;
 import org.springframework.data.jdbc.core.convert.JdbcConverter;
-import org.springframework.data.jdbc.repository.QueryMappingConfiguration;
+import org.springframework.data.jdbc.core.convert.QueryMappingConfiguration;
 import org.springframework.data.jdbc.repository.query.AbstractJdbcQuery;
 import org.springframework.data.jdbc.repository.query.JdbcQueryMethod;
 import org.springframework.data.jdbc.repository.query.PartTreeJdbcQuery;

diff --git a/...src/main/java/org/springframework/data/jdbc/repository/support/JdbcRepositoryFactory.java b/...src/main/java/org/springframework/data/jdbc/repository/support/JdbcRepositoryFactory.java
@@ -22,7 +22,7 @@
 import org.springframework.data.jdbc.core.JdbcAggregateTemplate;
 import org.springframework.data.jdbc.core.convert.DataAccessStrategy;
 import org.springframework.data.jdbc.core.convert.JdbcConverter;
-import org.springframework.data.jdbc.repository.QueryMappingConfiguration;
+import org.springframework.data.jdbc.core.convert.QueryMappingConfiguration;
 import org.springframework.data.mapping.callback.EntityCallbacks;
 import org.springframework.data.relational.core.dialect.Dialect;
 import org.springframework.data.relational.core.mapping.RelationalMappingContext;

diff --git a/...main/java/org/springframework/data/jdbc/repository/support/JdbcRepositoryFactoryBean.java b/...main/java/org/springframework/data/jdbc/repository/support/JdbcRepositoryFactoryBean.java
@@ -27,7 +27,7 @@
 import org.springframework.data.jdbc.core.convert.JdbcConverter;
 import org.springframework.data.jdbc.core.convert.SqlGeneratorSource;
 import org.springframework.data.jdbc.core.convert.SqlParametersFactory;
-import org.springframework.data.jdbc.repository.QueryMappingConfiguration;
+import org.springframework.data.jdbc.core.convert.QueryMappingConfiguration;
 import org.springframework.data.mapping.callback.EntityCallbacks;
 import org.springframework.data.relational.core.dialect.Dialect;
 import org.springframework.data.relational.core.mapping.RelationalMappingContext;
@@ -48,6 +48,7 @@
  * @author Mark Paluch
  * @author Hebert Coelho
  * @author Chirag Tailor
+ * @author Mikhail Polivakha
  */
 public class JdbcRepositoryFactoryBean<T extends Repository<S, ID>, S, ID extends Serializable>
 		extends TransactionalRepositoryFactoryBeanSupport<T, S, ID> implements ApplicationEventPublisherAware {
@@ -166,6 +167,10 @@ public void afterPropertiesSet() {
 			this.operations = beanFactory.getBean(NamedParameterJdbcOperations.class);
 		}
 
+		if (this.queryMappingConfiguration == null) {
+			this.queryMappingConfiguration = QueryMappingConfiguration.EMPTY;
+		}
+
 		if (this.dataAccessStrategy == null) {
 
 			Assert.state(beanFactory != null, "If no DataAccessStrategy is set a BeanFactory must be available");
@@ -181,16 +186,12 @@ public void afterPropertiesSet() {
 						InsertStrategyFactory insertStrategyFactory = new InsertStrategyFactory(this.operations, this.dialect);
 
 						DataAccessStrategyFactory factory = new DataAccessStrategyFactory(sqlGeneratorSource, this.converter,
-								this.operations, sqlParametersFactory, insertStrategyFactory);
+								this.operations, sqlParametersFactory, insertStrategyFactory, queryMappingConfiguration);
 
 						return factory.create();
 					});
 		}
 
-		if (this.queryMappingConfiguration == null) {
-			this.queryMappingConfiguration = QueryMappingConfiguration.EMPTY;
-		}
-
 		if (beanFactory != null) {
 			entityCallbacks = EntityCallbacks.create(beanFactory);
 		}

diff --git a/spring-data-jdbc/src/test/java/org/springframework/data/jdbc/DependencyTests.java b/spring-data-jdbc/src/test/java/org/springframework/data/jdbc/DependencyTests.java
@@ -62,7 +62,7 @@ void acrossModules() {
 						"org.springframework.data.jdbc", // Spring Data Relational
 						"org.springframework.data.relational", // Spring Data Relational
 						"org.springframework.data" // Spring Data Commons
-				).that(onlySpringData()) //
+				)
 				.that(ignore(AuditingHandlerBeanDefinitionParser.class)) //
 				.that(ignorePackage("org.springframework.data.aot.hint")) // ignoring aot, since it causes cycles in commons
 				.that(ignorePackage("org.springframework.data.aot")); // ignoring aot, since it causes cycles in commons