Polish "Add ProxyConnectionFactoryCustomizer"

See gh-40555

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/r2dbc/ProxyConnectionFactoryCustomizer.java

@@ -0,0 +1,36 @@
+/*
+ * 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.
+ * 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.r2dbc;
+
+import io.r2dbc.proxy.ProxyConnectionFactory;
+
+/**
+ * Callback interface that can be used to customize a
+ * {@link ProxyConnectionFactory.Builder}.
+ *
+ * @author Tadaya Tsuyukubo
+ * @since 3.4.0
+ */
+public interface ProxyConnectionFactoryCustomizer {
+
+	/**
+	 * Callback to customize a {@link ProxyConnectionFactory.Builder} instance.
+	 * @param builder the builder to customize
+	 */
+	void customize(ProxyConnectionFactory.Builder builder);
+
+}

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/r2dbc/R2dbcProxyAutoConfiguration.java

@@ -0,0 +1,50 @@
+/*
+ * 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.
+ * 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.r2dbc;
+
+import io.r2dbc.proxy.ProxyConnectionFactory;
+import io.r2dbc.spi.ConnectionFactory;
+
+import org.springframework.beans.factory.ObjectProvider;
+import org.springframework.boot.autoconfigure.AutoConfiguration;
+import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
+import org.springframework.boot.r2dbc.ConnectionFactoryDecorator;
+import org.springframework.context.annotation.Bean;
+
+/**
+ * {@link EnableAutoConfiguration Auto-configuration} for {@link ProxyConnectionFactory}.
+ *
+ * @author Tadaya Tsuyukubo
+ * @author Moritz Halbritter
+ * @since 3.4.0
+ */
+@AutoConfiguration
+@ConditionalOnClass({ ConnectionFactory.class, ProxyConnectionFactory.class })
+public class R2dbcProxyAutoConfiguration {
+
+	@Bean
+	ConnectionFactoryDecorator connectionFactoryDecorator(
+			ObjectProvider<ProxyConnectionFactoryCustomizer> customizers) {
+		return (connectionFactory) -> {
+			ProxyConnectionFactory.Builder builder = ProxyConnectionFactory.builder(connectionFactory);
+			customizers.orderedStream().forEach((customizer) -> customizer.customize(builder));
+			return builder.build();
+		};
+	}
+
+}

spring-boot-project/spring-boot-autoconfigure/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports

@@ -98,6 +98,7 @@ org.springframework.boot.autoconfigure.pulsar.PulsarAutoConfiguration
 org.springframework.boot.autoconfigure.pulsar.PulsarReactiveAutoConfiguration
 org.springframework.boot.autoconfigure.quartz.QuartzAutoConfiguration
 org.springframework.boot.autoconfigure.r2dbc.R2dbcAutoConfiguration
+org.springframework.boot.autoconfigure.r2dbc.R2dbcProxyAutoConfiguration
 org.springframework.boot.autoconfigure.r2dbc.R2dbcTransactionManagerAutoConfiguration
 org.springframework.boot.autoconfigure.reactor.ReactorAutoConfiguration
 org.springframework.boot.autoconfigure.rsocket.RSocketMessagingAutoConfiguration

spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/r2dbc/R2dbcProxyAutoConfigurationTests.java

@@ -0,0 +1,97 @@
+/*
+ * 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.
+ * 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.r2dbc;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.UUID;
+
+import io.r2dbc.spi.ConnectionFactory;
+import org.junit.jupiter.api.Test;
+
+import org.springframework.boot.autoconfigure.AutoConfigurations;
+import org.springframework.boot.r2dbc.ConnectionFactoryBuilder;
+import org.springframework.boot.r2dbc.ConnectionFactoryDecorator;
+import org.springframework.boot.test.context.FilteredClassLoader;
+import org.springframework.boot.test.context.runner.ApplicationContextRunner;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.core.annotation.Order;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Tests for {@link R2dbcProxyAutoConfiguration}.
+ *
+ * @author Tadaya Tsuyukubo
+ * @author Moritz Halbritter
+ */
+class R2dbcProxyAutoConfigurationTests {
+
+	private final ApplicationContextRunner runner = new ApplicationContextRunner()
+		.withConfiguration(AutoConfigurations.of(R2dbcProxyAutoConfiguration.class));
+
+	@Test
+	void shouldSupplyConnectionFactoryDecorator() {
+		this.runner.run((context) -> assertThat(context).hasSingleBean(ConnectionFactoryDecorator.class));
+	}
+
+	@Test
+	void shouldNotSupplyBeansIfR2dbcSpiIsNotOnClasspath() {
+		this.runner.withClassLoader(new FilteredClassLoader("io.r2dbc.spi"))
+			.run((context) -> assertThat(context).doesNotHaveBean(ConnectionFactoryDecorator.class));
+	}
+
+	@Test
+	void shouldNotSupplyBeansIfR2dbcProxyIsNotOnClasspath() {
+		this.runner.withClassLoader(new FilteredClassLoader("io.r2dbc.proxy"))
+			.run((context) -> assertThat(context).doesNotHaveBean(ConnectionFactoryDecorator.class));
+	}
+
+	@Test
+	void shouldApplyCustomizers() {
+		this.runner.withUserConfiguration(ProxyConnectionFactoryCustomizerConfig.class).run((context) -> {
+			ConnectionFactoryDecorator decorator = context.getBean(ConnectionFactoryDecorator.class);
+			ConnectionFactory connectionFactory = ConnectionFactoryBuilder
+				.withUrl("r2dbc:h2:mem:///" + UUID.randomUUID())
+				.build();
+			decorator.decorate(connectionFactory);
+			assertThat(context.getBean(ProxyConnectionFactoryCustomizerConfig.class).called).containsExactly("first",
+					"second");
+		});
+	}
+
+	@Configuration(proxyBeanMethods = false)
+	private static final class ProxyConnectionFactoryCustomizerConfig {
+
+		private final List<String> called = new ArrayList<>();
+
+		@Bean
+		@Order(1)
+		ProxyConnectionFactoryCustomizer first() {
+			return (builder) -> this.called.add("first");
+		}
+
+		@Bean
+		@Order(2)
+		ProxyConnectionFactoryCustomizer second() {
+			return (builder) -> this.called.add("second");
+		}
+
+	}
+
+}