tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
TDMQ for RocketMQ
    Documentation
    Download PDF

    Use of Spring Boot Starter

    Last updated: 2024-01-17 16:57:41
    Download PDF

      Overview

      This document describes how to use the open-source SDK to send and receive messages with the Spring Boot Starter SDK serving as example, for you to better understand the complete procedure involved in message sending and receiving.

      Prerequisites

      You have created the required resources.
      You have installed JDK 1.8 or later.
      You have installed Maven 2.5 or later.
      You have downloaded the Demo or visited the GitHub Project.

      Directions:

      Step 1: Incorporating Dependencies

      Introduce dependencies of to pom.xml.
      <dependency>
          <groupId>org.apache.rocketmq</groupId>
          <artifactId>rocketmq-spring-boot-starter</artifactId>
          <version>2.2.2</version>
           <exclusions>    
                   <exclusion>        
                       <groupId>org.apache.rocketmq</groupId>        
                       <artifactId>rocketmq-client</artifactId>    
                   </exclusion>    
                   <exclusion>        
                       <groupId>org.apache.rocketmq</groupId>        
                       <artifactId>rocketmq-acl</artifactId>    
                    </exclusion>
            </exclusions>
      </dependency>
       <dependency>    
                  <groupId>org.apache.rocketmq</groupId>    
                  <artifactId>rocketmq-client</artifactId>    
                  <version>4.9.7</version>
              </dependency>
              <dependency>    
                  <groupId>org.apache.rocketmq</groupId>    
                  <artifactId>rocketmq-acl</artifactId>    
                  <version>4.9.7</version>
       </dependency>

      Step 2: Preparing Configurations

      Add configuration information to the configuration file.
      server:
           port: 8082
      
         # rocketmq configuration information
         rocketmq:
           # Service access address of TDMQ for RocketMQ
           name-server: rocketmq-xxx.rocketmq.ap-bj.public.tencenttdmq.com:8080
           # Producer configurations
           producer:
             # Producer group name
             group: group111
             # Role key
             access-key: eyJrZXlJZC....
             # Name of the authorized role
             secret-key: admin
           # Common configurations for the consumer
           consumer:
             # Role key
             access-key: eyJrZXlJZC....
             # Name of the authorized role
             secret-key: admin
      
           # Custom configurations
      
           producer1:
             topic: testdev1
           consumer1:
             group: group111
             topic: testdev1
             subExpression: TAG1
           consumer2:
             group: group222
             topic: testdev1
             subExpression: TAG2
      Parameter
      Description
      name-server
      Cluster access address in the basic information of the cluster. Select either the private network or public network access address as needed.
      
      group
      Producer group name, which can be copied from the Group tab on the console.
      secret-key
      Role name, which can be copied from SecretKey on the Cluster Permission page.
      access-key
      Role key, which can be copied from accessKey on the Cluster Permission page.
      
      topic
      Topic name, which can be copied from the Topic tab on the console.
      subExpression
      Used to set the message tag.

      Step 3: Sending the Message

      1. Inject RcoketMQTemplate into the class in the message that needs to be sent.
      @Value("${rocketmq.producer1.topic}")
            private String topic;  // Topic name 
      
            @Autowired
            private RocketMQTemplate rocketMQTemplate;
      2. Send the message. The message body can either be a custom object or a message object (from the org.springframework.messaging package).
      SendResult sendResult = rocketMQTemplate.syncSend(destination, message);
      /*------------------------------------------------------------------------*/
      rocketMQTemplate.syncSend(destination, MessageBuilder.withPayload(message).build())
      3. The following is a complete sample.
      /**
      * Description: Message producer
      */
      @Service
      public class SendMessage {
      // Concatenate the topic name because the full name is required. Alternatively, you can set it by yourself. Format: topic name
       @Value("${rocketmq.producer1.topic}")
       private String topic;
           @Autowired
       private RocketMQTemplate rocketMQTemplate;
               /**
          * Synchronously sending
          *
          * @param message message content
          * @param tags    subscription tags
          */
       public void syncSend(String message, String tags) {
               // springboot does not support the use of headers to pass tags. Tags must be appended to the topic name as required. formats: `topicName:tags`. No concatenation indicates that there are no tags.
               String destination = StringUtils.isBlank(tags) ? topic : topic + ":" + tags;
               SendResult sendResult = rocketMQTemplate.syncSend(destination,
                               MessageBuilder.withPayload(message)
                                               .setHeader(MessageConst.PROPERTY_KEYS, "yourKey")   // Specify the business key
                                               .build());
               System.out.printf("syncSend1 to topic %s sendResult=%s %n", topic, sendResult);
       }
      }
      Note:
      This example is for synchronous transmission. For information on asynchronous transmission, one-way transmission, and so on, see the Demo or visit the GitHub Project.

      Step 4: Consuming the Message

      @Service
         @RocketMQMessageListener(
                 consumerGroup = "${rocketmq.consumer1.group}",  // Consumer group. Format: group name
                 // Concatenate full topic name because the full name is required. Alternatively, you can set it by yourself. Format: topic name
                 topic = "${rocketmq.consumer1.topic}",
                 selectorExpression = "${rocketmq.consumer1.subExpression}" // Subscription expression. If it is not configured, all messages are subscribed to
         )
         public class MessageConsumer implements RocketMQListener<String> {
      
             @Override
             public void onMessage(String message) {
                 System.out.println("Tag1Consumer has received the message:" + message);
             }
         }
      Multiple consumers can be configured based on your business needs. Other consumer configurations can be set as needed.
      Note:
      For the complete example, see Download Demo or visit the GitHub project.

      Step 5: Checking Consumption Details

      After the message is sent, you will receive a message ID (messageID). Developers can query the recently sent messages on the Message Query page, as shown in the following figure. Information such as details and traces for specific messages is also available. For details, see the Message Query section.
      
      
      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy