-
Notifications
You must be signed in to change notification settings - Fork 40.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add JdbcTemplate only on single DataSource
Update auto-configuration logic so that a `JdbcTemplate` is only added when there is a single candidate DataSource bean. Closes gh-6449
- Loading branch information
1 parent
e0adacb
commit 5ecb68b
Showing
6 changed files
with
235 additions
and
61 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
67 changes: 67 additions & 0 deletions
67
.../main/java/org/springframework/boot/autoconfigure/jdbc/JdbcTemplateAutoConfiguration.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| /* | ||
| * Copyright 2012-2016 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 | ||
| * | ||
| * http://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.boot.autoconfigure.jdbc; | ||
|
|
||
| import javax.sql.DataSource; | ||
|
|
||
| import org.springframework.boot.autoconfigure.AutoConfigureAfter; | ||
| import org.springframework.boot.autoconfigure.EnableAutoConfiguration; | ||
| import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; | ||
| import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; | ||
| import org.springframework.boot.autoconfigure.condition.ConditionalOnSingleCandidate; | ||
| import org.springframework.context.annotation.Bean; | ||
| import org.springframework.context.annotation.Configuration; | ||
| import org.springframework.jdbc.core.JdbcOperations; | ||
| import org.springframework.jdbc.core.JdbcTemplate; | ||
| import org.springframework.jdbc.core.namedparam.NamedParameterJdbcOperations; | ||
| import org.springframework.jdbc.core.namedparam.NamedParameterJdbcTemplate; | ||
|
|
||
| /** | ||
| * {@link EnableAutoConfiguration Auto-configuration} for {@link JdbcTemplate} and | ||
| * {@link NamedParameterJdbcTemplate}. | ||
| * | ||
| * @author Dave Syer | ||
| * @author Phillip Webb | ||
| * @author Stephane Nicoll | ||
| * @author Kazuki Shimizu | ||
| * @since 1.4.0 | ||
| */ | ||
| @Configuration | ||
| @ConditionalOnClass(DataSource.class) | ||
| @ConditionalOnSingleCandidate(DataSource.class) | ||
| @AutoConfigureAfter(DataSourceAutoConfiguration.class) | ||
| public class JdbcTemplateAutoConfiguration { | ||
|
|
||
| private final DataSource dataSource; | ||
|
|
||
| public JdbcTemplateAutoConfiguration(DataSource dataSource) { | ||
| this.dataSource = dataSource; | ||
| } | ||
|
|
||
| @Bean | ||
| @ConditionalOnMissingBean(JdbcOperations.class) | ||
| public JdbcTemplate jdbcTemplate() { | ||
| return new JdbcTemplate(this.dataSource); | ||
| } | ||
|
|
||
| @Bean | ||
| @ConditionalOnMissingBean(NamedParameterJdbcOperations.class) | ||
| public NamedParameterJdbcTemplate namedParameterJdbcTemplate() { | ||
| return new NamedParameterJdbcTemplate(this.dataSource); | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
164 changes: 164 additions & 0 deletions
164
.../java/org/springframework/boot/autoconfigure/jdbc/JdbcTemplateAutoConfigurationTests.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,164 @@ | ||
| /* | ||
| * Copyright 2012-2016 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 | ||
| * | ||
| * http://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.boot.autoconfigure.jdbc; | ||
|
|
||
| import java.util.Random; | ||
|
|
||
| import javax.sql.DataSource; | ||
|
|
||
| import org.apache.commons.dbcp.BasicDataSource; | ||
| import org.junit.After; | ||
| import org.junit.Before; | ||
| import org.junit.Test; | ||
|
|
||
| import org.springframework.boot.autoconfigure.PropertyPlaceholderAutoConfiguration; | ||
| import org.springframework.boot.test.util.EnvironmentTestUtils; | ||
| import org.springframework.context.annotation.AnnotationConfigApplicationContext; | ||
| import org.springframework.context.annotation.Bean; | ||
| import org.springframework.context.annotation.Configuration; | ||
| import org.springframework.jdbc.core.JdbcOperations; | ||
| import org.springframework.jdbc.core.JdbcTemplate; | ||
| import org.springframework.jdbc.core.namedparam.NamedParameterJdbcOperations; | ||
| import org.springframework.jdbc.core.namedparam.NamedParameterJdbcTemplate; | ||
|
|
||
| import static org.assertj.core.api.Assertions.assertThat; | ||
|
|
||
| /** | ||
| * Tests for {@link DataSourceAutoConfiguration}. | ||
| * | ||
| * @author Dave Syer | ||
| * @author Stephane Nicoll | ||
| * @author Kazuki Shimizu | ||
| * @since 1.4.0 | ||
| */ | ||
| public class JdbcTemplateAutoConfigurationTests { | ||
|
|
||
| private final AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(); | ||
|
|
||
| @Before | ||
| public void init() { | ||
| EmbeddedDatabaseConnection.override = null; | ||
| EnvironmentTestUtils.addEnvironment(this.context, | ||
| "spring.datasource.initialize:false", | ||
| "spring.datasource.url:jdbc:hsqldb:mem:testdb-" + new Random().nextInt()); | ||
| } | ||
|
|
||
| @After | ||
| public void restore() { | ||
| EmbeddedDatabaseConnection.override = null; | ||
| this.context.close(); | ||
| } | ||
|
|
||
| @Test | ||
| public void testJdbcTemplateExists() throws Exception { | ||
| this.context.register(DataSourceAutoConfiguration.class, | ||
| JdbcTemplateAutoConfiguration.class, | ||
| PropertyPlaceholderAutoConfiguration.class); | ||
| this.context.refresh(); | ||
| JdbcTemplate jdbcTemplate = this.context.getBean(JdbcTemplate.class); | ||
| assertThat(jdbcTemplate).isNotNull(); | ||
| assertThat(jdbcTemplate.getDataSource()).isNotNull(); | ||
| } | ||
|
|
||
| @Test | ||
| public void testJdbcTemplateExistsWithCustomDataSource() throws Exception { | ||
| this.context.register(TestDataSourceConfiguration.class, | ||
| DataSourceAutoConfiguration.class, JdbcTemplateAutoConfiguration.class, | ||
| PropertyPlaceholderAutoConfiguration.class); | ||
| this.context.refresh(); | ||
| JdbcTemplate jdbcTemplate = this.context.getBean(JdbcTemplate.class); | ||
| assertThat(jdbcTemplate).isNotNull(); | ||
| assertThat(jdbcTemplate.getDataSource() instanceof BasicDataSource).isTrue(); | ||
| } | ||
|
|
||
| @Test | ||
| public void testNamedParameterJdbcTemplateExists() throws Exception { | ||
| this.context.register(DataSourceAutoConfiguration.class, | ||
| JdbcTemplateAutoConfiguration.class, | ||
| PropertyPlaceholderAutoConfiguration.class); | ||
| this.context.refresh(); | ||
| assertThat(this.context.getBean(NamedParameterJdbcOperations.class)).isNotNull(); | ||
| } | ||
|
|
||
| @Test | ||
| public void testMultiDataSource() throws Exception { | ||
| this.context.register(MultiDataSourceConfiguration.class, | ||
| DataSourceAutoConfiguration.class, JdbcTemplateAutoConfiguration.class, | ||
| PropertyPlaceholderAutoConfiguration.class); | ||
| this.context.refresh(); | ||
| assertThat(this.context.getBeansOfType(JdbcOperations.class)).isEmpty(); | ||
| assertThat(this.context.getBeansOfType(NamedParameterJdbcOperations.class)) | ||
| .isEmpty(); | ||
| } | ||
|
|
||
| @Test | ||
| public void testMultiDataSourceUsingPrimary() throws Exception { | ||
| this.context.register(MultiDataSourceUsingPrimaryConfiguration.class, | ||
| DataSourceAutoConfiguration.class, JdbcTemplateAutoConfiguration.class, | ||
| PropertyPlaceholderAutoConfiguration.class); | ||
| this.context.refresh(); | ||
| assertThat(this.context.getBean(JdbcOperations.class)).isNotNull(); | ||
| assertThat(this.context.getBean(NamedParameterJdbcOperations.class)).isNotNull(); | ||
| } | ||
|
|
||
| @Test | ||
| public void testExistingCustomJdbcTemplate() throws Exception { | ||
| this.context.register(CustomConfiguration.class, | ||
| DataSourceAutoConfiguration.class, JdbcTemplateAutoConfiguration.class, | ||
| PropertyPlaceholderAutoConfiguration.class); | ||
| this.context.refresh(); | ||
| assertThat(this.context.getBean(JdbcOperations.class)) | ||
| .isEqualTo(this.context.getBean("customJdbcOperations")); | ||
| } | ||
|
|
||
| @Test | ||
| public void testExistingCustomNamedParameterJdbcTemplate() throws Exception { | ||
| this.context.register(CustomConfiguration.class, | ||
| DataSourceAutoConfiguration.class, JdbcTemplateAutoConfiguration.class, | ||
| PropertyPlaceholderAutoConfiguration.class); | ||
| this.context.refresh(); | ||
| assertThat(this.context.getBean(NamedParameterJdbcOperations.class)) | ||
| .isEqualTo(this.context.getBean("customNamedParameterJdbcOperations")); | ||
| } | ||
|
|
||
| @Configuration | ||
| static class CustomConfiguration { | ||
|
|
||
| @Bean | ||
| public JdbcOperations customJdbcOperations(DataSource dataSource) { | ||
| return new JdbcTemplate(dataSource); | ||
| } | ||
|
|
||
| @Bean | ||
| public NamedParameterJdbcOperations customNamedParameterJdbcOperations( | ||
| DataSource dataSource) { | ||
| return new NamedParameterJdbcTemplate(dataSource); | ||
| } | ||
|
|
||
| } | ||
|
|
||
| @Configuration | ||
| static class TestDataSourceConfiguration { | ||
|
|
||
| @Bean | ||
| public DataSource dataSource() { | ||
| return new TestDataSource("overridedb"); | ||
| } | ||
|
|
||
| } | ||
|
|
||
| } |