RocketMQ官方教程（翻译加扩充）——快速开始

本翻译教程来自RocketMQ官方网站，中间会加上自己的理解，有错误或者不妥之处请及时指正。另外，本文所基于的版本是4.4.0

本快速入门指南是将RocketMQ配置在本地电脑上来发送和接收消息。

先决条件

假设本地电脑上安装了一下软件：

1. 64bit OS, Linux/Unix/Mac is recommended; (建议安装在非Windows系统的电脑上)
2. 64bit JDK 1.8+; (java JDK)
3. Maven 3.2.x; (maven)
4. Git; (git)
5. 4g+ free disk for Broker server. (为Broker server空出4g以上的空间)

下载并构建

大家可以从这个地方进行source release的下载，也可以从这个地方进行binary release的下载。

下面可以执行如下命令进行解压source release的压缩包和构建二进制可执行文件。

  > unzip rocketmq-all-4.4.0-source-release.zip
  > cd rocketmq-all-4.4.0/
  > mvn -Prelease-all -DskipTests clean install -U
  > cd distribution/target/apache-rocketmq

开启name server

通过如下命令开启name server

  > nohup sh bin/mqnamesrv &
  > tail -f ~/logs/rocketmqlogs/namesrv.log
  The Name Server boot success...

开启broker

通过以下命令开启broker，这里的name server和broker都是RocketMQ的核心组件

  > nohup sh bin/mqbroker -n localhost:9876 &
  > tail -f ~/logs/rocketmqlogs/broker.log 
  The broker[%s, 172.30.30.233:10911] boot success...

发送和接收消息

在发送和接收消息之前，我们需要告诉客户端name server的位置在哪。RocketMQ提供了很多种方法来实现这一点。这里我们使用一种简单的方式，通过环境变量来设置，其他的方式同学们需要自行去探究。下面命令设置了环境变量，并使用官方的例子来尝试进行消息的发送和接收。

 > 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...

关闭服务

当我们不需要继续发送和接收消息的时候，可以通过以下命令将broker和name server进行关闭。

> sh bin/mqshutdown broker
The mqbroker(36695) is running...
Send shutdown request to mqbroker(36695) OK

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

生产者和消费者

上面用来测试发送和接受接收消息的生产者和消费者代码如下，我在里面加上了详细的注释，如果读者想要方便的下载这些代码，包括后面所有博客中有关RocketMQ教程中用到的代码，请到我的GitHub仓库进行下载。

生产者

package org.apache.rocketmq.example.quickstart;

import org.apache.rocketmq.client.exception.MQClientException;
import org.apache.rocketmq.client.producer.DefaultMQProducer;
import org.apache.rocketmq.client.producer.SendResult;
import org.apache.rocketmq.common.message.Message;
import org.apache.rocketmq.remoting.common.RemotingHelper;

/**
 * 这段代码展示了如何使用DefaultMQProducer来向broker发送消息
 */
public class Producer {
    public static void main(String[] args) throws MQClientException, InterruptedException {

        /*
         * 实例化DefaultMQProducer，这里如要设置生产者组名。
         */
        DefaultMQProducer producer = new DefaultMQProducer("please_rename_unique_group_name");
        /*
         * 可以通过下面这句话来设置name server的地址，当然你也可以通过环境变量来进行设置
         * 因为我们在前面已经设置了环境变量，所以这里应该将这句话注释掉
         */
        producer.setNamesrvAddr("name-server1-ip:9876;name-server2-ip:9876");
        /*
         * 启动实例
         */
        producer.start();

        // 发送1000个消息
        for (int i = 0; i < 1000; i++) {
            try {

                /*
                 * 创建消息实例，指定topic、tag和消息主体
                 */
                Message msg = new Message("TopicTest" /* Topic */,
                        "TagA" /* Tag */,
                        ("Hello RocketMQ " + i).getBytes(RemotingHelper.DEFAULT_CHARSET) /* Message body */
                );

                /*
                 * 调用send方法来将消息发送给其中一个broker
                 */
                SendResult sendResult = producer.send(msg);

                System.out.printf("%s%n", sendResult);
            } catch (Exception e) {
                e.printStackTrace();
                Thread.sleep(1000);
            }
        }

        /*
         * 最后关闭生产者producer，只需关闭一次
         */
        producer.shutdown();
    }
}

消费者

package org.apache.rocketmq.example.quickstart;

import java.util.List;
import org.apache.rocketmq.client.consumer.DefaultMQPushConsumer;
import org.apache.rocketmq.client.consumer.listener.ConsumeConcurrentlyContext;
import org.apache.rocketmq.client.consumer.listener.ConsumeConcurrentlyStatus;
import org.apache.rocketmq.client.consumer.listener.MessageListenerConcurrently;
import org.apache.rocketmq.client.exception.MQClientException;
import org.apache.rocketmq.common.consumer.ConsumeFromWhere;
import org.apache.rocketmq.common.message.MessageExt;

/**
 * 下面这段代码展示了如何使用DefaultMQPushConsumer来进行消息的订阅和消费
 */
public class Consumer {

    public static void main(String[] args) throws InterruptedException, MQClientException {

        /*
         * 实例化DefaultMQPushConsumer，同样这里需要设置消费者组名
         */
        DefaultMQPushConsumer consumer = new DefaultMQPushConsumer("please_rename_unique_group_name_4");

        /*
         * 可以通过下面这句话来设置name server的地址，当然你也可以通过环境变量来进行设置
         * 因为我们在前面已经设置了环境变量，所以这里应该将这句话注释掉
         */
        consumer.setNamesrvAddr("name-server1-ip:9876;name-server2-ip:9876");

        /*
         * 在指定的消费者组是全新的情况下，指定从哪里开始消费。
         * ConsumeFromWhere是一个枚举类
         */
        consumer.setConsumeFromWhere(ConsumeFromWhere.CONSUME_FROM_FIRST_OFFSET);

        /*
         * 指定要订阅的topic来进行消费
         */
        consumer.subscribe("TopicTest", "*");

        /*
         *  注册一个回调函数，这个回调函数会在消息从broker中取过来的时候调用执行
         */
        consumer.registerMessageListener(new MessageListenerConcurrently() {

            public ConsumeConcurrentlyStatus consumeMessage(List<MessageExt> msgs,
                                                            ConsumeConcurrentlyContext context) {
                System.out.printf("%s Receive New Messages: %s %n", Thread.currentThread().getName(), msgs);
                return ConsumeConcurrentlyStatus.CONSUME_SUCCESS;
            }
        });

        /*
         *  开启消费者实例
         */
        consumer.start();

        System.out.printf("Consumer Started.%n");
    }
}