跳到主要内容
版本：7.0.2

出站通道适配器

DeepSeek V3 中英对照 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();
}

  • 此适配器的唯一 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 会设置其值。如果未提供此属性且头部映射器也未设置，则默认值取决于 RabbitTemplate 使用的底层 Spring AMQP MessagePropertiesConverter。如果该转换器完全未自定义，则默认为 PERSISTENT。可选。

  • 定义关联数据的表达式。提供此表达式时，将配置底层 AMQP 模板以接收发布者确认。需要一个专用的 RabbitTemplate 和一个 publisherConfirms 属性设置为 true 的 CachingConnectionFactory。当收到发布者确认并提供关联数据时，根据确认类型，该数据将被写入 confirm-ack-channel 或 confirm-nack-channel。确认的有效负载是由此表达式定义的关联数据。消息具有一个 amqp_publishConfirm 头，设置为 true（ack）或 false（nack）。示例：headers['myCorrelationData'] 和 payload。版本 4.1 引入了 amqp_publishConfirmNackCause 消息头。它包含发布者确认中 nack 的 cause。从版本 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 的时间将在此值的 1 倍到 1.5 倍之间。另请参阅 发布者确认和返回的替代机制。默认无（不会生成 nack）。

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

  • 发送返回消息的通道。提供此通道时，底层 AMQP 模板将被配置为将无法投递的消息返回给适配器。当未配置 ErrorMessageStrategy 时，消息是根据从 AMQP 接收的数据构建的，并带有以下附加头：amqp_returnReplyCode、amqp_returnReplyText、amqp_returnExchange、amqp_returnRoutingKey。当存在 ErrorMessageStrategy 时，消息是一个 ErrorMessage，其有效负载为 ReturnedAmqpMessageException。另请参阅 发布者确认和返回的替代机制。可选。

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

  • 发送 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

使用 return-channel 需要将 RabbitTemplate 的 mandatory 属性设置为 true，并将 CachingConnectionFactory 的 publisherReturns 属性设置为 true。当多个出站端点使用返回机制时，每个端点都需要一个独立的 RabbitTemplate。