|
对于最新的稳定版本，请使用 Spring Integration 6.5.1！ |
TCP 连接工厂
概述
对于 TCP，基础连接的配置是通过使用连接工厂提供的。 提供两种类型的连接工厂：客户端连接工厂和服务器连接工厂。 客户端连接工厂建立传出连接。 服务器连接工厂侦听传入连接。
出站通道适配器使用客户机连接工厂，但您也可以提供对入站通道适配器的客户机连接工厂的引用。 该适配器接收在出站适配器创建的连接上接收的任何传入消息。
入站通道适配器或网关使用服务器连接工厂。 （事实上，没有一个，连接工厂就无法运行）。 您还可以提供对出站适配器的服务器连接工厂的引用。 然后，您可以使用该适配器向同一连接上的传入邮件发送回复。
仅当回复包含ip_connectionId由连接工厂插入到原始消息中的标头。 |
| 这是在入站和出站适配器之间共享连接工厂时执行的消息关联范围。 这种共享允许通过 TCP 进行异步双向通信。 默认情况下，仅使用 TCP 传输有效负载信息。 因此，任何消息关联都必须由下游组件（例如聚合器或其他终结点）执行。 3.0 版中引入了对传输选定标头的支持。 有关详细信息，请参阅 TCP 消息关联。 |
您可以向每种类型的最多一个适配器提供对连接工厂的引用。
Spring Integration提供了使用该连接工厂的连接工厂java.net.Socket和java.nio.channel.SocketChannel.
以下示例显示了一个简单的服务器连接工厂，该工厂使用java.net.Socket连接：
<int-ip:tcp-connection-factory id="server"
type="server"
port="1234"/>以下示例显示了一个简单的服务器连接工厂，该工厂使用java.nio.channel.SocketChannel连接：
<int-ip:tcp-connection-factory id="server"
type="server"
port="1234"
using-nio="true"/>从 Spring Integration 版本 4.2 开始，如果服务器配置为侦听随机端口（通过将端口设置为0），您可以使用以下命令获取作系统选择的实际端口getPort().
也getServerSocketAddress()让您获得完整的SocketAddress.
请参阅Javadoc 的TcpServerConnectionFactory接口了解更多信息。 |
<int-ip:tcp-connection-factory id="client"
type="client"
host="localhost"
port="1234"
single-use="true"
so-timeout="10000"/>以下示例显示了使用java.net.Socketconnections 并为每条消息创建一个新连接：
<int-ip:tcp-connection-factory id="client"
type="client"
host="localhost"
port="1234"
single-use="true"
so-timeout="10000"
using-nio=true/>从 V5.2 开始，客户端连接工厂支持connectTimeout，以秒为单位指定，默认为 60。
消息分界（序列化程序和反序列化程序）
TCP 是一种流协议。 这意味着必须为通过 TCP 传输的数据提供一些结构，以便接收方可以将数据划分为离散的消息。 连接工厂配置为使用序列化程序和反序列化程序在消息有效负载和通过 TCP 发送的位之间进行转换。 这是通过分别为入站和出站消息提供反序列化程序和序列化程序来实现的。 Spring Integration 提供了许多标准序列化器和反序列化器。
ByteArrayCrlfSerializer*将字节数组转换为字节流，后跟回车符和换行符 （\r\n).
这是默认的序列化程序（和反序列化程序），可以（例如）与 telnet 一起使用作为客户端。
这ByteArraySingleTerminatorSerializer*将字节数组转换为字节流，后跟单个终止字符（默认值为0x00).
这ByteArrayLfSerializer*将字节数组转换为字节流，后跟单个换行字符 （0x0a).
这ByteArrayStxEtxSerializer*将字节数组转换为前面有 STX （0x02），然后是 ETX （0x03).
这ByteArrayLengthHeaderSerializer将字节数组转换为前面按网络字节顺序（大端）排列的二进制长度的字节流。
这是一个高效的反序列化器，因为它不必解析每个字节来查找终止字符序列。
它还可用于包含二进制数据的有效负载。
前面的序列化程序仅支持有效负载中的文本。
长度标头的默认大小为 4 个字节（一个整数），允许最多 （2^31 - 1） 字节的消息。
但是，length对于最多 255 字节的消息，标头可以是单个字节（无符号），对于最多 （2^16 - 1） 字节的消息，标头可以是无符号短字节（2 字节）。
如果您需要任何其他格式的标头，您可以子类化ByteArrayLengthHeaderSerializer并为readHeader和writeHeader方法。
绝对最大数据大小为 （2^31 - 1） 字节。
从版本 5.2 开始，标头值除了有效负载之外还可以包括标头的长度。
将inclusive属性来启用该机制（必须为生产者和使用者设置相同的机制）。
这ByteArrayRawSerializer*，将字节数组转换为字节流，并且不添加额外的消息分界数据。
使用此序列化程序 （和反序列化程序） ，客户端以有序方式关闭套接字来指示消息的结束。
使用此序列化程序时，消息接收将挂起，直到客户端关闭套接字或发生超时。
超时不会导致消息。
当使用此序列化程序并且客户端是 Spring Integration 应用程序时，客户端必须使用配置为single-use="true".
这样做会导致适配器在发送消息后关闭套接字。
序列化程序本身不会关闭连接。
您应该仅将此序列化程序用于通道适配器（而不是网关）使用的连接工厂，并且连接工厂应由入站或出站适配器使用，但不能同时由两者使用。
也可以看看ByteArrayElasticRawDeserializer，在本节后面。
但是，从版本 5.2 开始，出站网关有一个新属性closeStreamAfterSend;这允许使用原始序列化程序/反序列化程序，因为 EOF 会向服务器发出信号，同时保持连接打开以接收回复。
在 4.2.2 版之前，当使用非阻塞 I/O （NIO） 时，该序列化器将超时（读取期间）视为文件结束，并且到目前为止读取的数据作为消息发出。
这是不可靠的，不应用于分隔消息。
它现在将此类情况视为例外。
万一以这种方式使用它，您可以通过将treatTimeoutAsEndOfMessageconstructor 参数设置为true. |
其中每一个都是AbstractByteArraySerializer，它实现了org.springframework.core.serializer.Serializer和org.springframework.core.serializer.Deserializer.
为了向后兼容，使用AbstractByteArraySerializer对于序列化，也接受String首先转换为字节数组。
这些序列化程序和反序列化程序中的每一个都将包含相应格式的输入流转换为字节数组有效负载。
为了避免由于行为不良的客户端（不遵守已配置序列化程序的协议）而导致内存耗尽，这些序列化程序会强制设置最大消息大小。
如果传入邮件超过此大小，则会引发异常。
默认最大消息大小为 2048 字节。
您可以通过设置maxMessageSize财产。
如果您使用缺省序列化程序或反序列化程序并希望增加最大消息大小，则必须将最大消息大小声明为显式 Bean，并使用maxMessageSize属性设置并配置连接工厂以使用该 Bean。
本节前面标记的类使用中间缓冲区，并将解码的数据复制到大小正确的最终缓冲区。
从 4.3 版开始，您可以通过设置*poolSize属性，让这些原始缓冲区被重用，而不是为每条消息分配和丢弃，这是默认行为。
将属性设置为负值将创建一个没有边界的池。
如果池是有界的，您还可以将poolWaitTimeout属性（以毫秒为单位），之后如果没有可用的缓冲区，则会引发异常。
它默认为无大。
此类异常会导致套接字关闭。
如果您希望在自定义反序列化器中使用相同的机制，您可以扩展AbstractPooledBufferByteArraySerializer（而不是它的超类，AbstractByteArraySerializer）并实现doDeserialize()而不是deserialize().
缓冲区会自动返回到池中。AbstractPooledBufferByteArraySerializer还提供了一种方便的实用方法：copyToSizedArray().
5.0 版本添加了ByteArrayElasticRawDeserializer.
这类似于ByteArrayRawSerializer上面，除了没有必要设置一个maxMessageSize.
在内部，它使用ByteArrayOutputStream这让缓冲液根据需要增长。
客户端必须有序关闭套接字，以发出消息结束的信号。
| 仅当对等方受信任时，才应使用此反序列化程序;由于内存不足，它容易受到 DoS 附加的影响。 |
这MapJsonSerializer使用JacksonObjectMapper在Map和 JSON。
您可以将此序列化程序与MessageConvertingTcpMessageMapper和MapMessageConverter以 JSON 格式传输选定的标头和有效负载。
JacksonObjectMapper无法划分流中的消息。
因此，MapJsonSerializer需要委托给另一个序列化程序或反序列化程序来处理消息分界。
默认情况下，一个ByteArrayLfSerializer，则生成格式为<json><LF>在网络上，但您可以将其配置为使用其他。
（下一个示例演示了如何执行此作。 |
最终的标准序列化程序是org.springframework.core.serializer.DefaultSerializer，您可以使用它来转换具有 Java 序列化的可序列化对象。org.springframework.core.serializer.DefaultDeserializer用于对包含可序列化对象的流进行入站反序列化。
如果您不想使用默认序列化器和反序列化程序 （ByteArrayCrLfSerializer），您必须将serializer和deserializer属性。
以下示例显示了如何执行此作：
<bean id="javaSerializer"
class="org.springframework.core.serializer.DefaultSerializer" />
<bean id="javaDeserializer"
class="org.springframework.core.serializer.DefaultDeserializer" />
<int-ip:tcp-connection-factory id="server"
type="server"
port="1234"
deserializer="javaDeserializer"
serializer="javaSerializer"/>使用java.net.Socket连接，并在网络上使用 Java 序列化。
有关连接工厂上可用属性的完整详细信息，请参阅本节末尾的参考。
默认情况下，不对入站数据包执行反向 DNS 查找：在未配置 DNS 的环境（例如 Docker 容器）中，这可能会导致连接延迟。
要将 IP 地址转换为主机名以用于邮件头，可以通过将lookup-host属性设置为true.
| 您还可以修改套接字和套接字工厂的属性。 有关更多信息，请参阅 SSL/TLS 支持。 如前所述，如果使用 SSL 或不使用 SSL，则可以进行此类修改。 |
自定义序列化器和解串化器
如果你的数据不是标准反序列化程序之一支持的格式，你可以实现自己的格式;还可以实现自定义序列化程序。
要实现自定义序列化器和反序列化器对，请实现org.springframework.core.serializer.Deserializer和org.springframework.core.serializer.Serializer接口。
当反序列化程序检测到消息之间的关闭输入流时，它必须引发SoftEndOfStreamException;这是向框架发出的信号，表明收盘价是“正常”的。
如果在解码消息时关闭流，则应引发其他异常。
从 5.2 版本开始，SoftEndOfStreamException现在是一个RuntimeException而不是扩展IOException.
TCP 故障转移客户端连接工厂
您可以配置支持故障转移到一个或多个其他服务器的 TCP 连接工厂。 发送消息时，工厂会遍历其所有配置的工厂，直到可以发送消息或找不到连接。 最初，使用已配置列表中的第一个工厂。 如果连接随后失败，则下一个工厂将成为当前工厂。 以下示例演示如何配置故障转移客户端连接工厂：
<bean id="failCF" class="o.s.i.ip.tcp.connection.FailoverClientConnectionFactory">
<constructor-arg>
<list>
<ref bean="clientFactory1"/>
<ref bean="clientFactory2"/>
</list>
</constructor-arg>
</bean>使用故障转移连接工厂时，singleUse属性必须在工厂本身和它配置为使用的工厂列表之间保持一致。 |
当与共享连接 （singleUse=false):
-
refreshSharedInterval -
closeOnRefresh
根据上述配置，请考虑以下方案：
比方说clientFactory1无法建立连接，但clientFactory2能。
当failCF getConnection()方法在refreshSharedInterval已通过，我们将再次尝试使用clientFactory1;如果成功，则连接到clientFactory2将关闭。
如果closeOnRefresh是false，“旧”连接将保持打开状态，如果第一个工厂再次出现故障，将来可能会重复使用。
设置refreshSharedInterval仅在该时间到期后才尝试重新连接第一家工厂;将其设置为Long.MAX_VALUE（默认）如果您只想在当前连接失败时故障恢复到第一个工厂。
设置closeOnRefresh在刷新后关闭“旧”连接实际上会创建一个新连接。
如果任何委托工厂是CachingClientConnectionFactory因为连接缓存在那里处理;在这种情况下，将始终查阅连接工厂列表以获取连接。 |
从 5.3 版开始，这些默认为Long.MAX_VALUE和true因此，工厂仅在当前连接失败时才尝试故障回复。
要恢复到以前版本的默认行为，请将它们设置为0和false.
另请参阅测试连接。
TCP 线程关联连接工厂
Spring Integration 5.0 版引入了这个连接工厂。
它将连接绑定到调用线程，并且每次该线程发送消息时都会重复使用相同的连接。
这种情况一直持续到连接关闭（由服务器或网络）或直到线程调用releaseConnection()方法。
连接本身由另一个客户端工厂实现提供，必须将其配置为提供非共享（一次性）连接，以便每个线程获得连接。
以下示例显示如何配置 TCP 线程关联连接工厂：
@Bean
public TcpNetClientConnectionFactory cf() {
TcpNetClientConnectionFactory cf = new TcpNetClientConnectionFactory("localhost",
Integer.parseInt(System.getProperty(PORT)));
cf.setSingleUse(true);
return cf;
}
@Bean
public ThreadAffinityClientConnectionFactory tacf() {
return new ThreadAffinityClientConnectionFactory(cf());
}
@Bean
@ServiceActivator(inputChannel = "out")
public TcpOutboundGateway outGate() {
TcpOutboundGateway outGate = new TcpOutboundGateway();
outGate.setConnectionFactory(tacf());
outGate.setReplyChannelName("toString");
return outGate;
}