SpringBoot中Rabbit的基本使用和自動配置原理

1 一個簡單的示例

在Spring Boot項目中使用spring-rabbit時，需要經過以下幾個步驟：

1. 引入依賴。
2. 配置基本連接信息。
3. 創建消息發布者，並發送消息。
4. 創建消息消費者，監聽消息並處理。

我們以一個簡單的例子開始，展示這個基本過程。

1.1 引入依賴

如果是Maven項目，需要在pom.xml文件中引入基本依賴如下：

<dependency>
    <groupId>org.springframework.amqp</groupId>
    <artifactId>spring-rabbit</artifactId>
    <version>2.3.10</version>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-autoconfigure</artifactId>
    <version>2.5.5</version>
</dependency>

其中：

• spring-rabbit用於與RabbitMQ服務器交互的工具包
• spring-boot-autoconfigure用於自動配置RabbitMQ客戶端與服務器連接等基本信息。

1.2 配置連接信息

由於spring-boot-autoconfigure的自動配置功能，我們僅需要在application.yml文件中配置連接信息即可。以下是一個例子：

spring:
  rabbitmq:
    host: localhost
    port: 5672
    username: guest
    password: guest
    virtual-host: /

其中：

• host：服務器地址。
• port：服務器端口。
• username：用戶名。
• password：密碼。
• virtual-host：交換機/隊列所屬虛擬主機。

1.3 消息發布者&消費者

我們直接在Spring Boot主程序中簡單編寫一個發布&接收消息的示例：

@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }

    @Bean
    public Queue myQueue() {
        return new Queue("myQueue");
    }

    @RabbitListener(queues = "myQueue")
    public void listen(String in) {
        System.out.println(in);
    }

    @Bean
    public ApplicationRunner runner(AmqpTemplate template) {
        return args -> template.convertAndSend("myQueue", "Hello World!");
    }
}

我們在這段代碼中做了如下工作：

1. 聲明隊列myQueue。
2. 創建消息消費者，監聽隊列myQueue。
3. 使用AmqpTemplate對象，向消息隊列myQueue發送消息：Hello World!。

1.4 啟動項目

如果我們在本地啟動了RabbitMQ服務器，並且端口、用戶名和密碼都沒有問題。

那么啟動項目，可以從控制台得到如下輸出：

Hello World!

1.5 提出問題

不知道大家會不會有這些疑問：

1. 為什么在application.yml文件中寫入這些字符就可以連接到RabbitMQ服務器？
2. AmqpTemplate對象為什么不用聲明就可以直接使用？

其實，這一切的功勞都歸因於我們引入了spring-boot-autoconfigure。它為我們做了以下基本工作：

1. 從application.yml文件中讀取基本配置信息。
2. 使用基本配置信息為我們創建出AmqpTemplate等對象，存放到Spring容器中。

接下來，由我來給大家揭開spring-boot-autoconfigure為spring-rabbit自動配置的面紗。

2 RabbitProperties

2.1 看看源碼

在spring-boot-autoconfigure依賴的org.springframework.boot.autoconfigure.amqp包下，有個RabbitProperties類。

它的作用是：從application.yml文件中讀取到spring-rabbit相關配置信息。

在IDEA中，我們可以簡單使用以下方法進入到這個類。

方法一，從application.yml文件進入：

• 在application.yml文件中，按住Ctrl鍵，鼠標左鍵點擊某個配置信息。

方法二，搜索：

• 快速連續按兩下Shift鍵，跳出搜索框進行搜索。

RabbitProperties源碼簡要如下：

package org.springframework.boot.autoconfigure.amqp;

@ConfigurationProperties(prefix = "spring.rabbitmq")
public class RabbitProperties {
   private static final int DEFAULT_PORT = 5672;
   private static final int DEFAULT_PORT_SECURE = 5671;
   private String host = "localhost";
   private Integer port;
   private String username = "guest";
   private String password = "guest";
   private final Ssl ssl = new Ssl();
   private String virtualHost;
   private String addresses;
   private AddressShuffleMode addressShuffleMode = AddressShuffleMode.NONE;
   @DurationUnit(ChronoUnit.SECONDS)
   private Duration requestedHeartbeat;
   private int requestedChannelMax = 2047;
   private boolean publisherReturns;
   private ConfirmType publisherConfirmType;
   private Duration connectionTimeout;
   private Duration channelRpcTimeout = Duration.ofMinutes(10);
   private final Cache cache = new Cache();
   private final Listener listener = new Listener();
   private final Template template = new Template();
   private List<Address> parsedAddresses;
}

