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

Polishing.

Browse Source 
Refactor JdbcLookupStrategy to not generally require BeanFactory. Reintroduce deprecated setBeanFactory(…) method.

See #1872
Original pull request: #1874
This commit is contained in:
Mark Paluch
2024-09-12 14:44:11 +02:00
parent d2bb64f4ca
commit 033ac1f95a
4 changed files with 50 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
spring-data-jdbc/src/main/java/org/springframework/data/jdbc/repository/query/AbstractJdbcQuery.java
View File

@@ -23,7 +23,6 @@ import java.util.stream.Stream;
import org.springframework.core.convert.converter.Converter;
import org.springframework.dao.EmptyResultDataAccessException;
import org.springframework.data.jdbc.core.convert.JdbcArrayColumns;
import org.springframework.data.repository.query.RepositoryQuery;
import org.springframework.data.repository.query.ResultProcessor;
import org.springframework.data.repository.query.ReturnedType;
@@ -171,8 +170,8 @@ public abstract class AbstractJdbcQuery implements RepositoryQuery {
* @param reference must not be {@code null}.
* @since 3.4
*/
default RowMapper<Object> rowMapperByReference(String reference) {
throw new UnsupportedOperationException("rowMapperByReference is not supported");
default RowMapper<Object> getRowMapper(String reference) {
throw new UnsupportedOperationException("getRowMapper is not supported");
}
/**
@@ -181,8 +180,8 @@ public abstract class AbstractJdbcQuery implements RepositoryQuery {
* @param reference must not be {@code null}.
* @since 3.4
*/
default ResultSetExtractor<Object> resultSetExtractorByReference(String reference) {
throw new UnsupportedOperationException("resultSetExtractorByReference is not supported");
default ResultSetExtractor<Object> getResultSetExtractor(String reference) {
throw new UnsupportedOperationException("getResultSetExtractor is not supported");
}
}

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

@@ -352,6 +352,9 @@ public class StringBasedJdbcQuery extends AbstractJdbcQuery {
return configuredClass == null || configuredClass == defaultClass;
}
@Deprecated(since = "3.4")
public void setBeanFactory(BeanFactory beanFactory) {}
class CachedRowMapperFactory {
private final Lazy<RowMapper<Object>> cachedRowMapper;
@@ -375,7 +378,7 @@ public class StringBasedJdbcQuery extends AbstractJdbcQuery {
this.cachedRowMapper = Lazy.of(() -> {
if (!ObjectUtils.isEmpty(rowMapperRef)) {
return rowMapperFactory.rowMapperByReference(rowMapperRef);
return rowMapperFactory.getRowMapper(rowMapperRef);
}
if (isUnconfigured(rowMapperClass, RowMapper.class)) {
@@ -426,7 +429,7 @@ public class StringBasedJdbcQuery extends AbstractJdbcQuery {
this.resultSetExtractorFactory = rowMapper -> {
if (!ObjectUtils.isEmpty(resultSetExtractorRef)) {
return rowMapperFactory.resultSetExtractorByReference(resultSetExtractorRef);
return rowMapperFactory.getResultSetExtractor(resultSetExtractorRef);
}
if (isUnconfigured(resultSetExtractorClass, ResultSetExtractor.class)) {

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

@@ -73,13 +73,12 @@ abstract class JdbcQueryLookupStrategy extends RelationalQueryLookupStrategy {
private final JdbcConverter converter;
private final QueryMappingConfiguration queryMappingConfiguration;
private final NamedParameterJdbcOperations operations;
@Nullable private final BeanFactory beanfactory;
protected final QueryMethodEvaluationContextProvider evaluationContextProvider;
JdbcQueryLookupStrategy(ApplicationEventPublisher publisher, @Nullable EntityCallbacks callbacks,
RelationalMappingContext context, JdbcConverter converter, Dialect dialect,
QueryMappingConfiguration queryMappingConfiguration, NamedParameterJdbcOperations operations,
@Nullable BeanFactory beanfactory, QueryMethodEvaluationContextProvider evaluationContextProvider) {
QueryMethodEvaluationContextProvider evaluationContextProvider) {
super(context, dialect);
@@ -87,7 +86,7 @@ abstract class JdbcQueryLookupStrategy extends RelationalQueryLookupStrategy {
Assert.notNull(converter, "JdbcConverter must not be null");
Assert.notNull(queryMappingConfiguration, "QueryMappingConfiguration must not be null");
Assert.notNull(operations, "NamedParameterJdbcOperations must not be null");
Assert.notNull(evaluationContextProvider, "QueryMethodEvaluationContextProvier must not be null");
Assert.notNull(evaluationContextProvider, "QueryMethodEvaluationContextProvider must not be null");
this.context = context;
this.publisher = publisher;
@@ -95,7 +94,6 @@ abstract class JdbcQueryLookupStrategy extends RelationalQueryLookupStrategy {
this.converter = converter;
this.queryMappingConfiguration = queryMappingConfiguration;
this.operations = operations;
this.beanfactory = beanfactory;
this.evaluationContextProvider = evaluationContextProvider;
}
@@ -114,9 +112,9 @@ abstract class JdbcQueryLookupStrategy extends RelationalQueryLookupStrategy {
CreateQueryLookupStrategy(ApplicationEventPublisher publisher, @Nullable EntityCallbacks callbacks,
RelationalMappingContext context, JdbcConverter converter, Dialect dialect,
QueryMappingConfiguration queryMappingConfiguration, NamedParameterJdbcOperations operations,
@Nullable BeanFactory beanfactory, QueryMethodEvaluationContextProvider evaluationContextProvider) {
QueryMethodEvaluationContextProvider evaluationContextProvider) {
super(publisher, callbacks, context, converter, dialect, queryMappingConfiguration, operations, beanfactory,
super(publisher, callbacks, context, converter, dialect, queryMappingConfiguration, operations,
evaluationContextProvider);
}
@@ -140,12 +138,16 @@ abstract class JdbcQueryLookupStrategy extends RelationalQueryLookupStrategy {
*/
static class DeclaredQueryLookupStrategy extends JdbcQueryLookupStrategy {
private final AbstractJdbcQuery.RowMapperFactory rowMapperFactory;
DeclaredQueryLookupStrategy(ApplicationEventPublisher publisher, @Nullable EntityCallbacks callbacks,
RelationalMappingContext context, JdbcConverter converter, Dialect dialect,
QueryMappingConfiguration queryMappingConfiguration, NamedParameterJdbcOperations operations,
@Nullable BeanFactory beanfactory, QueryMethodEvaluationContextProvider evaluationContextProvider) {
super(publisher, callbacks, context, converter, dialect, queryMappingConfiguration, operations, beanfactory,
super(publisher, callbacks, context, converter, dialect, queryMappingConfiguration, operations,
evaluationContextProvider);
this.rowMapperFactory = new BeanFactoryRowMapperFactory(beanfactory);
}
@Override
@@ -163,36 +165,51 @@ abstract class JdbcQueryLookupStrategy extends RelationalQueryLookupStrategy {
String queryString = evaluateTableExpressions(repositoryMetadata, queryMethod.getRequiredQuery());
return new StringBasedJdbcQuery(queryString, queryMethod, getOperations(),
new BeanFactoryRowMapperFactory(getBeanFactory()), getConverter(), evaluationContextProvider);
return new StringBasedJdbcQuery(queryString, queryMethod, getOperations(), rowMapperFactory, getConverter(),
evaluationContextProvider);
}
throw new IllegalStateException(
String.format("Did neither find a NamedQuery nor an annotated query for method %s", method));
}
@SuppressWarnings("unchecked")
private class BeanFactoryRowMapperFactory implements AbstractJdbcQuery.RowMapperFactory {
private final BeanFactory beanFactory;
private final @Nullable BeanFactory beanFactory;
BeanFactoryRowMapperFactory(BeanFactory beanFactory) {
BeanFactoryRowMapperFactory(@Nullable BeanFactory beanFactory) {
this.beanFactory = beanFactory;
}
@Override
public RowMapper<Object> create(Class<?> result) {
return createMapper(result);
}
@Override
public RowMapper<Object> rowMapperByReference(String reference) {
public RowMapper<Object> getRowMapper(String reference) {
if (beanFactory == null) {
throw new IllegalStateException(
"Cannot resolve RowMapper bean reference '" + reference + "'; BeanFactory is not configured.");
}
return beanFactory.getBean(reference, RowMapper.class);
}
@Override
public ResultSetExtractor<Object> resultSetExtractorByReference(String reference) {
public ResultSetExtractor<Object> getResultSetExtractor(String reference) {
if (beanFactory == null) {
throw new IllegalStateException(
"Cannot resolve ResultSetExtractor bean reference '" + reference + "'; BeanFactory is not configured.");
}
return beanFactory.getBean(reference, ResultSetExtractor.class);
}
}
}
/**
@@ -217,10 +234,10 @@ abstract class JdbcQueryLookupStrategy extends RelationalQueryLookupStrategy {
CreateIfNotFoundQueryLookupStrategy(ApplicationEventPublisher publisher, @Nullable EntityCallbacks callbacks,
RelationalMappingContext context, JdbcConverter converter, Dialect dialect,
QueryMappingConfiguration queryMappingConfiguration, NamedParameterJdbcOperations operations,
@Nullable BeanFactory beanfactory, CreateQueryLookupStrategy createStrategy,
CreateQueryLookupStrategy createStrategy,
DeclaredQueryLookupStrategy lookupStrategy, QueryMethodEvaluationContextProvider evaluationContextProvider) {
super(publisher, callbacks, context, converter, dialect, queryMappingConfiguration, operations, beanfactory,
super(publisher, callbacks, context, converter, dialect, queryMappingConfiguration, operations,
evaluationContextProvider);
Assert.notNull(createStrategy, "CreateQueryLookupStrategy must not be null");
@@ -277,23 +294,23 @@ abstract class JdbcQueryLookupStrategy extends RelationalQueryLookupStrategy {
Assert.notNull(operations, "NamedParameterJdbcOperations must not be null");
CreateQueryLookupStrategy createQueryLookupStrategy = new CreateQueryLookupStrategy(publisher, callbacks, context,
converter, dialect, queryMappingConfiguration, operations, beanFactory, evaluationContextProvider);
converter, dialect, queryMappingConfiguration, operations, evaluationContextProvider);
DeclaredQueryLookupStrategy declaredQueryLookupStrategy = new DeclaredQueryLookupStrategy(publisher, callbacks,
context, converter, dialect, queryMappingConfiguration, operations, beanFactory, evaluationContextProvider);
Key cleanedKey = key != null ? key : Key.CREATE_IF_NOT_FOUND;
Key keyToUse = key != null ? key : Key.CREATE_IF_NOT_FOUND;
LOG.debug(String.format("Using the queryLookupStrategy %s", cleanedKey));
LOG.debug(String.format("Using the queryLookupStrategy %s", keyToUse));
switch (cleanedKey) {
switch (keyToUse) {
case CREATE:
return createQueryLookupStrategy;
case USE_DECLARED_QUERY:
return declaredQueryLookupStrategy;
case CREATE_IF_NOT_FOUND:
return new CreateIfNotFoundQueryLookupStrategy(publisher, callbacks, context, converter, dialect,
queryMappingConfiguration, operations, beanFactory, createQueryLookupStrategy, declaredQueryLookupStrategy,
queryMappingConfiguration, operations, createQueryLookupStrategy, declaredQueryLookupStrategy,
evaluationContextProvider);
default:
throw new IllegalArgumentException(String.format("Unsupported query lookup strategy %s", key));
@@ -308,11 +325,6 @@ abstract class JdbcQueryLookupStrategy extends RelationalQueryLookupStrategy {
return operations;
}
@Nullable
BeanFactory getBeanFactory() {
return beanfactory;
}
@SuppressWarnings("unchecked")
RowMapper<Object> createMapper(Class<?> returnedObjectType) {

8
spring-data-jdbc/src/test/java/org/springframework/data/jdbc/repository/query/StringBasedJdbcQueryUnitTests.java
View File

@@ -645,21 +645,21 @@ class StringBasedJdbcQueryUnitTests {
}
@Override
public RowMapper<Object> rowMapperByReference(String reference) {
public RowMapper<Object> getRowMapper(String reference) {
if (preparedReference.equals(reference)) {
return (RowMapper<Object>) value;
}
return AbstractJdbcQuery.RowMapperFactory.super.rowMapperByReference(reference);
return AbstractJdbcQuery.RowMapperFactory.super.getRowMapper(reference);
}
@Override
public ResultSetExtractor<Object> resultSetExtractorByReference(String reference) {
public ResultSetExtractor<Object> getResultSetExtractor(String reference) {
if (preparedReference.equals(reference)) {
return (ResultSetExtractor<Object>) value;
}
return AbstractJdbcQuery.RowMapperFactory.super.resultSetExtractorByReference(reference);
return AbstractJdbcQuery.RowMapperFactory.super.getResultSetExtractor(reference);
}
}
}