RocketMQ基本概念

RocketMQ 是一个分布式消息中间件,用于实现可靠的、可伸缩的消息传递。消息中间件大致上都分为消息生产端、消息存储端、消息消费端。RocketMQ的领域模型大致如下:

image-20231023152728033

消息生产端:

  • 生产者(Producer):

    生产者是消息的发送方,负责产生并发送消息到 RocketMQ Broker。生产者将消息发送到指定的 Topic(主题)。

消息存储端:

  • 主题(Topic):

    主题是 Apache RocketMQ 中消息传输和存储的顶层容器,用于标识同一类业务逻辑的消息,所有消息资源的定义都在主题内部完成,但主题是一个逻辑概念,并不是实际的消息容器。

    主题内部由多个队列组成,消息的存储和水平扩展能力最终是由队列实现的;并且针对主题的所有约束和属性设置,最终也是通过主题内部的队列来实现。

  • 队列(MessageQueue):

    队列是 Apache RocketMQ 中消息存储和传输的实际容器,也是 Apache RocketMQ 消息的最小存储单元。 Apache RocketMQ 的所有主题都是由多个队列组成,以此实现队列数量的水平拆分和队列内部的流式存储。

  • 消息(Message):

    Apache RocketMQ 的最小传输单元。消息具备不可变性,在初始化发送和完成存储后即不可变。

消息消费端:

  • 消费者分组(ConsumerGroup):

    Apache RocketMQ 发布订阅模型中定义的独立的消费身份分组,用于统一管理底层运行的多个消费者(Consumer)。同一个消费组的多个消费者必须保持消费逻辑和配置一致,共同分担该消费组订阅的消息,实现消费能力的水平扩展。

  • 消费者(Consumer):

    消费者是 Apache RocketMQ 中用来接收并处理消息的运行实体。 消费者通常被集成在业务系统中,从 Apache RocketMQ 服务端获取消息,并将消息转化成业务可理解的信息,供业务逻辑处理。

    在消息消费端,可以定义如下传输行为:

    • 消费者身份:消费者必须关联一个指定的消费者分组,以获取分组内统一定义的行为配置和消费状态。
    • 消费者类型:Apache RocketMQ 面向不同的开发场景提供了多样的消费者类型,包括PushConsumer类型、SimpleConsumer类型、PullConsumer类型(仅推荐流处理场景使用)等。具体信息,请参见消费者分类
    • 消费者本地运行配置:消费者根据不同的消费者类型,控制消费者客户端本地的运行配置。例如消费者客户端的线程数,消费并发度等,实现不同的传输效果。
  • 订阅关系(Subscription):

    Apache RocketMQ 发布订阅模型中消息过滤、重试、消费进度的规则配置。订阅关系以消费组粒度进行管理,消费组通过定义订阅关系控制指定消费组下的消费者如何实现消息过滤、消费重试及消费进度恢复等。

    Apache RocketMQ 的订阅关系除过滤表达式之外都是持久化的,即服务端重启或请求断开,订阅关系依然保留。

快速开始

安装服务端

  1. 下载Apache RocketMQ

    GitHub releases选择Source code下载zip文件。解压源码包并编译构建二进制可执行文件。

    1
    2
    3
    4
    $ unzip rocketmq-all-5.1.4-source-release.zip
    $ cd rocketmq-all-5.1.4-source-release/
    $ mvn -Prelease-all -DskipTests -Dspotbugs.skip=true clean install -U
    $ cd distribution/target/rocketmq-5.1.4/rocketmq-5.1.4

    RocketMQ 的安装包分为两种,二进制包和源码包。 二进制包是已经编译完成后可以直接运行的,源码包是需要编译后运行的。

  2. 启动NameServer

    1
    2
    3
    4
    5
    6
    ### 启动namesrv
    $ nohup sh bin/mqnamesrv &

    ### 验证namesrv是否启动成功
    $ tail -f ~/logs/rocketmqlogs/namesrv.log
    The Name Server boot success...
  3. 启动Broker+Proxy

    NameServer成功启动后,再启动Broker和Proxy,5.x 版本下建议使用 Local 模式部署,即 Broker 和 Proxy 同进程部署。5.x 版本也支持 Broker 和 Proxy 分离部署以实现更灵活的集群能力。

    1
    2
    3
    4
    5
    6
    ### 先启动broker
    $ nohup sh bin/mqbroker -n localhost:9876 --enable-proxy &

    ### 验证broker是否启动成功, 比如, broker的ip是192.168.1.2 然后名字是broker-a
    $ tail -f ~/logs/rocketmqlogs/proxy.log
    The broker[broker-a,192.169.1.2:10911] boot success...
  4. 关闭服务器

    1
    2
    3
    4
    5
    6
    7
    $ sh bin/mqshutdown broker
    The mqbroker(36695) is running...
    Send shutdown request to mqbroker with proxy enable OK(36695)

    $ sh bin/mqshutdown namesrv
    The mqnamesrv(36664) is running...
    Send shutdown request to mqnamesrv(36664) OK

