com.alibaba.rocketmq.client.producer

类 DefaultMQProducer

java.lang.Object

com.alibaba.rocketmq.client.ClientConfig

com.alibaba.rocketmq.client.producer.DefaultMQProducer

所有已实现的接口:

MQAdmin, MQProducer

直接已知子类:

TransactionMQProducer

public class DefaultMQProducer
extends ClientConfig
implements MQProducer

消息生产者，适合使用spring初始化

从以下版本开始:

2013-7-25

作者:

shijia.wxr

字段概要

字段

限定符和类型	字段和说明
protected DefaultMQProducerImpl	defaultMQProducerImpl

构造器概要

构造器

构造器和说明
DefaultMQProducer()
DefaultMQProducer(String producerGroup)

方法概要

方法

限定符和类型	方法和说明
void	createTopic(String key, String newTopic, int queueNum) 创建topic
long	earliestMsgStoreTime(MessageQueue mq) 向服务器查询队列保存的最早消息对应的存储时间
List<MessageQueue>	fetchPublishMessageQueues(String topic) 根据topic获取对应的MessageQueue，如果是顺序消息，则按照顺序消息配置返回
int	getCompressMsgBodyOverHowmuch()
String	getCreateTopicKey()
DefaultMQProducerImpl	getDefaultMQProducerImpl()
int	getDefaultTopicQueueNums()
int	getMaxMessageSize()
String	getProducerGroup()
int	getSendMsgTimeout()
boolean	isRetryAnotherBrokerWhenNotStoreOK()
long	maxOffset(MessageQueue mq) 向服务器查询队列最大Offset PS: 最大Offset无对应消息，减1有消息
long	minOffset(MessageQueue mq) 向服务器查询队列最小Offset PS: 最小Offset有对应消息
QueryResult	queryMessage(String topic, String key, int maxNum, long begin, long end) 根据消息Key查询消息
long	searchOffset(MessageQueue mq, long timestamp) 根据时间查询对应的offset，精确到毫秒 P.S.
SendResult	send(Message msg) 发送消息，同步调用
SendResult	send(Message msg, MessageQueue mq) 向指定队列发送消息，同步调用
SendResult	send(Message msg, MessageQueueSelector selector, Object arg) 发送消息，可以自定义选择队列，队列的总数可能会由于Broker的启停变化 如果要保证消息严格有序，在向运维人员申请Topic时，需要特别说明 同步调用
void	send(Message msg, MessageQueueSelector selector, Object arg, SendCallback sendCallback) 发送消息，可以自定义选择队列，队列的总数可能会由于Broker的启停变化 如果要保证消息严格有序，在向运维人员申请Topic时，需要特别说明 异步调用
void	send(Message msg, MessageQueue mq, SendCallback sendCallback) 向指定队列发送消息，异步调用
void	send(Message msg, SendCallback sendCallback) 发送消息，异步调用
TransactionSendResult	sendMessageInTransaction(Message msg, LocalTransactionExecuter tranExecuter, Object arg)
void	sendOneway(Message msg) 发送消息，Oneway形式，服务器不应答，无法保证消息是否成功到达服务器
void	sendOneway(Message msg, MessageQueue mq) 向指定队列发送消息，Oneway形式，服务器不应答，无法保证消息是否成功到达服务器
void	sendOneway(Message msg, MessageQueueSelector selector, Object arg) 发送消息，可以自定义选择队列，队列的总数可能会由于Broker的启停变化 如果要保证消息严格有序，在向运维人员申请Topic时，需要特别说明 Oneway形式，服务器不应答，无法保证消息是否成功到达服务器
void	setCompressMsgBodyOverHowmuch(int compressMsgBodyOverHowmuch)
void	setCreateTopicKey(String createTopicKey)
void	setDefaultTopicQueueNums(int defaultTopicQueueNums)
void	setMaxMessageSize(int maxMessageSize)
void	setProducerGroup(String producerGroup)
void	setRetryAnotherBrokerWhenNotStoreOK(boolean retryAnotherBrokerWhenNotStoreOK)
void	setSendMsgTimeout(int sendMsgTimeout)
void	shutdown() 关闭服务，一旦关闭，此对象将不可用
void	start() 启动服务
MessageExt	viewMessage(String msgId) 根据消息ID，从服务器获取完整的消息

