UDP 适配器

本节介绍如何配置和使用 UDP 适配器。

出站 UDP 适配器（XML 配置）

以下示例配置了一个 UDP 出站通道适配器

<int-ip:udp-outbound-channel-adapter id="udpOut"
    host="somehost"
    port="11111"
    multicast="false"
    socket-customizer="udpCustomizer"
    channel="exampleChannel"/>

当将 multicast 设置为 true 时，您还应在主机属性中提供多播地址。

UDP 是一种高效但不可靠的协议。Spring Integration 添加了两个属性来提高可靠性：check-length 和 acknowledge。当 check-length 设置为 true 时，适配器会在消息数据之前添加一个长度字段（网络字节序中的四个字节）。这使接收方能够验证接收到的数据包的长度。如果接收系统使用的缓冲区太短而无法容纳数据包，则数据包可能会被截断。length 标头提供了一种检测此问题的机制。

从版本 4.3 开始，您可以将 port 设置为 0，在这种情况下，操作系统会选择端口。可以在适配器启动后调用 getPort() 并且 isListening() 返回 true 来发现所选端口。

从版本 5.3.3 开始，您可以添加一个 SocketCustomizer bean 来修改 DatagramSocket（例如，调用 setTrafficClass(0x10)）。

以下示例展示了一个出站通道适配器，它为数据报包添加了长度检查。

<int-ip:udp-outbound-channel-adapter id="udpOut"
    host="somehost"
    port="11111"
    multicast="false"
    check-length="true"
    channel="exampleChannel"/>

接收数据报包的方也必须配置为预期在实际数据之前有一个长度。对于 Spring Integration UDP 入站通道适配器，请设置其 `check-length` 属性。

第二个可靠性改进允许使用应用程序级确认协议。接收方必须在指定时间内向发送方发送确认。

以下示例展示了一个出站通道适配器，它为数据报包添加了长度检查并等待确认。

<int-ip:udp-outbound-channel-adapter id="udpOut"
    host="somehost"
    port="11111"
    multicast="false"
    check-length="true"
    acknowledge="true"
    ack-host="thishost"
    ack-port="22222"
    ack-timeout="10000"
    channel="exampleChannel"/>

将 `acknowledge` 设置为 `true` 意味着数据报包的接收方可以解释添加到数据报包中的包含确认数据（主机和端口）的报头。最有可能的是，接收方是 Spring Integration 入站通道适配器。

当多播为真时，一个额外的属性（`min-acks-for-success`）指定在 `ack-timeout` 内必须接收多少个确认。

从 4.3 版本开始，您可以将 `ackPort` 设置为 `0`，在这种情况下，操作系统将选择端口。

出站 UDP 适配器（Java 配置）

以下示例展示了如何使用 Java 配置出站 UDP 适配器。

@Bean
@ServiceActivator(inputChannel = "udpOut")
public UnicastSendingMessageHandler handler() {
    return new UnicastSendingMessageHandler("localhost", 11111);
}

（或 `MulticastSendingChannelAdapter` 用于多播）。

出站 UDP 适配器（Java DSL 配置）

以下示例展示了如何使用 Java DSL 配置出站 UDP 适配器。

@Bean
public IntegrationFlow udpOutFlow() {
    return f -> f.handle(Udp.outboundAdapter("localhost", 1234)
                    .configureSocket(socket -> socket.setTrafficClass(0x10)))
                .get();
}

入站 UDP 适配器（XML 配置）

以下示例展示了如何配置一个基本的单播入站 UDP 通道适配器。

<int-ip:udp-inbound-channel-adapter id="udpReceiver"
    channel="udpOutChannel"
    port="11111"
    receive-buffer-size="500"
    multicast="false"
    socket-customizer="udpCustomizer"
    check-length="true"/>

以下示例展示了如何配置一个基本的多播入站 UDP 通道适配器。

