流支持

在许多情况下,应用程序数据是从流中获取的。不建议将对流的引用作为消息有效负载发送给消费者。相反,消息是从从输入流读取的数据创建的,并且消息有效负载逐个写入输出流。

您需要将此依赖项包含到您的项目中

  • Maven

  • Gradle

<dependency>
    <groupId>org.springframework.integration</groupId>
    <artifactId>spring-integration-stream</artifactId>
    <version>6.3.5</version>
</dependency>
compile "org.springframework.integration:spring-integration-stream:6.3.5"

从流中读取

Spring Integration 为流提供了两个适配器。ByteStreamReadingMessageSourceCharacterStreamReadingMessageSource 都实现了 MessageSource。通过在通道适配器元素中配置其中一个,可以配置轮询周期,并且消息总线可以自动检测和调度它们。字节流版本需要一个 InputStream,而字符流版本需要一个 Reader 作为唯一的构造函数参数。ByteStreamReadingMessageSource 还接受 'bytesPerMessage' 属性来确定它尝试读取到每个 Message 中的字节数。默认值为 1024。以下示例创建一个输入流,该输入流创建的消息每个包含 2048 个字节

<bean class="org.springframework.integration.stream.ByteStreamReadingMessageSource">
  <constructor-arg ref="someInputStream"/>
  <property name="bytesPerMessage" value="2048"/>
</bean>

<bean class="org.springframework.integration.stream.CharacterStreamReadingMessageSource">
  <constructor-arg ref="someReader"/>
</bean>

CharacterStreamReadingMessageSource 将读取器包装在一个 BufferedReader 中(如果它本身不是一个 BufferedReader)。您可以在第二个构造函数参数中设置缓冲读取器使用的缓冲区大小。从 5.0 版本开始,第三个构造函数参数 (blockToDetectEOF) 控制 CharacterStreamReadingMessageSource 的行为。当为 false(默认值)时,receive() 方法检查读取器是否 ready(),如果否则返回 null。在这种情况下,不会检测到 EOF(文件结束)。当为 true 时,receive() 方法会阻塞,直到数据可用或在底层流上检测到 EOF。当检测到 EOF 时,会发布一个 StreamClosedEvent(应用程序事件)。您可以使用实现 ApplicationListener<StreamClosedEvent> 的 bean 来使用此事件。

为了方便 EOF 检测,轮询线程在 receive() 方法中阻塞,直到数据到达或检测到 EOF。
一旦检测到 EOF,轮询程序就会在每次轮询时继续发布事件。应用程序侦听器可以停止适配器以防止这种情况。事件在轮询线程上发布。停止适配器会导致线程中断。如果您打算在停止适配器后执行某些可中断的任务,则必须在不同的线程上执行 stop() 或为这些下游活动使用不同的线程。请注意,发送到 QueueChannel 是可中断的,因此,如果您希望从侦听器发送消息,请在停止适配器之前执行此操作。

这有助于“管道”或将数据重定向到 stdin,如下面的两个示例所示

cat myfile.txt | java -jar my.jar
java -jar my.jar < foo.txt

这种方法允许应用程序在管道关闭时停止。

有四个方便的工厂方法可用

public static final CharacterStreamReadingMessageSource stdin() { ... }

public static final CharacterStreamReadingMessageSource stdin(String charsetName) { ... }

public static final CharacterStreamReadingMessageSource stdinPipe() { ... }

public static final CharacterStreamReadingMessageSource stdinPipe(String charsetName) { ... }

写入流

对于目标流,您可以使用以下两种实现之一:ByteStreamWritingMessageHandlerCharacterStreamWritingMessageHandler。每个都需要一个构造函数参数(字节流的 OutputStream 或字符流的 Writer),并且每个都提供第二个构造函数,该构造函数添加可选的 'bufferSize'。由于这两个最终都实现了 MessageHandler 接口,因此您可以从 channel-adapter 配置中引用它们,如 通道适配器 中所述。

<bean class="org.springframework.integration.stream.ByteStreamWritingMessageHandler">
  <constructor-arg ref="someOutputStream"/>
  <constructor-arg value="1024"/>
</bean>

<bean class="org.springframework.integration.stream.CharacterStreamWritingMessageHandler">
  <constructor-arg ref="someWriter"/>
</bean>

流命名空间支持

Spring Integration 定义了一个命名空间以减少流相关通道适配器所需的配置。需要以下架构位置才能使用它

<?xml version="1.0" encoding="UTF-8"?>
<beans:beans xmlns:int-stream="http://www.springframework.org/schema/integration/stream"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:beans="http://www.springframework.org/schema/beans"
  xsi:schemaLocation="http://www.springframework.org/schema/beans
      https://www.springframework.org/schema/beans/spring-beans.xsd
      http://www.springframework.org/schema/integration/stream
      https://www.springframework.org/schema/integration/stream/spring-integration-stream.xsd">

以下代码片段显示了支持的用于配置入站通道适配器的不同配置选项

<int-stream:stdin-channel-adapter id="adapterWithDefaultCharset"/>

<int-stream:stdin-channel-adapter id="adapterWithProvidedCharset" charset="UTF-8"/>

从 5.0 版本开始,您可以设置 detect-eof 属性,该属性设置 blockToDetectEOF 属性。有关更多信息,请参阅 从流中读取

要配置出站通道适配器,您也可以使用命名空间支持。以下示例显示了出站通道适配器的不同配置

<int-stream:stdout-channel-adapter id="stdoutAdapterWithDefaultCharset"
    channel="testChannel"/>

<int-stream:stdout-channel-adapter id="stdoutAdapterWithProvidedCharset" charset="UTF-8"
    channel="testChannel"/>

<int-stream:stderr-channel-adapter id="stderrAdapter" channel="testChannel"/>

<int-stream:stdout-channel-adapter id="newlineAdapter" append-newline="true"
    channel="testChannel"/>