程序包 org.apache.rocketmq.spring.annotation

注释类型 RocketMQMessageListener

@Target(TYPE)
@Retention(RUNTIME)
@Documented
public @interface RocketMQMessageListener

字段概要

字段

修饰符和类型	字段	说明
static String	ACCESS_CHANNEL_PLACEHOLDER
static String	ACCESS_KEY_PLACEHOLDER
static String	NAME_SERVER_PLACEHOLDER
static String	SECRET_KEY_PLACEHOLDER
static String	TRACE_TOPIC_PLACEHOLDER

必需元素概要

所需元素

修饰符和类型	必需的元素	说明
String	consumerGroup	Consumers of the same role is required to have exactly same subscriptions and consumerGroup to correctly achieve load balance.
String	topic	Topic name.

可选元素概要

可选元素

修饰符和类型	可选元素	说明
String	accessChannel	The property of "access-channel".
String	accessKey	The property of "access-key".
int	awaitTerminationMillisWhenShutdown	Maximum time to await message consuming when shutdown consumer, in milliseconds.
ConsumeMode	consumeMode	Control consume mode, you can choice receive message concurrently or orderly.
int	consumeThreadMax	Max consumer thread number.
int	consumeThreadNumber	consumer thread number.
long	consumeTimeout	Maximum amount of time in minutes a message may block the consuming thread.
String	customizedTraceTopic	The name value of message trace topic.If you don't config,you can use the default trace topic name.
int	delayLevelWhenNextConsume	Message consume retry strategy in concurrently mode
boolean	enableMsgTrace	Switch flag instance for message trace.
String	instanceName	The property of "instanceName".
int	maxReconsumeTimes	Max re-consume times.
MessageModel	messageModel	Control message mode, if you want all subscribers receive message all message, broadcasting is a good choice.
String	nameServer	The property of "name-server".
String	namespace	The namespace of consumer.
String	namespaceV2	The namespace V2 version of listener, it can not be used in combination with namespace.
int	replyTimeout	Timeout for sending reply messages.
String	secretKey	The property of "secret-key".
String	selectorExpression	Control which message can be select.
SelectorType	selectorType	Control how to selector message.
int	suspendCurrentQueueTimeMillis	The interval of suspending the pull in orderly mode, in milliseconds.
String	tlsEnable	The property of "tlsEnable" default false.

字段详细资料

NAME_SERVER_PLACEHOLDER

static final String NAME_SERVER_PLACEHOLDER

ACCESS_KEY_PLACEHOLDER

static final String ACCESS_KEY_PLACEHOLDER

SECRET_KEY_PLACEHOLDER

static final String SECRET_KEY_PLACEHOLDER

TRACE_TOPIC_PLACEHOLDER

static final String TRACE_TOPIC_PLACEHOLDER

ACCESS_CHANNEL_PLACEHOLDER

static final String ACCESS_CHANNEL_PLACEHOLDER

元素详细资料

consumerGroup

String consumerGroup

Consumers of the same role is required to have exactly same subscriptions and consumerGroup to correctly achieve load balance. It's required and needs to be globally unique. See here for further discussion.

topic

String topic

Topic name.

selectorType

SelectorType selectorType

Control how to selector message.

另请参阅:

SelectorType

默认值:

org.apache.rocketmq.spring.annotation.SelectorType.TAG

selectorExpression

String selectorExpression

Control which message can be select. Grammar please see SelectorType.TAG and SelectorType.SQL92

默认值:

"*"

consumeMode

ConsumeMode consumeMode

Control consume mode, you can choice receive message concurrently or orderly.

默认值:

org.apache.rocketmq.spring.annotation.ConsumeMode.CONCURRENTLY

messageModel

MessageModel messageModel

Control message mode, if you want all subscribers receive message all message, broadcasting is a good choice.

默认值:

org.apache.rocketmq.spring.annotation.MessageModel.CLUSTERING

consumeThreadMax

int consumeThreadMax

Max consumer thread number. This property control consumer thread pool executor maximumPoolSize see ConsumeMessageService.updateCorePoolSize(int)

另请参阅:

issues#546

默认值:

64

consumeThreadNumber

int consumeThreadNumber

consumer thread number.

默认值:

20

maxReconsumeTimes

int maxReconsumeTimes

Max re-consume times. In concurrently mode, -1 means 16; In orderly mode, -1 means Integer.MAX_VALUE.

默认值:

-1

consumeTimeout

long consumeTimeout

Maximum amount of time in minutes a message may block the consuming thread.

默认值:

15L

replyTimeout

int replyTimeout

Timeout for sending reply messages.

默认值:

3000

accessKey

String accessKey

The property of "access-key".

默认值:

"${rocketmq.consumer.access-key:}"

secretKey

String secretKey

The property of "secret-key".

默认值:

"${rocketmq.consumer.secret-key:}"

enableMsgTrace

boolean enableMsgTrace

Switch flag instance for message trace.

默认值:

false

customizedTraceTopic

String customizedTraceTopic

The name value of message trace topic.If you don't config,you can use the default trace topic name.

默认值:

"${rocketmq.consumer.customized-trace-topic:}"

nameServer

String nameServer

The property of "name-server".

默认值:

"${rocketmq.name-server:}"

accessChannel

String accessChannel

The property of "access-channel".

默认值:

"${rocketmq.access-channel:}"

tlsEnable

String tlsEnable

The property of "tlsEnable" default false.

默认值:

"false"

namespace

String namespace

The namespace of consumer.

默认值:

""

namespaceV2

String namespaceV2

The namespace V2 version of listener, it can not be used in combination with namespace.

默认值:

""

delayLevelWhenNextConsume

int delayLevelWhenNextConsume

Message consume retry strategy in concurrently mode. -1,no retry,put into DLQ directly 0,broker control retry frequency >0,client control retry frequency

默认值:

0

suspendCurrentQueueTimeMillis

int suspendCurrentQueueTimeMillis

The interval of suspending the pull in orderly mode, in milliseconds. The minimum value is 10 and the maximum is 30000.

默认值:

1000

awaitTerminationMillisWhenShutdown

int awaitTerminationMillisWhenShutdown

Maximum time to await message consuming when shutdown consumer, in milliseconds. The minimum value is 0

默认值:

1000

instanceName

String instanceName

The property of "instanceName".

默认值:

"DEFAULT"