写入文件

要将消息写入文件系统，可以使用 FileWritingMessageHandler。此类可以处理以下有效负载类型

  • 文件

  • 字符串

  • 字节数组

  • InputStream（自版本 4.2起）

对于字符串有效负载，您可以配置编码和字符集。

为了简化操作，您可以使用 XML 命名空间将 FileWritingMessageHandler 配置为出站通道适配器或出站网关的一部分。

从版本 4.3 开始，您可以指定写入文件时要使用的缓冲区大小。

从版本 5.1 开始，您可以提供一个 BiConsumer<File, Message<?>> newFileCallback，如果使用 FileExistsMode.APPEND 或 FileExistsMode.APPEND_NO_FLUSH 并且必须创建一个新文件，则会触发此回调。此回调接收新创建的文件和触发它的消息。例如，此回调可用于写入消息头中定义的 CSV 标题。

生成文件名

在最简单的形式中，FileWritingMessageHandler 只需要一个用于写入文件的目标目录。要写入的文件名由处理程序的 FileNameGenerator 确定。 默认实现 查找其键与定义为 FileHeaders.FILENAME 的常量匹配的消息头。

或者，您可以指定一个表达式，该表达式针对消息进行评估以生成文件名，例如 headers['myCustomHeader'] + '.something'。表达式必须评估为 String。为了方便起见，DefaultFileNameGenerator 还提供了 setHeaderName 方法，允许您显式指定其值用作文件名的消息头。

设置后，DefaultFileNameGenerator 使用以下解析步骤来确定给定消息有效负载的文件名

  1. 针对消息评估表达式，如果结果是非空 String，则将其用作文件名。

  2. 否则，如果有效负载是 java.io.File，则使用 File 对象的文件名。

  3. 否则，使用附加有 .msg 的消息 ID 作为文件名。

当您使用 XML 命名空间支持时，文件出站通道适配器和文件出站网关都支持以下互斥配置属性

  • filename-generator（对 FileNameGenerator 实现的引用）

  • filename-generator-expression（评估为 String 的表达式）

在写入文件时，会使用临时文件后缀（其默认值为 .writing）。在写入文件时将其附加到文件名。要自定义后缀，您可以在文件出站通道适配器和文件出站网关上都设置 temporary-file-suffix 属性。

使用 APPEND 文件 mode 时，将忽略 temporary-file-suffix 属性，因为数据会直接附加到文件。

从版本 4.2.5 开始，生成的文件名（作为 filename-generator 或 filename-generator-expression 评估的结果）可以表示子路径以及目标文件名。它以前用作 File(File parent, String child) 的第二个构造函数参数。但是，过去我们没有为子路径创建（mkdirs()）目录，只假定文件名。这种方法对于需要恢复文件系统树以匹配源目录的情况很有用，例如，解压缩存档并将所有文件按原始顺序保存到目标目录中。

指定输出目录

文件出站通道适配器和文件出站网关都提供两个互斥配置属性来指定输出目录

  • directory

  • directory-expression

Spring Integration 2.2 引入了 directory-expression 属性。

使用 directory 属性

当您使用 directory 属性时，输出目录将设置为固定值，该值在初始化 FileWritingMessageHandler 时设置。如果您未指定此属性，则必须使用 directory-expression 属性。

使用 directory-expression 属性

如果您希望获得完整的 SpEL 支持，则可以使用 directory-expression 属性。此属性接受一个 SpEL 表达式，该表达式针对正在处理的每条消息进行评估。因此，在动态指定输出文件目录时，您可以完全访问消息的有效负载及其标头。

SpEL 表达式必须解析为 String、java.io.File 或 org.springframework.core.io.Resource。（后者无论如何都会评估为 File。）此外，生成的 String 或 File 必须指向目录。如果您未指定 directory-expression 属性，则必须设置 directory 属性。

使用 auto-create-directory 属性

默认情况下，如果目标目录不存在，则会自动创建相应的目标目录和任何不存在的父目录。要阻止此行为，您可以将 auto-create-directory 属性设置为 false。此属性适用于 directory 和 directory-expression 属性。

当使用 directory 属性且 auto-create-directory 为 false 时，从 Spring Integration 2.2 开始进行了以下更改

不再在适配器初始化时检查目标目录是否存在，而是现在针对正在处理的每条消息执行此检查。

此外，如果 auto-create-directory 为 true 并且目录在消息处理之间被删除，则会为正在处理的每条消息重新创建该目录。

