mirror of
https://github.com/spring-projects/spring-boot.git
synced 2024-07-05 00:56:58 +08:00
Merge pull request #40555 from ttddyy
* pr/40555: Polish "Add ProxyConnectionFactoryCustomizer" Add ProxyConnectionFactoryCustomizer Closes gh-40555
This commit is contained in:
commit
9980362607
|
@ -1,5 +1,5 @@
|
||||||
/*
|
/*
|
||||||
* Copyright 2012-2023 the original author or authors.
|
* Copyright 2012-2024 the original author or authors.
|
||||||
*
|
*
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
* you may not use this file except in compliance with the License.
|
* you may not use this file except in compliance with the License.
|
||||||
|
@ -30,15 +30,17 @@ import org.springframework.boot.autoconfigure.AutoConfiguration;
|
||||||
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
|
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
|
||||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
|
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
|
||||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
|
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
|
||||||
|
import org.springframework.boot.autoconfigure.r2dbc.ProxyConnectionFactoryCustomizer;
|
||||||
import org.springframework.boot.context.properties.EnableConfigurationProperties;
|
import org.springframework.boot.context.properties.EnableConfigurationProperties;
|
||||||
import org.springframework.boot.r2dbc.ConnectionFactoryDecorator;
|
|
||||||
import org.springframework.boot.r2dbc.OptionsCapableConnectionFactory;
|
import org.springframework.boot.r2dbc.OptionsCapableConnectionFactory;
|
||||||
import org.springframework.context.annotation.Bean;
|
import org.springframework.context.annotation.Bean;
|
||||||
|
import org.springframework.core.annotation.Order;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* {@link EnableAutoConfiguration Auto-configuration} for R2DBC observability support.
|
* {@link EnableAutoConfiguration Auto-configuration} for R2DBC observability support.
|
||||||
*
|
*
|
||||||
* @author Moritz Halbritter
|
* @author Moritz Halbritter
|
||||||
|
* @author Tadaya Tsuyukubo
|
||||||
* @since 3.2.0
|
* @since 3.2.0
|
||||||
*/
|
*/
|
||||||
@AutoConfiguration(after = ObservationAutoConfiguration.class)
|
@AutoConfiguration(after = ObservationAutoConfiguration.class)
|
||||||
|
@ -46,20 +48,27 @@ import org.springframework.context.annotation.Bean;
|
||||||
@EnableConfigurationProperties(R2dbcObservationProperties.class)
|
@EnableConfigurationProperties(R2dbcObservationProperties.class)
|
||||||
public class R2dbcObservationAutoConfiguration {
|
public class R2dbcObservationAutoConfiguration {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* {@code @Order} value of the observation customizer.
|
||||||
|
*/
|
||||||
|
public static final int R2DBC_PROXY_OBSERVATION_CUSTOMIZER_ORDER = 0;
|
||||||
|
|
||||||
@Bean
|
@Bean
|
||||||
|
@Order(R2DBC_PROXY_OBSERVATION_CUSTOMIZER_ORDER)
|
||||||
@ConditionalOnBean(ObservationRegistry.class)
|
@ConditionalOnBean(ObservationRegistry.class)
|
||||||
ConnectionFactoryDecorator connectionFactoryDecorator(R2dbcObservationProperties properties,
|
ProxyConnectionFactoryCustomizer observationProxyConnectionFactoryCustomizer(R2dbcObservationProperties properties,
|
||||||
ObservationRegistry observationRegistry,
|
ObservationRegistry observationRegistry,
|
||||||
ObjectProvider<QueryObservationConvention> queryObservationConvention,
|
ObjectProvider<QueryObservationConvention> queryObservationConvention,
|
||||||
ObjectProvider<QueryParametersTagProvider> queryParametersTagProvider) {
|
ObjectProvider<QueryParametersTagProvider> queryParametersTagProvider) {
|
||||||
return (connectionFactory) -> {
|
return (builder) -> {
|
||||||
|
ConnectionFactory connectionFactory = builder.getConnectionFactory();
|
||||||
HostAndPort hostAndPort = extractHostAndPort(connectionFactory);
|
HostAndPort hostAndPort = extractHostAndPort(connectionFactory);
|
||||||
ObservationProxyExecutionListener listener = new ObservationProxyExecutionListener(observationRegistry,
|
ObservationProxyExecutionListener listener = new ObservationProxyExecutionListener(observationRegistry,
|
||||||
connectionFactory, hostAndPort.host(), hostAndPort.port());
|
connectionFactory, hostAndPort.host(), hostAndPort.port());
|
||||||
listener.setIncludeParameterValues(properties.isIncludeParameterValues());
|
listener.setIncludeParameterValues(properties.isIncludeParameterValues());
|
||||||
queryObservationConvention.ifAvailable(listener::setQueryObservationConvention);
|
queryObservationConvention.ifAvailable(listener::setQueryObservationConvention);
|
||||||
queryParametersTagProvider.ifAvailable(listener::setQueryParametersTagProvider);
|
queryParametersTagProvider.ifAvailable(listener::setQueryParametersTagProvider);
|
||||||
return ProxyConnectionFactory.builder(connectionFactory).listener(listener).build();
|
builder.listener(listener);
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/*
|
/*
|
||||||
* Copyright 2012-2023 the original author or authors.
|
* Copyright 2012-2024 the original author or authors.
|
||||||
*
|
*
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
* you may not use this file except in compliance with the License.
|
* you may not use this file except in compliance with the License.
|
||||||
|
@ -30,10 +30,11 @@ import reactor.core.publisher.Mono;
|
||||||
|
|
||||||
import org.springframework.boot.autoconfigure.AutoConfiguration;
|
import org.springframework.boot.autoconfigure.AutoConfiguration;
|
||||||
import org.springframework.boot.autoconfigure.AutoConfigurations;
|
import org.springframework.boot.autoconfigure.AutoConfigurations;
|
||||||
|
import org.springframework.boot.autoconfigure.r2dbc.ProxyConnectionFactoryCustomizer;
|
||||||
|
import org.springframework.boot.autoconfigure.r2dbc.R2dbcProxyAutoConfiguration;
|
||||||
import org.springframework.boot.context.annotation.ImportCandidates;
|
import org.springframework.boot.context.annotation.ImportCandidates;
|
||||||
import org.springframework.boot.r2dbc.ConnectionFactoryBuilder;
|
import org.springframework.boot.r2dbc.ConnectionFactoryBuilder;
|
||||||
import org.springframework.boot.r2dbc.ConnectionFactoryDecorator;
|
import org.springframework.boot.r2dbc.ConnectionFactoryDecorator;
|
||||||
import org.springframework.boot.test.context.FilteredClassLoader;
|
|
||||||
import org.springframework.boot.test.context.assertj.AssertableApplicationContext;
|
import org.springframework.boot.test.context.assertj.AssertableApplicationContext;
|
||||||
import org.springframework.boot.test.context.runner.ApplicationContextRunner;
|
import org.springframework.boot.test.context.runner.ApplicationContextRunner;
|
||||||
|
|
||||||
|
@ -43,11 +44,13 @@ import static org.assertj.core.api.Assertions.assertThat;
|
||||||
* Tests for {@link R2dbcObservationAutoConfiguration}.
|
* Tests for {@link R2dbcObservationAutoConfiguration}.
|
||||||
*
|
*
|
||||||
* @author Moritz Halbritter
|
* @author Moritz Halbritter
|
||||||
|
* @author Tadaya Tsuyukubo
|
||||||
*/
|
*/
|
||||||
class R2dbcObservationAutoConfigurationTests {
|
class R2dbcObservationAutoConfigurationTests {
|
||||||
|
|
||||||
private final ApplicationContextRunner runnerWithoutObservationRegistry = new ApplicationContextRunner()
|
private final ApplicationContextRunner runnerWithoutObservationRegistry = new ApplicationContextRunner()
|
||||||
.withConfiguration(AutoConfigurations.of(R2dbcObservationAutoConfiguration.class));
|
.withConfiguration(
|
||||||
|
AutoConfigurations.of(R2dbcProxyAutoConfiguration.class, R2dbcObservationAutoConfiguration.class));
|
||||||
|
|
||||||
private final ApplicationContextRunner runner = this.runnerWithoutObservationRegistry
|
private final ApplicationContextRunner runner = this.runnerWithoutObservationRegistry
|
||||||
.withBean(ObservationRegistry.class, ObservationRegistry::create);
|
.withBean(ObservationRegistry.class, ObservationRegistry::create);
|
||||||
|
@ -58,27 +61,10 @@ class R2dbcObservationAutoConfigurationTests {
|
||||||
.contains(R2dbcObservationAutoConfiguration.class.getName());
|
.contains(R2dbcObservationAutoConfiguration.class.getName());
|
||||||
}
|
}
|
||||||
|
|
||||||
@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
|
@Test
|
||||||
void shouldNotSupplyBeansIfObservationRegistryIsNotPresent() {
|
void shouldNotSupplyBeansIfObservationRegistryIsNotPresent() {
|
||||||
this.runnerWithoutObservationRegistry
|
this.runnerWithoutObservationRegistry
|
||||||
.run((context) -> assertThat(context).doesNotHaveBean(ConnectionFactoryDecorator.class));
|
.run((context) -> assertThat(context).doesNotHaveBean(ProxyConnectionFactoryCustomizer.class));
|
||||||
}
|
}
|
||||||
|
|
||||||
@Test
|
@Test
|
||||||
|
|
|
@ -50,6 +50,7 @@ dependencies {
|
||||||
optional("io.projectreactor.netty:reactor-netty-http")
|
optional("io.projectreactor.netty:reactor-netty-http")
|
||||||
optional("io.r2dbc:r2dbc-spi")
|
optional("io.r2dbc:r2dbc-spi")
|
||||||
optional("io.r2dbc:r2dbc-pool")
|
optional("io.r2dbc:r2dbc-pool")
|
||||||
|
optional("io.r2dbc:r2dbc-proxy")
|
||||||
optional("io.rsocket:rsocket-core")
|
optional("io.rsocket:rsocket-core")
|
||||||
optional("io.rsocket:rsocket-transport-netty")
|
optional("io.rsocket:rsocket-transport-netty")
|
||||||
optional("io.undertow:undertow-servlet")
|
optional("io.undertow:undertow-servlet")
|
||||||
|
|
|
@ -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);
|
||||||
|
|
||||||
|
}
|
|
@ -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();
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
|
@ -98,6 +98,7 @@ org.springframework.boot.autoconfigure.pulsar.PulsarAutoConfiguration
|
||||||
org.springframework.boot.autoconfigure.pulsar.PulsarReactiveAutoConfiguration
|
org.springframework.boot.autoconfigure.pulsar.PulsarReactiveAutoConfiguration
|
||||||
org.springframework.boot.autoconfigure.quartz.QuartzAutoConfiguration
|
org.springframework.boot.autoconfigure.quartz.QuartzAutoConfiguration
|
||||||
org.springframework.boot.autoconfigure.r2dbc.R2dbcAutoConfiguration
|
org.springframework.boot.autoconfigure.r2dbc.R2dbcAutoConfiguration
|
||||||
|
org.springframework.boot.autoconfigure.r2dbc.R2dbcProxyAutoConfiguration
|
||||||
org.springframework.boot.autoconfigure.r2dbc.R2dbcTransactionManagerAutoConfiguration
|
org.springframework.boot.autoconfigure.r2dbc.R2dbcTransactionManagerAutoConfiguration
|
||||||
org.springframework.boot.autoconfigure.reactor.ReactorAutoConfiguration
|
org.springframework.boot.autoconfigure.reactor.ReactorAutoConfiguration
|
||||||
org.springframework.boot.autoconfigure.rsocket.RSocketMessagingAutoConfiguration
|
org.springframework.boot.autoconfigure.rsocket.RSocketMessagingAutoConfiguration
|
||||||
|
|
|
@ -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");
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
Loading…
Reference in New Issue
Block a user