configuration配置类作用，rabbitMq代码示例如何自定义bean

小灰灰 2024-02-19 11:20 9阅读 0赞

@Configuration
    @ConditionalOnClass(SimpleRabbitListenerContainerFactory.class)
    public class ConsumerConfig {
    
    	@Value("${rabbit.batch.num:100}")
    	private int batchNum;
    
    	@Bean("batchQueueRabbitListenerContainerFactory")
    	public SimpleRabbitListenerContainerFactory batchQueueRabbitListenerContainerFactory(ConnectionFactory connectionFactory) {
    		SimpleRabbitListenerContainerFactory factory = new SimpleRabbitListenerContainerFactory();
    		factory.setConnectionFactory(connectionFactory);
    		factory.setBatchListener(true);
    		factory.setConsumerBatchEnabled(true);
    		factory.setBatchSize(batchNum);
    		return factory;
    	}
    } 
    
    这段代码是一个基于Spring Boot的RabbitMQ消息消费者配置类。让我逐步来解释并举例说明：
    
        @Configuration：这个注解表示这是一个配置类，它会被Spring容器扫描并加载其中的Bean定义。
    
        @ConditionalOnClass(SimpleRabbitListenerContainerFactory.class)：这个注解表示当类路径中存在SimpleRabbitListenerContainerFactory时，该配置类才会生效。简单来说，它是一种条件装配，确保在特定条件下才会创建相关的Bean。
    
        ConsumerConfig 类名：这是配置类的名称，用来标识这个配置类。
    
        @Value("${rabbit.batch.num:100}") private int batchNum;：这是一个属性注入，意思是从配置文件中读取名为rabbit.batch.num的属性值，如果不存在则使用默认值100，并将其注入到batchNum变量中。
    
        @Bean("batchQueueRabbitListenerContainerFactory")：这是一个Bean定义，返回的Bean名称为batchQueueRabbitListenerContainerFactory。这个方法返回了一个SimpleRabbitListenerContainerFactory类型的Bean。
    
        public SimpleRabbitListenerContainerFactory batchQueueRabbitListenerContainerFactory(ConnectionFactory connectionFactory)：这是一个工厂方法，用来创建SimpleRabbitListenerContainerFactory Bean。它需要一个ConnectionFactory作为参数，这个参数由Spring容器自动注入。
    
        SimpleRabbitListenerContainerFactory factory = new SimpleRabbitListenerContainerFactory();：创建一个SimpleRabbitListenerContainerFactory实例。
    
        factory.setConnectionFactory(connectionFactory);：设置连接工厂，用于连接到RabbitMQ服务器。
    
        factory.setBatchListener(true);：设置为批量监听模式，表示消息的消费方式为批量消费。
    
        factory.setConsumerBatchEnabled(true);：设置消费者批量模式开启，允许消费者使用批量模式消费消息。
    
        factory.setBatchSize(batchNum);：设置批量消费的消息数量，这里使用了之前注入的batchNum属性作为批量大小。
              
                  
    
    
    
    示例：
    假设你有一个应用需要消费RabbitMQ中的消息，并且对性能有一定要求，你可以使用这个配置类来实现批量消费。通过设置rabbit.batch.num属性来控制每次批量消费的消息数量，以达到提高消费效率的目的。

代码关系讲解rabbitMq监听消息：

