SpringBoot RabbitMQ配置多vhost/多RabbitMQ实例方案

问题背景

在实际开发中，应用在使用期间可能既是消息生产者也是消息消费者的场景非常普遍，但可能消费的消息和生产的消息需要发送到不同的RabbitMQ服务示例或者同一个RabbitMQ示例下的不同vhost。在使用SpringBoot时，通过配置默认只能配置一个vhost，所以针对以上场景需要作出各自的配置。

解决方案

准备事项

添加maven依赖：

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-amqp</artifactId>
</dependency>

多vhost

配置文件配置链接RabbitMQ实例的基本信息，例如：

spring.rabbitmq.host=localhost
spring.rabbitmq.port=5672
spring.rabbitmq.username=guest
spring.rabbitmq.password=guest
#spring.rabbitmq.virtual-host=/
spring.rabbitmq.listener.simple.acknowledge-mode=manual

由于要使用多vhost，所以配置文件中的spring.rabbitmq.virtual-host可以不用设置，在后续JavaConfig中配置。

RabbitMQConfig.java，注意使用时各ConnectionFactory按名称区分，以免混淆。

@EnableRabbit
@Configuration
public class RabbitMQConfig {

    /**
     * {@link org.springframework.boot.autoconfigure.amqp.RabbitAutoConfiguration}
     * 自动发送JSON结构或消费时自动将JSON转成相应的对象
     *
     * @return mq 消息序列化工具
     */
    @Bean
    public MessageConverter jsonMessageConverter() {
        return new Jackson2JsonMessageConverter();
    }


    /**
     * 默认的RabbitTemplate，vhost:/
     *
     * @param rabbitProperties
     * @return
     */
    @Bean("defaultConnectionFactory")
    @Primary
    public ConnectionFactory defaultConnectionFactory(RabbitProperties rabbitProperties) {
        CachingConnectionFactory cachingConnectionFactory = new CachingConnectionFactory();
        cachingConnectionFactory.setHost(rabbitProperties.getHost());
        cachingConnectionFactory.setPort(rabbitProperties.getPort());
        cachingConnectionFactory.setUsername(rabbitProperties.getUsername());
        cachingConnectionFactory.setPassword(rabbitProperties.getPassword());
        cachingConnectionFactory.setVirtualHost("/");
        return cachingConnectionFactory;
    }


    /**
     * RabbitTemplate，vhost:/my_demo
     *
     * @param rabbitProperties
     * @return
     */
    @Bean("myDemoConnectionFactory")
    public ConnectionFactory ucConnectionFactory(RabbitProperties rabbitProperties) {
        CachingConnectionFactory cachingConnectionFactory = new CachingConnectionFactory();
        cachingConnectionFactory.setHost(rabbitProperties.getHost());
        cachingConnectionFactory.setPort(rabbitProperties.getPort());
        cachingConnectionFactory.setUsername(rabbitProperties.getUsername());
        cachingConnectionFactory.setPassword(rabbitProperties.getPassword());
        cachingConnectionFactory.setVirtualHost("my_demo");
        return cachingConnectionFactory;
    }


    @Bean("rabbitTemplate")
    @Primary
    public RabbitTemplate rabbitTemplate(@Qualifier("defaultConnectionFactory") ConnectionFactory connectionFactory) {
        RabbitTemplate rabbitTemplate = new RabbitTemplate(connectionFactory);
        rabbitTemplate.setMessageConverter(jsonMessageConverter());
        return rabbitTemplate;
    }


    @Bean("myDemoRabbitTemplate")
    public RabbitTemplate jsonRabbitTemplate(@Qualifier("myDemoConnectionFactory") ConnectionFactory connectionFactory) {
        RabbitTemplate rabbitTemplate = new RabbitTemplate(connectionFactory);
        rabbitTemplate.setMessageConverter(jsonMessageConverter());
        return rabbitTemplate;
    }


    /**
     * 默认(v-host:/)的ListenerContainer
     *
     * @param configurer
     * @param connectionFactory
     * @return
     */
    @Bean(name = "defaultRabbitListenerContainer")
    public SimpleRabbitListenerContainerFactory defaultRabbitListenerContainer(SimpleRabbitListenerContainerFactoryConfigurer configurer,
                                                                               @Qualifier("defaultConnectionFactory") ConnectionFactory connectionFactory) {
        SimpleRabbitListenerContainerFactory factory = new SimpleRabbitListenerContainerFactory();
        configurer.configure(factory, connectionFactory);
        return factory;
    }


    /**
     * /my_demo v-host的ListenerContainer
     *
     * @param configurer
     * @param connectionFactory
     * @return
     */
    @Bean("myDemoRabbitListenerContainer")
    public SimpleRabbitListenerContainerFactory ucRabbitListenerContainer(SimpleRabbitListenerContainerFactoryConfigurer configurer,
                                                                          @Qualifier("myDemoConnectionFactory") ConnectionFactory connectionFactory) {
        SimpleRabbitListenerContainerFactory factory = new SimpleRabbitListenerContainerFactory();
        configurer.configure(factory, connectionFactory);
        return factory;
    }
}

以上每个vhost都配置相应的ConnectionFacotry、RabbitTemplate、RabbitListenerContainerFactory，以确保个vhost的有效性和隔离性，避免出现相关参数共享而出现不可预知的问题。其中ConnectionFactory用于RabbitTemplate和RabbitListenerContainerFactory的连接设置，避免出现混淆。RabbitTemplate用于作为生产者时将消息发送到指定的vhost下，RabbitListenerContainerFactory用于作为消费者时，监听指定vhost下的消息，比如使用注解@RabbitListener的消费消息是，设置属性containerFactory对应的值，即可消费指定vhost消息。

注意，在RabbitMQConfig.java中RabbitProperties是默认的配置，所以配置文件中关于RabbitMQ的相关配置可自动注入到该配置类中，以下多Rabbit实例中，该配置需要自定义，将有所不同，注意区别。

多Rabbit实例

此时，由于要连接多个Rabbit实例，则配置内容也要配置多个，且互不影响，配置文件示例如下

#比如要同时连接开发环境和测试环境
spring.rabbitmq.dev.host=localhost
spring.rabbitmq.dev.port=5672
spring.rabbitmq.dev.username=guest
spring.rabbitmq.dev.password=guest
#spring.rabbitmq.dev.virtual-host=/
spring.rabbitmq.dev.listener.simple.acknowledge-mode=manual

spring.rabbitmq.test.host=localhost
spring.rabbitmq.test.port=5672
spring.rabbitmq.test.username=guest
spring.rabbitmq.test.password=guest
#spring.rabbitmq.test.virtual-host=/
spring.rabbitmq.test.listener.simple.acknowledge-mode=manual

JavaConfig大致如下，基本配置和原有的RabbitProperties一致，只不过区分了环境

@Configuration
public class RabbitMQConfigManager {

    @Data
    @Component
    @ConfigurationProperties(prefix = "spring")
    class RabbitConfig {
        //org.springframework.boot.autoconfigure.amqp.RabbitProperties
        private Map<String, RabbitProperties> rabbitmq;
    }

}

通过这样的JavaConfig定义，属性rabbitmq的key便是环境的名称，这样的配置也不会影响到Spring Boot RabbitMQ默认的配置。

其余配置和多vhost的配置一样，如果每个Rabbit示例中又要处理多个vhost，则每个vhost对应一个ConnectionFacotry、RabbitTemplate、RabbitListenerContainerFactory即可，此时的配置文件则比较繁杂。

关于多vhost和多Rabbit实例的配置，如果哪位仁兄有更优的配置方案，还请不吝赐教！