2.2 功能講解

通過簡單閱讀RabbitProperties，我們可以發現兩點重要信息：

• 該類添加了@ConfigurationProperties(prefix = "spring.rabbitmq")注解。
• 該類的部分成員變量名與application.yml中配置信息名一致，例如host、port、username、password和virtual-host。

在此我們需要先簡單了解@ConfigurationProperties注解的功能：

1. @ConfigurationProperties可以用來獲取外部配置信息，默認是application.yml等Spring Boot配置文件。
2. 將該注解添加到類上，會通過setter（默認）或constructor方法的方式，將外部配置信息賦值給對應成員變量。
3. prefix可以指定配置文件中的前綴，用來將外部配置信息與成員變量進行匹配。

回到RabbitProperties源碼，我們應該很容易理解RabbitProperties的功能：

1. 從application.yml文件中讀取前綴為spring.rabbitmq的配置信息。
2. 將setter方法將配置信息賦值給對應的成員變量。

通過上述過程，完成了將配置信息從文件讀取到緩存（RabbitProperties對象）的過程，以便於后續使用。

2.3 動手實戰

我們也可以編寫一個類似的MyRabbitProperties，用來從application.yml文件中讀取RabbitMQ配置信息。

2.3.1 MyRabbitProperties

代碼如下：

@ConfigurationProperties(prefix = "spring.rabbitmq")
public class MyRabbitProperties {
    private String host;
    private Integer port;
    private String username;
    private String password;
    private String virtualHost;

    public void setHost(String host) {
        this.host = host;
    }

    public void setPort(Integer port) {
        this.port = port;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public void setPassword(String password) {
        this.password = password;
    }

    public void setVirtualHost(String virtualHost) {
        this.virtualHost = virtualHost;
    }

    @Override
    public String toString() {
        return "MyRabbitProperties{" +
                "host='" + host + '\'' +
                ", port=" + port +
                ", username='" + username + '\'' +
                ", password='" + password + '\'' +
                ", virtualHost='" + virtualHost + '\'' +
                '}';
    }
}

簡要說明：

• 添加@ConfigurationProperties(prefix = "spring.rabbitmq")，用來從application.yml文件中讀取前綴為spring.rabbitmq的配置信息。
• 添加setter方法，用來為成員變量注入配置信息。
• 添加toString()方法，便於后續打印信息。

2.3.2 application.yml

我們在application.yml文件中寫入如下配置信息：

spring:
  rabbitmq:
    host: localhost
    port: 5672
    username: guest
    password: guest
    virtual-host: /

2.3.3 啟動類

我們簡單編寫如下啟動類：

@EnableConfigurationProperties(MyRabbitProperties.class)
@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
    
    @Bean
    public ApplicationRunner runner(MyRabbitProperties properties) {
        return args -> {
            System.out.println(properties);
        };
    }
}

簡要說明：

• 添加SpringBootApplication注解，表明這是一個Spring Boot啟動類。
• 添加@EnableConfigurationProperties(MyRabbitProperties.class)注解，可以將@ConfigurationProperties標注的類聲明為Bean。這樣Spring容器才能為MyRabbitProperties注入配置信息。
• 添加main()函數，用來啟動Spring Boot項目。
• 聲明ApplicationRunner為Bean，項目啟動后會執行其中的代碼。

需要注意的是：聯合@EnableConfigurationProperties只是@ConfigurationProperties注解使用方式的一種。我們也可以直接在MyRabbitProperties類上標注@Configuration或@Component等注解，直接聲明為Bean。

2.3.4 啟動項目

啟動項目后，可以從控制台中得到如下輸出，說明我們成功將配置信息注入到MyRabbitProperteis對象中：

MyRabbitProperties{host='localhost', port=5672, username='guest', password='guest', virtualHost='/'}

3 RabbitAutoConfiguration

通過RabbitProperteis我們已經從application.yml文件中獲取到了連接RabbitMQ服務器的配置信息，接下來我們繼續揭秘：

