此版本仍在开发中，尚未被视为稳定版本。对于最新的稳定版本，请使用 Spring Integration 6.3.1！

此版本仍在开发中，尚未被视为稳定版本。对于最新的稳定版本，请使用 Spring Integration 6.3.1！

FTP 出站网关提供一组有限的命令来与远程 FTP 或 FTPS 服务器进行交互。 支持的命令包括：

  • ls（列表文件）

  • nlst（列出文件名）

  • get（检索文件）

  • mget（检索文件）

  • rm（删除文件）

  • mv（移动/重命名文件）

  • put（发送文件）

  • mput（发送多个文件）

使用命令ls

ls列出远程文件并支持以下选项：

  • -1：检索文件名列表。 默认值是检索对象列表。FileInfo

  • -a：包括所有文件（包括以“.”开头的文件）

  • -f：不对列表进行排序

  • -dirs：包含目录（默认情况下排除这些目录）

  • -links：包含符号链接（默认情况下排除）

  • -R：以递归方式列出远程目录

此外，还以与 . 请参阅 FTP 入站通道适配器。inbound-channel-adapter

操作生成的消息有效负载是文件名列表或对象列表。 这些对象提供修改时间、权限和其他详细信息等信息。lsFileInfo

标头中提供了命令所操作的远程目录。lsfile_remoteDirectory

使用递归选项 （） 时，包含任何子目录元素，表示文件的相对路径（相对于远程目录）。 如果包含该选项，则每个递归目录也会作为列表中的一个元素返回。 在这种情况下，建议您不要使用该选项，因为您将无法区分文件和目录，而您可以对对象执行此操作。-RfileName-dirs-1FileInfo

从版本 4.3 开始，对 and 方法的支持。 因此，您可以省略该属性。 为方便起见，Java 配置有两个没有参数的构造函数。 或者，，和命令，根据FTP协议，被视为客户端工作目录。 所有其他命令都必须随 to evaluate the remote path against the request message。 您可以在扩展 和 实现回调时使用函数设置工作目录。FtpSessionnulllist()listNames()expressionexpressionLSNLSTPUTMPUTnullexpressionFTPClient.changeWorkingDirectory()DefaultFtpSessionFactorypostProcessClientAfterConnect()

使用命令nlst

版本 5 引入了对该命令的支持。nlst

nlst列出远程文件名，并且仅支持一个选项：

  • -f：不对列表进行排序

操作生成的消息有效负载是文件名列表。nlst

标头中提供了命令所操作的远程目录。nlstfile_remoteDirectory

与使用命令的 ls 命令选项不同，该命令将命令发送到目标 FTP 服务器。 当服务器不支持（例如，由于安全限制）时，此命令非常有用。 操作的结果是没有其他详细信息的名称。 因此，框架无法确定实体是否为目录，例如执行过滤或递归列表。-1LISTnlstNLSTLISTnlst

使用命令get

get检索远程文件。 它支持以下选项：

  • -P：保留远程文件的时间戳。

  • -stream：以流的形式检索远程文件。

  • -D：传输成功后删除远程文件。 如果忽略传输，则不会删除远程文件，因为 is 和本地文件已存在。FileExistsModeIGNORE

标头提供远程目录名称，标头提供文件名。file_remoteDirectoryfile_remoteFile

操作生成的消息有效负载是表示检索到的文件的对象，或者是使用该选项时的对象。 该选项允许将文件作为流进行检索。 对于文本文件，常见的用例是将此操作与文件拆分器或流转换器结合使用。 当将远程文件作为流使用时，您负责在流使用后关闭。 为方便起见，标头中提供了 标头，您可以使用以下示例中的便利方法访问该标头，该标头显示了如何使用便利方法：getFileInputStream-stream-streamSessionSessioncloseableResourceIntegrationMessageHeaderAccessor

Closeable closeable = new IntegrationMessageHeaderAccessor(message).getCloseableResource();
if (closeable != null) {
    closeable.close();
}

文件拆分器和流转换器等框架组件在传输数据后自动关闭会话。

以下示例演示如何将文件用作流：

<int-ftp:outbound-gateway session-factory="ftpSessionFactory"
                            request-channel="inboundGetStream"
                            command="get"
                            command-options="-stream"
                            expression="payload"
                            remote-directory="ftpTarget"
                            reply-channel="stream" />

<int-file:splitter input-channel="stream" output-channel="lines" />
如果在自定义组件中使用输入流，则必须关闭 . 您可以在自定义代码中执行此操作，也可以通过将消息的副本路由到 并使用 SpEL 来执行此操作，如以下示例所示：Sessionservice-activator 
<int:service-activator input-channel="closeSession"
    expression="headers['closeableResource'].close()" />
如果在自定义组件中使用输入流，则必须关闭 . 您可以在自定义代码中执行此操作，也可以通过将消息的副本路由到 并使用 SpEL 来执行此操作，如以下示例所示：Sessionservice-activator

使用命令mget

mget根据模式检索多个远程文件，并支持以下选项：

  • -P：保留远程文件的时间戳。

  • -R：以递归方式检索整个目录树。

  • -x：如果没有与模式匹配的文件，则引发异常（否则返回空列表）。

  • -D：成功传输后删除每个远程文件。 如果忽略传输，则不会删除远程文件，因为 is 和本地文件已存在。FileExistsModeIGNORE

操作生成的消息有效负载是一个对象（即对象的 a，每个对象代表一个检索到的文件）。mgetList<File>ListFile

从版本 5.0 开始，如果 是 ，则输出消息的有效负载不再包含由于文件已存在而未获取的文件。 以前，该列表包含所有文件，包括已存在的文件。FileExistsModeIGNORE

用于确定远程路径的表达式应产生以 - 结尾的结果，例如 somedir/ 将获取 下的完整树。somedir

从 V5.0 开始，递归 与新模式相结合，可用于定期在本地同步整个远程目录树。 此模式将本地文件上次修改的时间戳替换为远程时间戳，而不考虑（保留时间戳）选项。mgetFileExistsMode.REPLACE_IF_MODIFIED-P

使用递归 （-R)

该模式将被忽略，并被假定为。 默认情况下，将检索整个远程树。 但是，可以通过提供 . 树中的目录也可以通过这种方式进行过滤。 A 可以通过引用、按 或按属性提供。 例如，检索远程目录和子目录中以结尾的所有文件。 但是，下一个示例显示了 5.0 版提供的替代方法。*FileListFilterFileListFilterfilename-patternfilename-regexfilename-regex="(subDir|.*1.txt)"1.txtsubDir

如果筛选了子目录，则不会执行该子目录的其他遍历。

不允许使用该选项（递归使用递归来获取目录树，因此目录本身不能包含在列表中）。-dirsmgetls

通常，您将在 中使用变量，以便将远程目录结构保留在本地。#remoteDirectorylocal-directory-expression

持久性文件列表筛选器现在具有 boolean 属性。 将此属性设置为 也会设置 ，这意味着出站网关 （ 和 ） 上的递归操作现在每次都将始终遍历整个目录树。 这是为了解决未检测到目录树深处的更改的问题。 此外，还会导致文件的完整路径用作元数据存储键;这解决了一个问题，即如果具有相同名称的文件在不同目录中多次出现，则筛选器无法正常工作。 重要说明：这意味着在顶级目录下的文件中找不到持久性元数据存储中的现有键。 因此，默认情况下，该属性是;这在将来的版本中可能会发生变化。forRecursiontruealwaysAcceptDirectorieslsmgetforRecursion=truefalse

从 V5.0 开始，可以通过将属性设置为 来将 and 配置为始终传递目录。 这样做允许对简单模式进行递归，如以下示例所示：FtpSimplePatternFileListFilterFtpRegexPatternFileListFilteralwaysAcceptDirectoriestrue

<bean id="starDotTxtFilter"
        class="org.springframework.integration.ftp.filters.FtpSimplePatternFileListFilter">
    <constructor-arg value="*.txt" />
    <property name="alwaysAcceptDirectories" value="true" />
</bean>

<bean id="dotStarDotTxtFilter"
            class="org.springframework.integration.ftp.filters.FtpRegexPatternFileListFilter">
    <constructor-arg value="^.*\.txt$" />
    <property name="alwaysAcceptDirectories" value="true" />
</bean>

定义筛选器（如上例中的筛选器）后，可以通过在网关上设置属性来使用筛选器。filter

另请参阅出站网关部分成功（mget 和 mput）。

从版本 5.0 开始，如果 是 ，则输出消息的有效负载不再包含由于文件已存在而未获取的文件。 以前，该列表包含所有文件，包括已存在的文件。FileExistsModeIGNORE
使用递归 （-R)

