diff --git a/spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/data-access.adoc b/spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/data-access.adoc index d4a562bc531..67d81492617 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/data-access.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/data-access.adoc @@ -54,10 +54,15 @@ app: pool-size: 30 ---- -However, there is a catch. -Because the actual type of the connection pool is not exposed, no keys are generated in the metadata for your custom `DataSource` and no completion is available in your IDE (because the `DataSource` interface exposes no properties). -Also, if you happen to have Hikari on the classpath, this basic setup does not work, because Hikari has no `url` property (but does have a `jdbcUrl` property). -In that case, you must rewrite your configuration as follows: +However, there is a catch due to the method's `DataSource` return type. +This hides the actual type of the connection pool so no configuration property metadata is generated for your custom `DataSource` and no auto-completion is available in your IDE. +To address this problem, use the builder's `type(Class)` method to specify the type of `DataSource` to be built and update the method's return type. +For example, the following shows how to create a `HikariDataSource` with `DataSourceBuilder`: + +include-code::simple/MyDataSourceConfiguration[] + +Unfortunately, this basic setup does not work because Hikari has no `url` property. +Instead, it has a `jdbc-url` property which means that you must rewrite your configuration as follows: [configprops%novalidate,yaml] ---- @@ -69,22 +74,15 @@ app: pool-size: 30 ---- -You can fix that by forcing the connection pool to use and return a dedicated implementation rather than `DataSource`. -You cannot change the implementation at runtime, but the list of options will be explicit. - -The following example shows how to create a `HikariDataSource` with `DataSourceBuilder`: - -include-code::simple/MyDataSourceConfiguration[] - -You can even go further by leveraging what `DataSourceProperties` does for you -- that is, by providing a default embedded database with a sensible username and password if no URL is provided. -You can easily initialize a `DataSourceBuilder` from the state of any `DataSourceProperties` object, so you could also inject the DataSource that Spring Boot creates automatically. -However, that would split your configuration into two namespaces: `url`, `username`, `password`, `type`, and `driver` on `spring.datasource` and the rest on your custom namespace (`app.datasource`). -To avoid that, you can redefine a custom `DataSourceProperties` on your custom namespace, as shown in the following example: +To address this problem, make use of `DataSourceProperties` which will handle the `url` to `jdbc-url` translation for you. +You can initialize a `DataSourceBuilder` from the state of any `DataSourceProperties` object using its `initializeDataSourceBuilder()` method. +You could inject the `DataSourceProperties` that Spring Boot creates automatically, however, that would split your configuration across `+spring.datasource.*+` and `+app.datasource.*+`. +To avoid this, define a custom `DataSourceProperties` with a custom configuration properties prefix, as shown in the following example: include-code::configurable/MyDataSourceConfiguration[] -This setup puts you _in sync_ with what Spring Boot does for you by default, except that a dedicated connection pool is chosen (in code) and its settings are exposed in the `app.datasource.configuration` sub namespace. -Because `DataSourceProperties` is taking care of the `url`/`jdbcUrl` translation for you, you can configure it as follows: +This setup is equivalent to what Spring Boot does for you by default, except that the pool's type is specified in code and its settings are exposed as `app.datasource.configuration.*` properties. +`DataSourceProperties` takes care of the `url` to `jdbc-url` translation, so you can configure it as follows: [configprops%novalidate,yaml] ---- @@ -97,13 +95,16 @@ app: maximum-pool-size: 30 ---- +Note that, as the custom configuration specifies in code that Hikari should be used, `app.datasource.type` will have no effect. + +As described in xref:reference:data/sql.adoc#data.sql.datasource.connection-pool[], `DataSourceBuilder` supports several different connection pools. +To use a pool other than Hikari, add it to the classpath, use the `type(Class)` method to specify the pool class to use, and update the `@Bean` method's return type to match. +This will also provide you with configuration property metadata for the specific connection pool that you've chosen. + TIP: Spring Boot will expose Hikari-specific settings to `spring.datasource.hikari`. This example uses a more generic `configuration` sub namespace as the example does not support multiple datasource implementations. -NOTE: Because your custom configuration chooses to go with Hikari, `app.datasource.type` has no effect. -In practice, the builder is initialized with whatever value you might set there and then overridden by the call to `.type()`. - -See xref:reference:data/sql.adoc#data.sql.datasource[] in the "`Spring Boot Features`" section and the {code-spring-boot-autoconfigure-src}/jdbc/DataSourceAutoConfiguration.java[`DataSourceAutoConfiguration`] class for more details. +See xref:reference:data/sql.adoc#data.sql.datasource[] and the {code-spring-boot-autoconfigure-src}/jdbc/DataSourceAutoConfiguration.java[`DataSourceAutoConfiguration`] class for more details. @@ -149,6 +150,9 @@ include-code::MyCompleteAdditionalDataSourceConfiguration[] The preceding example configures the additional data source with the same logic as Spring Boot would use in auto-configuration. Note that the `app.datasource.configuration.*` properties provide advanced settings based on the chosen implementation. +As with xref:how-to:data-access.adoc#howto.data-access.configure-custom-datasource[configuring a single custom `DataSource`], the type of one or both of the `DataSource` beans can be customized using the `type(Class)` method on `DataSourceBuilder`. +See xref:reference:data/sql.adoc#data.sql.datasource.connection-pool[] for details of the supported types. + [[howto.data-access.spring-data-repositories]] diff --git a/spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/testing.adoc b/spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/testing.adoc index 0f8ed0e7873..60647b045a7 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/testing.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/testing.adoc @@ -33,7 +33,7 @@ include-code::MyConfiguration[] For a `@WebMvcTest` for an application with the above `@Configuration` class, you might expect to have the `SecurityFilterChain` bean in the application context so that you can test if your controller endpoints are secured properly. However, `MyConfiguration` is not picked up by @WebMvcTest's component scanning filter because it doesn't match any of the types specified by the filter. You can include the configuration explicitly by annotating the test class with `@Import(MyConfiguration.class)`. -This will load all the beans in `MyConfiguration` including the `BasicDataSource` bean which isn't required when testing the web tier. +This will load all the beans in `MyConfiguration` including the `HikariDataSource` bean which isn't required when testing the web tier. Splitting the configuration class into two will enable importing just the security configuration. include-code::MySecurityConfiguration[] diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/howto/dataaccess/configuretwodatasources/MyAdditionalDataSourceConfiguration.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/howto/dataaccess/configuretwodatasources/MyAdditionalDataSourceConfiguration.java index 7780541c174..4882b940c76 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/howto/dataaccess/configuretwodatasources/MyAdditionalDataSourceConfiguration.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/howto/dataaccess/configuretwodatasources/MyAdditionalDataSourceConfiguration.java @@ -16,7 +16,7 @@ package org.springframework.boot.docs.howto.dataaccess.configuretwodatasources; -import org.apache.commons.dbcp2.BasicDataSource; +import com.zaxxer.hikari.HikariDataSource; import org.springframework.beans.factory.annotation.Qualifier; import org.springframework.boot.context.properties.ConfigurationProperties; @@ -30,8 +30,8 @@ public class MyAdditionalDataSourceConfiguration { @Qualifier("second") @Bean(defaultCandidate = false) @ConfigurationProperties("app.datasource") - public BasicDataSource secondDataSource() { - return DataSourceBuilder.create().type(BasicDataSource.class).build(); + public HikariDataSource secondDataSource() { + return DataSourceBuilder.create().type(HikariDataSource.class).build(); } } diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/howto/dataaccess/configuretwodatasources/MyCompleteAdditionalDataSourceConfiguration.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/howto/dataaccess/configuretwodatasources/MyCompleteAdditionalDataSourceConfiguration.java index 829a9c413dd..7e4058eed73 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/howto/dataaccess/configuretwodatasources/MyCompleteAdditionalDataSourceConfiguration.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/howto/dataaccess/configuretwodatasources/MyCompleteAdditionalDataSourceConfiguration.java @@ -16,7 +16,7 @@ package org.springframework.boot.docs.howto.dataaccess.configuretwodatasources; -import org.apache.commons.dbcp2.BasicDataSource; +import com.zaxxer.hikari.HikariDataSource; import org.springframework.beans.factory.annotation.Qualifier; import org.springframework.boot.autoconfigure.jdbc.DataSourceProperties; @@ -37,9 +37,9 @@ public class MyCompleteAdditionalDataSourceConfiguration { @Qualifier("second") @Bean(defaultCandidate = false) @ConfigurationProperties("app.datasource.configuration") - public BasicDataSource secondDataSource( + public HikariDataSource secondDataSource( @Qualifier("secondDataSourceProperties") DataSourceProperties secondDataSourceProperties) { - return secondDataSourceProperties.initializeDataSourceBuilder().type(BasicDataSource.class).build(); + return secondDataSourceProperties.initializeDataSourceBuilder().type(HikariDataSource.class).build(); } } diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/howto/testing/slicetests/MyConfiguration.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/howto/testing/slicetests/MyConfiguration.java index 8bb2f859031..4c92a61d5cf 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/howto/testing/slicetests/MyConfiguration.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/howto/testing/slicetests/MyConfiguration.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2022 the original author or authors. + * Copyright 2012-2024 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. @@ -16,7 +16,7 @@ package org.springframework.boot.docs.howto.testing.slicetests; -import org.apache.commons.dbcp2.BasicDataSource; +import com.zaxxer.hikari.HikariDataSource; import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.boot.jdbc.DataSourceBuilder; @@ -36,8 +36,8 @@ public class MyConfiguration { @Bean @ConfigurationProperties("app.datasource.second") - public BasicDataSource secondDataSource() { - return DataSourceBuilder.create().type(BasicDataSource.class).build(); + public HikariDataSource secondDataSource() { + return DataSourceBuilder.create().type(HikariDataSource.class).build(); } } diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/howto/testing/slicetests/MyDatasourceConfiguration.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/howto/testing/slicetests/MyDatasourceConfiguration.java index 70506c4ee42..8258bdfa7ae 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/howto/testing/slicetests/MyDatasourceConfiguration.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/howto/testing/slicetests/MyDatasourceConfiguration.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2022 the original author or authors. + * Copyright 2012-2024 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. @@ -16,7 +16,7 @@ package org.springframework.boot.docs.howto.testing.slicetests; -import org.apache.commons.dbcp2.BasicDataSource; +import com.zaxxer.hikari.HikariDataSource; import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.boot.jdbc.DataSourceBuilder; @@ -28,8 +28,8 @@ public class MyDatasourceConfiguration { @Bean @ConfigurationProperties("app.datasource.second") - public BasicDataSource secondDataSource() { - return DataSourceBuilder.create().type(BasicDataSource.class).build(); + public HikariDataSource secondDataSource() { + return DataSourceBuilder.create().type(HikariDataSource.class).build(); } } diff --git a/spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/howto/dataaccess/configuretwodatasources/MyAdditionalDataSourceConfiguration.kt b/spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/howto/dataaccess/configuretwodatasources/MyAdditionalDataSourceConfiguration.kt index 401f08d7f41..0fe9a2a18ff 100644 --- a/spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/howto/dataaccess/configuretwodatasources/MyAdditionalDataSourceConfiguration.kt +++ b/spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/howto/dataaccess/configuretwodatasources/MyAdditionalDataSourceConfiguration.kt @@ -16,7 +16,7 @@ package org.springframework.boot.docs.howto.dataaccess.configuretwodatasources -import org.apache.commons.dbcp2.BasicDataSource +import com.zaxxer.hikari.HikariDataSource import org.springframework.beans.factory.annotation.Qualifier import org.springframework.boot.context.properties.ConfigurationProperties @@ -30,8 +30,8 @@ class MyAdditionalDataSourceConfiguration { @Qualifier("second") @Bean(defaultCandidate = false) @ConfigurationProperties("app.datasource") - fun secondDataSource(): BasicDataSource { - return DataSourceBuilder.create().type(BasicDataSource::class.java).build() + fun secondDataSource(): HikariDataSource { + return DataSourceBuilder.create().type(HikariDataSource::class.java).build() } } diff --git a/spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/howto/dataaccess/configuretwodatasources/MyCompleteAdditionalDataSourceConfiguration.kt b/spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/howto/dataaccess/configuretwodatasources/MyCompleteAdditionalDataSourceConfiguration.kt index cccbbff269d..051933f9d1e 100644 --- a/spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/howto/dataaccess/configuretwodatasources/MyCompleteAdditionalDataSourceConfiguration.kt +++ b/spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/howto/dataaccess/configuretwodatasources/MyCompleteAdditionalDataSourceConfiguration.kt @@ -16,7 +16,7 @@ package org.springframework.boot.docs.howto.dataaccess.configuretwodatasources -import org.apache.commons.dbcp2.BasicDataSource +import com.zaxxer.hikari.HikariDataSource import org.springframework.beans.factory.annotation.Qualifier import org.springframework.boot.autoconfigure.jdbc.DataSourceProperties @@ -37,8 +37,8 @@ class MyCompleteAdditionalDataSourceConfiguration { @Qualifier("second") @Bean(defaultCandidate = false) @ConfigurationProperties("app.datasource.configuration") - fun secondDataSource(secondDataSourceProperties: DataSourceProperties): BasicDataSource { - return secondDataSourceProperties.initializeDataSourceBuilder().type(BasicDataSource::class.java).build() + fun secondDataSource(secondDataSourceProperties: DataSourceProperties): HikariDataSource { + return secondDataSourceProperties.initializeDataSourceBuilder().type(HikariDataSource::class.java).build() } } diff --git a/spring-boot-project/spring-boot-docs/src/test/java/org/springframework/boot/docs/howto/dataaccess/configuretwodatasources/MyDataSourcesConfigurationTests.java b/spring-boot-project/spring-boot-docs/src/test/java/org/springframework/boot/docs/howto/dataaccess/configuretwodatasources/MyDataSourcesConfigurationTests.java index dbee0f9c37a..8bd17a5c34f 100644 --- a/spring-boot-project/spring-boot-docs/src/test/java/org/springframework/boot/docs/howto/dataaccess/configuretwodatasources/MyDataSourcesConfigurationTests.java +++ b/spring-boot-project/spring-boot-docs/src/test/java/org/springframework/boot/docs/howto/dataaccess/configuretwodatasources/MyDataSourcesConfigurationTests.java @@ -20,7 +20,7 @@ import java.sql.SQLException; import javax.sql.DataSource; -import org.apache.commons.dbcp2.BasicDataSource; +import com.zaxxer.hikari.HikariDataSource; import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; @@ -36,7 +36,8 @@ import static org.assertj.core.api.Assertions.assertThat; * * @author Stephane Nicoll */ -@SpringBootTest(properties = { "app.datasource.url=jdbc:h2:mem:bar;DB_CLOSE_DELAY=-1", "app.datasource.max-total=42" }) +@SpringBootTest(properties = { "app.datasource.jdbc-url=jdbc:h2:mem:bar;DB_CLOSE_DELAY=-1", + "app.datasource.maximum-pool-size=42" }) @Import(MyAdditionalDataSourceConfiguration.class) class MyDataSourcesConfigurationTests { @@ -56,9 +57,10 @@ class MyDataSourcesConfigurationTests { assertThat(this.context.getBean("dataSource")).isSameAs(this.dataSource); assertThat(this.dataSource.getConnection().getMetaData().getURL()).startsWith("jdbc:h2:mem:"); assertThat(this.context.getBean("secondDataSource")).isSameAs(this.secondDataSource); - assertThat(this.secondDataSource).extracting((dataSource) -> ((BasicDataSource) dataSource).getUrl()) + assertThat(this.secondDataSource).extracting((dataSource) -> ((HikariDataSource) dataSource).getJdbcUrl()) .isEqualTo("jdbc:h2:mem:bar;DB_CLOSE_DELAY=-1"); - assertThat(this.secondDataSource).extracting((dataSource) -> ((BasicDataSource) dataSource).getMaxTotal()) + assertThat(this.secondDataSource) + .extracting((dataSource) -> ((HikariDataSource) dataSource).getMaximumPoolSize()) .isEqualTo(42); }