DATAJDBC-293 @EnableJdbcRepositories support multi jdbcTemplate

kdlan · kdlan · commit b20ccf00018d · 2018-11-30T13:59:30.000+08:00
diff --git a/src/main/java/org/springframework/data/jdbc/repository/config/EnableJdbcRepositories.java b/src/main/java/org/springframework/data/jdbc/repository/config/EnableJdbcRepositories.java
@@ -97,4 +97,17 @@
 	 * for {@code PersonRepositoryImpl}.
 	 */
 	String repositoryImplementationPostfix() default "Impl";
+
+	/**
+	 * Configures the name of the {@link NamedParameterJdbcOperations} bean definition to be used to create repositories 
+	 * discovered through this annotation. Defaults to {@code namedParameterJdbcTemplate}.
+	 */
+	String jdbcOperationsRef() default "namedParameterJdbcTemplate";
+
+
+	/**
+	 * Configures the name of the {@link DataAccessStrategy} bean definition to be used to create repositories 
+	 * discovered through this annotation. Defaults to {@code defaultDataAccessStrategy} if existed.
+	 */
+	String dataAccessStrategyRef() default "";
 }
diff --git a/src/main/java/org/springframework/data/jdbc/repository/config/JdbcRepositoryConfigExtension.java b/src/main/java/org/springframework/data/jdbc/repository/config/JdbcRepositoryConfigExtension.java
@@ -15,10 +15,21 @@
  */
 package org.springframework.data.jdbc.repository.config;
 
+import java.util.Arrays;
+import java.util.List;
 import java.util.Locale;
+import java.util.Optional;
 
+import org.springframework.beans.factory.ListableBeanFactory;
+import org.springframework.beans.factory.NoUniqueBeanDefinitionException;
+import org.springframework.beans.factory.support.BeanDefinitionBuilder;
+import org.springframework.beans.factory.support.BeanDefinitionRegistry;
+import org.springframework.data.jdbc.core.DataAccessStrategy;
 import org.springframework.data.jdbc.repository.support.JdbcRepositoryFactoryBean;
+import org.springframework.data.repository.config.AnnotationRepositoryConfigurationSource;
 import org.springframework.data.repository.config.RepositoryConfigurationExtensionSupport;
+import org.springframework.data.repository.config.RepositoryConfigurationSource;
+import org.springframework.util.StringUtils;
 
 /**
  * {@link org.springframework.data.repository.config.RepositoryConfigurationExtension} extending the repository
@@ -28,6 +39,10 @@
  */
 public class JdbcRepositoryConfigExtension extends RepositoryConfigurationExtensionSupport {
 
+	private static final String DEFAULT_JDBC_OPERATION_BEAN_NAME = "namedParameterJdbcTemplate";
+
+	
+	private ListableBeanFactory listableBeanFactory;
 	/*
 	* (non-Javadoc)
 	* @see org.springframework.data.repository.config.RepositoryConfigurationExtension#getModuleName()
@@ -36,6 +51,7 @@ public class JdbcRepositoryConfigExtension extends RepositoryConfigurationExtens
 	public String getModuleName() {
 		return "JDBC";
 	}
+	
 
 	/*
 	* (non-Javadoc)
@@ -55,4 +71,42 @@ protected String getModulePrefix() {
 		return getModuleName().toLowerCase(Locale.US);
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.repository.config.RepositoryConfigurationExtension#registerBeansForRoot(org.springframework.beans.factory.support.BeanDefinitionRegistry, org.springframework.data.repository.config.RepositoryConfigurationSource)
+	 */
+	public void registerBeansForRoot(BeanDefinitionRegistry registry,
+			RepositoryConfigurationSource configurationSource) {
+		if (registry instanceof ListableBeanFactory) {
+			this.listableBeanFactory =   (ListableBeanFactory) registry;
+		}
+	}
+
+
+	/* 
+	 * (non-Javadoc)
+	 * @see org.springframework.data.repository.config.RepositoryConfigurationExtensionSupport#postProcess(org.springframework.beans.factory.support.BeanDefinitionBuilder, org.springframework.data.repository.config.RepositoryConfigurationSource)
+	 */
+	@Override
+	public void postProcess(BeanDefinitionBuilder builder, RepositoryConfigurationSource source) {
+
+		Optional<String> jdbcOperationRef = source.getAttribute("jdbcOperationsRef");
+		builder.addPropertyReference("jdbcOperations", jdbcOperationRef.orElse(DEFAULT_JDBC_OPERATION_BEAN_NAME));
+		Optional<String> dataAccessStrategyRef = source.getAttribute("dataAccessStrategyRef").filter(StringUtils::hasText);
+		if (dataAccessStrategyRef.isPresent()) {
+			builder.addPropertyReference("dataAccessStrategy", dataAccessStrategyRef.get());
+		} else if(this.listableBeanFactory != null) {
+			List<String> beanNames=Arrays.asList(listableBeanFactory.getBeanNamesForType(DataAccessStrategy.class));
+
+			if (beanNames.size() > 1) {
+				throw new NoUniqueBeanDefinitionException(DataAccessStrategy.class, beanNames);
+			}
+
+			if (!beanNames.isEmpty()) {
+				builder.addPropertyReference("dataAccessStrategy", beanNames.get(0));
+			}
+
+		}
+	}
+
 }
