SFTP 入站通道适配器

SFTP 入站通道适配器是一种特殊的监听器，它连接到服务器并监听远程目录事件（例如创建新文件），此时它会启动文件传输。以下示例显示如何配置 SFTP 入站通道适配器

<int-sftp:inbound-channel-adapter id="sftpAdapterAutoCreate"
              session-factory="sftpSessionFactory"
            channel="requestChannel"
            filename-pattern="*.txt"
            remote-directory="/foo/bar"
            preserve-timestamp="true"
            local-directory="file:target/foo"
            auto-create-local-directory="true"
            local-filename-generator-expression="#this.toUpperCase() + '.a'"
            scanner="myDirScanner"
            local-filter="myFilter"
            temporary-file-suffix=".writing"
            max-fetch-size="-1"
            delete-remote-files="false">
        <int:poller fixed-rate="1000"/>
</int-sftp:inbound-channel-adapter>

前面的配置示例显示了如何为各种属性提供值，包括以下内容

local-directory：文件将要传输到的位置
remote-directory：文件将要传输的远程源目录
session-factory：对我们之前配置的 Bean 的引用

默认情况下，传输的文件与原始文件具有相同的名称。如果要覆盖此行为，可以设置 local-filename-generator-expression 属性，该属性允许您提供一个 SpEL 表达式来生成本地文件的名称。与出站网关和适配器不同，在出站网关和适配器中，SpEL 评估上下文的根对象是 Message，此入站适配器在评估时还没有消息，因为它是最终使用传输的文件作为其有效负载生成的消息。因此，SpEL 评估上下文的根对象是远程文件的原始名称（一个 String）。

入站通道适配器首先将文件检索到本地目录，然后根据轮询配置发出每个文件。从 5.0 版本开始，当需要检索新文件时，您可以限制从 SFTP 服务器获取的文件数量。当目标文件很大或在具有持久文件列表过滤器的集群系统中运行时，这可能很有用，将在本节后面讨论。为此，请使用 max-fetch-size。负值（默认值）表示没有限制，并且检索所有匹配的文件。有关更多信息，请参阅入站通道适配器：控制远程文件获取。从 5.0 版本开始，您还可以通过设置 scanner 属性，为 inbound-channel-adapter 提供自定义 DirectoryScanner 实现。

从 Spring Integration 3.0 开始，您可以指定 preserve-timestamp 属性（默认值为 false）。当为 true 时，本地文件的修改时间戳设置为从服务器检索到的值。否则，将其设置为当前时间。

从 4.2 版本开始，您可以指定 remote-directory-expression 而不是 remote-directory，这允许您在每次轮询时动态确定目录，例如 remote-directory-expression="@myBean.determineRemoteDir()"。

有时，仅基于通过 filename-pattern 属性指定的简单模式进行的文件过滤可能不够。如果是这种情况，您可以使用 filename-regex 属性指定正则表达式（例如，filename-regex=".*\.test$"）。如果您需要完全控制，可以使用 filter 属性提供对 org.springframework.integration.file.filters.FileListFilter 的自定义实现的引用，这是一个用于过滤文件列表的策略接口。此过滤器确定检索哪些远程文件。您还可以通过使用 CompositeFileListFilter 将基于模式的过滤器与其他过滤器（例如 AcceptOnceFileListFilter，以避免同步以前已获取的文件）结合起来。

AcceptOnceFileListFilter 将其状态存储在内存中。如果希望状态在系统重新启动后仍然存在，请考虑改用 SftpPersistentAcceptOnceFileListFilter。此过滤器将接受的文件名存储在 MetadataStore 策略的实例中（请参阅元数据存储）。此过滤器根据文件名和远程修改时间进行匹配。

从 4.0 版本开始，此过滤器需要 ConcurrentMetadataStore。当与共享数据存储（例如使用 RedisMetadataStore 的 Redis）一起使用时，这允许在多个应用程序或服务器实例之间共享过滤器键。

从 5.0 版本开始，默认情况下，SftpInboundFileSynchronizer 应用具有内存中 SimpleMetadataStore 的 SftpPersistentAcceptOnceFileListFilter。此过滤器也与 XML 配置中的 regex 或 pattern 选项一起应用，以及通过 Java DSL 中的 SftpInboundChannelAdapterSpec 应用。您可以通过使用 CompositeFileListFilter（或 ChainFileListFilter）处理任何其他用例。

以上讨论指的是在检索文件之前过滤文件。检索文件后，会对文件系统上的文件应用其他过滤器。默认情况下，这是一个 `AcceptOnceFileListFilter`，正如本节所述，它保留内存中的状态并且不考虑文件的修改时间。除非您的应用程序在处理后删除文件，否则适配器在应用程序重新启动后默认情况下会重新处理磁盘上的文件。

