Add ConnectionDetail support to JDBC auto-configuration

Update JDBC auto-configuration so that `JdbcConnectionDetails` beans
may be optionally used to provide connection details.

See gh-34657

Co-Authored-By: Mortitz Halbritter <[email protected]>
Co-Authored-By: Phillip Webb <[email protected]>

Author: 3 people

spring-boot-project/spring-boot-autoconfigure/build.gradle

@@ -236,6 +236,7 @@ dependencies {
 	testImplementation("org.junit.jupiter:junit-jupiter")
 	testImplementation("org.mockito:mockito-core")
 	testImplementation("org.mockito:mockito-junit-jupiter")
+	testImplementation("org.postgresql:postgresql")
 	testImplementation("org.skyscreamer:jsonassert")
 	testImplementation("org.springframework:spring-test")
 	testImplementation("org.springframework:spring-core-test")

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/flyway/FlywayAutoConfiguration.java

@@ -47,6 +47,7 @@
 import org.springframework.boot.autoconfigure.flyway.FlywayAutoConfiguration.FlywayAutoConfigurationRuntimeHints;
 import org.springframework.boot.autoconfigure.flyway.FlywayAutoConfiguration.FlywayDataSourceCondition;
 import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
+import org.springframework.boot.autoconfigure.jdbc.JdbcConnectionDetails;
 import org.springframework.boot.autoconfigure.jdbc.JdbcTemplateAutoConfiguration;
 import org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration;
 import org.springframework.boot.context.properties.ConfigurationPropertiesBinding;
@@ -86,6 +87,7 @@
  * @author Semyon Danilov
  * @author Chris Bono
  * @author Moritz Halbritter
+ * @author Andy Wilkinson
  * @since 1.1.0
  */
 @AutoConfiguration(after = { DataSourceAutoConfiguration.class, JdbcTemplateAutoConfiguration.class,
@@ -125,17 +127,23 @@ public Flyway flyway(FlywayProperties properties, ResourceLoader resourceLoader,
 				ObjectProvider<FlywayConfigurationCustomizer> fluentConfigurationCustomizers,
 				ObjectProvider<JavaMigration> javaMigrations, ObjectProvider<Callback> callbacks) {
 			return flyway(properties, resourceLoader, dataSource, flywayDataSource, fluentConfigurationCustomizers,
-					javaMigrations, callbacks, new ResourceProviderCustomizer());
+					javaMigrations, callbacks, new ResourceProviderCustomizer(), null);
 		}
 
 		@Bean
 		Flyway flyway(FlywayProperties properties, ResourceLoader resourceLoader, ObjectProvider<DataSource> dataSource,
 				@FlywayDataSource ObjectProvider<DataSource> flywayDataSource,
 				ObjectProvider<FlywayConfigurationCustomizer> fluentConfigurationCustomizers,
 				ObjectProvider<JavaMigration> javaMigrations, ObjectProvider<Callback> callbacks,
-				ResourceProviderCustomizer resourceProviderCustomizer) {
+				ResourceProviderCustomizer resourceProviderCustomizer,
+				ObjectProvider<JdbcConnectionDetails> connectionDetailsProvider) {
 			FluentConfiguration configuration = new FluentConfiguration(resourceLoader.getClassLoader());
-			configureDataSource(configuration, properties, flywayDataSource.getIfAvailable(), dataSource.getIfUnique());
+			JdbcConnectionDetails connectionDetails = (connectionDetailsProvider != null)
+					? connectionDetailsProvider.getIfAvailable() : null;
+			connectionDetails = (connectionDetails != null) ? connectionDetails
+					: new FlywayPropertiesJdbcConnectionDetails(properties);
+			configureDataSource(configuration, flywayDataSource.getIfAvailable(), dataSource.getIfUnique(),
+					connectionDetails);
 			configureProperties(configuration, properties);
 			configureCallbacks(configuration, callbacks.orderedStream().toList());
 			configureJavaMigrations(configuration, javaMigrations.orderedStream().toList());
@@ -144,38 +152,41 @@ Flyway flyway(FlywayProperties properties, ResourceLoader resourceLoader, Object
 			return configuration.load();
 		}
 
-		private void configureDataSource(FluentConfiguration configuration, FlywayProperties properties,
-				DataSource flywayDataSource, DataSource dataSource) {
-			DataSource migrationDataSource = getMigrationDataSource(properties, flywayDataSource, dataSource);
+		private void configureDataSource(FluentConfiguration configuration, DataSource flywayDataSource,
+				DataSource dataSource, JdbcConnectionDetails connectionDetails) {
+			DataSource migrationDataSource = getMigrationDataSource(flywayDataSource, dataSource, connectionDetails);
 			configuration.dataSource(migrationDataSource);
 		}
 
-		private DataSource getMigrationDataSource(FlywayProperties properties, DataSource flywayDataSource,
-				DataSource dataSource) {
+		private DataSource getMigrationDataSource(DataSource flywayDataSource, DataSource dataSource,
+				JdbcConnectionDetails connectionDetails) {
 			if (flywayDataSource != null) {
 				return flywayDataSource;
 			}
-			if (properties.getUrl() != null) {
+			String url = connectionDetails.getJdbcUrl();
+			if (url != null) {
 				DataSourceBuilder<?> builder = DataSourceBuilder.create().type(SimpleDriverDataSource.class);
-				builder.url(properties.getUrl());
-				applyCommonBuilderProperties(properties, builder);
+				builder.url(url);
+				applyConnectionDetails(connectionDetails, builder);
 				return builder.build();
 			}
-			if (properties.getUser() != null && dataSource != null) {
+			String user = connectionDetails.getUsername();
+			if (user != null && dataSource != null) {
 				DataSourceBuilder<?> builder = DataSourceBuilder.derivedFrom(dataSource)
 					.type(SimpleDriverDataSource.class);
-				applyCommonBuilderProperties(properties, builder);
+				applyConnectionDetails(connectionDetails, builder);
 				return builder.build();
 			}
 			Assert.state(dataSource != null, "Flyway migration DataSource missing");
 			return dataSource;
 		}
 
-		private void applyCommonBuilderProperties(FlywayProperties properties, DataSourceBuilder<?> builder) {
-			builder.username(properties.getUser());
-			builder.password(properties.getPassword());
-			if (StringUtils.hasText(properties.getDriverClassName())) {
-				builder.driverClassName(properties.getDriverClassName());
+		private void applyConnectionDetails(JdbcConnectionDetails connectionDetails, DataSourceBuilder<?> builder) {
+			builder.username(connectionDetails.getUsername());
+			builder.password(connectionDetails.getPassword());
+			String driverClassName = connectionDetails.getDriverClassName();
+			if (StringUtils.hasText(driverClassName)) {
+				builder.driverClassName(driverClassName);
 			}
 		}
 
@@ -373,6 +384,11 @@ private static final class DataSourceBeanCondition {
 
 		}
 
+		@ConditionalOnBean(JdbcConnectionDetails.class)
+		private static final class JdbcConnectionDetailsCondition {
+
+		}
+
 		@ConditionalOnProperty(prefix = "spring.flyway", name = "url")
 		private static final class FlywayUrlCondition {
 
@@ -389,4 +405,37 @@ public void registerHints(RuntimeHints hints, ClassLoader classLoader) {
 
 	}
 
+	/**
+	 * Adapts {@link FlywayProperties} to {@link JdbcConnectionDetails}.
+	 */
+	private static final class FlywayPropertiesJdbcConnectionDetails implements JdbcConnectionDetails {
+
+		private final FlywayProperties properties;
+
+		private FlywayPropertiesJdbcConnectionDetails(FlywayProperties properties) {
+			this.properties = properties;
+		}
+
+		@Override
+		public String getUsername() {
+			return this.properties.getUser();
+		}
+
+		@Override
+		public String getPassword() {
+			return this.properties.getPassword();
+		}
+
+		@Override
+		public String getJdbcUrl() {
+			return this.properties.getUrl();
+		}
+
+		@Override
+		public String getDriverClassName() {
+			return this.properties.getDriverClassName();
+		}
+
+	}
+
 }

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/DataSourceConfiguration.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2020 the original author or authors.
+ * Copyright 2012-2023 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.
@@ -24,10 +24,13 @@
 import oracle.jdbc.OracleConnection;
 import oracle.ucp.jdbc.PoolDataSourceImpl;
 
+import org.springframework.beans.factory.ObjectProvider;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.boot.jdbc.DataSourceBuilder;
 import org.springframework.boot.jdbc.DatabaseDriver;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
@@ -40,6 +43,8 @@
  * @author Phillip Webb
  * @author Stephane Nicoll
  * @author Fabio Grassi
+ * @author Moritz Halbritter
+ * @author Andy Wilkinson
  */
 abstract class DataSourceConfiguration {
 
@@ -48,6 +53,17 @@ protected static <T> T createDataSource(DataSourceProperties properties, Class<?
 		return (T) properties.initializeDataSourceBuilder().type(type).build();
 	}
 
+	@SuppressWarnings("unchecked")
+	protected static <T> T createDataSource(JdbcConnectionDetails connectionDetails, Class<? extends DataSource> type,
+			ClassLoader classLoader) {
+		return (T) DataSourceBuilder.create(classLoader)
+			.url(connectionDetails.getJdbcUrl())
+			.username(connectionDetails.getUsername())
+			.password(connectionDetails.getPassword())
+			.type(type)
+			.build();
+	}
+
 	/**
 	 * Tomcat Pool DataSource configuration.
 	 */
@@ -58,13 +74,26 @@ protected static <T> T createDataSource(DataSourceProperties properties, Class<?
 			matchIfMissing = true)
 	static class Tomcat {
 
+		@Bean
+		@ConditionalOnBean(JdbcConnectionDetails.class)
+		static TomcatJdbcConnectionDetailsBeanPostProcessor tomcatJdbcConnectionDetailsBeanPostProcessor(
+				ObjectProvider<JdbcConnectionDetails> connectionDetailsProvider) {
+			return new TomcatJdbcConnectionDetailsBeanPostProcessor(connectionDetailsProvider);
+		}
+
 		@Bean
 		@ConfigurationProperties(prefix = "spring.datasource.tomcat")
-		org.apache.tomcat.jdbc.pool.DataSource dataSource(DataSourceProperties properties) {
-			org.apache.tomcat.jdbc.pool.DataSource dataSource = createDataSource(properties,
-					org.apache.tomcat.jdbc.pool.DataSource.class);
-			DatabaseDriver databaseDriver = DatabaseDriver.fromJdbcUrl(properties.determineUrl());
-			String validationQuery = databaseDriver.getValidationQuery();
+		org.apache.tomcat.jdbc.pool.DataSource dataSource(DataSourceProperties properties,
+				ObjectProvider<JdbcConnectionDetails> connectionDetailsProvider) {
+			JdbcConnectionDetails connectionDetails = connectionDetailsProvider.getIfAvailable();
+			Class<? extends DataSource> dataSourceType = org.apache.tomcat.jdbc.pool.DataSource.class;
+			org.apache.tomcat.jdbc.pool.DataSource dataSource = (connectionDetails != null)
+					? createDataSource(connectionDetails, dataSourceType, properties.getClassLoader())
+					: createDataSource(properties, dataSourceType);
+			String validationQuery;
+			String url = (connectionDetails != null) ? connectionDetails.getJdbcUrl() : properties.determineUrl();
+			DatabaseDriver databaseDriver = DatabaseDriver.fromJdbcUrl(url);
+			validationQuery = databaseDriver.getValidationQuery();
 			if (validationQuery != null) {
 				dataSource.setTestOnBorrow(true);
 				dataSource.setValidationQuery(validationQuery);
@@ -84,10 +113,21 @@ org.apache.tomcat.jdbc.pool.DataSource dataSource(DataSourceProperties propertie
 			matchIfMissing = true)
 	static class Hikari {
 
+		@Bean
+		@ConditionalOnBean(JdbcConnectionDetails.class)
+		static HikariJdbcConnectionDetailsBeanPostProcessor jdbcConnectionDetailsHikariBeanPostProcessor(
+				ObjectProvider<JdbcConnectionDetails> connectionDetailsProvider) {
+			return new HikariJdbcConnectionDetailsBeanPostProcessor(connectionDetailsProvider);
+		}
+
 		@Bean
 		@ConfigurationProperties(prefix = "spring.datasource.hikari")
-		HikariDataSource dataSource(DataSourceProperties properties) {
-			HikariDataSource dataSource = createDataSource(properties, HikariDataSource.class);
+		HikariDataSource dataSource(DataSourceProperties properties,
+				ObjectProvider<JdbcConnectionDetails> connectionDetailsProvider) {
+			JdbcConnectionDetails connectionDetails = connectionDetailsProvider.getIfAvailable();
+			HikariDataSource dataSource = (connectionDetails != null)
+					? createDataSource(connectionDetails, HikariDataSource.class, properties.getClassLoader())
+					: createDataSource(properties, HikariDataSource.class);
 			if (StringUtils.hasText(properties.getName())) {
 				dataSource.setPoolName(properties.getName());
 			}
@@ -106,10 +146,22 @@ HikariDataSource dataSource(DataSourceProperties properties) {
 			matchIfMissing = true)
 	static class Dbcp2 {
 
+		@Bean
+		@ConditionalOnBean(JdbcConnectionDetails.class)
+		static Dbcp2JdbcConnectionDetailsBeanPostProcessor dbcp2JdbcConnectionDetailsBeanPostProcessor(
+				ObjectProvider<JdbcConnectionDetails> connectionDetailsProvider) {
+			return new Dbcp2JdbcConnectionDetailsBeanPostProcessor(connectionDetailsProvider);
+		}
+
 		@Bean
 		@ConfigurationProperties(prefix = "spring.datasource.dbcp2")
-		org.apache.commons.dbcp2.BasicDataSource dataSource(DataSourceProperties properties) {
-			return createDataSource(properties, org.apache.commons.dbcp2.BasicDataSource.class);
+		org.apache.commons.dbcp2.BasicDataSource dataSource(DataSourceProperties properties,
+				ObjectProvider<JdbcConnectionDetails> connectionDetailsProvider) {
+			JdbcConnectionDetails connectionDetails = connectionDetailsProvider.getIfAvailable();
+			Class<? extends DataSource> dataSourceType = org.apache.commons.dbcp2.BasicDataSource.class;
+			return (connectionDetails != null)
+					? createDataSource(connectionDetails, dataSourceType, properties.getClassLoader())
+					: createDataSource(properties, dataSourceType);
 		}
 
 	}
@@ -124,10 +176,21 @@ org.apache.commons.dbcp2.BasicDataSource dataSource(DataSourceProperties propert
 			matchIfMissing = true)
 	static class OracleUcp {
 
+		@Bean
+		@ConditionalOnBean(JdbcConnectionDetails.class)
+		static OracleUcpJdbcConnectionDetailsBeanPostProcessor oracleUcpJdbcConnectionDetailsBeanPostProcessor(
+				ObjectProvider<JdbcConnectionDetails> connectionDetailsProvider) {
+			return new OracleUcpJdbcConnectionDetailsBeanPostProcessor(connectionDetailsProvider);
+		}
+
 		@Bean
 		@ConfigurationProperties(prefix = "spring.datasource.oracleucp")
-		PoolDataSourceImpl dataSource(DataSourceProperties properties) throws SQLException {
-			PoolDataSourceImpl dataSource = createDataSource(properties, PoolDataSourceImpl.class);
+		PoolDataSourceImpl dataSource(DataSourceProperties properties,
+				ObjectProvider<JdbcConnectionDetails> connectionDetailsProvider) throws SQLException {
+			JdbcConnectionDetails connectionDetails = connectionDetailsProvider.getIfAvailable();
+			PoolDataSourceImpl dataSource = (connectionDetails != null)
+					? createDataSource(connectionDetails, PoolDataSourceImpl.class, properties.getClassLoader())
+					: createDataSource(properties, PoolDataSourceImpl.class);
 			dataSource.setValidateConnectionOnBorrow(true);
 			if (StringUtils.hasText(properties.getName())) {
 				dataSource.setConnectionPoolName(properties.getName());
@@ -146,7 +209,17 @@ PoolDataSourceImpl dataSource(DataSourceProperties properties) throws SQLExcepti
 	static class Generic {
 
 		@Bean
-		DataSource dataSource(DataSourceProperties properties) {
+		DataSource dataSource(DataSourceProperties properties,
+				ObjectProvider<JdbcConnectionDetails> connectionDetailsProvider) {
+			JdbcConnectionDetails connectionDetails = connectionDetailsProvider.getIfAvailable();
+			if (connectionDetails != null) {
+				return DataSourceBuilder.create(properties.getClassLoader())
+					.url(connectionDetails.getJdbcUrl())
+					.username(connectionDetails.getUsername())
+					.password(connectionDetails.getPassword())
+					.type(properties.getType())
+					.build();
+			}
 			return properties.initializeDataSourceBuilder().build();
 		}
 

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/Dbcp2JdbcConnectionDetailsBeanPostProcessor.java

@@ -0,0 +1,46 @@
+/*
+ * Copyright 2012-2023 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
+ *
+ *      https://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.apache.commons.dbcp2.BasicDataSource;
+
+import org.springframework.beans.factory.ObjectProvider;
+
+/**
+ * Post-processes beans of type {@link BasicDataSource} and name 'dataSource' to apply the
+ * values from {@link JdbcConnectionDetails}.
+ *
+ * @author Moritz Halbritter
+ * @author Andy Wilkinson
+ * @author Phillip Webb
+ */
+class Dbcp2JdbcConnectionDetailsBeanPostProcessor extends JdbcConnectionDetailsBeanPostProcessor<BasicDataSource> {
+
+	Dbcp2JdbcConnectionDetailsBeanPostProcessor(ObjectProvider<JdbcConnectionDetails> connectionDetailsProvider) {
+		super(BasicDataSource.class, connectionDetailsProvider);
+	}
+
+	@Override
+	protected Object processDataSource(BasicDataSource dataSource, JdbcConnectionDetails connectionDetails) {
+		dataSource.setUrl(connectionDetails.getJdbcUrl());
+		dataSource.setUsername(connectionDetails.getUsername());
+		dataSource.setPassword(connectionDetails.getPassword());
+		dataSource.setDriverClassName(connectionDetails.getDriverClassName());
+		return dataSource;
+	}
+
+}