org.apache.rocketmq.spring.core

类 RocketMQTemplate

java.lang.Object

org.springframework.messaging.core.AbstractMessageSendingTemplate<String>

org.apache.rocketmq.spring.core.RocketMQTemplate

所有已实现的接口:

org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.messaging.core.MessageSendingOperations<String>

public class RocketMQTemplate
extends org.springframework.messaging.core.AbstractMessageSendingTemplate<String>
implements org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.DisposableBean

字段概要

从类继承的字段 org.springframework.messaging.core.AbstractMessageSendingTemplate

CONVERSION_HINT_HEADER, logger

构造器概要

构造器

构造器和说明
RocketMQTemplate()

方法概要

限定符和类型	方法和说明
void	afterPropertiesSet()
void	asyncSend(String destination, org.springframework.messaging.Message<?> message, org.apache.rocketmq.client.producer.SendCallback sendCallback) Send message to broker asynchronously. asynchronous transmission is generally used in response time sensitive business scenarios.
void	asyncSend(String destination, org.springframework.messaging.Message<?> message, org.apache.rocketmq.client.producer.SendCallback sendCallback, long timeout) Same to asyncSend(String, Message, SendCallback) with send timeout specified in addition.
void	asyncSend(String destination, org.springframework.messaging.Message<?> message, org.apache.rocketmq.client.producer.SendCallback sendCallback, long timeout, int delayLevel) Same to asyncSend(String, Message, SendCallback) with send timeout and delay level specified in addition.
void	asyncSend(String destination, Object payload, org.apache.rocketmq.client.producer.SendCallback sendCallback) Same to asyncSend(String, Message, SendCallback).
void	asyncSend(String destination, Object payload, org.apache.rocketmq.client.producer.SendCallback sendCallback, long timeout) Same to asyncSend(String, Object, SendCallback) with send timeout specified in addition.
void	asyncSendOrderly(String destination, org.springframework.messaging.Message<?> message, String hashKey, org.apache.rocketmq.client.producer.SendCallback sendCallback) Same to asyncSend(String, Message, SendCallback) with send orderly with hashKey by specified.
void	asyncSendOrderly(String destination, org.springframework.messaging.Message<?> message, String hashKey, org.apache.rocketmq.client.producer.SendCallback sendCallback, long timeout) Same to asyncSendOrderly(String, Message, String, SendCallback) with send timeout specified in addition.
void	asyncSendOrderly(String destination, Object payload, String hashKey, org.apache.rocketmq.client.producer.SendCallback sendCallback) Same to asyncSendOrderly(String, Message, String, SendCallback).
void	asyncSendOrderly(String destination, Object payload, String hashKey, org.apache.rocketmq.client.producer.SendCallback sendCallback, long timeout) Same to asyncSendOrderly(String, Object, String, SendCallback) with send timeout specified in addition.
boolean	createAndStartTransactionMQProducer(String txProducerGroup, RocketMQLocalTransactionListener transactionListener, ExecutorService executorService, org.apache.rocketmq.remoting.RPCHook rpcHook) Create and start a transaction MQProducer, this new producer is cached in memory.
void	destroy()
protected org.springframework.messaging.Message<?>	doConvert(Object payload, Map<String,Object> headers, org.springframework.messaging.core.MessagePostProcessor postProcessor)
protected void	doSend(String destination, org.springframework.messaging.Message<?> message)
String	getCharset()
org.apache.rocketmq.client.producer.MessageQueueSelector	getMessageQueueSelector()
com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
org.apache.rocketmq.client.producer.DefaultMQProducer	getProducer()
void	removeTransactionMQProducer(String txProducerGroup) Remove a TransactionMQProducer from cache by manual.
org.apache.rocketmq.client.producer.TransactionSendResult	sendMessageInTransaction(String txProducerGroup, String destination, org.springframework.messaging.Message<?> message, Object arg) Send Spring Message in Transaction
void	sendOneWay(String destination, org.springframework.messaging.Message<?> message) Similar to UDP, this method won't wait for acknowledgement from broker before return.
void	sendOneWay(String destination, Object payload) Same to sendOneWay(String, Message)
void	sendOneWayOrderly(String destination, org.springframework.messaging.Message<?> message, String hashKey) Same to sendOneWay(String, Message) with send orderly with hashKey by specified.
void	sendOneWayOrderly(String destination, Object payload, String hashKey) Same to sendOneWayOrderly(String, Message, String)
void	setCharset(String charset)
void	setMessageQueueSelector(org.apache.rocketmq.client.producer.MessageQueueSelector messageQueueSelector)
void	setObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)
void	setProducer(org.apache.rocketmq.client.producer.DefaultMQProducer producer)
org.apache.rocketmq.client.producer.SendResult	syncSend(String destination, Collection<org.springframework.messaging.Message<?>> messages, long timeout) syncSend batch messages in a given timeout.
org.apache.rocketmq.client.producer.SendResult	syncSend(String destination, org.springframework.messaging.Message<?> message) Send message in synchronous mode.
org.apache.rocketmq.client.producer.SendResult	syncSend(String destination, org.springframework.messaging.Message<?> message, long timeout) Same to syncSend(String, Message) with send timeout specified in addition.
org.apache.rocketmq.client.producer.SendResult	syncSend(String destination, org.springframework.messaging.Message<?> message, long timeout, int delayLevel) Same to syncSend(String, Message) with send timeout specified in addition.
org.apache.rocketmq.client.producer.SendResult	syncSend(String destination, Object payload) Same to syncSend(String, Message).
org.apache.rocketmq.client.producer.SendResult	syncSend(String destination, Object payload, long timeout) Same to syncSend(String, Object) with send timeout specified in addition.
org.apache.rocketmq.client.producer.SendResult	syncSendOrderly(String destination, org.springframework.messaging.Message<?> message, String hashKey) Same to syncSend(String, Message) with send orderly with hashKey by specified.
org.apache.rocketmq.client.producer.SendResult	syncSendOrderly(String destination, org.springframework.messaging.Message<?> message, String hashKey, long timeout) Same to syncSendOrderly(String, Message, String) with send timeout specified in addition.
org.apache.rocketmq.client.producer.SendResult	syncSendOrderly(String destination, Object payload, String hashKey) Same to syncSend(String, Object) with send orderly with hashKey by specified.
org.apache.rocketmq.client.producer.SendResult	syncSendOrderly(String destination, Object payload, String hashKey, long timeout) Same to syncSendOrderly(String, Object, String) with send timeout specified in addition.

从类继承的方法 org.springframework.messaging.core.AbstractMessageSendingTemplate

convertAndSend, convertAndSend, convertAndSend, convertAndSend, convertAndSend, convertAndSend, getDefaultDestination, getMessageConverter, getRequiredDefaultDestination, processHeadersToSend, send, send, setDefaultDestination, setMessageConverter

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

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

构造器详细资料

RocketMQTemplate

public RocketMQTemplate()

方法详细资料

getProducer

public org.apache.rocketmq.client.producer.DefaultMQProducer getProducer()

setProducer

public void setProducer(org.apache.rocketmq.client.producer.DefaultMQProducer producer)

getObjectMapper

public com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()

setObjectMapper

public void setObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

getCharset

public String getCharset()

setCharset

public void setCharset(String charset)

getMessageQueueSelector

public org.apache.rocketmq.client.producer.MessageQueueSelector getMessageQueueSelector()

setMessageQueueSelector

public void setMessageQueueSelector(org.apache.rocketmq.client.producer.MessageQueueSelector messageQueueSelector)

syncSend

public org.apache.rocketmq.client.producer.SendResult syncSend(String destination,
                                                               org.springframework.messaging.Message<?> message)

Send message in synchronous mode. This method returns only when the sending procedure totally completes. Reliable synchronous transmission is used in extensive scenes, such as important notification messages, SMS notification, SMS marketing system, etc..