从类继承的方法 com.alibaba.rocketmq.client.ClientConfig

buildMQClientId, cloneClientConfig, getClientCallbackExecutorThreads, getClientIP, getHeartbeatBrokerInterval, getInstanceName, getNamesrvAddr, getPersistConsumerOffsetInterval, getPollNameServerInteval, resetClientConfig, setClientCallbackExecutorThreads, setClientIP, setHeartbeatBrokerInterval, setInstanceName, setNamesrvAddr, setPersistConsumerOffsetInterval, setPollNameServerInteval, toString

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

字段详细资料

defaultMQProducerImpl

protected final transient DefaultMQProducerImpl defaultMQProducerImpl

构造器详细资料

DefaultMQProducer

public DefaultMQProducer()

DefaultMQProducer

public DefaultMQProducer(String producerGroup)

方法详细资料

start

public void start()
           throws MQClientException

从接口复制的说明: MQProducer

启动服务

指定者:

start 在接口中 MQProducer

抛出:

MQClientException

shutdown

public void shutdown()

从接口复制的说明: MQProducer

关闭服务，一旦关闭，此对象将不可用

指定者:

shutdown 在接口中 MQProducer

fetchPublishMessageQueues

public List<MessageQueue> fetchPublishMessageQueues(String topic)
                                             throws MQClientException

从接口复制的说明: MQProducer

根据topic获取对应的MessageQueue，如果是顺序消息，则按照顺序消息配置返回

指定者:

fetchPublishMessageQueues 在接口中 MQProducer

参数:

topic - 消息Topic

返回:

返回队列集合

抛出:

MQClientException

send

public SendResult send(Message msg)
                throws MQClientException,
                       com.alibaba.rocketmq.remoting.exception.RemotingException,
                       MQBrokerException,
                       InterruptedException

从接口复制的说明: MQProducer

发送消息，同步调用

指定者:

send 在接口中 MQProducer

参数:

msg - 消息

返回:

发送结果

抛出:

MQClientException

com.alibaba.rocketmq.remoting.exception.RemotingException

MQBrokerException

InterruptedException

send

public void send(Message msg,
        SendCallback sendCallback)
          throws MQClientException,
                 com.alibaba.rocketmq.remoting.exception.RemotingException,
                 InterruptedException

从接口复制的说明: MQProducer

发送消息，异步调用

指定者:

send 在接口中 MQProducer

参数:

msg - 消息

sendCallback - 发送结果通过此接口回调

抛出:

MQClientException

com.alibaba.rocketmq.remoting.exception.RemotingException

InterruptedException

sendOneway

public void sendOneway(Message msg)
                throws MQClientException,
                       com.alibaba.rocketmq.remoting.exception.RemotingException,
                       InterruptedException

从接口复制的说明: MQProducer

发送消息，Oneway形式，服务器不应答，无法保证消息是否成功到达服务器

指定者:

sendOneway 在接口中 MQProducer

参数:

msg - 消息

抛出:

MQClientException

com.alibaba.rocketmq.remoting.exception.RemotingException

InterruptedException

send

public SendResult send(Message msg,
              MessageQueue mq)
                throws MQClientException,
                       com.alibaba.rocketmq.remoting.exception.RemotingException,
                       MQBrokerException,
                       InterruptedException

从接口复制的说明: MQProducer

向指定队列发送消息，同步调用

指定者:

send 在接口中 MQProducer

参数:

msg - 消息

mq - 队列

返回:

发送结果

抛出:

MQClientException

com.alibaba.rocketmq.remoting.exception.RemotingException

MQBrokerException

InterruptedException

send