• spring-boot-autoconfigure為我們預先創建了哪些Bean？
• 它是如何創建這些Bean的？

預先小結：這些功能都在RabbitAutoConfiguration中。

3.1 看看源碼

在spring-boot-autoconfigure依賴的org.springframework.boot.autoconfigure.amqp包下，有個RabbitAutoConfiguration類。

它的作用是，當類路徑中存在RabbitMQ和Spring AMQP客戶端類庫時，可能會為我們自動創建如下Bean：

• org.springframework.amqp.rabbit.connection.CachingConnectionFactory：創建客戶端與RabbitMQ服務器連接的工廠。
• org.springframework.amqp.core.AmqpAdmin：封裝了聲明交換機/消息隊列/綁定等模板方法。
• org.springframework.amqp.rabbit.core.RabbitTemplate：封裝了與RabbitMQ服務器交互的模板方法，例如：發送消息和接收消息等。
• org.springframework.amqp.rabbit.core.RabbitMessagingTemplate：功能與RabbitTemplate相同，但底層使用org.springframework.messaging.Message作為消息抽象，較少使用。

在IDEA中，我們可以簡單使用以下方法進入到這個類：

• 快速連續按兩下Shift鍵，跳出搜索框進行搜索。

其源碼結構如下：

package org.springframework.boot.autoconfigure.amqp;

@Configuration(proxyBeanMethods = false)
@ConditionalOnClass({ RabbitTemplate.class, Channel.class })
@EnableConfigurationProperties(RabbitProperties.class)
@Import(RabbitAnnotationDrivenConfiguration.class)
public class RabbitAutoConfiguration {

    // 創建連接工廠Bean
   protected static class RabbitConnectionFactoryCreator {}

    // 創建RabbitTemplate和AmqpAdmin
   protected static class RabbitTemplateConfiguration {}

    // 創建RabbitMessagingTemplate
   protected static class MessagingTemplateConfiguration {}
}

3.2 功能講解

通過簡單閱讀源碼，我們可以將其分成四個部分進行介紹：

1. RabbitAutoConfiguration標注注解：自動配置主類。
2. RabbitConnectionFactoryCreator內部類：創建連接工廠，默認為CachingConnectionFactory。
3. RabbitTemplateConfiguration內部類：創建RabbitTemplate和AmqpAdmin。
4. MessagingTemplateConfiguration內部類：創建RabbitMessagingTemplate。

接下來，我們分別來介紹它們的功能。

3.2.1 配置主類

RabbitAutoConfiguration配置主類標注如以下四個注解：

• @Configuration(proxyBeanMethods = false)
• @ConditionalOnClass({ RabbitTemplate.class, Channel.class })
• @EnableConfigurationProperties(RabbitProperties.class)
• @Import(RabbitAnnotationDrivenConfiguration.class)

1、@Configuration(proxyBeanMethods = false)

@Configuration將RabbitAutoConfiguration標注成配置類，可以在其內部聲明Bean。

proxyBeanMethods = false表示Spring容器不會動態代理內部用@Bean標注的方法，可以提高性能。

2、@ConditionalOnClass({ RabbitTemplate.class, Channel.class })

@ConditionalOnClass注解表示只有當類路徑中存在以下類時，才會將RabbitAutoConfiguration注冊成Bean：

• org.springframework.amqp.rabbit.core.RabbitTemplate
• com.rabbitmq.client.Channel

也就是說，只有在類路徑中存在RabbitMQ和Spring AMQP客戶端類庫，Spring容器才會為我們對RabbitMQ進行自動配置。

4、@EnableConfigurationProperties(RabbitProperties.class)

@EnableConfigurationProperties與@ConfigurationProperties注解聯用，可以將RabbitProperties注冊成Bean，從而將配置信息從application.yml讀取到內存中。

5、@Import(RabbitAnnotationDrivenConfiguration.class)

@Import注解可以引入另外的配置類——RabbitAnnotationDrivenConfiguration：用於配置Spring AMQP注解驅動斷點。

簡單來說，它為我們注冊了如下Bean：

• org.springframework.amqp.rabbit.config.SimpleRabbitListenerContainerFactory：創建SimpleMessageListenerContainer的工廠。
• DirectRabbitListenerContainerFactory：創建DirectMessageListenerContainer的工廠。