该模式将被忽略，并被假定为。 默认情况下，将检索整个远程树。 但是，可以通过提供 . 树中的目录也可以通过这种方式进行过滤。 A 可以通过引用、按 或按属性提供。 例如，检索远程目录和子目录中以结尾的所有文件。 但是，下一个示例显示了 5.0 版提供的替代方法。*FileListFilterFileListFilterfilename-patternfilename-regexfilename-regex="(subDir|.*1.txt)"1.txtsubDir

如果筛选了子目录，则不会执行该子目录的其他遍历。

不允许使用该选项（递归使用递归来获取目录树，因此目录本身不能包含在列表中）。-dirsmgetls

通常，您将在 中使用变量，以便将远程目录结构保留在本地。#remoteDirectorylocal-directory-expression

使用命令put

该命令将文件发送到远程服务器。 消息的有效负载可以是 、 a 或 。 （或表达式）用于命名远程文件。 其他可用属性包括 、 及其等效项： 和 。 有关详细信息，请参阅架构文档。putjava.io.Filebyte[]Stringremote-filename-generatorremote-directorytemporary-remote-directory*-expressionuse-temporary-file-nameauto-create-directory

操作生成的消息有效负载是表示传输后服务器上文件的完整路径。putString

版本 5.2 引入了该属性，该属性在上传后更改远程文件权限。 您可以使用传统的 Unix 八进制格式（例如，仅允许文件所有者进行读写）。 使用 java 配置适配器时，可以使用 . 仅当 FTP 服务器支持子命令时才适用。chmod600setChmod(0600)SITE CHMOD

使用命令mput

将多个文件发送到服务器，并且仅支持一个选项：mput

  • -R：递归的。 发送目录及其子目录中的所有文件（可能已过滤）。

邮件负载必须是表示本地目录的（或）。 从版本 5.1 开始，还支持 or 的集合。java.io.FileStringFileString

此命令支持与 put 命令相同的属性。 此外，可以使用 、 、 或 之一对本地目录中的文件进行过滤。 只要子目录本身通过过滤器，过滤器就适用于递归。 未通过筛选器的子目录不会被递归。mput-patternmput-regexmput-filtermput-filter-expression

操作生成的消息有效负载是一个对象（即传输产生的远程文件路径）。mputList<String>List

另请参阅出站网关部分成功（mget 和 mput）。

版本 5.2 引入了该属性，该属性允许您在上传后更改远程文件权限。 您可以使用传统的 Unix 八进制格式（例如，仅允许文件所有者进行读写）。 使用 Java 配置适配器时，可以使用 或 . 仅当 FTP 服务器支持子命令时才适用。chmod600setChmodOctal("600")setChmod(0600)SITE CHMOD

使用命令rm

该命令将删除文件。rm

该命令没有选项。rm

操作生成的消息有效负载是删除成功还是成功。 标头提供远程目录，标头提供文件名。rmBoolean.TRUEBoolean.FALSEfile_remoteDirectoryfile_remoteFile

使用命令mv

该命令移动文件。mv

该命令没有选项。mv

属性定义“from”路径，属性定义“to”路径。 默认情况下，是 . 此表达式的计算结果不得为 null 或空 。 如有必要，将创建任何必要的远程目录。 结果消息的有效负载为 。 标头提供原始远程目录，标头提供文件名。 新路径位于标头中。expressionrename-expressionrename-expressionheaders['file_renameTo']StringBoolean.TRUEfile_remoteDirectoryfile_remoteFilefile_renameTo

从版本 5.5.6 开始，为方便起见，可以在命令中使用 。 如果“from”文件不是完整的文件路径，则将 的结果用作远程目录。 这同样适用于“to”文件，例如，如果任务只是重命名某个目录中的远程文件。remoteDirectoryExpressionmvremoteDirectoryExpression

有关 FTP 出站网关命令的其他信息

and 命令支持该属性。 它定义了一个 SpEL 表达式，用于在传输过程中生成本地文件的名称。 评估上下文的根对象是请求消息。 对 特别有用的变量也可用，例如 。getmgetlocal-filename-generator-expressionremoteFileNamemgetlocal-filename-generator-expression="#remoteFileName.toUpperCase() + headers.something"

