FTP 入站通道适配器

QWen Plus 中英对照 FTP Inbound Channel Adapter

FTP 入站通道适配器是一个特殊的监听器，它连接到 FTP 服务器并监听远程目录事件（例如，创建新文件），此时它会发起文件传输。以下示例展示了如何配置 inbound-channel-adapter：

<int-ftp:inbound-channel-adapter id="ftpInbound"
    channel="ftpChannel"
    session-factory="ftpSessionFactory"
    auto-create-local-directory="true"
    delete-remote-files="true"
    filename-pattern="*.txt"
    remote-directory="some/remote/path"
    remote-file-separator="/"
    preserve-timestamp="true"
    local-filename-generator-expression="#this.toUpperCase() + '.a'"
    scanner="myDirScanner"
    local-filter="myFilter"
    temporary-file-suffix=".writing"
    max-fetch-size="-1"
    local-directory=".">
    <int:poller fixed-rate="1000"/>
</int-ftp:inbound-channel-adapter>

xml

如上所述的配置所示，您可以使用 inbound-channel-adapter 元素来配置 FTP 入站通道适配器，同时为各种属性提供值，例如 local-directory、filename-pattern（它是基于简单的模式匹配，而不是正则表达式），以及对 session-factory 的引用。

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

传入通道适配器首先检索本地目录的 File 对象，然后根据轮询器配置发出每个文件。从 5.0 版开始，现在可以在需要新的文件检索时限制从 FTP 服务器获取的文件数量。当目标文件非常大或在带有持久文件列表过滤器的集群系统中运行时，这可能会有所帮助，稍后会讨论。为此请使用 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()"。

从 4.3 版开始，您可以省略 remote-directory 和 remote-directory-expression 属性。它们默认为 null。在这种情况下，根据 FTP 协议，客户端工作目录将用作默认远程目录。

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

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

自从 4.0 版本以来，此过滤器需要一个 ConcurrentMetadataStore。当与共享数据存储（例如使用 RedisMetadataStore 的 Redis）一起使用时，它可以让多个应用程序或服务器实例之间共享过滤键。

从 5.0 版本开始，默认为 FtpInboundFileSynchronizer 应用带有内存中 SimpleMetadataStore 的 FtpPersistentAcceptOnceFileListFilter。此过滤器也应用于 XML 配置中的 regex 或 pattern 选项，以及 Java DSL 中的 FtpInboundChannelAdapterSpec。任何其他使用场景都可以通过 CompositeFileListFilter（或 ChainFileListFilter）来管理。

前面的讨论涉及在检索文件之前对其进行过滤。一旦文件被检索出来，文件系统上的文件会应用额外的过滤器。默认情况下，这是 AcceptOnceFileListFilter，如前所述，它在内存中保留状态，并不考虑文件的修改时间。除非您的应用程序在处理后删除文件，否则适配器会在应用程序重启后默认重新处理磁盘上的文件。

另外，如果你配置 filter 使用 FtpPersistentAcceptOnceFileListFilter 并且远程文件的时间戳发生变化（导致它被重新获取），默认的本地过滤器不会让这个新文件被处理。

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

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

自从 4.1.5 版本以来，这些过滤器有了一个新属性 (flushOnUpdate)，该属性会在每次更新时导致它们刷新元数据存储（如果存储实现了 Flushable）。

important

进一步地，如果你使用分布式 MetadataStore （例如 Redis），你可以拥有同一个适配器或应用程序的多个实例，并确保每个文件只被处理一次。

实际的本地过滤器是一个 CompositeFileListFilter，它包含提供的过滤器和一个防止处理正在下载中的文件的模式过滤器（基于 temporary-file-suffix）。文件会带有此后缀进行下载（默认是 .writing），当传输完成时，文件会被重命名为其最终名称，使其对过滤器“可见”。

remote-file-separator 属性允许你配置一个文件分隔符字符，如果默认的 '/' 不适用于你的特定环境。

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

你还应该理解，FTP 入站通道适配器是一个轮询消费者。因此，你必须配置一个轮询器（使用全局默认值或本地子元素）。一旦文件被传输，就会生成并发送一个以 java.io.File 作为其有效负载的消息到由 channel 属性标识的通道。

从 6.2 版本开始，您可以使用 FtpLastModifiedFileListFilter 根据最后修改策略过滤 FTP 文件。此过滤器可以配置一个 age 属性，以便只有比此值更旧的文件才会通过过滤器。年龄默认为 60 秒，但您应该选择一个足够大的年龄以避免过早地获取文件（由于，比如说，网络故障）。更多详细信息请参阅其 Javadoc。

更多关于文件过滤和不完整文件

有时，刚刚出现在监控（远程）目录中的文件可能不完整。通常，此类文件会使用临时扩展名（例如 somefile.txt.writing）进行写入，在写入过程完成后才会重命名。在大多数情况下，您只对完整的文件感兴趣，并且希望仅筛选出完整的文件。要处理这些场景，您可以使用由 filename-pattern、filename-regex 和 filter 属性提供的过滤支持。以下示例使用自定义过滤器实现：

<int-ftp:inbound-channel-adapter
    channel="ftpChannel"
    session-factory="ftpSessionFactory"
    filter="customFilter"
    local-directory="file:/my_transfers">
    remote-directory="some/remote/path"
    <int:poller fixed-rate="1000"/>
</int-ftp:inbound-channel-adapter>

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

xml

Inbound FTP 适配器的轮询器配置说明

入站 FTP 适配器的工作由两个任务组成：

1. 与远程服务器通信，以将文件从远程目录传输到本地目录。