這兩個XxxListenerContainer主要用來監聽RabbitMQ服務器發送的消息。

因此，RabbitAnnotationDrivenConfiguration配置類主要與監聽消息有關。由於篇幅限制，這里就不進行深入講解了。其源碼結構如下：

package org.springframework.boot.autoconfigure.amqp;

@Configuration(proxyBeanMethods = false)
@ConditionalOnClass(EnableRabbit.class)
class RabbitAnnotationDrivenConfiguration {

   @Bean
   @ConditionalOnMissingBean
   SimpleRabbitListenerContainerFactoryConfigurer simpleRabbitListenerContainerFactoryConfigurer() {}

   @Bean(name = "rabbitListenerContainerFactory")
   @ConditionalOnMissingBean(name = "rabbitListenerContainerFactory")
   @ConditionalOnProperty(prefix = "spring.rabbitmq.listener", name = "type", havingValue = "simple",
         matchIfMissing = true)
   SimpleRabbitListenerContainerFactory simpleRabbitListenerContainerFactory(}

   @Bean
   @ConditionalOnMissingBean
   DirectRabbitListenerContainerFactoryConfigurer directRabbitListenerContainerFactoryConfigurer() {}

   @Bean(name = "rabbitListenerContainerFactory")
   @ConditionalOnMissingBean(name = "rabbitListenerContainerFactory")
   @ConditionalOnProperty(prefix = "spring.rabbitmq.listener", name = "type", havingValue = "direct")
   DirectRabbitListenerContainerFactory directRabbitListenerContainerFactory(}

   @Configuration(proxyBeanMethods = false)
   @EnableRabbit
   @ConditionalOnMissingBean(name = RabbitListenerConfigUtils.RABBIT_LISTENER_ANNOTATION_PROCESSOR_BEAN_NAME)
   static class EnableRabbitConfiguration {}

}

3.2.2 RabbitConnectionFactoryCreator內部類

RabbitConnectionFactoryCreator內部類的作用是：注冊CachingConnectionFactory作為連接工廠Bean。

其頭部標注了以下兩個注解：

• @Configuration(proxyBeanMethods = false)：聲明為配置類。
• @ConditionalOnMissingBean(ConnectionFactory.class)：只有org.springframework.amqp.rabbit.connection.ConnectionFactory類存在時才會生效，即只有類路徑中添加了spring-rabbit依賴時才會生效。

其內部默認將CachingConnectionFactory注冊為連接工廠Bean，步驟如下：

1. 實例化CachingConnectionFactory對象。
2. 將配置文件中的配置信息注入到CachingConnectionFactory對象中。

其源碼簡要如下：

@Configuration(proxyBeanMethods = false)
@ConditionalOnMissingBean(ConnectionFactory.class)
protected static class RabbitConnectionFactoryCreator {

    // 注冊CachingConnectionFactory作為連接工廠Bean
   @Bean
   public CachingConnectionFactory rabbitConnectionFactory(RabbitProperties properties,
         ResourceLoader resourceLoader, ObjectProvider<CredentialsProvider> credentialsProvider,
         ObjectProvider<CredentialsRefreshService> credentialsRefreshService,
         ObjectProvider<ConnectionNameStrategy> connectionNameStrategy,
         ObjectProvider<ConnectionFactoryCustomizer> connectionFactoryCustomizers) throws Exception {
       // 1、實例化CachingConnectionFactory對象
      com.rabbitmq.client.ConnectionFactory connectionFactory = getRabbitConnectionFactoryBean(properties,
            resourceLoader, credentialsProvider, credentialsRefreshService).getObject();
      connectionFactoryCustomizers.orderedStream()
            .forEach((customizer) -> customizer.customize(connectionFactory));
      CachingConnectionFactory factory = new CachingConnectionFactory(connectionFactory);
       // 2、將配置文件中的配置信息注入到CachingConnectionFactory對象中
      PropertyMapper map = PropertyMapper.get();
      map.from(properties::determineAddresses).to(factory::setAddresses);
       // 省略其他map.from().to()方法
      return factory;
   }