Warn: this method has internal retry-mechanism, that is, internal implementation will retry DefaultMQProducer.getRetryTimesWhenSendFailed() times before claiming failure. As a result, multiple messages may potentially delivered to broker(s). It's up to the application developers to resolve potential duplication issue.

参数:

destination - formats: `topicName:tags`

message - Message

返回:

SendResult

syncSend

public org.apache.rocketmq.client.producer.SendResult syncSend(String destination,
                                                               org.springframework.messaging.Message<?> message,
                                                               long timeout)

Same to syncSend(String, Message) with send timeout specified in addition.

参数:

destination - formats: `topicName:tags`

message - Message

timeout - send timeout with millis

返回:

SendResult

syncSend

public org.apache.rocketmq.client.producer.SendResult syncSend(String destination,
                                                               Collection<org.springframework.messaging.Message<?>> messages,
                                                               long timeout)

syncSend batch messages in a given timeout.

参数:

destination - formats: `topicName:tags`

messages - Collection of Message

timeout - send timeout with millis

返回:

SendResult

syncSend

public org.apache.rocketmq.client.producer.SendResult syncSend(String destination,
                                                               org.springframework.messaging.Message<?> message,
                                                               long timeout,
                                                               int delayLevel)

Same to syncSend(String, Message) with send timeout specified in addition.

参数:

destination - formats: `topicName:tags`

message - Message

timeout - send timeout with millis

delayLevel - level for the delay message

返回:

SendResult

syncSend

public org.apache.rocketmq.client.producer.SendResult syncSend(String destination,
                                                               Object payload)

Same to syncSend(String, Message).

参数:

destination - formats: `topicName:tags`

payload - the Object to use as payload

返回:

SendResult

syncSend

public org.apache.rocketmq.client.producer.SendResult syncSend(String destination,
                                                               Object payload,
                                                               long timeout)

Same to syncSend(String, Object) with send timeout specified in addition.

参数:

destination - formats: `topicName:tags`

payload - the Object to use as payload

timeout - send timeout with millis

返回:

SendResult

syncSendOrderly

public org.apache.rocketmq.client.producer.SendResult syncSendOrderly(String destination,
                                                                      org.springframework.messaging.Message<?> message,
                                                                      String hashKey)

Same to syncSend(String, Message) with send orderly with hashKey by specified.

参数:

destination - formats: `topicName:tags`

message - Message

hashKey - use this key to select queue. for example: orderId, productId ...

返回:

SendResult

syncSendOrderly

public org.apache.rocketmq.client.producer.SendResult syncSendOrderly(String destination,
                                                                      org.springframework.messaging.Message<?> message,
                                                                      String hashKey,
                                                                      long timeout)

Same to syncSendOrderly(String, Message, String) with send timeout specified in addition.

参数:

destination - formats: `topicName:tags`

message - Message

hashKey - use this key to select queue. for example: orderId, productId ...

timeout - send timeout with millis

返回:

SendResult

syncSendOrderly

public org.apache.rocketmq.client.producer.SendResult syncSendOrderly(String destination,
                                                                      Object payload,
                                                                      String hashKey)

Same to syncSend(String, Object) with send orderly with hashKey by specified.

参数:

destination - formats: `topicName:tags`

payload - the Object to use as payload

hashKey - use this key to select queue. for example: orderId, productId ...

返回:

SendResult

syncSendOrderly

public org.apache.rocketmq.client.producer.SendResult syncSendOrderly(String destination,
                                                                      Object payload,
                                                                      String hashKey,
                                                                      long timeout)

Same to syncSendOrderly(String, Object, String) with send timeout specified in addition.

参数:

destination - formats: `topicName:tags`

payload - the Object to use as payload

hashKey - use this key to select queue. for example: orderId, productId ...

timeout - send timeout with millis