此外，如果您将 filter 配置为使用 SftpPersistentAcceptOnceFileListFilter 并且远程文件时间戳发生更改（导致重新获取），则默认本地过滤器不允许处理此新文件。

有关此过滤器及其使用方法的更多信息，请参阅远程持久文件列表过滤器。

您可以使用 local-filter 属性配置本地文件系统过滤器的行为。从 4.3.8 版本开始，默认配置了 FileSystemPersistentAcceptOnceFileListFilter。此过滤器将接受的文件名和修改时间戳存储在 MetadataStore 策略的实例中（请参阅元数据存储）并检测本地文件修改时间的更改。默认 MetadataStore 是一个 SimpleMetadataStore，它将状态存储在内存中。

从 4.1.5 版本开始，这些过滤器有一个名为 flushOnUpdate 的新属性，它会导致它们在每次更新时刷新元数据存储（如果存储实现 Flushable）。

此外，如果您使用分布式 MetadataStore（例如 Redis 元数据存储），则可以拥有同一适配器或应用程序的多个实例，并确保只有一个实例处理一个文件。

实际的本地过滤器是一个 CompositeFileListFilter，它包含提供的过滤器和一个模式过滤器，该模式过滤器阻止处理正在下载过程中的文件（基于 temporary-file-suffix）。文件使用此后缀（默认为 .writing）下载，并且在传输完成后将文件重命名为其最终名称，使它们对过滤器“可见”。

有关这些属性的更多详细信息，请参阅架构。

SFTP 入站通道适配器是轮询消费者。因此，您必须配置一个轮询器（全局默认值或本地元素）。将文件传输到本地目录后，会生成一个有效负载类型为 java.io.File 的消息，并将其发送到由 channel 属性标识的通道。

从 6.2 版本开始，您可以使用 SftpLastModifiedFileListFilter 基于上次修改策略过滤 SFTP 文件。此过滤器可以使用 age 属性进行配置，以便仅将此值之前的文件传递给过滤器。年龄默认为 60 秒，但您应该选择一个足够大的年龄以避免过早获取文件（例如，由于网络故障）。查看其 Javadoc 以获取更多信息。

关于文件过滤和大文件的更多信息

有时，刚刚出现在监控（远程）目录中的文件可能不完整。通常，此类文件使用一些临时扩展名（例如，名为 something.txt.writing 的文件的 .writing）写入，然后在写入过程完成后重命名。在大多数情况下，开发人员只对完整的文件感兴趣，并且希望仅过滤这些文件。为了处理这些场景，您可以使用 filename-pattern、filename-regex 和 filter 属性提供的过滤支持。如果您需要自定义过滤器实现，可以通过设置 filter 属性在适配器中包含一个引用。以下示例显示了如何操作

<int-sftp:inbound-channel-adapter id="sftpInbondAdapter"
            channel="receiveChannel"
            session-factory="sftpSessionFactory"
            filter="customFilter"
            local-directory="file:/local-test-dir"
            remote-directory="/remote-test-dir">
        <int:poller fixed-rate="1000" max-messages-per-poll="10" task-executor="executor"/>
</int-sftp:inbound-channel-adapter>

<bean id="customFilter" class="org.foo.CustomFilter"/>

从故障中恢复

您应该了解适配器的架构。文件同步器获取文件，并且 FileReadingMessageSource 为每个同步的文件发出消息。如前面所述，涉及两个过滤器。filter 属性（和模式）引用远程 (SFTP) 文件列表，以避免获取已经获取的文件。FileReadingMessageSource 使用 local-filter 来确定哪些文件要作为消息发送。

同步器列出远程文件并查阅其过滤器。然后传输文件。如果在文件传输过程中发生 IO 错误，则会删除已添加到过滤器中的任何文件，以便它们在下次轮询时有资格重新获取。这仅适用于过滤器实现 ReversibleFileListFilter（例如 AcceptOnceFileListFilter）的情况。

如果在同步文件后，在处理文件的下游流中发生错误，则不会自动回滚过滤器，因此默认情况下不会重新处理失败的文件。

如果希望在发生故障后重新处理此类文件，可以使用类似于以下内容的配置来促进从过滤器中删除失败的文件

<int-sftp:inbound-channel-adapter id="sftpAdapter"
        session-factory="sftpSessionFactory"
        channel="requestChannel"
        remote-directory-expression="'/sftpSource'"
        local-directory="file:myLocalDir"
        auto-create-local-directory="true"
        filename-pattern="*.txt">
    <int:poller fixed-rate="1000">
        <int:transactional synchronization-factory="syncFactory" />
    </int:poller>