    // 實例化RabbitConnectionFactoryBean對象
   private RabbitConnectionFactoryBean getRabbitConnectionFactoryBean(RabbitProperties properties,
         ResourceLoader resourceLoader, ObjectProvider<CredentialsProvider> credentialsProvider,
         ObjectProvider<CredentialsRefreshService> credentialsRefreshService) {
       // 省略
      return factory;
   }

}

3.2.3 RabbitTemplateConfiguration內部類

RabbitTemplateConfiguration內部類的作用是：注冊RabbitTemplate和AmqpAdmin作為交互模板Bean。

其頭部標注了以下兩個注解：

• @Configuration(proxyBeanMethods = false)：聲明為配置類。
• @Import(RabbitConnectionFactoryCreator.class)：引入RabbitConnectionFactoryCreator配置類。

其內部默認注冊RabbitTemplate和AmqpAdmin作為交互模板Bean，本質上就是實例化對象。源碼簡要如下：

@Configuration(proxyBeanMethods = false)
@Import(RabbitConnectionFactoryCreator.class)
protected static class RabbitTemplateConfiguration {

   @Bean
   @ConditionalOnMissingBean
   public RabbitTemplateConfigurer rabbitTemplateConfigurer(RabbitProperties properties,
         ObjectProvider<MessageConverter> messageConverter,
         ObjectProvider<RabbitRetryTemplateCustomizer> retryTemplateCustomizers) {
      RabbitTemplateConfigurer configurer = new RabbitTemplateConfigurer();
      configurer.setMessageConverter(messageConverter.getIfUnique());
      configurer
         .setRetryTemplateCustomizers(retryTemplateCustomizers.orderedStream().collect(Collectors.toList()));
      configurer.setRabbitProperties(properties);
      return configurer;
   }

    // 注冊RabbitTemplate
   @Bean
   @ConditionalOnSingleCandidate(ConnectionFactory.class)
   @ConditionalOnMissingBean(RabbitOperations.class)
   public RabbitTemplate rabbitTemplate(RabbitTemplateConfigurer configurer, ConnectionFactory connectionFactory) {
      RabbitTemplate template = new RabbitTemplate();
      configurer.configure(template, connectionFactory);
      return template;
   }

    // 注冊AmqpAdmin
   @Bean
   @ConditionalOnSingleCandidate(ConnectionFactory.class)
   @ConditionalOnProperty(prefix = "spring.rabbitmq", name = "dynamic", matchIfMissing = true)
   @ConditionalOnMissingBean
   public AmqpAdmin amqpAdmin(ConnectionFactory connectionFactory) {
      return new RabbitAdmin(connectionFactory);
   }

}

3.2.4 MessagingTemplateConfiguration內部類

MessagingTemplateConfiguration內部類的作用是：注冊RabbitMessagingTemplate作為交互模板Bean。

RabbitMessagingTemplate與RabbitTemplate的功能沒有本質差別，它們的差別在於繼承結構不同：

• RabbitMessagingTemplate：繼承自org.springframework.messaging.core.AbstractMessageSendingTemplate抽象類。
• RabbitTemplate：繼承自org.springframework.amqp.rabbit.connection.RabbitAccessor抽象類。

項目中通常使用的是RabbitTemplate。

MessagingTemplateConfiguration內部類的源碼如下：

@Configuration(proxyBeanMethods = false)
@ConditionalOnClass(RabbitMessagingTemplate.class)
@ConditionalOnMissingBean(RabbitMessagingTemplate.class)
@Import(RabbitTemplateConfiguration.class)
protected static class MessagingTemplateConfiguration {

   @Bean
   @ConditionalOnSingleCandidate(RabbitTemplate.class)
   public RabbitMessagingTemplate rabbitMessagingTemplate(RabbitTemplate rabbitTemplate) {
      return new RabbitMessagingTemplate(rabbitTemplate);
   }
}

4 總結

通過以上的簡單介紹，想必大家對Spring Boot項目中spring-rabbit的自動配置有了大概的了解。

Spring Boot對其他工具，如：spring-web、spring-security、spring-datasource、spring-transaction、spring-kafka以及spring.jackson等都采用類似的自動配置方式，大家可以采用本文類似的步驟閱讀相關源碼。

本篇文章就到這里了，希望大家身體健康，工作順利！