public void send(Message msg,
        MessageQueue mq,
        SendCallback sendCallback)
          throws MQClientException,
                 com.alibaba.rocketmq.remoting.exception.RemotingException,
                 InterruptedException

从接口复制的说明: MQProducer

向指定队列发送消息，异步调用

指定者:

send 在接口中 MQProducer

参数:

msg - 消息

mq - 队列

sendCallback - 发送结果通过此接口回调

抛出:

MQClientException

com.alibaba.rocketmq.remoting.exception.RemotingException

InterruptedException

sendOneway

public void sendOneway(Message msg,
              MessageQueue mq)
                throws MQClientException,
                       com.alibaba.rocketmq.remoting.exception.RemotingException,
                       InterruptedException

从接口复制的说明: MQProducer

向指定队列发送消息，Oneway形式，服务器不应答，无法保证消息是否成功到达服务器

指定者:

sendOneway 在接口中 MQProducer

参数:

msg - 消息

mq - 队列

抛出:

MQClientException

com.alibaba.rocketmq.remoting.exception.RemotingException

InterruptedException

send

public SendResult send(Message msg,
              MessageQueueSelector selector,
              Object arg)
                throws MQClientException,
                       com.alibaba.rocketmq.remoting.exception.RemotingException,
                       MQBrokerException,
                       InterruptedException

从接口复制的说明: MQProducer

发送消息，可以自定义选择队列，队列的总数可能会由于Broker的启停变化
如果要保证消息严格有序，在向运维人员申请Topic时，需要特别说明
同步调用

指定者:

send 在接口中 MQProducer

参数:

msg - 消息

selector - 队列选择器，发送时会回调

arg - 回调队列选择器时，此参数会传入队列选择方法

返回:

发送结果

抛出:

MQClientException

com.alibaba.rocketmq.remoting.exception.RemotingException

MQBrokerException

InterruptedException

send

public void send(Message msg,
        MessageQueueSelector selector,
        Object arg,
        SendCallback sendCallback)
          throws MQClientException,
                 com.alibaba.rocketmq.remoting.exception.RemotingException,
                 InterruptedException

从接口复制的说明: MQProducer

发送消息，可以自定义选择队列，队列的总数可能会由于Broker的启停变化
如果要保证消息严格有序，在向运维人员申请Topic时，需要特别说明
异步调用

指定者:

send 在接口中 MQProducer

参数:

msg - 消息

selector - 队列选择器，发送时会回调

arg - 回调队列选择器时，此参数会传入队列选择方法

sendCallback - 发送结果通过此接口回调

抛出:

MQClientException

com.alibaba.rocketmq.remoting.exception.RemotingException

InterruptedException

sendOneway

public void sendOneway(Message msg,
              MessageQueueSelector selector,
              Object arg)
                throws MQClientException,
                       com.alibaba.rocketmq.remoting.exception.RemotingException,
                       InterruptedException

从接口复制的说明: MQProducer

发送消息，可以自定义选择队列，队列的总数可能会由于Broker的启停变化
如果要保证消息严格有序，在向运维人员申请Topic时，需要特别说明
Oneway形式，服务器不应答，无法保证消息是否成功到达服务器

指定者:

sendOneway 在接口中 MQProducer

参数:

msg - 消息

selector - 队列选择器，发送时会回调

arg - 回调队列选择器时，此参数会传入队列选择方法

抛出:

MQClientException

com.alibaba.rocketmq.remoting.exception.RemotingException

InterruptedException

sendMessageInTransaction

public TransactionSendResult sendMessageInTransaction(Message msg,
                                             LocalTransactionExecuter tranExecuter,
                                             Object arg)
                                               throws MQClientException

指定者:

sendMessageInTransaction 在接口中 MQProducer

抛出:

MQClientException

createTopic

public void createTopic(String key,
               String newTopic,
               int queueNum)
                 throws MQClientException

从接口复制的说明: MQAdmin

创建topic

指定者:

createTopic 在接口中 MQAdmin

参数:

key - 请向运维人员申请

newTopic - 要创建的新topic

queueNum - 新topic队列数

