TCP 网关
入站 TCP 网关 TcpInboundGateway 和出站 TCP 网关 TcpOutboundGateway 分别使用服务器和客户端连接工厂。每个连接一次可以处理一个请求或响应。
入站网关在用传入的有效载荷构建消息并将其发送到 requestChannel 后,等待响应并将其有效载荷从响应消息写入连接来发送。
对于入站网关,您必须保留或填充 ip_connectionId 标头,因为它用于将消息与连接关联。源自网关的消息会自动设置该标头。如果回复是作为新消息构建的,则需要设置该标头。标头值可以从传入消息中捕获。 |
与入站适配器一样,入站网关通常使用 type="server" 连接工厂,它监听传入的连接请求。在某些情况下,您可能希望反向建立连接,使得入站网关连接到外部服务器,然后在该连接上等待并回复入站消息。
通过在入站网关上使用 client-mode="true" 来支持这种拓扑。在这种情况下,连接工厂必须是 client 类型,并且必须将 single-use 设置为 false。
两个附加属性支持此机制。retry-interval 指定(以毫秒为单位)框架在连接失败后尝试重新连接的频率。scheduler 提供一个 TaskScheduler 来调度连接尝试并测试连接是否仍然活跃。
如果网关已启动,您可以通过发送 <control-bus/> 命令 @adapter_id.retryConnection() 来强制网关建立连接,并通过 @adapter_id.isClientModeConnected() 来检查当前状态。
出站网关在通过连接发送消息后,等待响应,构建响应消息,并将其放入回复通道。连接上的通信是单线程的。一次只能处理一条消息。如果另一个线程尝试在当前响应被接收之前发送消息,它将阻塞直到任何先前的请求完成(或超时)。但是,如果客户端连接工厂配置为单次使用的连接,则每个新请求都会获得自己的连接并立即处理。以下示例配置了一个入站 TCP 网关。
<int-ip:tcp-inbound-gateway id="inGateway"
request-channel="tcpChannel"
reply-channel="replyChannel"
connection-factory="cfServer"
reply-timeout="10000"/>
如果使用配置了默认序列化器或反序列化器的连接工厂,消息将是 \r\n 分隔的数据,网关可以由简单的客户端(如 telnet)使用。
以下示例显示了一个出站 TCP 网关。
<int-ip:tcp-outbound-gateway id="outGateway"
request-channel="tcpChannel"
reply-channel="replyChannel"
connection-factory="cfClient"
request-timeout="10000"
remote-timeout="10000"/> <!-- or e.g. remote-timeout-expression="headers['timeout']" -->
client-mode 目前不适用于出站网关。
从版本 5.2 开始,出站网关可以通过属性 closeStreamAfterSend 进行配置。如果连接工厂配置为 single-use(每个请求/回复使用一个新的连接),网关将关闭输出流;这会向服务器发送 EOF 信号。如果服务器使用 EOF 而不是流中的某个分隔符来确定消息的结束,但为了接收回复而保持连接打开,这会很有用。
通常,调用线程将在网关中阻塞,等待回复(或超时)。从版本 5.3 开始,您可以将网关上的 async 属性设置为 true,发送线程将被释放以执行其他工作。回复(或错误)将在接收线程上发送。这仅适用于使用 TcpNetClientConnectionFactory 的情况,在使用 NIO 时会忽略它,因为存在一个竞态条件,即在收到回复之后发生的套接字错误可能会在回复之前传递给网关。
当使用共享连接 (singleUse=false) 时,在一个请求正在处理时发出新请求,将阻塞直到收到当前回复。如果您希望支持在长连接池上进行并发请求,请考虑使用 CachingClientConnectionFactory。 |
从版本 5.4 开始,入站可以配置 unsolicitedMessageChannel。未经请求的入站消息将发送到此通道,以及延迟回复(当客户端超时时)。为了在服务器端支持这一点,您现在可以向连接工厂注册多个 TcpSender。网关和通道适配器会自动注册。从服务器发送未经请求的消息时,您必须将适当的 IpHeaders.CONNECTION_ID 添加到发送的消息中。
另请参阅 基于注解的配置 和 使用 Java DSL 进行 TCP 组件配置。