diff --git a/src/main/java/org/springframework/data/jdbc/repository/support/JdbcRepositoryFactoryBean.java b/src/main/java/org/springframework/data/jdbc/repository/support/JdbcRepositoryFactoryBean.java
@@ -110,7 +110,6 @@ public void setRowMapperMap(RowMapperMap rowMapperMap) {
 		this.rowMapperMap = rowMapperMap;
 	}
 
-	@Autowired
 	public void setJdbcOperations(NamedParameterJdbcOperations operations) {
 		this.operations = operations;
 	}
diff --git a/src/test/java/org/springframework/data/jdbc/mybatis/MyBatisCustomizingNamespaceHsqlIntegrationTests.java b/src/test/java/org/springframework/data/jdbc/mybatis/MyBatisCustomizingNamespaceHsqlIntegrationTests.java
@@ -75,7 +75,7 @@ public void myBatisGetsUsedForInsertAndSelect() {
 
 	@org.springframework.context.annotation.Configuration
 	@Import(TestConfiguration.class)
-	@EnableJdbcRepositories(considerNestedRepositories = true)
+	@EnableJdbcRepositories(considerNestedRepositories = true, dataAccessStrategyRef="myBatisDataAccessStrategy")
 	static class Config {
 
 		@Bean
@@ -104,7 +104,7 @@ SqlSessionTemplate sqlSessionTemplate(SqlSessionFactory factory) {
 			return new SqlSessionTemplate(factory);
 		}
 
-		@Bean
+		@Bean("myBatisDataAccessStrategy")
 		MyBatisDataAccessStrategy dataAccessStrategy(SqlSession sqlSession) {
 
 			MyBatisDataAccessStrategy strategy = new MyBatisDataAccessStrategy(sqlSession);
diff --git a/src/test/java/org/springframework/data/jdbc/mybatis/MyBatisHsqlIntegrationTests.java b/src/test/java/org/springframework/data/jdbc/mybatis/MyBatisHsqlIntegrationTests.java
@@ -58,7 +58,7 @@ public class MyBatisHsqlIntegrationTests {
 
 	@org.springframework.context.annotation.Configuration
 	@Import(TestConfiguration.class)
-	@EnableJdbcRepositories(considerNestedRepositories = true)
+	@EnableJdbcRepositories(considerNestedRepositories = true, dataAccessStrategyRef = "myBatisDataAccessStrategy")
 	static class Config {
 
 		@Bean
@@ -87,7 +87,7 @@ SqlSessionTemplate sqlSessionTemplate(SqlSessionFactory factory) {
 			return new SqlSessionTemplate(factory);
 		}
 
-		@Bean
+		@Bean("myBatisDataAccessStrategy")
 		DataAccessStrategy dataAccessStrategy(RelationalMappingContext context, RelationalConverter converter,
 				SqlSession sqlSession, EmbeddedDatabase db) {
 			return MyBatisDataAccessStrategy.createCombinedAccessStrategy(context, converter,
diff --git a/src/test/java/org/springframework/data/jdbc/repository/config/EnableJdbcRepositoriesIntegrationTests.java b/src/test/java/org/springframework/data/jdbc/repository/config/EnableJdbcRepositoriesIntegrationTests.java
@@ -15,30 +15,40 @@
  */
 package org.springframework.data.jdbc.repository.config;
 
-import static org.assertj.core.api.Assertions.*;
-import static org.mockito.Mockito.*;
-
-import lombok.Data;
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.Mockito.mock;
 
 import java.lang.reflect.Field;
 
+import javax.sql.DataSource;
+
 import org.junit.BeforeClass;
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Qualifier;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.ComponentScan;
 import org.springframework.context.annotation.FilterType;
 import org.springframework.data.annotation.Id;
+import org.springframework.data.jdbc.core.DataAccessStrategy;
+import org.springframework.data.jdbc.core.DefaultDataAccessStrategy;
+import org.springframework.data.jdbc.core.SqlGeneratorSource;
 import org.springframework.data.jdbc.repository.RowMapperMap;
 import org.springframework.data.jdbc.repository.config.EnableJdbcRepositoriesIntegrationTests.TestConfiguration;
 import org.springframework.data.jdbc.repository.support.JdbcRepositoryFactoryBean;
+import org.springframework.data.relational.core.conversion.RelationalConverter;
+import org.springframework.data.relational.core.mapping.RelationalMappingContext;
 import org.springframework.data.repository.CrudRepository;
 import org.springframework.jdbc.core.RowMapper;
+import org.springframework.jdbc.core.namedparam.NamedParameterJdbcOperations;
+import org.springframework.jdbc.core.namedparam.NamedParameterJdbcTemplate;
 import org.springframework.test.context.ContextConfiguration;
 import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
 import org.springframework.util.ReflectionUtils;
 
+import lombok.Data;
+
 /**
  * Tests the {@link EnableJdbcRepositories} annotation.
  *
@@ -50,15 +60,23 @@
 public class EnableJdbcRepositoriesIntegrationTests {
 
 	static final Field ROW_MAPPER_MAP = ReflectionUtils.findField(JdbcRepositoryFactoryBean.class, "rowMapperMap");
+	static final Field OPERATIONS = ReflectionUtils.findField(JdbcRepositoryFactoryBean.class, "operations");
+	static final Field DATA_ACCESS_STRATEGY = ReflectionUtils.findField(JdbcRepositoryFactoryBean.class, "dataAccessStrategy");
 	public static final RowMapper DUMMY_ENTITY_ROW_MAPPER = mock(RowMapper.class);
 	public static final RowMapper STRING_ROW_MAPPER = mock(RowMapper.class);
 
 	@Autowired JdbcRepositoryFactoryBean factoryBean;
 	@Autowired DummyRepository repository;
+	@Autowired @Qualifier("namedParameterJdbcTemplate") NamedParameterJdbcOperations defaultOperations;
+	@Autowired @Qualifier("defaultDataAccessStrategy") DataAccessStrategy defaultDataAccessStrategy;
+	@Autowired @Qualifier("qualifierJdbcOperations") NamedParameterJdbcOperations qualifierJdbcOperations;
+	@Autowired @Qualifier("qualifierDataAccessStrategy") DataAccessStrategy qualifierDataAccessStrategy;
 
 	@BeforeClass
 	public static void setup() {
 		ROW_MAPPER_MAP.setAccessible(true);
+		OPERATIONS.setAccessible(true);
+		DATA_ACCESS_STRATEGY.setAccessible(true);
 	}
 
 	@Test // DATAJDBC-100
@@ -80,6 +98,15 @@ public void customRowMapperConfigurationGetsPickedUp() {
 		assertThat(mapping.rowMapperFor(DummyEntity.class)).isEqualTo(DUMMY_ENTITY_ROW_MAPPER);
 	}
 
+ 	@Test // DATAJDBC-293
+	public void jdbcOperationsRef() {
+		NamedParameterJdbcOperations operations = (NamedParameterJdbcOperations) ReflectionUtils.getField(OPERATIONS, factoryBean);
+		assertThat(operations).isNotSameAs(defaultDataAccessStrategy).isSameAs(qualifierJdbcOperations);
+
+		DataAccessStrategy dataAccessStrategy = (DataAccessStrategy) ReflectionUtils.getField(DATA_ACCESS_STRATEGY, factoryBean);
+		assertThat(dataAccessStrategy).isNotSameAs(defaultDataAccessStrategy).isSameAs(qualifierDataAccessStrategy);
+	}
+
 	interface DummyRepository extends CrudRepository<DummyEntity, Long> {
 
 	}
@@ -90,7 +117,9 @@ static class DummyEntity {
 	}
 
 	@ComponentScan("org.springframework.data.jdbc.testing")
-	@EnableJdbcRepositories(considerNestedRepositories = true, includeFilters = @ComponentScan.Filter(type = FilterType.ASSIGNABLE_TYPE, classes = DummyRepository.class))
+	@EnableJdbcRepositories(considerNestedRepositories = true, 
+			includeFilters = @ComponentScan.Filter(type = FilterType.ASSIGNABLE_TYPE, classes = DummyRepository.class), 
+			jdbcOperationsRef = "qualifierJdbcOperations", dataAccessStrategyRef = "qualifierDataAccessStrategy")
 	static class TestConfiguration {
 
 		@Bean
@@ -105,5 +134,15 @@ RowMapperMap rowMappers() {
 					.register(String.class, STRING_ROW_MAPPER);
 		}
 
+		@Bean("qualifierJdbcOperations")
+		NamedParameterJdbcOperations qualifierJdbcOperations(DataSource dataSource) {
+			return new NamedParameterJdbcTemplate(dataSource);
+		}
+
+		@Bean("qualifierDataAccessStrategy")
+		DataAccessStrategy defaultDataAccessStrategy(@Qualifier("namedParameterJdbcTemplate") NamedParameterJdbcOperations template,
+				RelationalMappingContext context, RelationalConverter converter) {
+			return new DefaultDataAccessStrategy(new SqlGeneratorSource(context), context, converter, template);
+		}
 	}
 }
diff --git a/src/test/java/org/springframework/data/jdbc/testing/TestConfiguration.java b/src/test/java/org/springframework/data/jdbc/testing/TestConfiguration.java
@@ -21,10 +21,12 @@
 
 import org.apache.ibatis.session.SqlSessionFactory;
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Qualifier;
 import org.springframework.context.ApplicationEventPublisher;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.ComponentScan;
 import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Primary;
 import org.springframework.data.convert.CustomConversions;
 import org.springframework.data.jdbc.core.DataAccessStrategy;
 import org.springframework.data.jdbc.core.DefaultDataAccessStrategy;
@@ -56,8 +58,8 @@ public class TestConfiguration {
 	@Autowired(required = false) SqlSessionFactory sqlSessionFactory;
 
 	@Bean
-	JdbcRepositoryFactory jdbcRepositoryFactory(DataAccessStrategy dataAccessStrategy, RelationalMappingContext context,
-			RelationalConverter converter) {
+	JdbcRepositoryFactory jdbcRepositoryFactory(@Qualifier("defaultDataAccessStrategy") DataAccessStrategy dataAccessStrategy, 
+			RelationalMappingContext context, RelationalConverter converter) {
 		return new JdbcRepositoryFactory(dataAccessStrategy, context, converter, publisher, namedParameterJdbcTemplate());
 	}
 
@@ -72,13 +74,13 @@ PlatformTransactionManager transactionManager() {
 	}
 
 	@Bean
-	DataAccessStrategy defaultDataAccessStrategy(RelationalMappingContext context, RelationalConverter converter) {
-		return new DefaultDataAccessStrategy(new SqlGeneratorSource(context), context, converter,
-				namedParameterJdbcTemplate());
+	DataAccessStrategy defaultDataAccessStrategy(@Qualifier("namedParameterJdbcTemplate") NamedParameterJdbcOperations template,
+			RelationalMappingContext context, RelationalConverter converter) {
+		return new DefaultDataAccessStrategy(new SqlGeneratorSource(context), context, converter,template);
 	}
 
 	@Bean
-	RelationalMappingContext jdbcMappingContext(NamedParameterJdbcOperations template,
+	RelationalMappingContext jdbcMappingContext(@Qualifier("namedParameterJdbcTemplate") NamedParameterJdbcOperations template,
 			Optional<NamingStrategy> namingStrategy, CustomConversions conversions) {
 
 		RelationalMappingContext mappingContext = new RelationalMappingContext(

Original file line number	Diff line number	Diff line change
`@@ -110,7 +110,6 @@ public void setRowMapperMap(RowMapperMap rowMapperMap) {`
`110`	`110`	`this.rowMapperMap = rowMapperMap;`
`111`	`111`	`}`
`112`	`112`
`113`		`- @Autowired`
`114`	`113`	`public void setJdbcOperations(NamedParameterJdbcOperations operations) {`
`115`	`114`	`this.operations = operations;`
`116`	`115`	`}`