</int-sftp:inbound-channel-adapter>

<bean id="acceptOnceFilter"
    class="org.springframework.integration.file.filters.AcceptOnceFileListFilter" />

<int:transaction-synchronization-factory id="syncFactory">
    <int:after-rollback expression="payload.delete()" />
</int:transaction-synchronization-factory>

<bean id="transactionManager"
    class="org.springframework.integration.transaction.PseudoTransactionManager" />

前面的配置适用于任何 ResettableFileListFilter。

从 5.0 版本开始，入站通道适配器可以根据生成的本地文件名在本地构建子目录。这也可以是远程子路径。为了能够根据层次结构支持递归读取本地目录以进行修改，您现在可以为内部FileReadingMessageSource提供一个基于Files.walk()算法的新RecursiveDirectoryScanner。有关更多信息，请参阅AbstractInboundFileSynchronizingMessageSource.setScanner()。此外，您现在可以通过使用setUseWatchService()选项将AbstractInboundFileSynchronizingMessageSource切换到基于WatchService的DirectoryScanner。它还配置了所有WatchEventType实例以对本地目录中的任何修改做出反应。前面显示的重新处理示例基于FileReadingMessageSource.WatchServiceDirectoryScanner的内置功能，该功能在文件从本地目录中删除（StandardWatchEventKinds.ENTRY_DELETE）时使用ResettableFileListFilter.remove()。有关更多信息，请参阅WatchServiceDirectoryScanner。

使用 Java 配置进行配置

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

@SpringBootApplication
public class SftpJavaApplication {

    public static void main(String[] args) {
        new SpringApplicationBuilder(SftpJavaApplication.class)
            .web(false)
            .run(args);
    }

    @Bean
    public SessionFactory<SftpClient.DirEntry> sftpSessionFactory() {
        DefaultSftpSessionFactory factory = new DefaultSftpSessionFactory(true);
        factory.setHost("localhost");
        factory.setPort(port);
        factory.setUser("foo");
        factory.setPassword("foo");
        factory.setAllowUnknownKeys(true);
        factory.setTestSession(true);
        return new CachingSessionFactory<>(factory);
    }

    @Bean
    public SftpInboundFileSynchronizer sftpInboundFileSynchronizer() {
        SftpInboundFileSynchronizer fileSynchronizer = new SftpInboundFileSynchronizer(sftpSessionFactory());
        fileSynchronizer.setDeleteRemoteFiles(false);
        fileSynchronizer.setRemoteDirectory("foo");
        fileSynchronizer.setFilter(new SftpSimplePatternFileListFilter("*.xml"));
        return fileSynchronizer;
    }

    @Bean
    @InboundChannelAdapter(channel = "sftpChannel", poller = @Poller(fixedDelay = "5000"))
    public MessageSource<File> sftpMessageSource() {
        SftpInboundFileSynchronizingMessageSource source =
                new SftpInboundFileSynchronizingMessageSource(sftpInboundFileSynchronizer());
        source.setLocalDirectory(new File("sftp-inbound"));
        source.setAutoCreateLocalDirectory(true);
        source.setLocalFilter(new AcceptOnceFileListFilter<File>());
        source.setMaxFetchSize(1);
        return source;
    }

    @Bean
    @ServiceActivator(inputChannel = "sftpChannel")
    public MessageHandler handler() {
        return new MessageHandler() {

            @Override
            public void handleMessage(Message<?> message) throws MessagingException {
                System.out.println(message.getPayload());
            }

        };
    }

}

使用 Java DSL 进行配置

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

@SpringBootApplication
public class SftpJavaApplication {

    public static void main(String[] args) {
        new SpringApplicationBuilder(SftpJavaApplication.class)
            .web(false)
            .run(args);
    }

    @Bean
    public IntegrationFlow sftpInboundFlow() {
        return IntegrationFlow
            .from(Sftp.inboundAdapter(this.sftpSessionFactory)
                    .preserveTimestamp(true)
                    .remoteDirectory("foo")
                    .regexFilter(".*\\.txt$")
                    .localFilenameExpression("#this.toUpperCase() + '.a'")
                    .localDirectory(new File("sftp-inbound")),
                 e -> e.id("sftpInboundAdapter")
                    .autoStartup(true)
                    .poller(Pollers.fixedDelay(5000)))
            .handle(m -> System.out.println(m.getPayload()))
            .get();
    }
}

处理不完整数据

请参阅处理不完整数据。

提供SftpSystemMarkerFilePresentFileListFilter来过滤远程系统上没有相应标记文件的远程文件。有关配置信息，请参阅Javadoc。