跳到主要内容

流支持

QWen Plus 中英对照 Stream Support

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

你需要将这个依赖项添加到你的项目中：

<dependency>
    <groupId>org.springframework.integration</groupId>
    <artifactId>spring-integration-stream</artifactId>
    <version>6.4.2</version>
</dependency>
xml

从流读取​

Spring Integration 提供了两种用于流的适配器。ByteStreamReadingMessageSource 和 CharacterStreamReadingMessageSource 都实现了 MessageSource。通过在 channel-adapter 元素内配置其中一个，可以配置轮询周期，并且消息总线可以自动检测和调度它们。字节流版本需要一个 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>
xml

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

备注

为了便于检测 EOF，轮询线程在 receive() 方法中阻塞，直到数据到达或检测到 EOF。

important

轮询器在检测到 EOF 后继续在每次轮询时发布一个事件。应用程序监听器可以停止适配器以防止这种情况。事件是在轮询线程上发布的。停止适配器会导致线程被中断。如果你打算在停止适配器后执行一些可中断的任务，你必须要么在不同的线程上执行 stop()，要么为这些下游活动使用不同的线程。请注意，向 QueueChannel 发送是可中断的，因此，如果你想从监听器发送消息，请在停止适配器之前进行。

这便于“管道”或重定向数据到 stdin，如下两个示例所示：

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

这种方法可以让应用程序在管道关闭时停止。

提供了四种方便的工厂方法：

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

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

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

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

写入流​

对于目标流，您可以使用两种实现中的任意一种：ByteStreamWritingMessageHandler 或 CharacterStreamWritingMessageHandler。每种实现都需要一个构造函数参数（字节流的 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>
xml

流命名空间支持​

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">
xml

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

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

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

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

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

<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"/>
xml