From fa357f0e27e405a032710d5a745c210ea8c66cb6 Mon Sep 17 00:00:00 2001 From: Kazuki Shimizu Date: Fri, 13 Jan 2017 01:21:17 +0900 Subject: [PATCH 1/2] Allow to customize the JdbcTemplate See gh-7960 --- .../autoconfigure/jdbc/JdbcProperties.java | 87 +++++++++++++++++++ .../jdbc/JdbcTemplateAutoConfiguration.java | 23 ++++- .../JdbcTemplateAutoConfigurationTests.java | 16 ++++ 3 files changed, 123 insertions(+), 3 deletions(-) create mode 100644 spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/JdbcProperties.java diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/JdbcProperties.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/JdbcProperties.java new file mode 100644 index 00000000000..21ac651fc5d --- /dev/null +++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/JdbcProperties.java @@ -0,0 +1,87 @@ +/* + * Copyright 2012-2017 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 org.springframework.boot.context.properties.ConfigurationProperties; + +/** + * Configuration properties for JDBC. + * + * @author Kazuki Shimizu + * @since 1.5.0 + */ +@ConfigurationProperties(prefix = "spring.jdbc") +public class JdbcProperties { + + /** + * Settings for JdbcTemplate. + */ + private final Template template = new Template(); + + public Template getTemplate() { + return this.template; + } + + /** + * {@link org.springframework.jdbc.core.JdbcTemplate} settings. + */ + public static class Template { + + /** + * Fetch size. + * @see org.springframework.jdbc.core.JdbcTemplate#fetchSize + */ + private Integer fetchSize; + + /** + * Max row count. + * @see org.springframework.jdbc.core.JdbcTemplate#maxRows + */ + private Integer maxRows; + + /** + * Query timeout in seconds. + * @see org.springframework.jdbc.core.JdbcTemplate#queryTimeout + */ + private Integer queryTimeout; + + public Integer getFetchSize() { + return this.fetchSize; + } + + public void setFetchSize(Integer fetchSize) { + this.fetchSize = fetchSize; + } + + public Integer getMaxRows() { + return this.maxRows; + } + + public void setMaxRows(Integer maxRows) { + this.maxRows = maxRows; + } + + public Integer getQueryTimeout() { + return this.queryTimeout; + } + + public void setQueryTimeout(Integer queryTimeout) { + this.queryTimeout = queryTimeout; + } + } + +} diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/JdbcTemplateAutoConfiguration.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/JdbcTemplateAutoConfiguration.java index beed0591222..4110f6a1542 100644 --- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/JdbcTemplateAutoConfiguration.java +++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/JdbcTemplateAutoConfiguration.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2016 the original author or authors. + * Copyright 2012-2017 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. @@ -23,6 +23,7 @@ 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.boot.context.properties.EnableConfigurationProperties; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Import; @@ -46,6 +47,7 @@ import org.springframework.jdbc.core.namedparam.NamedParameterJdbcTemplate; @ConditionalOnClass({ DataSource.class, JdbcTemplate.class }) @ConditionalOnSingleCandidate(DataSource.class) @AutoConfigureAfter(DataSourceAutoConfiguration.class) +@EnableConfigurationProperties(JdbcProperties.class) public class JdbcTemplateAutoConfiguration { @Configuration @@ -53,15 +55,30 @@ public class JdbcTemplateAutoConfiguration { private final DataSource dataSource; - JdbcTemplateConfiguration(DataSource dataSource) { + private final JdbcProperties properties; + + JdbcTemplateConfiguration(DataSource dataSource, JdbcProperties properties) { this.dataSource = dataSource; + this.properties = properties; } @Bean @Primary @ConditionalOnMissingBean(JdbcOperations.class) public JdbcTemplate jdbcTemplate() { - return new JdbcTemplate(this.dataSource); + JdbcTemplate jdbcTemplate = new JdbcTemplate(this.dataSource); + JdbcProperties.Template template = this.properties.getTemplate(); + if (template.getFetchSize() != null) { + jdbcTemplate.setFetchSize(template.getFetchSize()); + } + if (template.getQueryTimeout() != null) { + jdbcTemplate.setQueryTimeout(template.getQueryTimeout()); + } + if (template.getMaxRows() != null) { + jdbcTemplate.setMaxRows(template.getMaxRows()); + } + return jdbcTemplate; + } } diff --git a/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/jdbc/JdbcTemplateAutoConfigurationTests.java b/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/jdbc/JdbcTemplateAutoConfigurationTests.java index f492e75dcec..30fe4d8afc9 100644 --- a/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/jdbc/JdbcTemplateAutoConfigurationTests.java +++ b/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/jdbc/JdbcTemplateAutoConfigurationTests.java @@ -62,6 +62,22 @@ public class JdbcTemplateAutoConfigurationTests { JdbcTemplate jdbcTemplate = this.context.getBean(JdbcTemplate.class); assertThat(jdbcTemplate.getDataSource()).isEqualTo( this.context.getBean(DataSource.class)); + assertThat(jdbcTemplate.getFetchSize()).isEqualTo(-1); + assertThat(jdbcTemplate.getQueryTimeout()).isEqualTo(-1); + assertThat(jdbcTemplate.getMaxRows()).isEqualTo(-1); + } + + @Test + public void testJdbcTemplateWithCustomProperties() throws Exception { + load("spring.jdbc.template.fetch-size:100", + "spring.jdbc.template.query-timeout:60", + "spring.jdbc.template.max-rows:1000"); + JdbcTemplate jdbcTemplate = this.context.getBean(JdbcTemplate.class); + assertThat(jdbcTemplate).isNotNull(); + assertThat(jdbcTemplate.getDataSource()).isNotNull(); + assertThat(jdbcTemplate.getFetchSize()).isEqualTo(100); + assertThat(jdbcTemplate.getQueryTimeout()).isEqualTo(60); + assertThat(jdbcTemplate.getMaxRows()).isEqualTo(1000); } @Test From 5ea3ab4595dffe60bb38b49126f32960cef2d4b8 Mon Sep 17 00:00:00 2001 From: Stephane Nicoll Date: Thu, 1 Jun 2017 10:48:25 +0200 Subject: [PATCH 2/2] Polish "Allow to customize the JdbcTemplate" Closes gh-7960 --- .../autoconfigure/jdbc/JdbcProperties.java | 38 +++++++++---------- .../jdbc/JdbcTemplateAutoConfiguration.java | 13 ++----- .../appendix-application-properties.adoc | 5 +++ .../main/asciidoc/spring-boot-features.adoc | 9 +++++ 4 files changed, 35 insertions(+), 30 deletions(-) diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/JdbcProperties.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/JdbcProperties.java index 21ac651fc5d..ec5a8fd6a04 100644 --- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/JdbcProperties.java +++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/JdbcProperties.java @@ -22,14 +22,12 @@ import org.springframework.boot.context.properties.ConfigurationProperties; * Configuration properties for JDBC. * * @author Kazuki Shimizu - * @since 1.5.0 + * @author Stephane Nicoll + * @since 2.0.0 */ @ConfigurationProperties(prefix = "spring.jdbc") public class JdbcProperties { - /** - * Settings for JdbcTemplate. - */ private final Template template = new Template(); public Template getTemplate() { @@ -37,51 +35,51 @@ public class JdbcProperties { } /** - * {@link org.springframework.jdbc.core.JdbcTemplate} settings. + * {@code JdbcTemplate} settings. */ public static class Template { /** - * Fetch size. - * @see org.springframework.jdbc.core.JdbcTemplate#fetchSize + * Number of rows that should be fetched from the database when more rows are + * needed. Use -1 to use the JDBC driver's default configuration. */ - private Integer fetchSize; + private int fetchSize = -1; /** - * Max row count. - * @see org.springframework.jdbc.core.JdbcTemplate#maxRows + * Maximum number of rows. Use -1 to use the JDBC driver's default configuration. */ - private Integer maxRows; + private int maxRows = -1; /** - * Query timeout in seconds. - * @see org.springframework.jdbc.core.JdbcTemplate#queryTimeout + * Query timeout in seconds. Use -1 to use the JDBC driver's default + * configuration. */ - private Integer queryTimeout; + private int queryTimeout = -1; - public Integer getFetchSize() { + public int getFetchSize() { return this.fetchSize; } - public void setFetchSize(Integer fetchSize) { + public void setFetchSize(int fetchSize) { this.fetchSize = fetchSize; } - public Integer getMaxRows() { + public int getMaxRows() { return this.maxRows; } - public void setMaxRows(Integer maxRows) { + public void setMaxRows(int maxRows) { this.maxRows = maxRows; } - public Integer getQueryTimeout() { + public int getQueryTimeout() { return this.queryTimeout; } - public void setQueryTimeout(Integer queryTimeout) { + public void setQueryTimeout(int queryTimeout) { this.queryTimeout = queryTimeout; } + } } diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/JdbcTemplateAutoConfiguration.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/JdbcTemplateAutoConfiguration.java index 4110f6a1542..70b189c6ad5 100644 --- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/JdbcTemplateAutoConfiguration.java +++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/JdbcTemplateAutoConfiguration.java @@ -68,17 +68,10 @@ public class JdbcTemplateAutoConfiguration { public JdbcTemplate jdbcTemplate() { JdbcTemplate jdbcTemplate = new JdbcTemplate(this.dataSource); JdbcProperties.Template template = this.properties.getTemplate(); - if (template.getFetchSize() != null) { - jdbcTemplate.setFetchSize(template.getFetchSize()); - } - if (template.getQueryTimeout() != null) { - jdbcTemplate.setQueryTimeout(template.getQueryTimeout()); - } - if (template.getMaxRows() != null) { - jdbcTemplate.setMaxRows(template.getMaxRows()); - } + jdbcTemplate.setFetchSize(template.getFetchSize()); + jdbcTemplate.setMaxRows(template.getMaxRows()); + jdbcTemplate.setQueryTimeout(template.getQueryTimeout()); return jdbcTemplate; - } } diff --git a/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc b/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc index a3643a269fd..fc3d6e422ef 100644 --- a/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc +++ b/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc @@ -710,6 +710,11 @@ content into your application; rather pick only the properties that you need. # JOOQ ({sc-spring-boot-autoconfigure}/jooq/JooqAutoConfiguration.{sc-ext}[JooqAutoConfiguration]) spring.jooq.sql-dialect= # Sql dialect to use, auto-detected by default. + # JDBC ({sc-spring-boot-autoconfigure}/jdbc/JdbcProperties.{sc-ext}[JdbcProperties]) + spring.jdbc.template.fetch-size=-1 # Number of rows that should be fetched from the database when more rows are needed. + spring.jdbc.template.max-rows=-1 # Maximum number of rows. + spring.jdbc.template.query-timeout=-1 # Query timeout in seconds. + # JPA ({sc-spring-boot-autoconfigure}/orm/jpa/JpaBaseConfiguration.{sc-ext}[JpaBaseConfiguration], {sc-spring-boot-autoconfigure}/orm/jpa/HibernateJpaAutoConfiguration.{sc-ext}[HibernateJpaAutoConfiguration]) spring.data.jpa.repositories.enabled=true # Enable JPA repositories. spring.jpa.database= # Target database to operate on, auto-detected by default. Can be alternatively set using the "databasePlatform" property. diff --git a/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc b/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc index c15cc9b9150..0e479446f38 100644 --- a/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc +++ b/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc @@ -2932,11 +2932,20 @@ you can `@Autowire` them directly into your own beans: } ---- +You can customize some properties of the template using the `spring.jdbc.template.*` +properties: + +[source,properties,indent=0] +---- + spring.jdbc.template.max-rows=500 +---- + TIP: The `NamedParameterJdbcTemplate` reuses the same `JdbcTemplate` instance behind the scene. If more than one `JdbcTemplate` is defined and no primary candidate exists, the `NamedParameterJdbcTemplate` is not auto-configured. + [[boot-features-jpa-and-spring-data]] === JPA and '`Spring Data`' The Java Persistence API is a standard technology that allows you to '`map`' objects to