2. 对于每个传输的文件，生成一条消息，该文件作为有效负载，并将其发送到由 'channel' 属性标识的通道。这就是为什么它们被称为“通道适配器”而不是简单的“适配器”。这种适配器的主要任务是生成要发送到消息通道的消息。实际上，第二个任务具有优先级，也就是说，如果您的本地目录已经有一个或多个文件，它会首先从这些文件生成消息。只有当所有本地文件都处理完毕后，才会启动远程通信以获取更多文件。

另外，在轮询器上配置触发器时，您应该密切关注 max-messages-per-poll 属性。它的默认值为所有 SourcePollingChannelAdapter 实例（包括 FTP）的 1。这意味着，一旦处理了一个文件，它就会等待下一个由您的触发器配置确定的执行时间。如果您碰巧有一个或多个文件位于 local-directory 中，它会在与远程 FTP 服务器发起通信之前处理这些文件。此外，如果 max-messages-per-poll 设置为 1（默认值），它会按照您的触发器定义的时间间隔一次只处理一个文件，实际上就是“一次轮询 === 一个文件”。

对于典型的文件传输用例，您最有可能需要相反的行为：在每次轮询时处理所有可以处理的文件，然后才等待下一次轮询。如果是这种情况，请将 max-messages-per-poll 设置为 -1。这样，在每次轮询时，适配器会尝试生成尽可能多的消息。换句话说，它会处理本地目录中的所有内容，然后连接到远程目录，将所有可处理的文件传输到本地进行处理。只有在此之后，轮询操作才会被认为完成，轮询器才会等待下一次执行时间。

你可以将 'max-messages-per-poll' 值设置为一个正数，该正数表示每次轮询从文件中创建的消息数量的上限。例如，值为 10 意味着每次轮询时，它尝试处理的文件不超过十个。

从故障中恢复

了解适配器的架构非常重要。有一个文件同步器负责获取文件，还有一个 FileReadingMessageSource 会为每个同步的文件发出一条消息。如前所述，涉及两个过滤器。filter 属性（和模式）是指远程（FTP）文件列表，以避免获取已经获取过的文件。local-filter 被 FileReadingMessageSource 使用，以确定哪些文件将被发送为消息。

同步器列出远程文件并咨询其过滤器。然后传输文件。如果在文件传输期间发生 IO 错误，已经添加到过滤器的任何文件都会被移除，以便它们可以在下次轮询时重新获取。这仅适用于实现 ReversibleFileListFilter 接口的过滤器（例如 AcceptOnceFileListFilter）。

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

如果您希望在失败后重新处理此类文件，可以使用类似的配置来便于将失败的文件从过滤器中移除：

<int-ftp:inbound-channel-adapter id="ftpAdapter"
        session-factory="ftpSessionFactory"
        channel="requestChannel"
        remote-directory-expression="'/ftpSource'"
        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-ftp: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" />

xml

上述配置适用于任何 ResettableFileListFilter。

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

使用 Java 配置进行配置

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

@SpringBootApplication
public class FtpJavaApplication {

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

    @Bean
    public SessionFactory<FTPFile> ftpSessionFactory() {
        DefaultFtpSessionFactory sf = new DefaultFtpSessionFactory();
        sf.setHost("localhost");
        sf.setPort(port);
        sf.setUsername("foo");
        sf.setPassword("foo");
        sf.setTestSession(true);
        return new CachingSessionFactory<FTPFile>(sf);
    }

    @Bean
    public FtpInboundFileSynchronizer ftpInboundFileSynchronizer() {
        FtpInboundFileSynchronizer fileSynchronizer = new FtpInboundFileSynchronizer(ftpSessionFactory());
        fileSynchronizer.setDeleteRemoteFiles(false);
        fileSynchronizer.setRemoteDirectory("foo");
        fileSynchronizer.setFilter(new FtpSimplePatternFileListFilter("*.xml"));
        return fileSynchronizer;
    }

    @Bean
    @InboundChannelAdapter(channel = "ftpChannel", poller = @Poller(fixedDelay = "5000"))
    public MessageSource<File> ftpMessageSource() {
        FtpInboundFileSynchronizingMessageSource source =
                new FtpInboundFileSynchronizingMessageSource(ftpInboundFileSynchronizer());
        source.setLocalDirectory(new File("ftp-inbound"));
        source.setAutoCreateLocalDirectory(true);
        source.setLocalFilter(new AcceptOnceFileListFilter<File>());
        source.setMaxFetchSize(1);
        return source;
    }

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

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

        };
    }

}

java

使用 Java DSL 进行配置

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

@SpringBootApplication
public class FtpJavaApplication {

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

    @Bean
    public IntegrationFlow ftpInboundFlow() {
        return IntegrationFlow
            .from(Ftp.inboundAdapter(this.ftpSessionFactory)
                    .preserveTimestamp(true)
                    .remoteDirectory("foo")
                    .regexFilter(".*\\.txt$")
                    .localFilename(f -> f.toUpperCase() + ".a")
                    .localDirectory(new File("d:\\ftp_files")),
                e -> e.id("ftpInboundAdapter")
                    .autoStartup(true)
                    .poller(Pollers.fixedDelay(5000)))
            .handle(m -> System.out.println(m.getPayload()))
            .get();
    }
}

java

处理不完整数据

见 处理不完整数据。

提供了 FtpSystemMarkerFilePresentFileListFilter 用于过滤远程系统上没有对应标记文件的远程文件。有关配置信息，请参阅 Javadoc （并浏览到父类）。