From 5f77c1cd77d42fce50253e956d64951f60b68c10 Mon Sep 17 00:00:00 2001 From: dzcr <1137729123@qq.com> Date: Thu, 2 Feb 2023 15:38:54 +0800 Subject: [PATCH 1/2] Add RabbitTemplateCustomizer See gh-34050 --- .../amqp/RabbitAutoConfiguration.java | 4 ++- .../amqp/RabbitTemplateCustomizer.java | 36 +++++++++++++++++++ .../amqp/RabbitAutoConfigurationTests.java | 33 +++++++++++++++++ 3 files changed, 72 insertions(+), 1 deletion(-) create mode 100644 spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/amqp/RabbitTemplateCustomizer.java diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/amqp/RabbitAutoConfiguration.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/amqp/RabbitAutoConfiguration.java index f31e8106da3..2165ad8180e 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/amqp/RabbitAutoConfiguration.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/amqp/RabbitAutoConfiguration.java @@ -154,9 +154,11 @@ public class RabbitAutoConfiguration { @Bean @ConditionalOnSingleCandidate(ConnectionFactory.class) @ConditionalOnMissingBean(RabbitOperations.class) - public RabbitTemplate rabbitTemplate(RabbitTemplateConfigurer configurer, ConnectionFactory connectionFactory) { + public RabbitTemplate rabbitTemplate(RabbitTemplateConfigurer configurer, ConnectionFactory connectionFactory, + ObjectProvider rabbitTemplateCustomizers) { RabbitTemplate template = new RabbitTemplate(); configurer.configure(template, connectionFactory); + rabbitTemplateCustomizers.orderedStream().forEach((customizer) -> customizer.customize(template)); return template; } diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/amqp/RabbitTemplateCustomizer.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/amqp/RabbitTemplateCustomizer.java new file mode 100644 index 00000000000..940e3d5505a --- /dev/null +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/amqp/RabbitTemplateCustomizer.java @@ -0,0 +1,36 @@ +/* + * Copyright 2012-2022 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.amqp; + +import org.springframework.amqp.rabbit.core.RabbitTemplate; + +/** + * Callback interface that can be used to customize a {@link RabbitTemplate}. + * + * @author dang zhicairang + * @since 2.3.0 + */ +@FunctionalInterface +public interface RabbitTemplateCustomizer { + + /** + * Customize the {@link RabbitTemplate}. + * @param rabbitTemplate the rabbitTemplate to customize + */ + void customize(RabbitTemplate rabbitTemplate); + +} diff --git a/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/amqp/RabbitAutoConfigurationTests.java b/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/amqp/RabbitAutoConfigurationTests.java index bb3f63adf63..bb98a23cd8a 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/amqp/RabbitAutoConfigurationTests.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/amqp/RabbitAutoConfigurationTests.java @@ -385,6 +385,22 @@ class RabbitAutoConfigurationTests { }); } + @Test + void whenMultipleRabbitTemplateCustomizersAreDefinedThenTheyAreCalledInOrder() { + this.contextRunner.withUserConfiguration(MultipleRabbitTemplateCustomizersConfiguration.class) + .run((context) -> { + RabbitTemplateCustomizer firstCustomizer = context.getBean("firstCustomizer", + RabbitTemplateCustomizer.class); + RabbitTemplateCustomizer secondCustomizer = context.getBean("secondCustomizer", + RabbitTemplateCustomizer.class); + InOrder inOrder = inOrder(firstCustomizer, secondCustomizer); + RabbitTemplate template = context.getBean(RabbitTemplate.class); + then(firstCustomizer).should(inOrder).customize(template); + then(secondCustomizer).should(inOrder).customize(template); + inOrder.verifyNoMoreInteractions(); + }); + } + @Test void testConnectionFactoryBackOff() { this.contextRunner.withUserConfiguration(TestConfiguration2.class).run((context) -> { @@ -992,6 +1008,23 @@ class RabbitAutoConfigurationTests { } + @Configuration(proxyBeanMethods = false) + static class MultipleRabbitTemplateCustomizersConfiguration { + + @Bean + @Order(Ordered.LOWEST_PRECEDENCE) + RabbitTemplateCustomizer secondCustomizer() { + return mock(RabbitTemplateCustomizer.class); + } + + @Bean + @Order(0) + RabbitTemplateCustomizer firstCustomizer() { + return mock(RabbitTemplateCustomizer.class); + } + + } + @Configuration(proxyBeanMethods = false) static class ConnectionNameStrategyConfiguration { From 2becf70c2ac32fcf1c1bd5166f9e60fc1d1befe1 Mon Sep 17 00:00:00 2001 From: Moritz Halbritter Date: Wed, 1 Mar 2023 12:58:59 +0100 Subject: [PATCH 2/2] Polish "Add RabbitTemplateCustomizer" See gh-34050 --- .../amqp/RabbitAutoConfiguration.java | 4 ++-- .../amqp/RabbitTemplateCustomizer.java | 4 ++-- .../amqp/RabbitAutoConfigurationTests.java | 22 +++++++++---------- .../src/docs/asciidoc/messaging/amqp.adoc | 2 ++ 4 files changed, 17 insertions(+), 15 deletions(-) diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/amqp/RabbitAutoConfiguration.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/amqp/RabbitAutoConfiguration.java index 2165ad8180e..c14a74c9ebd 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/amqp/RabbitAutoConfiguration.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/amqp/RabbitAutoConfiguration.java @@ -155,10 +155,10 @@ public class RabbitAutoConfiguration { @ConditionalOnSingleCandidate(ConnectionFactory.class) @ConditionalOnMissingBean(RabbitOperations.class) public RabbitTemplate rabbitTemplate(RabbitTemplateConfigurer configurer, ConnectionFactory connectionFactory, - ObjectProvider rabbitTemplateCustomizers) { + ObjectProvider customizers) { RabbitTemplate template = new RabbitTemplate(); configurer.configure(template, connectionFactory); - rabbitTemplateCustomizers.orderedStream().forEach((customizer) -> customizer.customize(template)); + customizers.orderedStream().forEach((customizer) -> customizer.customize(template)); return template; } diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/amqp/RabbitTemplateCustomizer.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/amqp/RabbitTemplateCustomizer.java index 940e3d5505a..9c807456076 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/amqp/RabbitTemplateCustomizer.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/amqp/RabbitTemplateCustomizer.java @@ -22,13 +22,13 @@ import org.springframework.amqp.rabbit.core.RabbitTemplate; * Callback interface that can be used to customize a {@link RabbitTemplate}. * * @author dang zhicairang - * @since 2.3.0 + * @since 3.1.0 */ @FunctionalInterface public interface RabbitTemplateCustomizer { /** - * Customize the {@link RabbitTemplate}. + * Callback to customize a {@link RabbitTemplate} instance. * @param rabbitTemplate the rabbitTemplate to customize */ void customize(RabbitTemplate rabbitTemplate); diff --git a/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/amqp/RabbitAutoConfigurationTests.java b/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/amqp/RabbitAutoConfigurationTests.java index bb98a23cd8a..9244a0c0972 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/amqp/RabbitAutoConfigurationTests.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/amqp/RabbitAutoConfigurationTests.java @@ -388,17 +388,17 @@ class RabbitAutoConfigurationTests { @Test void whenMultipleRabbitTemplateCustomizersAreDefinedThenTheyAreCalledInOrder() { this.contextRunner.withUserConfiguration(MultipleRabbitTemplateCustomizersConfiguration.class) - .run((context) -> { - RabbitTemplateCustomizer firstCustomizer = context.getBean("firstCustomizer", - RabbitTemplateCustomizer.class); - RabbitTemplateCustomizer secondCustomizer = context.getBean("secondCustomizer", - RabbitTemplateCustomizer.class); - InOrder inOrder = inOrder(firstCustomizer, secondCustomizer); - RabbitTemplate template = context.getBean(RabbitTemplate.class); - then(firstCustomizer).should(inOrder).customize(template); - then(secondCustomizer).should(inOrder).customize(template); - inOrder.verifyNoMoreInteractions(); - }); + .run((context) -> { + RabbitTemplateCustomizer firstCustomizer = context.getBean("firstCustomizer", + RabbitTemplateCustomizer.class); + RabbitTemplateCustomizer secondCustomizer = context.getBean("secondCustomizer", + RabbitTemplateCustomizer.class); + InOrder inOrder = inOrder(firstCustomizer, secondCustomizer); + RabbitTemplate template = context.getBean(RabbitTemplate.class); + then(firstCustomizer).should(inOrder).customize(template); + then(secondCustomizer).should(inOrder).customize(template); + inOrder.verifyNoMoreInteractions(); + }); } @Test diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/messaging/amqp.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/messaging/amqp.adoc index e81d893505f..42d230aaac7 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/messaging/amqp.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/messaging/amqp.adoc @@ -41,6 +41,8 @@ To configure lower-level details of the RabbitMQ `ConnectionFactory` that is use If a `ConnectionNameStrategy` bean exists in the context, it will be automatically used to name connections created by the auto-configured `CachingConnectionFactory`. +To make an application-wide, additive customization to the `RabbitTemplate`, use a `RabbitTemplateCustomizer` bean. + TIP: See https://spring.io/blog/2010/06/14/understanding-amqp-the-protocol-used-by-rabbitmq/[Understanding AMQP, the protocol used by RabbitMQ] for more details.