本範例為RabbitMQ官方教學Java Client Producer及Consumer的實作。
RabbitMQ是用來收發訊息(message)的訊息中介伺服器(message broker server),通常用在不同系統間的非同步訊息溝通。訊息的發送方稱為producer;接收方稱為consumer。
producer將訊息發送給RabbitMQ並存在內部的queue(佇列),然後RabbitMQ再把queue中的訊息轉發給consumer。
RabbitMQ
┌───────────────┐
│ queue │
┌────────┐ │ ┌─┬─┬─┬─┬─┐ │ ┌────────┐
│producer├──────┼─►│ │ │ │ │ ├──┼──────►│consumer│
└────────┘ │ └─┴─┴─┴─┴─┘ │ └────────┘
│ │
└───────────────┘
queue為存放訊息資料的地方(通常是記憶體),其概念同Java的Queue
,為一有順序的資料結構且具有先進先出(FIFO)的特性。
本範例會建立簡單兩個Java應用程式,分別作為發送訊息的producer及consumer。
範例環境:
- RabbitMQ Server (docker)
- Java 1.8
- Maven
- IntelliJ IDEA
producer及consumer皆為Java Maven (Quickstart Archetype)應用程式專案。兩專案的依賴相同,皆需要加入RabbitMQ Java Client及SLF4J的依賴如下。
<dependency>
<groupId>com.rabbitmq</groupId>
<artifactId>amqp-client</artifactId>
<version>5.11.0</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>1.7.30</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-simple</artifactId>
<version>1.7.30</version>
</dependency>
除了加入上述依賴並會使用maven-assembly-plugin
把專案打包成可執行的jar檔。
producer
producer專案名為rabbitmq-producer
,參考完整的pom.xml
設定。
建立一支Producer
類別如下,作用為將訊息發送給RabbitMQ。
使用ConnectionFactory
建立連線Connection
及Channel
物件。呼叫Channel.queueDeclare()
宣告使用的queue名稱為hello
,然後呼叫Channel.basicPublish()
將訊息"Hello World"發送到queue。
Producer
package com.abc.demo;
import com.rabbitmq.client.Channel;
import com.rabbitmq.client.Connection;
import com.rabbitmq.client.ConnectionFactory;
import java.nio.charset.StandardCharsets;
public class Producer {
private static final String QUEUE_NAME = "hello"; // queue的名稱
public static void main(String[] arges) {
ConnectionFactory factory = new ConnectionFactory();
factory.setHost("localhost");
try (
Connection connection = factory.newConnection();
Channel channel = connection.createChannel()
) {
String message = "Hello World!";
channel.queueDeclare(QUEUE_NAME, false, false, false, null);
channel.basicPublish("", QUEUE_NAME, null, message.getBytes(StandardCharsets.UTF_8));
System.out.println(" [x] Sent '" + message + "'");
} catch (Exception e) {
e.printStackTrace();
}
}
}
在專案根目錄執行mvn package
打包為可執行的jar。在專案根目錄的target
中可找到打包好的rabbitmq-producer-jar-with-dependencies.jar
。
consumer
consumer專案名為rabbitmq-consumer
,參考完整的pom.xml
設定。
建立一支Consuemr
類別如下,作用為接收RabbitMQ queue的訊息。
使用ConnectionFactory
建立連線Connection
及Channel
物件。呼叫Channel.queueDeclare()
宣告使用的queue名稱為hello
。呼叫Channel.basicConsume()
設定要接收的queue為hello
,並傳入DeliverCallback
物件作為接收訊息後的callback處理邏輯。
Consumer
package com.abc.demo;
import com.rabbitmq.client.Channel;
import com.rabbitmq.client.Connection;
import com.rabbitmq.client.ConnectionFactory;
import com.rabbitmq.client.DeliverCallback;
import java.nio.charset.StandardCharsets;
public class Consumer {
private static final String QUEUE_NAME = "hello";
public static void main(String[] arges) {
ConnectionFactory factory = new ConnectionFactory();
factory.setHost("localhost");
try {
Connection connection = factory.newConnection();
Channel channel = connection.createChannel();
channel.queueDeclare(QUEUE_NAME, false, false, false, null);
System.out.println(" [*] Waiting for messages. To exit press CTRL+C");
DeliverCallback deliverCallback = (consumerTag, delivery) -> {
String message = new String(delivery.getBody(), StandardCharsets.UTF_8);
System.out.println(" [x] Received '" + message + "'");
};
channel.basicConsume(QUEUE_NAME, true, deliverCallback, consumerTag -> {});
} catch (Exception e) {
e.printStackTrace();
}
}
}
在專案根目錄執行mvn package
打包為可執行的jar。在專案根目錄的target
中可找到打包好的rabbitmq-consumer-jar-with-dependencies.jar
。
測試
啟動RabbitMQ Server,然後在命令列使用java -jar rabbitmq-producer-jar-with-dependencies.jar
執行producer如下。
$ java -jar rabbitmq-producer-jar-with-dependencies.jar
[x] Sent 'Hello World!'
執行後會將"Hello World"訊息發送到RabbitMQ名為hello的queue。
在執行consumer前可在RabbitMQ的host使用rabbitmqctl list_queues
列出現有的queue,可以看到名為hello的queue中有一個message。
root@b9f73c3c6f51:/# rabbitmqctl list_queues
Timeout: 60.0 seconds ...
Listing queues for vhost / ...
name messages
hello 1
接著開啟另一個命令列執行java -jar rabbitmq-consumer-jar-with-dependencies.jar
啟動consumer來接收hello queue的訊息如下。可以看到接收到"Hello World"訊息並印出。
$ java -jar rabbitmq-consumer-jar-with-dependencies.jar
[*] Waiting for messages. To exit press CTRL+C
[x] Received 'Hello World!'
再一次於RabbitMQ的host使用rabbitmqctl list_queues
列出現有的queue,可以看到名為hello的queue的message變成0了,因為已經被consumer接受消費掉了。
root@b9f73c3c6f51:/# rabbitmqctl list_queues
Timeout: 60.0 seconds ...
Listing queues for vhost / ...
name messages
hello 0
沒有留言:
張貼留言