测试消息收发

  1. 工具测试消息收发

    在进行工具测试消息收发之前,我们需要告诉客户端NameServer的地址,RocketMQ有多种方式在客户端中设置NameServer地址,这里我们利用环境变量NAMESRV_ADDR

    1
    2
    3
    4
    5
    6
    $ export NAMESRV_ADDR=localhost:9876
    $ sh bin/tools.sh org.apache.rocketmq.example.quickstart.Producer
    SendResult [sendStatus=SEND_OK, msgId= ...

    $ sh bin/tools.sh org.apache.rocketmq.example.quickstart.Consumer
    ConsumeMessageThread_%d Receive New Messages: [MessageExt...
  2. SDK测试消息收发

    1. 添加pom依赖。

      1
      2
      3
      4
      5
      <dependency>
      <groupId>org.apache.rocketmq</groupId>
      <artifactId>rocketmq-client-java</artifactId>
      <version>${rocketmq-client-java-version}</version>
      </dependency>
    2. 通过mqadmin创建 Topic。

      1
      $ sh bin/mqadmin updatetopic -n localhost:9876 -t TestTopic -c DefaultCluster
    3. 在已创建的Java工程中,创建发送普通消息程序并运行,示例代码如下:

      1
      2
      3
      4
      5
      6
      7
      8
      9
      10
      11
      12
      13
      14
      15
      16
      17
      18
      19
      20
      21
      22
      23
      24
      25
      26
      27
      28
      29
      30
      31
      32
      33
      34
      35
      36
      37
      38
      39
      40
      41
      42
      43
      44
      45
      46
      import org.apache.rocketmq.client.apis.ClientConfiguration;
      import org.apache.rocketmq.client.apis.ClientConfigurationBuilder;
      import org.apache.rocketmq.client.apis.ClientException;
      import org.apache.rocketmq.client.apis.ClientServiceProvider;
      import org.apache.rocketmq.client.apis.message.Message;
      import org.apache.rocketmq.client.apis.producer.Producer;
      import org.apache.rocketmq.client.apis.producer.SendReceipt;
      import org.slf4j.Logger;
      import org.slf4j.LoggerFactory;

      public class ProducerExample {
      private static final Logger logger = LoggerFactory.getLogger(ProducerExample.class);

      public static void main(String[] args) throws ClientException {
      // 接入点地址,需要设置成Proxy的地址和端口列表,一般是xxx:8081;xxx:8081。
      String endpoint = "localhost:8081";
      // 消息发送的目标Topic名称,需要提前创建。
      String topic = "TestTopic";
      ClientServiceProvider provider = ClientServiceProvider.loadService();
      ClientConfigurationBuilder builder = ClientConfiguration.newBuilder().setEndpoints(endpoint);
      ClientConfiguration configuration = builder.build();
      // 初始化Producer时需要设置通信配置以及预绑定的Topic。
      Producer producer = provider.newProducerBuilder()
      .setTopics(topic)
      .setClientConfiguration(configuration)
      .build();
      // 普通消息发送。
      Message message = provider.newMessageBuilder()
      .setTopic(topic)
      // 设置消息索引键,可根据关键字精确查找某条消息。
      .setKeys("messageKey")
      // 设置消息Tag,用于消费端根据指定Tag过滤消息。
      .setTag("messageTag")
      // 消息体。
      .setBody("messageBody".getBytes())
      .build();
      try {
      // 发送消息,需要关注发送结果,并捕获失败等异常。
      SendReceipt sendReceipt = producer.send(message);
      logger.info("Send message successfully, messageId={}", sendReceipt.getMessageId());
      } catch (ClientException e) {
      logger.error("Failed to send message", e);
      }
      // producer.close();
      }
      }
    4. 在已创建的Java工程中,创建订阅普通消息程序并运行。

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    import java.io.IOException;
    import java.util.Collections;
    import org.apache.rocketmq.client.apis.ClientConfiguration;
    import org.apache.rocketmq.client.apis.ClientException;
    import org.apache.rocketmq.client.apis.ClientServiceProvider;
    import org.apache.rocketmq.client.apis.consumer.ConsumeResult;
    import org.apache.rocketmq.client.apis.consumer.FilterExpression;
    import org.apache.rocketmq.client.apis.consumer.FilterExpressionType;
    import org.apache.rocketmq.client.apis.consumer.PushConsumer;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;

    public class PushConsumerExample {
    private static final Logger logger = LoggerFactory.getLogger(PushConsumerExample.class);

    private PushConsumerExample() {
    }

    public static void main(String[] args) throws ClientException, IOException, InterruptedException {
    final ClientServiceProvider provider = ClientServiceProvider.loadService();
    // 接入点地址,需要设置成Proxy的地址和端口列表,一般是xxx:8081;xxx:8081。
    String endpoints = "localhost:8081";
    ClientConfiguration clientConfiguration = ClientConfiguration.newBuilder()
    .setEndpoints(endpoints)
    .build();
    // 订阅消息的过滤规则,表示订阅所有Tag的消息。
    String tag = "*";
    FilterExpression filterExpression = new FilterExpression(tag, FilterExpressionType.TAG);
    // 为消费者指定所属的消费者分组,Group需要提前创建。
    String consumerGroup = "YourConsumerGroup";
    // 指定需要订阅哪个目标Topic,Topic需要提前创建。
    String topic = "TestTopic";
    // 初始化PushConsumer,需要绑定消费者分组ConsumerGroup、通信参数以及订阅关系。
    PushConsumer pushConsumer = provider.newPushConsumerBuilder()
    .setClientConfiguration(clientConfiguration)
    // 设置消费者分组。
    .setConsumerGroup(consumerGroup)
    // 设置预绑定的订阅关系。
    .setSubscriptionExpressions(Collections.singletonMap(topic, filterExpression))
    // 设置消费监听器。
    .setMessageListener(messageView -> {
    // 处理消息并返回消费结果。
    logger.info("Consume message successfully, messageId={}", messageView.getMessageId());
    return ConsumeResult.SUCCESS;
    })
    .build();
    Thread.sleep(Long.MAX_VALUE);
    // 如果不需要再使用 PushConsumer,可关闭该实例。
    // pushConsumer.close();
    }
    }

消费消息时,消息对象是MessageView,它存放内容的实体是字节数组,可以使用Java NIO包的Charset来解码字节序列。以下是示例代码:

1
2
3
4
String message = StandardCharsets.UTF_8
.decode(messageView.getBody())
.toString();
System.out.println("message" + message);