发送普通消息(三种方式)

云消息队列 RocketMQ 版提供三种方式来发送普通消息:同步(Sync)发送、异步(Async)发送和单向(Oneway)发送。本文介绍了每种发送方式的原理、应用场景、示例代码,以及三种发送方式的对比。

前提条件

  • 安装Java SDK。更多信息,请参见准备环境

  • 创建资源。代码中涉及的资源信息,例如实例、Topic和Group ID等,需要在控制台上提前创建。更多信息,请参见创建资源

  • 获取阿里云访问密钥AccessKey ID和AccessKey Secret。更多信息,请参见创建AccessKey

  • 可选:日志配置

同步发送

  • 原理

    同步发送是指消息发送方发出一条消息后,会在收到服务端同步响应之后才发下一条消息的通讯方式。同步发送

  • 应用场景

    此种方式应用场景非常广泛,例如重要通知邮件、报名短信通知、营销短信系统等。

  • 示例代码

        import com.aliyun.openservices.ons.api.Message;
        import com.aliyun.openservices.ons.api.Producer;
        import com.aliyun.openservices.ons.api.SendResult;
        import com.aliyun.openservices.ons.api.ONSFactory;
        import com.aliyun.openservices.ons.api.PropertyKeyConst;
    
        import java.util.Properties;
    
        public class ProducerTest {
            public static void main(String[] args) {
                Properties properties = new Properties();
                // 请确保环境变量ALIBABA_CLOUD_ACCESS_KEY_ID、ALIBABA_CLOUD_ACCESS_KEY_SECRET已设置。
                // AccessKey ID,阿里云身份验证标识。
                properties.put(PropertyKeyConst.AccessKey, System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"));
                // AccessKey Secret,阿里云身份验证密钥。
                properties.put(PropertyKeyConst.SecretKey, System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
                //设置发送超时时间,单位:毫秒。
                properties.setProperty(PropertyKeyConst.SendMsgTimeoutMillis, "3000");
                // 设置TCP接入域名,进入云消息队列 RocketMQ 版控制台实例详情页面的接入点区域查看。
                properties.put(PropertyKeyConst.NAMESRV_ADDR, "XXX");
                Producer producer = ONSFactory.createProducer(properties);
                // 在发送消息前,必须调用start方法来启动Producer,只需调用一次即可。
                producer.start();
    
                //循环发送消息。
                for (int i = 0; i < 100; i++){
                    Message msg = new Message( 
                        // 普通消息所属的Topic,切勿使用普通消息的Topic来收发其他类型的消息。
                        "TopicTestMQ",
                        // Message Tag可理解为Gmail中的标签,对消息进行再归类,方便Consumer指定过滤条件在消息队列RocketMQ版的服务器过滤。
                        // Tag的具体格式和设置方法,请参见Topic与Tag最佳实践。
                        "TagA",
                        // Message Body可以是任何二进制形式的数据,消息队列RocketMQ版不做任何干预。
                        // 需要Producer与Consumer协商好一致的序列化和反序列化方式。
                        "Hello MQ".getBytes());
                    // 设置代表消息的业务关键属性,请尽可能全局唯一。
                    // 以方便您在无法正常收到消息情况下,可通过消息队列RocketMQ版控制台查询消息并补发。
                    // 注意:不设置也不会影响消息正常收发。
                    msg.setKey("ORDERID_" + i);
    
                    try {
                        SendResult sendResult = producer.send(msg);
                        // 同步发送消息,只要不抛异常就是成功。
                        if (sendResult != null) {
                            System.out.println(new Date() + " Send mq message success. Topic is:" + msg.getTopic() + " msgId is: " + sendResult.getMessageId());
                        }
                    }
                    catch (Exception e) {
                        // 消息发送失败,需要进行重试处理,可重新发送这条消息或持久化这条数据进行补偿处理。
                        System.out.println(new Date() + " Send mq message failed. Topic is:" + msg.getTopic());
                        e.printStackTrace();
                    }
                }
    
                // 在应用退出前,销毁Producer对象。
                // 注意:销毁Producer对象可以节约系统内存,若您需要频繁发送消息,则无需销毁Producer对象。
                producer.shutdown();
            }
        }               

异步发送

  • 原理

    异步发送是指发送方发出一条消息后,不等服务端返回响应,接着发送下一条消息的通讯方式。云消息队列 RocketMQ 版的异步发送,需要您实现异步发送回调接口(SendCallback)。消息发送方在发送了一条消息后,不需要等待服务端响应即可发送第二条消息。发送方通过回调接口接收服务端响应,并处理响应结果。

    异步发送
  • 应用场景

    异步发送一般用于链路耗时较长,对响应时间较为敏感的业务场景,例如,您视频上传后通知启动转码服务,转码完成后通知推送转码结果等。

  • 示例代码

        import com.aliyun.openservices.ons.api.Message;
        import com.aliyun.openservices.ons.api.OnExceptionContext;
        import com.aliyun.openservices.ons.api.Producer;
        import com.aliyun.openservices.ons.api.SendCallback;
        import com.aliyun.openservices.ons.api.SendResult;
        import com.aliyun.openservices.ons.api.ONSFactory;
        import com.aliyun.openservices.ons.api.PropertyKeyConst;
    
        import java.util.Properties;
        import java.util.concurrent.TimeUnit;
    
        public class ProducerTest {
            public static void main(String[] args) throws InterruptedException {
                Properties properties = new Properties();
                // 请确保环境变量ALIBABA_CLOUD_ACCESS_KEY_ID、ALIBABA_CLOUD_ACCESS_KEY_SECRET已设置。
                // AccessKey ID,阿里云身份验证标识。
                properties.put(PropertyKeyConst.AccessKey, System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"));
                // AccessKey Secret,阿里云身份验证密钥。
                properties.put(PropertyKeyConst.SecretKey, System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
                //设置发送超时时间,单位毫秒。
                properties.setProperty(PropertyKeyConst.SendMsgTimeoutMillis, "3000");
                // 设置TCP接入域名,进入云消息队列 RocketMQ 版控制台实例详情页面的接入点区域查看。
                properties.put(PropertyKeyConst.NAMESRV_ADDR, "XXX");
    
                Producer producer = ONSFactory.createProducer(properties);
                // 在发送消息前,必须调用start方法来启动Producer,只需调用一次即可。
                producer.start();
    
                Message msg = new Message(
                        // 普通消息所属的Topic,切勿使用普通消息的Topic来收发其他类型的消息。
                        "TopicTestMQ",
                        // Message Tag,可理解为Gmail中的标签,对消息进行再归类,方便Consumer指定过滤条件在消息队列RocketMQ版的服务器过滤。
                        "TagA",
                        // Message Body,任何二进制形式的数据,消息队列RocketMQ版不做任何干预,需要Producer与Consumer协商好一致的序列化和反序列化方式。
                        "Hello MQ".getBytes());
    
                // 设置代表消息的业务关键属性,请尽可能全局唯一。 以方便您在无法正常收到消息情况下,可通过消息队列RocketMQ版控制台查询消息并补发。
                // 注意:不设置也不会影响消息正常收发。
                msg.setKey("ORDERID_100");
    
                // 异步发送消息, 发送结果通过callback返回给客户端。
                producer.sendAsync(msg, new SendCallback() {
                    @Override
                    public void onSuccess(final SendResult sendResult) {
                        // 消息发送成功。
                        System.out.println("send message success. topic=" + sendResult.getTopic() + ", msgId=" + sendResult.getMessageId());
                    }
    
                    @Override
                    public void onException(OnExceptionContext context) {
                        // 消息发送失败,需要进行重试处理,可重新发送这条消息或持久化这条数据进行补偿处理。
                        System.out.println("send message failed. topic=" + context.getTopic() + ", msgId=" + context.getMessageId());
                    }
                });
    
                // 阻塞当前线程3秒,等待异步发送结果。
                TimeUnit.SECONDS.sleep(3);
    
                // 在应用退出前,销毁Producer对象。
                // 注意:销毁Producer对象可以节约系统内存,若您需要频繁发送消息,则无需销毁Producer对象。
                producer.shutdown();
            }
        }                

单向发送

  • 原理

    发送方只负责发送消息,不等待服务端返回响应且没有回调函数触发,即只发送请求不等待应答。此方式发送消息的过程耗时非常短,一般在微秒级别。

    单向发送
  • 应用场景

    适用于某些耗时非常短,但对可靠性要求并不高的场景,例如日志收集。

  • 示例代码

        import com.aliyun.openservices.ons.api.Message;
        import com.aliyun.openservices.ons.api.Producer;
        import com.aliyun.openservices.ons.api.ONSFactory;
        import com.aliyun.openservices.ons.api.PropertyKeyConst;
    
        import java.util.Properties;
    
        public class ProducerTest {
            public static void main(String[] args) {
                Properties properties = new Properties();
                // 请确保环境变量ALIBABA_CLOUD_ACCESS_KEY_ID、ALIBABA_CLOUD_ACCESS_KEY_SECRET已设置。
                // AccessKey ID,阿里云身份验证标识。
                properties.put(PropertyKeyConst.AccessKey, System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"));
                // AccessKey Secret,阿里云身份验证密钥。
                properties.put(PropertyKeyConst.SecretKey, System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
                // 设置发送超时时间,单位:毫秒。
                properties.setProperty(PropertyKeyConst.SendMsgTimeoutMillis, "3000");
                // 设置TCP接入域名,进入消息队列RocketMQ版控制台的实例详情页面的接入点区域查看。
                properties.put(PropertyKeyConst.NAMESRV_ADDR,
                  "XXX");
    
                Producer producer = ONSFactory.createProducer(properties);
                // 在发送消息前,必须调用start方法来启动Producer,只需调用一次即可。
                producer.start();
                //循环发送消息。
                for (int i = 0; i < 100; i++){
                    Message msg = new Message(
                            // 普通消息所属的Topic,切勿使用普通消息的Topic来收发其他类型的消息。
                            "TopicTestMQ",
                            // Message Tag,
                            // 可理解为Gmail中的标签,对消息进行再归类,方便Consumer指定过滤条件在消息队列RocketMQ版的服务器过滤。
                            "TagA",
                            // Message Body
                            // 任何二进制形式的数据,云消息队列 RocketMQ 版不做任何干预,需要Producer与Consumer协商好一致的序列化和反序列化方式。
                            "Hello MQ".getBytes());
    
                    // 设置代表消息的业务关键属性,请尽可能全局唯一。
                    // 以方便您在无法正常收到消息情况下,可通过消息队列RocketMQ版控制台查询消息并补发。
                    // 注意:不设置也不会影响消息正常收发。
                    msg.setKey("ORDERID_" + i);
    
                    // 由于在oneway方式发送消息时没有请求应答处理,如果出现消息发送失败,则会因为没有重试而导致数据丢失。若数据不可丢,建议选用可靠同步或可靠异步发送方式。
                    producer.sendOneway(msg);
                }
    
                // 在应用退出前,销毁Producer对象。
                // 注意:销毁Producer对象可以节约系统内存,若您需要频繁发送消息,则无需销毁Producer对象。
                producer.shutdown();
            }
        }

三种发送方式的对比

发送方式

发送TPS

发送结果反馈

可靠性

同步发送

不丢失

异步发送

不丢失

单向发送

最快

可能丢失

订阅普通消息

订阅普通消息的示例代码,请参见订阅消息