Help & Documentation>TDMQ for RocketMQ

Downloading and Running Demo

Last updated: 2024-10-14 11:30:01

Scenario

This document describes how to use open-source SDK to send and receive messages by using the SDK for Java as an example and helps you better understand the message sending and receiving processes.
Note
The following takes the Java client as an example. For clients in other languages, see SDK Documentation.

Preparations

Instructions

Step 1. Install the Java dependent library

Introduce dependencies in a Java project and add the following dependencies to the pom.xml file. This document uses a Maven project as an example.
Note
The dependency version must be v4.9.3 or later.
<!-- in your <dependencies> block -->
<dependency>
<groupId>org.apache.rocketmq</groupId>
<artifactId>rocketmq-client</artifactId>
<version>4.9.3</version>
</dependency>

<dependency>
<groupId>org.apache.rocketmq</groupId>
<artifactId>rocketmq-acl</artifactId>
<version>4.9.3</version>
</dependency>

Step 2. Produce messages

1. Create message producers

// Instantiate the message producer
DefaultMQProducer producer = new DefaultMQProducer(
namespace,
groupName,
new AclClientRPCHook(new SessionCredentials(accessKey, secretKey))
// ACL permissions
);
// Set the Nameserver address
producer.setNamesrvAddr(nameserver);
// Start the producer instance
producer.start();
Category
Note
namespace
Namespace name, which can be copied under the Namespace tab in the console.

groupName
Producer group name, which can be copied under the Group tab on the Cluster page in the console.
nameserver
Copy the cluster access address from the Network module on the cluster's basic information page in the console.
secretKey
Copy the role name from the Role Management page.
accessKey
Copy the role key from the Role Management page by clicking on the copy option in the key column.


2. Send a message

There are various methods to send messages: synchronous sending, asynchronous sending, one-way sending, and so forth.
Synchronous sending
for (int i = 0; i < 10; i++) {
// Instantiate a message, set the topic and message content
Message msg = new Message(topic_name, "TAG", ("Hello RocketMQ " + i).getBytes(RemotingHelper.DEFAULT_CHARSET));
// Send the message
SendResult sendResult = producer.send(msg);
System.out.printf("%s%n", sendResult);
}
Category
Note
topic_name
Topic name, which can be copied under the Topic tab on the Cluster page in the console.
TAG
A parameter used to set the message tag.
Asynchronous sending
// Disable retry upon sending failures
producer.setRetryTimesWhenSendAsyncFailed(0);
// Set the number of messages to be sent
int messageCount = 10;
final CountDownLatch countDownLatch = new CountDownLatch(messageCount);
for (int i = 0; i < messageCount; i++) {
try {
final int index = i;
// Construct a message entity, set the topic and message content
Message msg = new Message(topic_name, "TAG", ("Hello rocketMq " + index).getBytes(RemotingHelper.DEFAULT_CHARSET));
producer.send(msg, new SendCallback() {
@Override
public void onSuccess(SendResult sendResult) {
// Logic for message sending successes
countDownLatch.countDown();
System.out.printf("%-10d OK %s %n", index, sendResult.getMsgId());
}

@Override
public void onException(Throwable e) {
// Logic for message sending failures
countDownLatch.countDown();
System.out.printf("%-10d Exception %s %n", index, e);
e.printStackTrace();
}
});
} catch (Exception e) {
e.printStackTrace();
}
}
countDownLatch.await(5, TimeUnit.SECONDS);
Category
Note
topic_name
Topic name, which can be copied under the Topic tab on the Cluster page in the console.
TAG
A parameter used to set the message tag.
One-way sending
for (int i = 0; i < 10; i++) {
// Instantiate a message, set the topic and message content
Message msg = new Message(topic_name, "TAG", ("Hello RocketMQ " + i).getBytes(RemotingHelper.DEFAULT_CHARSET));
// Send one-way messages
producer.sendOneway(msg);
}
Category
Note
topic_name
Topic name, which can be copied under the Topic tab on the Cluster page in the console.
TAG
A parameter used to set the message tag.
Note
For more information on batch sending or other scenarios, see Demo or Community Documentation.

