跳到主要内容

输出通道适配器

QWen Plus 中英对照 Outbound Channel Adapter

以下示例显示了 AMQP 外发通道适配器的可用属性：

@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();
}
java

  • 此适配器的唯一 ID。可选。

  • 消息应发送到的消息通道，以将其转换并发布到 AMQP 交换。必需。

  • 已配置的 AMQP 模板的 Bean 引用。可选（默认为 amqpTemplate）。

  • 消息发送到的 AMQP 交换的名称。如果没有提供，消息将发送到默认的无名交换。与 'exchange-name-expression' 互斥。可选。

  • 一个 SpEL 表达式，用于确定消息发送到的 AMQP 交换的名称，消息作为根对象进行评估。如果没有提供，消息将发送到默认的无名交换。与 'exchange-name' 互斥。可选。

  • 当注册多个消费者时此消费者的顺序，从而实现负载均衡和故障转移。可选（默认为 Ordered.LOWEST_PRECEDENCE [=Integer.MAX_VALUE]）。

  • 发送消息时使用的固定路由键。默认情况下，这是一个空的 String。与 'routing-key-expression' 互斥。可选。

  • 一个 SpEL 表达式，用于确定发送消息时使用的路由键，消息作为根对象进行评估（例如，'payload.key'）。默认情况下，这是一个空的 String。与 'routing-key' 互斥。可选。

  • 消息的默认传递模式：PERSISTENT 或 NON_PERSISTENT。如果 header-mapper 设置了传递模式，则会覆盖此设置。如果存在 Spring Integration 消息头 amqp_deliveryMode，DefaultHeaderMapper 会设置该值。如果未提供此属性且头映射器未设置它，则默认取决于底层 Spring AMQP MessagePropertiesConverter，由 RabbitTemplate 使用。如果完全未自定义，默认为 PERSISTENT。可选。

  • 定义相关数据的表达式。当提供时，这会配置底层 AMQP 模板以接收发布确认。需要一个专用的 RabbitTemplate 和 CachingConnectionFactory，并且 publisherConfirms 属性设置为 true。当收到发布确认并且提供了相关数据时，它会被写入 confirm-ack-channel 或 confirm-nack-channel，具体取决于确认类型。确认的有效载荷是根据此表达式定义的相关数据。消息具有 'amqp_publishConfirm' 头，设置为 true (ack) 或 false (nack)。版本 4.1 引入了 amqp_publishConfirmNackCause 消息头。它包含发布确认的 'nack' 的 原因。从版本 4.2 开始，如果表达式解析为 Message<?> 实例（如 #this），则在 ack/nack 通道上发出的消息基于该消息，并添加额外的头。以前，无论类型如何，都会创建一个新消息，其有效载荷为相关数据。另请参阅 发布确认和返回的替代机制。可选。

  • 正向 (ack) 发布确认发送到的通道。有效载荷是由 confirm-correlation-expression 定义的相关数据。如果表达式是 #root 或 #this，消息将从原始消息构建，amqp_publishConfirm 头设置为 true。另请参阅 发布确认和返回的替代机制。可选（默认为 nullChannel）。

  • 负向 (nack) 发布确认发送到的通道。有效载荷是由 confirm-correlation-expression 定义的相关数据（如果没有配置 ErrorMessageStrategy）。如果表达式是 #root 或 #this，消息将从原始消息构建，amqp_publishConfirm 头设置为 false。当有 ErrorMessageStrategy 时，消息是一个 ErrorMessage，有效载荷为 NackedAmqpMessageException。另请参阅 发布确认和返回的替代机制。可选（默认为 nullChannel）。

  • 设置后，适配器将在指定毫秒内未收到发布确认时合成负确认（nack）。每 50% 的这个值检查一次待确认，因此实际发送 nack 的时间会在 1x 到 1.5x 这个值之间。另请参阅 发布确认和返回的替代机制。默认无（不会生成 nack）。

  • 设置为 true 时，调用线程将阻塞，等待发布确认。这需要配置了确认的 RabbitTemplate 以及 confirm-correlation-expression。线程最多会阻塞 confirm-timeout（默认为 5 秒）。如果超时发生，将抛出 MessageTimeoutException。如果启用了返回并且消息被返回，或者在等待确认期间发生任何其他异常，将抛出带有适当消息的 MessageHandlingException。

  • 返回消息发送到的通道。当提供时，底层 AMQP 模板将配置为将不可投递的消息返回给适配器。如果没有配置 ErrorMessageStrategy，消息将根据从 AMQP 接收到的数据构建，并附加以下额外头：amqp_returnReplyCode、amqp_returnReplyText、amqp_returnExchange、amqp_returnRoutingKey。如果有 ErrorMessageStrategy，消息是一个 ErrorMessage，有效载荷为 ReturnedAmqpMessageException。另请参阅 发布确认和返回的替代机制。可选。

  • 用于构建 ErrorMessage 实例的 ErrorMessageStrategy 实现的引用，在发送返回或负确认消息时使用。

  • 用于发送 AMQP 消息时使用的 AmqpHeaderMapper 的引用。默认情况下，只有标准 AMQP 属性（如 contentType）会被复制到 Spring Integration MessageHeaders 中。默认的 DefaultAmqpHeaderMapper 不会将任何用户定义的头复制到消息中。如果提供了 'request-header-names'，则不允许。可选。

  • 从 MessageHeaders 映射到 AMQP 消息的 AMQP 头名称的逗号分隔列表。如果提供了 'header-mapper' 引用，则不允许。此列表中的值也可以是与头名称匹配的简单模式（例如 "*" 或 "thing1*, thing2" 或 "*thing1"）。

  • 设置为 false 时，端点会在应用程序上下文初始化期间尝试连接到代理。这允许快速检测不良配置，但也可能导致初始化失败，如果代理关闭的话。当 true（默认），连接会在发送第一条消息时建立（如果因为其他组件已经建立了连接而不存在，则不重新建立）。

  • 设置为 true 时，类型为 Iterable<Message<?>> 的有效载荷将作为离散消息在同一通道内发送，在单个 RabbitTemplate 调用范围内。需要 RabbitTemplate。当 wait-for-confirms 为 true 时，消息发送后会调用 RabbitTemplate.waitForConfirmsOrDie()。对于事务性模板，发送将在新事务或已启动的事务中执行（如果存在）。

important

返回通道

使用 return-channel 需要一个 RabbitTemplate，其 mandatory 属性设置为 true，并且需要一个 CachingConnectionFactory，其 publisherReturns 属性设置为 true。当使用多个带有返回功能的 outbound 终结点时，每个终结点都需要一个单独的 RabbitTemplate。