返回:

SendResult

asyncSend

public void asyncSend(String destination,
                      org.springframework.messaging.Message<?> message,
                      org.apache.rocketmq.client.producer.SendCallback sendCallback,
                      long timeout,
                      int delayLevel)

Same to asyncSend(String, Message, SendCallback) with send timeout and delay level specified in addition.

参数:

destination - formats: `topicName:tags`

message - Message

sendCallback - SendCallback

timeout - send timeout with millis

delayLevel - level for the delay message

asyncSend

public void asyncSend(String destination,
                      org.springframework.messaging.Message<?> message,
                      org.apache.rocketmq.client.producer.SendCallback sendCallback,
                      long timeout)

Same to asyncSend(String, Message, SendCallback) with send timeout specified in addition.

参数:

destination - formats: `topicName:tags`

message - Message

sendCallback - SendCallback

timeout - send timeout with millis

asyncSend

public void asyncSend(String destination,
                      org.springframework.messaging.Message<?> message,
                      org.apache.rocketmq.client.producer.SendCallback sendCallback)

Send message to broker asynchronously. asynchronous transmission is generally used in response time sensitive business scenarios.

This method returns immediately. On sending completion, sendCallback will be executed.

Similar to syncSend(String, Object), internal implementation would potentially retry up to DefaultMQProducer.getRetryTimesWhenSendAsyncFailed() times before claiming sending failure, which may yield message duplication and application developers are the one to resolve this potential issue.

参数:

destination - formats: `topicName:tags`

message - Message

sendCallback - SendCallback

asyncSend

public void asyncSend(String destination,
                      Object payload,
                      org.apache.rocketmq.client.producer.SendCallback sendCallback,
                      long timeout)

Same to asyncSend(String, Object, SendCallback) with send timeout specified in addition.

参数:

destination - formats: `topicName:tags`

payload - the Object to use as payload

sendCallback - SendCallback

timeout - send timeout with millis

asyncSend

public void asyncSend(String destination,
                      Object payload,
                      org.apache.rocketmq.client.producer.SendCallback sendCallback)

Same to asyncSend(String, Message, SendCallback).

参数:

destination - formats: `topicName:tags`

payload - the Object to use as payload

sendCallback - SendCallback

asyncSendOrderly

public void asyncSendOrderly(String destination,
                             org.springframework.messaging.Message<?> message,
                             String hashKey,
                             org.apache.rocketmq.client.producer.SendCallback sendCallback,
                             long timeout)

Same to asyncSendOrderly(String, Message, String, SendCallback) with send timeout specified in addition.

参数:

destination - formats: `topicName:tags`

message - Message

hashKey - use this key to select queue. for example: orderId, productId ...

sendCallback - SendCallback

timeout - send timeout with millis

asyncSendOrderly

public void asyncSendOrderly(String destination,
                             org.springframework.messaging.Message<?> message,
                             String hashKey,
                             org.apache.rocketmq.client.producer.SendCallback sendCallback)

Same to asyncSend(String, Message, SendCallback) with send orderly with hashKey by specified.

参数:

destination - formats: `topicName:tags`

message - Message

hashKey - use this key to select queue. for example: orderId, productId ...

sendCallback - SendCallback

asyncSendOrderly

public void asyncSendOrderly(String destination,
                             Object payload,
                             String hashKey,
                             org.apache.rocketmq.client.producer.SendCallback sendCallback)

Same to asyncSendOrderly(String, Message, String, SendCallback).

参数:

destination - formats: `topicName:tags`

payload - the Object to use as payload

hashKey - use this key to select queue. for example: orderId, productId ...

sendCallback - SendCallback

asyncSendOrderly

public void asyncSendOrderly(String destination,
                             Object payload,
                             String hashKey,
                             org.apache.rocketmq.client.producer.SendCallback sendCallback,
                             long timeout)

Same to asyncSendOrderly(String, Object, String, SendCallback) with send timeout specified in addition.