Step 3. Consume messages

1. Create a consumer

TDMQ for RocketMQ supports two consumption modes: push and pull.
Push consumer
// Instantiate the consumer
DefaultMQPushConsumer pushConsumer = new DefaultMQPushConsumer(
namespace,
groupName,
new AclClientRPCHook(new SessionCredentials(accessKey, secretKey))); //ACL Permission
// Set the Nameserver address
pushConsumer.setNamesrvAddr(nameserver);
Category
Note
namespace
Namespace name, which can be copied under the Namespace tab in the console.



groupName
Producer group name, which can be copied under the Group tab on the Cluster page in the console.
nameserver
Copy the cluster access address from the Network module on the cluster's basic information page in the console.
secretKey
Copy the role name from the Role Management page.
accessKey
Copy the role key from the Role Management page by clicking on the copy option in the key column.



Pull consumer
// Instantiate the consumer
DefaultLitePullConsumer pullConsumer = new DefaultLitePullConsumer(
namespace,
groupName,
new AclClientRPCHook(new SessionCredentials(accessKey, secretKey)));
// Set the Nameserver address
pullConsumer.setNamesrvAddr(nameserver);
// Specify the first offset as the start offset for consumption
pullConsumer.setConsumeFromWhere(ConsumeFromWhere.CONSUME_FROM_FIRST_OFFSET);
Category
Note
namespace
Namespace name, which can be copied on the Namespace tab on the cluster details page in the console. Its format is cluster ID + | + namespace.
groupName
Producer group name, which can be copied under the Group tab on the Cluster page in the console.
nameserver
Cluster access address, which can be obtained from Access Address in the Operation column on the Cluster page in the console.
secretKey
Copy the role name from the Role Management page.
accessKey
Copy the role key from the Role Management page by clicking on the copy option in the key column.

Note
For more consumption mode information, see Demo or RocketMQ documentation.

2. Subscribe to messages

The subscription modes vary by consumption mode.
Push subscription
// Subscribe to a topic
pushConsumer.subscribe(topic_name, "*");
// Register a callback implementation class to process messages pulled from the broker
pushConsumer.registerMessageListener((MessageListenerConcurrently) (msgs, context) -> {
// Message processing logic
System.out.printf("%s Receive New Messages: %s %n", Thread.currentThread().getName(), msgs);
// Mark the message as being successfully consumed, returning the handling status based on the consumption situation.
return ConsumeConcurrentlyStatus.CONSUME_SUCCESS;
});
// Start the consumer instance
pushConsumer.start();
Category
Note
topic_name
Topic name, which can be copied under the Topic tab on the Cluster page in the console.
"*"
If the subscription expression is left empty or specified as asterisk (*), all messages are subscribed to. tag1 || tag2 || tag3 means subscribing to multiple types of tags.
Pull subscription
// Subscribe to a topic
pullConsumer.subscribe(topic_name, "*");
// Start the consumer instance
pullConsumer.start();
try {
System.out.printf("Consumer Started.%n");
while (true) {
// Pull the message
List<MessageExt> messageExts = pullConsumer.poll();
System.out.printf("%s%n", messageExts);
}
} finally {
pullConsumer.shutdown();
}
Category
Note
topic_name
Topic name, which can be copied under the Topic tab on the Cluster page in the console.
"*"
If the subscription expression is left empty or specified as asterisk (*), all messages are subscribed to. tag1 || tag2 || tag3 means subscribing to multiple types of tags.

Step 4. View consumption details

Log in to the TDMQ Console, navigate to Cluster Management > Group page to view the list of clients connected to the Group. Click View Details in the operation column to view consumer details.

Note
The above is a succinct overview of the methods for publishing and subscribing to messages. For additional operations, refer to the Demo or consult the Community Documentation.