<int-ip:udp-inbound-channel-adapter id="udpReceiver"
    channel="udpOutChannel"
    port="11111"
    receive-buffer-size="500"
    multicast="true"
    multicast-address="225.6.7.8"
    check-length="true"/>

默认情况下，不会对入站数据包执行反向 DNS 查询：在没有配置 DNS 的环境（例如 Docker 容器）中，这会导致连接延迟。要将 IP 地址转换为主机名以供消息头使用，可以通过将 `lookup-host` 属性设置为 `true` 来覆盖默认行为。

从 5.3.3 版本开始，您可以添加一个 SocketCustomizer bean 来修改 DatagramSocket，在它创建之后。它被用于接收套接字和为发送确认而创建的任何套接字。

入站 UDP 适配器（Java 配置）

以下示例展示了如何使用 Java 配置入站 UDP 适配器

@Bean
public UnicastReceivingChannelAdapter udpIn() {
    UnicastReceivingChannelAdapter adapter = new UnicastReceivingChannelAdapter(11111);
    adapter.setOutputChannelName("udpChannel");
    return adapter;
}

以下示例展示了如何使用 Java DSL 配置入站 UDP 适配器

入站 UDP 适配器（Java DSL 配置）

@Bean
public IntegrationFlow udpIn() {
    return IntegrationFlow.from(Udp.inboundAdapter(11111))
            .channel("udpChannel")
            .get();
}

服务器监听事件

从 5.0.2 版本开始，当入站适配器启动并开始监听时，会发出一个 UdpServerListeningEvent。当适配器配置为监听端口 0 时，这很有用，这意味着操作系统会选择端口。如果您需要在启动一些将连接到套接字的其他进程之前等待，也可以使用它来代替轮询 isListening()。

高级出站配置

<int-ip:udp-outbound-channel-adapter>（UnicastSendingMessageHandler）具有 destination-expression 和 socket-expression 选项。

您可以使用 destination-expression 作为硬编码 host-port 对的运行时替代方案，以确定针对 requestMessage（使用评估上下文的根对象）的传出数据报包的目标地址。表达式必须计算为一个 URI、一个 String（以 URI 样式，参见 RFC-2396）或一个 SocketAddress。您也可以使用入站 IpHeaders.PACKET_ADDRESS 标头来表示此表达式。在框架中，DatagramPacketMessageMapper 在我们接收 UnicastReceivingChannelAdapter 中的数据报并将其转换为消息时，会填充此标头。标头值与传入数据报的 DatagramPacket.getSocketAddress() 的结果完全相同。

使用 socket-expression，出站通道适配器可以使用（例如）入站通道适配器套接字通过接收数据报的相同端口发送数据报。这在我们的应用程序充当 UDP 服务器而客户端在网络地址转换 (NAT) 后面运行的情况下很有用。此表达式必须计算为一个 DatagramSocket。requestMessage 用作评估上下文的根对象。您不能将 socket-expression 参数与 multicast 和 acknowledge 参数一起使用。以下示例展示了如何配置一个 UDP 入站通道适配器，该适配器使用一个转换器将数据转换为大写，并使用一个套接字

<int-ip:udp-inbound-channel-adapter id="inbound" port="0" channel="in" />

<int:channel id="in" />

<int:transformer expression="new String(payload).toUpperCase()"
                       input-channel="in" output-channel="out"/>

<int:channel id="out" />

<int-ip:udp-outbound-channel-adapter id="outbound"
                        socket-expression="@inbound.socket"
                        destination-expression="headers['ip_packetAddress']"
                        channel="out" />

以下示例展示了使用 Java DSL 的等效配置

@Bean
public IntegrationFlow udpEchoUpcaseServer() {
    return IntegrationFlow.from(Udp.inboundAdapter(11111).id("udpIn"))
            .<byte[], String>transform(p -> new String(p).toUpperCase())
            .handle(Udp.outboundAdapter("headers['ip_packetAddress']")
                    .socketExpression("@udpIn.socket"))
            .get();
}