参数:

destination - formats: `topicName:tags`

payload - the Object to use as payload

hashKey - use this key to select queue. for example: orderId, productId ...

sendCallback - SendCallback

timeout - send timeout with millis

sendOneWay

public void sendOneWay(String destination,
                       org.springframework.messaging.Message<?> message)

Similar to UDP, this method won't wait for acknowledgement from broker before return. Obviously, it has maximums throughput yet potentials of message loss.

One-way transmission is used for cases requiring moderate reliability, such as log collection.

参数:

destination - formats: `topicName:tags`

message - Message

sendOneWay

public void sendOneWay(String destination,
                       Object payload)

Same to sendOneWay(String, Message)

参数:

destination - formats: `topicName:tags`

payload - the Object to use as payload

sendOneWayOrderly

public void sendOneWayOrderly(String destination,
                              org.springframework.messaging.Message<?> message,
                              String hashKey)

Same to sendOneWay(String, Message) with send orderly with hashKey by specified.

参数:

destination - formats: `topicName:tags`

message - Message

hashKey - use this key to select queue. for example: orderId, productId ...

sendOneWayOrderly

public void sendOneWayOrderly(String destination,
                              Object payload,
                              String hashKey)

Same to sendOneWayOrderly(String, Message, String)

参数:

destination - formats: `topicName:tags`

payload - the Object to use as payload

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

指定者:

afterPropertiesSet 在接口中 org.springframework.beans.factory.InitializingBean

抛出:

Exception

doSend

protected void doSend(String destination,
                      org.springframework.messaging.Message<?> message)

指定者:

doSend 在类中 org.springframework.messaging.core.AbstractMessageSendingTemplate<String>

doConvert

protected org.springframework.messaging.Message<?> doConvert(Object payload,
                                                             Map<String,Object> headers,
                                                             org.springframework.messaging.core.MessagePostProcessor postProcessor)

覆盖:

doConvert 在类中 org.springframework.messaging.core.AbstractMessageSendingTemplate<String>

destroy

public void destroy()

指定者:

destroy 在接口中 org.springframework.beans.factory.DisposableBean

sendMessageInTransaction

public org.apache.rocketmq.client.producer.TransactionSendResult sendMessageInTransaction(String txProducerGroup,
                                                                                          String destination,
                                                                                          org.springframework.messaging.Message<?> message,
                                                                                          Object arg)
                                                                                   throws org.springframework.messaging.MessagingException

Send Spring Message in Transaction

参数:

txProducerGroup - the validate txProducerGroup name, set null if using the default name

destination - destination formats: `topicName:tags`

message - message Message

arg - ext arg

返回:

TransactionSendResult

抛出:

org.springframework.messaging.MessagingException

removeTransactionMQProducer

public void removeTransactionMQProducer(String txProducerGroup)
                                 throws org.springframework.messaging.MessagingException

Remove a TransactionMQProducer from cache by manual.

Note: RocketMQTemplate can release all cached producers when bean destroying, it is not recommended to directly use this method by user.

参数:

txProducerGroup -

抛出:

org.springframework.messaging.MessagingException

createAndStartTransactionMQProducer

public boolean createAndStartTransactionMQProducer(String txProducerGroup,
                                                   RocketMQLocalTransactionListener transactionListener,
                                                   ExecutorService executorService,
                                                   org.apache.rocketmq.remoting.RPCHook rpcHook)
                                            throws org.springframework.messaging.MessagingException

Create and start a transaction MQProducer, this new producer is cached in memory.

Note: This method is invoked internally when processing @RocketMQLocalTransactionListener, it is not recommended to directly use this method by user.

参数:

txProducerGroup - Producer (group) name, unique for each producer

transactionListener - TransactoinListener impl class

executorService - Nullable.

rpcHook - Nullable.

返回:

true if producer is created and started; false if the named producer already exists in cache.

抛出:

org.springframework.messaging.MessagingException