处理现有目标文件

当您写入文件并且目标文件已存在时，默认行为是覆盖该目标文件。您可以通过在相关的文件出站组件上设置 mode 属性来更改此行为。存在以下选项

  • REPLACE（默认值）

  • REPLACE_IF_MODIFIED

  • APPEND

  • APPEND_NO_FLUSH

  • FAIL

  • IGNORE

Spring Integration 2.2 引入了 mode 属性以及 APPEND、FAIL 和 IGNORE 选项。
REPLACE

如果目标文件已存在，则将其覆盖。如果未指定 mode 属性，则这是写入文件时的默认行为。

REPLACE_IF_MODIFIED

如果目标文件已存在，则仅当上次修改时间戳与源文件的时间戳不同时才覆盖它。对于 File 有效负载，将有效负载 lastModified 时间与现有文件进行比较。对于其他有效负载，将 FileHeaders.SET_MODIFIED (file_setModified) 标头与现有文件进行比较。如果标头丢失或其值为非 Number，则始终替换文件。

APPEND

此模式允许您将消息内容附加到现有文件，而不是每次都创建新文件。请注意，此属性与 temporary-file-suffix 属性互斥，因为当它将内容附加到现有文件时，适配器不再使用临时文件。每个消息后都会关闭文件。

APPEND_NO_FLUSH

此选项与 APPEND 具有相同的语义，但数据不会刷新，并且每个消息后都不会关闭文件。这可以在发生故障时以数据丢失的风险为代价提供显着的性能。有关更多信息，请参阅 使用 APPEND_NO_FLUSH 时刷新文件。

FAIL

如果目标文件存在，则会抛出 MessageHandlingException。

IGNORE

如果目标文件存在，则会静默忽略消息有效负载。

当使用临时文件后缀（默认值为 .writing）时，如果最终文件名或临时文件名存在，则 IGNORE 选项适用。

使用 APPEND_NO_FLUSH 时刷新文件

APPEND_NO_FLUSH 模式是在版本 4.3 中添加的。使用它可以提高性能，因为每个消息后都不会关闭文件。但是，这可能导致发生故障时数据丢失。

Spring Integration 提供了几种刷新策略来减少这种数据丢失

  • 使用 flushInterval。如果一段时间内未写入文件，则会自动刷新该文件。这是近似的，可能高达此时间的 1.33x（平均为 1.167x）。

  • 向消息处理程序的 trigger 方法发送包含正则表达式的消息。与模式匹配的绝对路径名的文件将被刷新。

  • 为处理程序提供自定义 MessageFlushPredicate 实现以修改发送消息到 trigger 方法时采取的操作。

  • 通过传入自定义 FileWritingMessageHandler.FlushPredicate 或 FileWritingMessageHandler.MessageFlushPredicate 实现来调用处理程序的 flushIfNeeded 方法之一。

针对每个打开的文件调用谓词。有关更多信息，请参阅这些接口的 Javadoc。请注意，从版本 5.0 开始，谓词方法提供了另一个参数：如果文件是新创建或之前已关闭，则提供该文件首次写入的时间。

使用 flushInterval 时，间隔从上次写入开始。仅当文件空闲一段时间后才会刷新文件。从版本 4.3.7 开始，可以将附加属性 (flushWhenIdle) 设置为 false，这意味着间隔从第一次写入之前已刷新（或新的）文件开始。

文件时间戳

默认情况下，目标文件的lastModified时间戳是文件创建时间（除了就地重命名保留当前时间戳）。从版本 4.3 开始，您现在可以配置preserve-timestamp（或在使用 Java 配置时使用setPreserveTimestamp(true)）。对于File有效负载，这会将时间戳从入站文件传输到出站文件（无论是否需要复制）。对于其他有效负载，如果存在FileHeaders.SET_MODIFIED标头（file_setModified），则将其用于设置目标文件的lastModified时间戳，前提是该标头为Number。

文件权限

从版本 5.0 开始，当将文件写入支持 Posix 权限的文件系统时，您可以在出站通道适配器或网关上指定这些权限。该属性是一个整数，通常以熟悉的八进制格式提供，例如0640，表示所有者具有读写权限，组具有只读权限，其他用户没有访问权限。

文件出站通道适配器

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

<int-file:outbound-channel-adapter id="filesOut" directory="${input.directory.property}"/>

基于命名空间的配置还支持delete-source-files属性。如果设置为true，则在写入目标后触发原始源文件的删除。该标志的默认值为false。以下示例显示如何将其设置为true

