以下示例显示了 AMQP 出站通道适配器的可用属性:
-
Java DSL
-
Java
-
XML
@Bean
public IntegrationFlow amqpOutbound(AmqpTemplate amqpTemplate,
MessageChannel amqpOutboundChannel) {
return IntegrationFlow.from(amqpOutboundChannel)
.handle(Amqp.outboundAdapter(amqpTemplate)
.routingKey("queue1")) // default exchange - route to queue 'queue1'
.get();
}
@Bean
@ServiceActivator(inputChannel = "amqpOutboundChannel")
public AmqpOutboundEndpoint amqpOutbound(AmqpTemplate amqpTemplate) {
AmqpOutboundEndpoint outbound = new AmqpOutboundEndpoint(amqpTemplate);
outbound.setRoutingKey("queue1"); // default exchange - route to queue 'queue1'
return outbound;
}
@Bean
public MessageChannel amqpOutboundChannel() {
return new DirectChannel();
}
<int-amqp:outbound-channel-adapter id="outboundAmqp" (1)
channel="outboundChannel" (2)
amqp-template="myAmqpTemplate" (3)
exchange-name="" (4)
exchange-name-expression="" (5)
order="1" (6)
routing-key="" (7)
routing-key-expression="" (8)
default-delivery-mode"" (9)
confirm-correlation-expression="" (10)
confirm-ack-channel="" (11)
confirm-nack-channel="" (12)
confirm-timeout="" (13)
wait-for-confirm="" (14)
return-channel="" (15)
error-message-strategy="" (16)
header-mapper="" (17)
mapped-request-headers="" (18)
lazy-connect="true" (19)
multi-send="false"/> (20)
1 | 此适配器的唯一 ID。 自选。 |
2 | 消息通道,应将消息发送到该通道,以便将消息转换并发布到 AMQP 交换。 必填。 |
3 | 对已配置的 AMQP 模板的 Bean 引用。
可选 (默认为 )。amqpTemplate |
4 | 消息发送到的 AMQP 交换的名称。 如果未提供,则消息将发送到默认的 no-name 交换。 与 'exchange-name-expression' 互斥。 自选。 |
5 | 一个 SPEL 表达式,用于确定消息发送到的 AMQP 交换的名称,并将消息作为根对象。 如果未提供,则消息将发送到默认的 no-name 交换。 与 'exchange-name' 互斥。 自选。 |
6 | 注册多个使用者时此使用者的顺序,从而启用负载均衡和故障转移。
可选 (默认为 )。Ordered.LOWEST_PRECEDENCE [=Integer.MAX_VALUE] |
7 | 发送消息时使用的固定 routing-key。
默认情况下,这是一个空的 .
与 'routing-key-expression' 互斥。
自选。String |
8 | 一个 SPEL 表达式,用于确定发送消息时要使用的路由键,并将消息作为根对象(例如,'payload.key')。
默认情况下,这是一个空的 .
与 'routing-key' 互斥。
自选。String |
9 | 邮件的默认传递模式:或 .
如果设置了传递模式,则被覆盖。
如果存在 Spring Integration 消息标头,则设置值。
如果未提供此属性并且标头映射器未设置它,则默认值取决于 .
如果根本没有自定义,则默认值为 。
自选。PERSISTENT NON_PERSISTENT header-mapper amqp_deliveryMode DefaultHeaderMapper MessagePropertiesConverter RabbitTemplate PERSISTENT |
10 | 定义相关数据的表达式。
如果提供,这会将底层 AMQP 模板配置为接收发布者确认。
需要 dedicated 和 a,并将属性设置为 。
收到发布者确认并提供关联数据后,会将其写入 或 ,具体取决于确认类型。
确认的有效负载是相关数据,如此表达式所定义。
邮件的 'amqp_publishConfirm' 报头设置为 () 或 ()。
示例:和 .
版本 4.1 引入了消息标头。
它包含用于发布者确认的 'nack'。
从版本 4.2 开始,如果表达式解析为实例(例如 ),则在 / 通道上发出的消息基于该消息,并添加了其他 Headers。
以前,无论类型如何,都会使用关联数据作为其负载创建新消息。
另请参阅发布者确认和返回的替代机制。
自选。RabbitTemplate CachingConnectionFactory publisherConfirms true confirm-ack-channel confirm-nack-channel true ack false nack headers['myCorrelationData'] payload amqp_publishConfirmNackCause cause Message<?> #this ack nack |
11 | positive () 发布者确认发送到的渠道。
有效负载是由 .
如果表达式为 或 ,则消息是从原始消息构建的,标题设置为 。
另请参阅发布者确认和返回的替代机制。
可选(默认值为 )。ack confirm-correlation-expression #root #this amqp_publishConfirm true nullChannel |
12 | 否定 () 发布者确认发送到的渠道。
payload 是由 定义的关联数据(如果未配置)。
如果表达式为 或 ,则消息是从原始消息构建的,标题设置为 。
当存在 时,消息是具有有效负载的 an。
另请参阅发布者确认和返回的替代机制。
可选(默认值为 )。nack confirm-correlation-expression ErrorMessageStrategy #root #this amqp_publishConfirm false ErrorMessageStrategy ErrorMessage NackedAmqpMessageException nullChannel |
13 | 设置后,如果在此时间(以毫秒为单位)内未收到发布者确认,则适配器将合成否定确认 (nack)。 待处理确认每检查一次此值的 50%,因此发送 nack 的实际时间将介于此值的 1 倍到 1.5 倍之间。 另请参阅发布者确认和返回的替代机制。 默认无(不会生成 nack)。 |
14 | 当设置为 true 时,调用线程将阻塞,等待发布者确认。
这需要为 confirm 配置一个 以及 .
线程将阻塞长达 (或默认为 5 秒)。
如果发生超时,将引发 a。
如果启用了返回并返回了一条消息,或者在等待确认时发生任何其他异常,则将引发 a,并显示相应的消息。RabbitTemplate confirm-correlation-expression confirm-timeout MessageTimeoutException MessageHandlingException |
15 | 返回的消息发送到的通道。
如果提供,则底层 AMQP 模板配置为将无法传递的消息返回给适配器。
如果未配置,则根据从 AMQP 接收的数据构建消息,并具有以下附加标头: , , , 。
当存在 时,消息是具有有效负载的 an。
另请参阅发布者确认和返回的替代机制。
自选。ErrorMessageStrategy amqp_returnReplyCode amqp_returnReplyText amqp_returnExchange amqp_returnRoutingKey ErrorMessageStrategy ErrorMessage ReturnedAmqpMessageException |
16 | 对用于在发送返回或否定确认消息时构建实例的实现的引用。ErrorMessageStrategy ErrorMessage |
17 | 对发送 AMQP 消息时使用的引用。
默认情况下,只有标准的 AMQP 属性(例如 )被复制到 Spring Integration 。
默认的'DefaultAmqpHeaderMapper'不会将任何用户定义的 Headers 复制到消息中。
如果提供了 'request-header-names',则不允许。
自选。AmqpHeaderMapper contentType MessageHeaders |
18 | 要从 映射到 AMQP 消息的 AMQP 标头名称的逗号分隔列表。
如果提供了 'header-mapper' 引用,则不允许。
此列表中的值也可以是与 Headers 名称匹配的简单模式(例如 或 或 )。MessageHeaders "*" "thing1*, thing2" "*thing1" |
19 | 设置为 时,端点将在应用程序上下文初始化期间尝试连接到代理。
这允许对错误配置进行 “fail fast” 检测,但如果 broker 宕机,也会导致初始化失败。
When (默认值),在发送第一条消息时建立连接(如果它尚不存在,因为其他组件建立了它)。false true |
20 | 当设置为 时,类型的有效负载将作为离散消息在单次调用范围内的同一通道上发送。
需要 .
When is true,在发送消息后调用。
使用事务模板,将在新事务或已启动的事务(如果存在)中执行发送。true Iterable<Message<?>> RabbitTemplate RabbitTemplate wait-for-confirms RabbitTemplate.waitForConfirmsOrDie() |
1 | 此适配器的唯一 ID。 自选。 |
2 | 消息通道,应将消息发送到该通道,以便将消息转换并发布到 AMQP 交换。 必填。 |
3 | 对已配置的 AMQP 模板的 Bean 引用。
可选 (默认为 )。amqpTemplate |
4 | 消息发送到的 AMQP 交换的名称。 如果未提供,则消息将发送到默认的 no-name 交换。 与 'exchange-name-expression' 互斥。 自选。 |
5 | 一个 SPEL 表达式,用于确定消息发送到的 AMQP 交换的名称,并将消息作为根对象。 如果未提供,则消息将发送到默认的 no-name 交换。 与 'exchange-name' 互斥。 自选。 |
6 | 注册多个使用者时此使用者的顺序,从而启用负载均衡和故障转移。
可选 (默认为 )。Ordered.LOWEST_PRECEDENCE [=Integer.MAX_VALUE] |
7 | 发送消息时使用的固定 routing-key。
默认情况下,这是一个空的 .
与 'routing-key-expression' 互斥。
自选。String |
8 | 一个 SPEL 表达式,用于确定发送消息时要使用的路由键,并将消息作为根对象(例如,'payload.key')。
默认情况下,这是一个空的 .
与 'routing-key' 互斥。
自选。String |
9 | 邮件的默认传递模式:或 .
如果设置了传递模式,则被覆盖。
如果存在 Spring Integration 消息标头,则设置值。
如果未提供此属性并且标头映射器未设置它,则默认值取决于 .
如果根本没有自定义,则默认值为 。
自选。PERSISTENT NON_PERSISTENT header-mapper amqp_deliveryMode DefaultHeaderMapper MessagePropertiesConverter RabbitTemplate PERSISTENT |
10 | 定义相关数据的表达式。
如果提供,这会将底层 AMQP 模板配置为接收发布者确认。
需要 dedicated 和 a,并将属性设置为 。
收到发布者确认并提供关联数据后,会将其写入 或 ,具体取决于确认类型。
确认的有效负载是相关数据,如此表达式所定义。
邮件的 'amqp_publishConfirm' 报头设置为 () 或 ()。
示例:和 .
版本 4.1 引入了消息标头。
它包含用于发布者确认的 'nack'。
从版本 4.2 开始,如果表达式解析为实例(例如 ),则在 / 通道上发出的消息基于该消息,并添加了其他 Headers。
以前,无论类型如何,都会使用关联数据作为其负载创建新消息。
另请参阅发布者确认和返回的替代机制。
自选。RabbitTemplate CachingConnectionFactory publisherConfirms true confirm-ack-channel confirm-nack-channel true ack false nack headers['myCorrelationData'] payload amqp_publishConfirmNackCause cause Message<?> #this ack nack |
11 | positive () 发布者确认发送到的渠道。
有效负载是由 .
如果表达式为 或 ,则消息是从原始消息构建的,标题设置为 。
另请参阅发布者确认和返回的替代机制。
可选(默认值为 )。ack confirm-correlation-expression #root #this amqp_publishConfirm true nullChannel |
12 | 否定 () 发布者确认发送到的渠道。
payload 是由 定义的关联数据(如果未配置)。
如果表达式为 或 ,则消息是从原始消息构建的,标题设置为 。
当存在 时,消息是具有有效负载的 an。
另请参阅发布者确认和返回的替代机制。
可选(默认值为 )。nack confirm-correlation-expression ErrorMessageStrategy #root #this amqp_publishConfirm false ErrorMessageStrategy ErrorMessage NackedAmqpMessageException nullChannel |
13 | 设置后,如果在此时间(以毫秒为单位)内未收到发布者确认,则适配器将合成否定确认 (nack)。 待处理确认每检查一次此值的 50%,因此发送 nack 的实际时间将介于此值的 1 倍到 1.5 倍之间。 另请参阅发布者确认和返回的替代机制。 默认无(不会生成 nack)。 |
14 | 当设置为 true 时,调用线程将阻塞,等待发布者确认。
这需要为 confirm 配置一个 以及 .
线程将阻塞长达 (或默认为 5 秒)。
如果发生超时,将引发 a。
如果启用了返回并返回了一条消息,或者在等待确认时发生任何其他异常,则将引发 a,并显示相应的消息。RabbitTemplate confirm-correlation-expression confirm-timeout MessageTimeoutException MessageHandlingException |
15 | 返回的消息发送到的通道。
如果提供,则底层 AMQP 模板配置为将无法传递的消息返回给适配器。
如果未配置,则根据从 AMQP 接收的数据构建消息,并具有以下附加标头: , , , 。
当存在 时,消息是具有有效负载的 an。
另请参阅发布者确认和返回的替代机制。
自选。ErrorMessageStrategy amqp_returnReplyCode amqp_returnReplyText amqp_returnExchange amqp_returnRoutingKey ErrorMessageStrategy ErrorMessage ReturnedAmqpMessageException |
16 | 对用于在发送返回或否定确认消息时构建实例的实现的引用。ErrorMessageStrategy ErrorMessage |
17 | 对发送 AMQP 消息时使用的引用。
默认情况下,只有标准的 AMQP 属性(例如 )被复制到 Spring Integration 。
默认的'DefaultAmqpHeaderMapper'不会将任何用户定义的 Headers 复制到消息中。
如果提供了 'request-header-names',则不允许。
自选。AmqpHeaderMapper contentType MessageHeaders |
18 | 要从 映射到 AMQP 消息的 AMQP 标头名称的逗号分隔列表。
如果提供了 'header-mapper' 引用,则不允许。
此列表中的值也可以是与 Headers 名称匹配的简单模式(例如 或 或 )。MessageHeaders "*" "thing1*, thing2" "*thing1" |
19 | 设置为 时,端点将在应用程序上下文初始化期间尝试连接到代理。
这允许对错误配置进行 “fail fast” 检测,但如果 broker 宕机,也会导致初始化失败。
When (默认值),在发送第一条消息时建立连接(如果它尚不存在,因为其他组件建立了它)。false true |
20 | 当设置为 时,类型的有效负载将作为离散消息在单次调用范围内的同一通道上发送。
需要 .
When is true,在发送消息后调用。
使用事务模板,将在新事务或已启动的事务(如果存在)中执行发送。true Iterable<Message<?>> RabbitTemplate RabbitTemplate wait-for-confirms RabbitTemplate.waitForConfirmsOrDie() |
return-channel (返回通道)
使用 a 需要 a 且 属性设置为 ,以及 a 且 属性设置为 。
当使用多个带返回的出站终端节点时,每个终端节点都需要一个单独的终端节点。 |
return-channel (返回通道)
使用 a 需要 a 且 属性设置为 ,以及 a 且 属性设置为 。
当使用多个带返回的出站终端节点时,每个终端节点都需要一个单独的终端节点。 |