and 命令支持该属性。 它定义了一个 SpEL 表达式，用于在传输过程中生成本地目录的名称。 评估上下文的根对象是请求消息 but。 对 特别有用的变量也可用，例如： . 此属性与属性互斥。getmgetlocal-directory-expressionremoteDirectorymgetlocal-directory-expression="'/tmp/local/' + #remoteDirectory.toUpperCase() + headers.something"local-directory

对于所有命令，网关的“expression”属性提供命令操作的路径。 对于该命令，表达式的计算结果可能为“”，表示检索所有文件，或“somedirectory/”，依此类推。mget

以下示例显示了为命令配置的网关：ls

<int-ftp:outbound-gateway id="gateway1"
    session-factory="ftpSessionFactory"
    request-channel="inbound1"
    command="ls"
    command-options="-1"
    expression="payload"
    reply-channel="toSplitter"/>

发送到通道的消息的有效负载是每个对象包含文件名的对象列表。 如果省略该属性，则它包含对象。 它使用以空格分隔的选项，例如 .toSplitterStringcommand-optionsFileInfocommand-options="-1 -dirs -links"

从版本 4.2 开始，、 和命令支持一个属性（使用命名空间支持时）。 这会影响本地文件存在 （ 和 ） 或远程文件存在 （ 和 ） 时的行为。 支持的模式有 、 、 和 。 为了向后兼容，和 操作的默认模式是 。 对于 和 操作，默认值为 。GETMGETPUTMPUTFileExistsModemodeGETMGETPUTMPUTREPLACEAPPENDFAILIGNOREPUTMPUTREPLACEGETMGETFAIL

从版本 5.0 开始，（ 在 XML 中）上提供了 （ in XML） 选项。 它允许您在运行时更改客户端工作目录。 根据请求消息计算表达式。 每次网关操作后，都会恢复以前的工作目录。setWorkingDirExpression()working-dir-expressionFtpOutboundGateway<int-ftp:outbound-gateway>

使用 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
    @ServiceActivator(inputChannel = "ftpChannel")
    public MessageHandler handler() {
        FtpOutboundGateway ftpOutboundGateway =
                          new FtpOutboundGateway(ftpSessionFactory(), "ls", "'my_remote_dir/'");
        ftpOutboundGateway.setOutputChannelName("lsReplyChannel");
        return ftpOutboundGateway;
    }

}

使用 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 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 FtpOutboundGatewaySpec ftpOutboundGateway() {
        return Ftp.outboundGateway(ftpSessionFactory(),
            AbstractRemoteFileOutboundGateway.Command.MGET, "payload")
            .options(AbstractRemoteFileOutboundGateway.Option.RECURSIVE)
            .regexFileNameFilter("(subFtpSource|.*1.txt)")
            .localDirectoryExpression("'localDirectory/' + #remoteDirectory")
            .localFilenameExpression("#remoteFileName.replaceFirst('ftpSource', 'localTarget')");
    }

    @Bean
    public IntegrationFlow ftpMGetFlow(AbstractRemoteFileOutboundGateway<FTPFile> ftpOutboundGateway) {
        return f -> f
            .handle(ftpOutboundGateway)
            .channel(c -> c.queue("remoteFileOutputChannel"));
    }

}

出站网关部分成功 （ 和mgetmput)

当您对多个文件执行操作（通过使用 和 ）时，在传输一个或多个文件后的一段时间内可能会发生异常。 在本例中（从版本 4.2 开始），将抛出 a。 除了通常的属性 （ 和 ），此异常还有两个附加属性：mgetmputPartialSuccessExceptionMessagingExceptionfailedMessagecause

  • partialResults：成功转移结果。

  • derivedInput：从请求消息生成的文件列表（例如，要传输的本地文件）。mput

通过这些属性，您可以确定哪些文件已成功传输，哪些文件未成功传输。

在递归的情况下，可能有嵌套的出现。mputPartialSuccessExceptionPartialSuccessException

请考虑以下目录结构：

root/
|- file1.txt
|- subdir/
   | - file2.txt
   | - file3.txt
|- zoo.txt

如果异常发生在 上，则网关抛出的 有 、 和 和 。 它是另一个 of 和 和 。file3.txtPartialSuccessExceptionderivedInputfile1.txtsubdirzoo.txtpartialResultsfile1.txtcausePartialSuccessExceptionderivedInputfile2.txtfile3.txtpartialResultsfile2.txt