@Slf4j
    @Component
    @RequiredArgsConstructor
    public class AssemblerMessageConsumer {
    
    	private final AssemblerMessageService assemblerMessageService;
    
    	@RabbitListener(queues = test.queue", containerFactory = "batchQueueRabbitListenerContainerFactory")
    	@RabbitHandler
    	public void onMessage(List<Message> messages) {
    		List<MessageDto> list = messages.stream().map(message -> (MessageDto) message.getPayload()).collect(Collectors.toList());
    		assemblerMessageService.handler(list);
    	}
    }

这两段代码是关于使用Spring Boot集成RabbitMQ来实现消息消费的配置和消费者代码。让我逐一解释它们的作用和关系。

首先，ConsumerConfig类是一个配置类，通过@ConditionalOnClass(SimpleRabbitListenerContainerFactory.class)条件注解来确保只有在类路径中存在SimpleRabbitListenerContainerFactory类的情况下才会生效。该类定义了一个名为batchQueueRabbitListenerContainerFactory的Bean，用于创建一个批量消息监听的SimpleRabbitListenerContainerFactory实例。在这个Bean的初始化过程中，它会读取配置文件中名为rabbit.batch.num的属性值作为batchNum的默认值，如果未配置则使用默认值100，然后将其应用到创建的SimpleRabbitListenerContainerFactory中。

接着，AssemblerMessageConsumer类是一个消息消费者组件，通过@RabbitListener注解指定了监听的队列为"test.queue"，并且指定了使用batchQueueRabbitListenerContainerFactory工厂来创建消息监听容器。这样就实现了对"test.queue"队列中批量消息的消费。

**关于containerFactory和batchQueueRabbitListenerContainerFactory的关系：**

containerFactory是@RabbitListener注解中指定的参数，用于指定消息监听容器的工厂Bean。在这里，通过设置containerFactory = "batchQueueRabbitListenerContainerFactory"来告诉Spring使用名为batchQueueRabbitListenerContainerFactory的工厂Bean来创建消息监听容器。
    batchQueueRabbitListenerContainerFactory是在ConsumerConfig类中定义的批量消息监听容器工厂Bean，它会根据配置参数创建一个能够处理批量消息的监听容器。

关于rabbitMq服务器相关配置spring启动时被自动读取后是否会被赋值到containerFactory：

在ConsumerConfig类中，通过@Value注解将名为rabbit.batch.num的属性值赋给了batchNum变量，然后在batchQueueRabbitListenerContainerFactory Bean的初始化过程中将batchNum应用到了创建的SimpleRabbitListenerContainerFactory中。因此，rabbitMq服务器相关的配置会在Spring启动时被自动读取，并且通过batchQueueRabbitListenerContainerFactory工厂Bean传递到消息监听容器中。

**最后，containerFactory打印出来的数据是什么：**

关于启动时会自动读取这些配置信息后，为什么会创建一个ConnectionFactory Bean：  
由于containerFactory是一个消息监听容器的工厂Bean，它本身并不会打印出数据。它的作用是创建消息监听容器，而消息监听容器会在接收到消息时执行相应的业务逻辑，并可能会输出日志等。因此，实际的数据输出应该是由onMessage方法中的log.info语句输出的，输出的内容是收到的消息数据的JSON格式字符串。  
在Spring Boot应用中，配置文件中的RabbitMQ连接信息会被Spring容器读取并用于创建一个ConnectionFactory Bean。ConnectionFactory 是 RabbitMQ Java客户端提供的一个接口，它包含了与RabbitMQ服务器建立连接所需的所有信息，比如主机名、端口、用户名、密码等。

当Spring Boot应用启动时，根据配置文件中的信息，Spring会自动实例化一个ConnectionFactory Bean，并将其纳入到Spring应用上下文中管理。这样做的好处是，在需要与RabbitMQ进行通信的组件中，可以直接注入ConnectionFactory Bean，而无需每次手动创建连接。

例如，在之前提到的RabbitMQ消息监听器配置中，当我们使用@RabbitListener注解标识的方法需要连接到RabbitMQ时，可以通过Spring的依赖注入机制将ConnectionFactory注入到方法中，从而实现与RabbitMQ的连接和消息处理。

因此，当配置文件中的RabbitMQ连接信息被读取后，Spring会自动创建一个ConnectionFactory Bean，并在需要时将其注入到相关的组件中，以便与RabbitMQ建立连接和进行消息通信。

**关于rabbitMq相关配置：**  
使用application.properties文件的配置示例：

**\# RabbitMQ连接配置**

spring.rabbitmq.host=your_rabbitmq_host
    spring.rabbitmq.port=5672
    spring.rabbitmq.username=your_rabbitmq_username
    spring.rabbitmq.password=your_rabbitmq_password

兄弟们，提个醒，这个5672是连接mq的端口，15672是可视化后台的端口，切不可改错了  
使用application.yml文件的配置示例：

**\# RabbitMQ连接配置**

spring:
      rabbitmq:
        host: your_rabbitmq_host
        port: 5672
        username: your_rabbitmq_username
        password: your_rabbitmq_password

在这个示例中，你需要替换"your\_rabbitmq\_host"、"your\_rabbitmq\_username"和"your\_rabbitmq\_password"为你实际使用的RabbitMQ服务器的主机名、端口、用户名和密码。

关于RabbitMQ服务器的连接配置，通常会在项目的配置文件（如application.properties或者application.yml）中进行配置。你可以在配置文件中添加RabbitMQ服务器的连接信息，包括主机名、端口、用户名、密码等信息。Spring Boot在启动时会自动读取这些配置信息，并创建一个ConnectionFactory Bean，并将其注入到需要连接RabbitMQ的地方。在你的batchQueueRabbitListenerContainerFactory方法中，通过声明ConnectionFactory类型的参数，Spring会自动将上述配置好的连接工厂注入到该方法中，从而确保了与RabbitMQ服务器的连接。  
（在Spring Boot应用启动时，会自动读取这些配置并创建与RabbitMQ服务器的连接。在这里的代码中，连接工厂ConnectionFactory会由Spring自动注入到batchQueueRabbitListenerContainerFactory方法中，用于创建RabbitMQ连接。）