出站通道适配器

以下示例展示了 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 交换机名称。如果未提供,消息将发送到默认的无名称交换机。与 'exchange-name-expression' 互斥。可选。
5 用于确定消息发送到的 AMQP 交换机名称的 SpEL 表达式,消息作为根对象。如果未提供,消息将发送到默认的无名称交换机。与 'exchange-name' 互斥。可选。
6 注册多个消费者时,此消费者的顺序,从而实现负载均衡和故障转移。可选(默认为 Ordered.LOWEST_PRECEDENCE [=Integer.MAX_VALUE])。
7 发送消息时使用的固定路由键。默认情况下,这是一个空 String。与 'routing-key-expression' 互斥。可选。
8 用于确定发送消息时使用的路由键的 SpEL 表达式,消息作为根对象(例如,'payload.key')。默认情况下,这是一个空 String。与 'routing-key' 互斥。可选。
9 消息的默认投递模式:PERSISTENT(持久)或 NON_PERSISTENT(非持久)。如果 header-mapper 设置了投递模式,则会覆盖此设置。如果存在 Spring Integration 消息头 amqp_deliveryModeDefaultHeaderMapper 将设置该值。如果未提供此属性且 header mapper 未设置,则默认值取决于 RabbitTemplate 使用的底层 Spring AMQP MessagePropertiesConverter。如果未对其进行任何自定义,则默认值为 PERSISTENT。可选。
10 一个定义关联数据的表达式。提供此项时,将配置底层 AMQP 模板以接收 publisher 确认。需要专用的 RabbitTemplate 和一个 CachingConnectionFactory,且其 publisherConfirms 属性设置为 true。当收到 publisher 确认并提供关联数据时,根据确认类型,会将其写入 confirm-ack-channelconfirm-nack-channel。确认的 payload 是此表达式定义的关联数据。消息包含一个 'amqp_publishConfirm' 头,设置为 true (`ack`) 或 false (`nack`)。示例:headers['myCorrelationData']payload。版本 4.1 引入了 amqp_publishConfirmNackCause 消息头,它包含 publisher 确认 'nack' 的 cause。从版本 4.2 开始,如果表达式解析为 Message<?> 实例(例如 #this),则在 ack/nack 通道上发出的消息将基于该消息,并添加额外头。之前,无论类型如何,都会创建一个以关联数据作为 payload 的新消息。另请参阅 Publisher 确认和 Return 的替代机制。可选。
11 用于发送肯定 (`ack`) publisher 确认的通道。payload 是由 confirm-correlation-expression 定义的关联数据。如果表达式是 #root#this,则消息将基于原始消息构建,并设置 amqp_publishConfirm 头为 true。另请参阅 Publisher 确认和 Return 的替代机制。可选(默认为 nullChannel)。
12 用于发送否定 (`nack`) publisher 确认的通道。payload 是由 confirm-correlation-expression 定义的关联数据(如果未配置 ErrorMessageStrategy)。如果表达式是 #root#this,则消息将基于原始消息构建,并设置 amqp_publishConfirm 头为 false。如果配置了 ErrorMessageStrategy,则消息是一个 ErrorMessage,其 payload 是 NackedAmqpMessageException。另请参阅 Publisher 确认和 Return 的替代机制。可选(默认为 nullChannel)。
13 设置此项时,如果在指定毫秒时间内未收到 publisher 确认,适配器将合成一个否定确认 (nack)。待处理的确认每隔此值的 50% 进行检查,因此实际发送 nack 的时间将介于此值的 1 倍到 1.5 倍之间。另请参阅 Publisher 确认和 Return 的替代机制。默认无(不生成 nack)。
14 设置为 true 时,调用线程将阻塞,等待 publisher 确认。这需要配置用于确认的 RabbitTemplate 以及 confirm-correlation-expression。线程将阻塞直到 confirm-timeout(或默认 5 秒)。如果发生超时,将抛出 MessageTimeoutException。如果启用了 returns 并且消息被 returned,或在等待确认期间发生任何其他异常,将抛出 MessageHandlingException,并附带适当的消息。
15 用于发送 Returned 消息的通道。提供此项时,将配置底层 AMQP 模板将无法投递的消息 Returned 给适配器。如果未配置 ErrorMessageStrategy,则消息将根据从 AMQP 接收到的数据构建,并包含以下额外头:amqp_returnReplyCodeamqp_returnReplyTextamqp_returnExchangeamqp_returnRoutingKey。如果配置了 ErrorMessageStrategy,则消息是一个 ErrorMessage,其 payload 是 ReturnedAmqpMessageException。另请参阅 Publisher 确认和 Return 的替代机制。可选。
16 引用用于构建 ErrorMessage 实例的 ErrorMessageStrategy 实现,用于发送 Returned 或否定确认的消息。
17 发送 AMQP 消息时使用的 AmqpHeaderMapper 引用。默认情况下,只有标准 AMQP 属性(例如 contentType)会被复制到 Spring Integration MessageHeaders。任何用户定义的头都不会被默认的 DefaultAmqpHeaderMapper 复制到消息中。如果提供了 'request-header-names' 则不允许使用此项。可选。
18 逗号分隔的 AMQP 头名称列表,用于从 MessageHeaders 映射到 AMQP Message。如果提供了 'header-mapper' 引用,则不允许使用此项。此列表中的值也可以是与头名称匹配的简单模式(例如 "*""thing1*, thing2""*thing1")。
19 设置为 false 时,端点会在应用程序上下文初始化期间尝试连接到 broker。这允许“快速失败”检测不良配置,但也可能导致在 broker 关闭时初始化失败。当设置为 true(默认值)时,连接会在发送第一条消息时建立(如果因其他组件已建立连接而尚未存在)。
20 设置为 true 时,类型为 Iterable<Message<?>> 的 payloads 将在单个 RabbitTemplate 调用范围内,作为单独的消息发送到同一通道。需要一个 RabbitTemplate。当 wait-for-confirms 为 true 时,消息发送后会调用 RabbitTemplate.waitForConfirmsOrDie()。对于事务性模板,发送操作将在新事务或已启动的事务中执行(如果存在)。
return-channel

使用 return-channel 需要一个 RabbitTemplate,其 mandatory 属性设置为 true,以及一个 CachingConnectionFactory,其 publisherReturns 属性设置为 true。当使用多个启用 returns 的出站端点时,每个端点需要一个单独的 RabbitTemplate