RabbitMQ 入门案例项目

写在前面

本文不作消息队列的实现原理、异步处理优劣、rabbitmq安装说明、消息工作模式等内容分析，只讲述rabbitmq实际开发中的步骤说明，帮助同学快速上手体验消息队列的使用。

本文使用SpringAMQP，并非rabbitmq官方文档上的原生http请求连接。

步骤

1. 导入依赖

导入spring-boot-dependencies依赖，这步也可以直接用标签继承spring-boot来替代。不喜欢折腾就直接复制粘贴即可，我这里的spring-boot.version是2.3.7-RELEASE。关键依赖是spring-boot-starter-amqp，这里面集成了AMQP协议的工具类。spring-boot-starter-test用于测试发送mq消息。

    <dependencyManagement>
        <dependencies>
           	<dependency>
                <groupId>org.springframework.bootgroupId>
                <artifactId>spring-boot-dependenciesartifactId>
                <version>${spring-boot.version}version>
                <type>pomtype>
                <scope>importscope>
            dependency>
        dependencies>
    dependencyManagement>

    <dependencies>
        <dependency>
            <groupId>org.springframework.bootgroupId>
            <artifactId>spring-boot-starter-amqpartifactId>
        dependency>
        <dependency>
            <groupId>org.springframework.bootgroupId>
            <artifactId>spring-boot-starter-testartifactId>
        dependency>
    dependencies>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

2. 编写application.yml

关键的配置就这些，如果你的rabbitmq是安装在服务器上的，host就是服务器的ip；连接端口号默认是5672；
virtual-host可能有些同学不知道怎么看，可以看我图中的标识的位置，如果你有多个用户，一定要找到你连接的用户对应的Name

spring:
  rabbitmq:
    host: localhost
    port: 5672
    virtual-host: /
    username: guest
    password: guest123
1
2
3
4
5
6
7

3. 编写启动类

启动类是一定要有的，否则不存在spring容器环境，spring-boot-starter-test也无法使用。

@SpringBootApplication
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}
1
2
3
4
5
6
7

4. 编写测试类

在test目录下，创建好包，再创建一个名为SpringAmqpTest的测试类，在里面编写一个消息发送方法。

@RunWith注解不能省略！这是spring容器上下文的环境，省略后会出现找不到bean等一些错误。

RabbitTemplate 可直接通过@Autowired注入，因为在spring-boot-starter-amqp已经将bean放入到容器里面了。

调用里面的converAndSend即可向simple.queue消息队列中发送消息

@RunWith(SpringRunner.class)
@SpringBootTest
public class SpringAmqpTest {

    @Autowired
    private RabbitTemplate rabbitTemplate;

    @Test
    public void testSend() {
        String queueName = "simple.queue";
        String message = "hello world!";
        rabbitTemplate.convertAndSend(queueName,message);
    }
    
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

4. 在RabbitMQ控制台创建simple.queue队列

第一步，登录RabbitMQ控制台，点击queue->add a new queue

输入名称后，点击add queue即可，注意名称需要和你在代码上写的queueName一致

创建完成之后，点击一下刷新，会出现刚创建的queue，total为0，说明没有消息

5. 向simple.queue中发送消息

执行刚编写的测试方法

查看控制台日志打印，这样就是发送成功了

在RabbitMQ控制台上可以看到刚发送的消息

点击simple.queue这个标题，可以对queue进行一些操作，比如说我们要查看queue的消息

我们可以看到刚推送上来的消息内容

6. 消息消费

消息推送上去之后，我们要对这个queue进行监听，随后进行操作，这是我们正常的需求。

你可以在另外的工程里，配置rabbitmq的连接，监听simple.queue这个队列进行消息消费。

在案例中，我就偷懒省事，不额外新建项目了，直接在同一个工程中添加消息消费。

关键代码是@RabbitListener注解，这个注解实现了对simple.queue队列的监听，当队列中存入消息时，事件监听模型会通知到下面的listenSimpleQueue方法，自动执行该方法。

@Component
public class RabbitMqListener {

    @RabbitListener(queues = "simple.queue")
    public void listenSimpleQueue(String msg) {
        System.out.println("listen: "+msg);
    }
}
1
2
3
4
5
6
7
8

7. 启动Application

消费者接受mq是需要启动项目的。由于上面操作我们的消息队列中是存入一条消息，所以当项目启动，消费者会立刻监听到消息。

我们试一下，在生产者发送消息，能不能被消费者消费，在testSend方法，我多加了几个叹号

执行后，消费者能立刻消费

到此入门案例结束，相信你也入门了SpringAMQP连接RabbitMQ的使用体验了。