抛出:

MQClientException

searchOffset

public long searchOffset(MessageQueue mq,
                long timestamp)
                  throws MQClientException

从接口复制的说明: MQAdmin

根据时间查询对应的offset，精确到毫秒
P.S. 当前接口有较多IO开销，请勿频繁调用

指定者:

searchOffset 在接口中 MQAdmin

参数:

mq - 队列

timestamp - 毫秒形式时间戳

返回:

指定时间对应的offset

抛出:

MQClientException

maxOffset

public long maxOffset(MessageQueue mq)
               throws MQClientException

从接口复制的说明: MQAdmin

向服务器查询队列最大Offset PS: 最大Offset无对应消息，减1有消息

指定者:

maxOffset 在接口中 MQAdmin

参数:

mq - 队列

返回:

队列的最大Offset

抛出:

MQClientException

minOffset

public long minOffset(MessageQueue mq)
               throws MQClientException

从接口复制的说明: MQAdmin

向服务器查询队列最小Offset PS: 最小Offset有对应消息

指定者:

minOffset 在接口中 MQAdmin

参数:

mq - 队列

返回:

队列的最小Offset

抛出:

MQClientException

earliestMsgStoreTime

public long earliestMsgStoreTime(MessageQueue mq)
                          throws MQClientException

从接口复制的说明: MQAdmin

向服务器查询队列保存的最早消息对应的存储时间

指定者:

earliestMsgStoreTime 在接口中 MQAdmin

参数:

mq - 队列

返回:

最早消息对应的存储时间，精确到毫秒

抛出:

MQClientException

viewMessage

public MessageExt viewMessage(String msgId)
                       throws com.alibaba.rocketmq.remoting.exception.RemotingException,
                              MQBrokerException,
                              InterruptedException,
                              MQClientException

从接口复制的说明: MQAdmin

根据消息ID，从服务器获取完整的消息

指定者:

viewMessage 在接口中 MQAdmin

返回:

完整消息

抛出:

com.alibaba.rocketmq.remoting.exception.RemotingException

MQBrokerException

InterruptedException

MQClientException

queryMessage

public QueryResult queryMessage(String topic,
                       String key,
                       int maxNum,
                       long begin,
                       long end)
                         throws MQClientException,
                                InterruptedException

从接口复制的说明: MQAdmin

根据消息Key查询消息

指定者:

queryMessage 在接口中 MQAdmin

参数:

topic - 消息主题

key - 消息关键词

maxNum - 查询最大条数

begin - 起始时间戳

end - 结束时间戳

返回:

查询结果

抛出:

MQClientException

InterruptedException

getProducerGroup

public String getProducerGroup()

setProducerGroup

public void setProducerGroup(String producerGroup)

getCreateTopicKey

public String getCreateTopicKey()

setCreateTopicKey

public void setCreateTopicKey(String createTopicKey)

getSendMsgTimeout

public int getSendMsgTimeout()

setSendMsgTimeout

public void setSendMsgTimeout(int sendMsgTimeout)

getCompressMsgBodyOverHowmuch

public int getCompressMsgBodyOverHowmuch()

setCompressMsgBodyOverHowmuch

public void setCompressMsgBodyOverHowmuch(int compressMsgBodyOverHowmuch)

getDefaultMQProducerImpl

public DefaultMQProducerImpl getDefaultMQProducerImpl()

isRetryAnotherBrokerWhenNotStoreOK

public boolean isRetryAnotherBrokerWhenNotStoreOK()

setRetryAnotherBrokerWhenNotStoreOK

public void setRetryAnotherBrokerWhenNotStoreOK(boolean retryAnotherBrokerWhenNotStoreOK)

getMaxMessageSize

public int getMaxMessageSize()

setMaxMessageSize

public void setMaxMessageSize(int maxMessageSize)

getDefaultTopicQueueNums

public int getDefaultTopicQueueNums()

setDefaultTopicQueueNums

public void setDefaultTopicQueueNums(int defaultTopicQueueNums)