Address PR Comments; move unrelated changes to a different PR.

garyrussell · garyrussell · commit 98712708e636 · 2021-08-10T09:38:05.000-04:00
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/amqp/RabbitAnnotationDrivenConfiguration.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/amqp/RabbitAnnotationDrivenConfiguration.java
@@ -19,13 +19,10 @@
 import java.util.stream.Collectors;
 
 import org.springframework.amqp.rabbit.annotation.EnableRabbit;
-import org.springframework.amqp.rabbit.config.ContainerCustomizer;
 import org.springframework.amqp.rabbit.config.DirectRabbitListenerContainerFactory;
 import org.springframework.amqp.rabbit.config.RabbitListenerConfigUtils;
 import org.springframework.amqp.rabbit.config.SimpleRabbitListenerContainerFactory;
 import org.springframework.amqp.rabbit.connection.ConnectionFactory;
-import org.springframework.amqp.rabbit.listener.DirectMessageListenerContainer;
-import org.springframework.amqp.rabbit.listener.SimpleMessageListenerContainer;
 import org.springframework.amqp.rabbit.retry.MessageRecoverer;
 import org.springframework.amqp.support.converter.MessageConverter;
 import org.springframework.beans.factory.ObjectProvider;
@@ -51,23 +48,14 @@ class RabbitAnnotationDrivenConfiguration {
 
 	private final ObjectProvider<RabbitRetryTemplateCustomizer> retryTemplateCustomizers;
 
-	private final ObjectProvider<ContainerCustomizer<SimpleMessageListenerContainer>> simpleContainerCustomizers;
-
-	private final ObjectProvider<ContainerCustomizer<DirectMessageListenerContainer>> directContainerCustomizers;
-
 	private final RabbitProperties properties;
 
 	RabbitAnnotationDrivenConfiguration(ObjectProvider<MessageConverter> messageConverter,
 			ObjectProvider<MessageRecoverer> messageRecoverer,
-			ObjectProvider<RabbitRetryTemplateCustomizer> retryTemplateCustomizers,
-			ObjectProvider<ContainerCustomizer<SimpleMessageListenerContainer>> simpleContainerCustomizers,
-			ObjectProvider<ContainerCustomizer<DirectMessageListenerContainer>> directContainerCustomizers,
-			RabbitProperties properties) {
+			ObjectProvider<RabbitRetryTemplateCustomizer> retryTemplateCustomizers, RabbitProperties properties) {
 		this.messageConverter = messageConverter;
 		this.messageRecoverer = messageRecoverer;
 		this.retryTemplateCustomizers = retryTemplateCustomizers;
-		this.simpleContainerCustomizers = simpleContainerCustomizers;
-		this.directContainerCustomizers = directContainerCustomizers;
 		this.properties = properties;
 	}
 
@@ -91,7 +79,6 @@ SimpleRabbitListenerContainerFactory simpleRabbitListenerContainerFactory(
 			SimpleRabbitListenerContainerFactoryConfigurer configurer, ConnectionFactory connectionFactory) {
 		SimpleRabbitListenerContainerFactory factory = new SimpleRabbitListenerContainerFactory();
 		configurer.configure(factory, connectionFactory);
-		factory.setContainerCustomizer(this.simpleContainerCustomizers.getIfUnique());
 		return factory;
 	}
 
@@ -114,7 +101,6 @@ DirectRabbitListenerContainerFactory directRabbitListenerContainerFactory(
 			DirectRabbitListenerContainerFactoryConfigurer configurer, ConnectionFactory connectionFactory) {
 		DirectRabbitListenerContainerFactory factory = new DirectRabbitListenerContainerFactory();
 		configurer.configure(factory, connectionFactory);
-		factory.setContainerCustomizer(this.directContainerCustomizers.getIfUnique());
 		return factory;
 	}
 
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/amqp/RabbitProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/amqp/RabbitProperties.java
@@ -896,6 +896,10 @@ public void setMissingQueuesFatal(boolean missingQueuesFatal) {
 
 	public static class StreamContainer extends BaseContainer {
 
+		/**
+		 * When true, the container factory will create containers that support listeners
+		 * that consume native stream messages instead of spring-amqp {@code Message}s.
+		 */
 		boolean nativeListener;
 
 		public boolean isNativeListener() {
@@ -1167,12 +1171,26 @@ private boolean determineSslEnabled(boolean sslEnabled) {
 
 	public static final class Stream {
 
+		/**
+		 * Host of a RabbitMQ instance with the Stream Plugin Enabled
+		 */
 		private String host = "localhost";
 
+		/**
+		 * Stream port of a RabbitMQ instance with the Stream Plugin Enabled
+		 */
 		private int port = DEFAULT_STREAM_PORT;
 
-		private String userName;
+		/**
+		 * Login user to authenticate to the broker. If not set
+		 * {@code spring.rabbitmq.username} will be used.
+		 */
+		private String username;
 
+		/**
+		 * Login password to authenticate to the broker. If not set
+		 * {@code spring.rabbitmq.password} will be used.
+		 */
 		private String password;
 
 		public String getHost() {
@@ -1191,12 +1209,12 @@ public void setPort(int port) {
 			this.port = port;
 		}
 
-		public String getUserName() {
-			return this.userName;
+		public String getUsername() {
+			return this.username;
 		}
 
-		public void setUserName(String userName) {
-			this.userName = userName;
+		public void setUsername(String username) {
+			this.username = username;
 		}
 
 		public String getPassword() {
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/amqp/RabbitStreamConfiguration.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/amqp/RabbitStreamConfiguration.java
@@ -35,36 +35,31 @@
  * Configuration for Spring RabbitMQ Stream Plugin support.
  *
  * @author Gary Russell
- * @since 2.6
  */
 @Configuration(proxyBeanMethods = false)
-@ConditionalOnClass(EnableRabbit.class)
+@ConditionalOnClass(StreamRabbitListenerContainerFactory.class)
 @ConditionalOnProperty(prefix = "spring.rabbitmq.listener", name = "type", havingValue = "stream")
-public class RabbitStreamConfiguration {
+class RabbitStreamConfiguration {
 
 	@Bean(name = "rabbitListenerContainerFactory")
 	@ConditionalOnMissingBean(name = "rabbitListenerContainerFactory")
 	StreamRabbitListenerContainerFactory streamRabbitListenerContainerFactory(Environment rabbitStreamEnvironment,
-			RabbitProperties properties, ObjectProvider<ConsumerCustomizer> consumerCustomizers,
-			ObjectProvider<ContainerCustomizer<StreamListenerContainer>> containerCustomizers) {
+			RabbitProperties properties, ObjectProvider<ConsumerCustomizer> consumerCustomizer,
+			ObjectProvider<ContainerCustomizer<StreamListenerContainer>> containerCustomizer) {
 
 		StreamRabbitListenerContainerFactory factory = new StreamRabbitListenerContainerFactory(
 				rabbitStreamEnvironment);
 		factory.setNativeListener(properties.getListener().getStream().isNativeListener());
-		if (consumerCustomizers.getIfUnique() != null) {
-			factory.setConsumerCustomizer(consumerCustomizers.getIfUnique());
-		}
-		if (containerCustomizers.getIfUnique() != null) {
-			factory.setContainerCustomizer(containerCustomizers.getIfUnique());
-		}
+		consumerCustomizer.ifUnique(factory::setConsumerCustomizer);
+		containerCustomizer.ifUnique(factory::setContainerCustomizer);
 		return factory;
 	}
 
 	@Bean(name = "rabbitStreamEnvironment")
 	@ConditionalOnMissingBean(name = "rabbitStreamEnvironment")
 	Environment rabbitStreamEnvironment(RabbitProperties properties) {
 		RabbitProperties.Stream stream = properties.getStream();
-		String username = stream.getUserName();
+		String username = stream.getUsername();
 		if (username == null) {
 			username = properties.getUsername();
 		}
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
@@ -32,13 +32,12 @@
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
 import org.mockito.InOrder;
+
 import org.springframework.amqp.core.AcknowledgeMode;
 import org.springframework.amqp.core.AmqpAdmin;
 import org.springframework.amqp.core.Message;
 import org.springframework.amqp.rabbit.annotation.EnableRabbit;
-import org.springframework.amqp.rabbit.annotation.RabbitListener;
 import org.springframework.amqp.rabbit.config.AbstractRabbitListenerContainerFactory;
-import org.springframework.amqp.rabbit.config.ContainerCustomizer;
 import org.springframework.amqp.rabbit.config.DirectRabbitListenerContainerFactory;
 import org.springframework.amqp.rabbit.config.RabbitListenerConfigUtils;
 import org.springframework.amqp.rabbit.config.SimpleRabbitListenerContainerFactory;
@@ -50,9 +49,7 @@
 import org.springframework.amqp.rabbit.core.RabbitAdmin;
 import org.springframework.amqp.rabbit.core.RabbitMessagingTemplate;
 import org.springframework.amqp.rabbit.core.RabbitTemplate;
-import org.springframework.amqp.rabbit.listener.DirectMessageListenerContainer;
 import org.springframework.amqp.rabbit.listener.RabbitListenerContainerFactory;
-import org.springframework.amqp.rabbit.listener.SimpleMessageListenerContainer;
 import org.springframework.amqp.rabbit.retry.MessageRecoverer;
 import org.springframework.amqp.support.converter.MessageConverter;
 import org.springframework.beans.factory.NoSuchBeanDefinitionException;
@@ -852,20 +849,6 @@ void whenMultipleConnectionFactoryCustomizersAreDefinedThenTheyAreCalledInOrder(
 				});
 	}
 
-	@Test
-	void simpleContainerCustomizer() {
-		this.contextRunner.withUserConfiguration(SimpleContainerCustomizerConfiguration.class).run(
-				(context) -> assertThat(context.getBean(SimpleContainerCustomizerConfiguration.class).customizerCalled)
-						.isTrue());
-	}
-
-	@Test
-	void directContainerCustomizer() {
-		this.contextRunner.withUserConfiguration(DirectContainerCustomizerConfiguration.class)
-				.withPropertyValues("spring.rabbitmq.listener.type:direct").run((context) -> assertThat(
-						context.getBean(DirectContainerCustomizerConfiguration.class).customizerCalled).isTrue());
-	}
-
 	private com.rabbitmq.client.ConnectionFactory getTargetConnectionFactory(AssertableApplicationContext context) {
 		CachingConnectionFactory connectionFactory = context.getBean(CachingConnectionFactory.class);
 		return connectionFactory.getRabbitConnectionFactory();
@@ -1130,36 +1113,4 @@ ConnectionFactoryCustomizer firstCustomizer() {
 
 	}
 
-	@Configuration(proxyBeanMethods = false)
-	static class SimpleContainerCustomizerConfiguration {
-
-		boolean customizerCalled;
-
-		@RabbitListener(queues = "test", autoStartup = "false")
-		void listen(String in) {
-		}
-
-		@Bean
-		ContainerCustomizer<SimpleMessageListenerContainer> customizer() {
-			return (container) -> this.customizerCalled = true;
-		}
-
-	}
-
-	@Configuration(proxyBeanMethods = false)
-	static class DirectContainerCustomizerConfiguration {
-
-		boolean customizerCalled;
-
-		@RabbitListener(queues = "test", autoStartup = "false")
-		void listen(String in) {
-		}
-
-		@Bean
-		ContainerCustomizer<DirectMessageListenerContainer> customizer() {
-			return (container) -> this.customizerCalled = true;
-		}
-
-	}
-
 }