<int-file:outbound-channel-adapter id="filesOut"
    directory="${output.directory}"
    delete-source-files="true"/>
只有当入站消息具有File有效负载或FileHeaders.ORIGINAL_FILE标头值包含源File实例或表示原始文件路径的String时，delete-source-files属性才会生效。

从版本 4.2 开始，FileWritingMessageHandler支持append-new-line选项。如果设置为true，则在写入消息后会在文件末尾追加一个新行。默认属性值为false。以下示例显示如何使用append-new-line选项

<int-file:outbound-channel-adapter id="newlineAdapter"
	append-new-line="true"
    directory="${output.directory}"/>

出站网关

在您希望根据写入的文件继续处理消息的情况下，可以使用outbound-gateway。它起着与outbound-channel-adapter类似的作用。但是，在写入文件后，它还会将其发送到回复通道作为消息的有效负载。

以下示例配置了一个出站网关

<int-file:outbound-gateway id="mover" request-channel="moveInput"
    reply-channel="output"
    directory="${output.directory}"
    mode="REPLACE" delete-source-files="true"/>

如前所述，您还可以指定mode属性，该属性定义了处理目标文件已存在情况的行为。有关更多详细信息，请参阅处理现有目标文件。通常，在使用文件出站网关时，结果文件将作为回复通道上的消息有效负载返回。

这在指定IGNORE模式时也适用。在这种情况下，将返回预先存在的目标文件。如果请求消息的有效负载是文件，您仍然可以通过消息标头访问该原始文件。请参阅FileHeaders.ORIGINAL_FILE。

在您希望先移动文件然后通过处理管道发送文件的情况下，“outbound-gateway”非常有效。在这种情况下，您可以将文件命名空间的inbound-channel-adapter元素连接到outbound-gateway，然后将该网关的reply-channel连接到管道的开头。

如果您有更复杂的需要或需要支持作为输入的额外有效负载类型以转换为文件内容，您可以扩展FileWritingMessageHandler，但更好的选择是依赖于Transformer。

使用 Java 配置进行配置

以下 Spring Boot 应用程序显示了如何使用 Java 配置配置入站适配器的示例

@SpringBootApplication
@IntegrationComponentScan
public class FileWritingJavaApplication {

    public static void main(String[] args) {
        ConfigurableApplicationContext context =
                      new SpringApplicationBuilder(FileWritingJavaApplication.class)
                              .web(false)
                              .run(args);
             MyGateway gateway = context.getBean(MyGateway.class);
             gateway.writeToFile("foo.txt", new File(tmpDir.getRoot(), "fileWritingFlow"), "foo");
    }

    @Bean
    @ServiceActivator(inputChannel = "writeToFileChannel")
    public MessageHandler fileWritingMessageHandler() {
         Expression directoryExpression = new SpelExpressionParser().parseExpression("headers.directory");
         FileWritingMessageHandler handler = new FileWritingMessageHandler(directoryExpression);
         handler.setFileExistsMode(FileExistsMode.APPEND);
         return handler;
    }

    @MessagingGateway(defaultRequestChannel = "writeToFileChannel")
    public interface MyGateway {

        void writeToFile(@Header(FileHeaders.FILENAME) String fileName,
                       @Header(FileHeaders.FILENAME) File directory, String data);

    }
}

使用 Java DSL 进行配置

以下 Spring Boot 应用程序显示了如何使用 Java DSL 配置入站适配器的示例

@SpringBootApplication
public class FileWritingJavaApplication {

    public static void main(String[] args) {
        ConfigurableApplicationContext context =
                 new SpringApplicationBuilder(FileWritingJavaApplication.class)
                         .web(false)
                         .run(args);
        MessageChannel fileWritingInput = context.getBean("fileWritingInput", MessageChannel.class);
        fileWritingInput.send(new GenericMessage<>("foo"));
    }

    @Bean
   	public IntegrationFlow fileWritingFlow() {
   	    return IntegrationFlow.from("fileWritingInput")
   		        .enrichHeaders(h -> h.header(FileHeaders.FILENAME, "foo.txt")
   		                  .header("directory", new File(tmpDir.getRoot(), "fileWritingFlow")))
   	            .handle(Files.outboundGateway(m -> m.getHeaders().get("directory")))
   	            .channel(MessageChannels.queue("fileWritingResultChannel"))
   	            .get();
    }

}