对于最新的稳定版本，请使用 Spring Integration 6.3.1！Spring中文文档

对于最新的稳定版本，请使用 Spring Integration 6.3.1！Spring中文文档

SFTP 出站网关提供了一组有限的命令，可用于与远程 SFTP 服务器进行交互：Spring中文文档

使用命令ls

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

此外，文件名过滤的提供方式与 .inbound-channel-adapterSpring中文文档

操作生成的消息有效负载是文件名列表或对象列表（取决于是否使用交换机）。 这些对象提供修改时间、权限等信息。lsFileInfo-1Spring中文文档

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

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

如果列表的远程路径以符号开头，则 SFTP 会将其视为绝对路径;without - 作为当前用户主页中的相对路径。/Spring中文文档

使用命令nlst

版本 5 引入了对该命令的支持。nlstSpring中文文档

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

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

标头包含命令对其执行操作的远程目录。file_remoteDirectorynlstSpring中文文档

SFTP 协议不提供列出名称的功能。 此命令等同于带有选项的命令，为方便起见，在此处添加此命令。ls-1Spring中文文档

使用命令get

get检索远程文件并支持以下选项：Spring中文文档

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

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

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

标头保存远程目录，标头保存文件名。file_remoteDirectoryfile_remoteFileSpring中文文档

操作生成的消息有效负载是表示检索到的文件的对象。 如果使用该选项，则有效负载是 而不是 . 对于文本文件，常见的用例是将此操作与文件拆分器或流转换器结合使用。 当将远程文件作为流使用时，您负责在流使用后关闭。 为方便起见，在标题中提供了 ，并提供方便的方法：getFile-streamInputStreamFileSessionSessioncloseableResourceIntegrationMessageHeaderAccessorSpring中文文档

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

框架组件（如文件拆分器和流转换器）在传输数据后自动关闭会话。Spring中文文档

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

<int-sftp: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根据模式检索多个远程文件，并支持以下选项：Spring中文文档

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

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

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

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

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

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

您使用的表达式 determine the remote path 应生成一个以 结尾的结果，例如，获取 下的完整树。*myfiles/*myfilesSpring中文文档

从 V5.0 开始，您可以使用递归 与模式结合使用，以定期在本地同步整个远程目录树。 此模式将本地文件的上次修改时间戳设置为远程文件的时间戳，而不考虑 （保留时间戳） 选项。MGETFileExistsMode.REPLACE_IF_MODIFIED-PSpring中文文档

使用递归时的注意事项 （-R)

该模式将被忽略并被假定。 默认情况下，将检索整个远程树。 但是，您可以通过提供 . 您也可以通过这种方式过滤树中的目录。 A 可以通过引用或 or 属性提供。 例如，检索远程目录和子目录中所有以 结尾的文件。 但是，我们在此说明之后描述了可用的替代方案。*FileListFilterFileListFilterfilename-patternfilename-regexfilename-regex="(subDir|.*1.txt)"1.txtsubDirSpring中文文档

如果筛选子目录，则不会执行该子目录的额外遍历。Spring中文文档

不允许使用该选项（递归使用递归来获取目录树，并且目录本身不能包含在列表中）。-dirsmgetlsSpring中文文档

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

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

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

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

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

可以使用网关上的属性提供这些筛选器之一。filterSpring中文文档

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

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

该模式将被忽略并被假定。 默认情况下，将检索整个远程树。 但是，您可以通过提供 . 您也可以通过这种方式过滤树中的目录。 A 可以通过引用或 or 属性提供。 例如，检索远程目录和子目录中所有以 结尾的文件。 但是，我们在此说明之后描述了可用的替代方案。*FileListFilterFileListFilterfilename-patternfilename-regexfilename-regex="(subDir|.*1.txt)"1.txtsubDirSpring中文文档

如果筛选子目录，则不会执行该子目录的额外遍历。Spring中文文档

不允许使用该选项（递归使用递归来获取目录树，并且目录本身不能包含在列表中）。-dirsmgetlsSpring中文文档

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

使用命令put

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

操作生成的消息有效负载是包含传输后服务器上文件的完整路径。putStringSpring中文文档

版本 4.3 引入了该属性，该属性在上传后更改远程文件权限。 您可以使用传统的 Unix 八进制格式（例如，仅允许文件所有者进行读写）。 使用 java 配置适配器时，可以使用 .chmod600setChmod(0600)Spring中文文档

使用命令mput

mput将多个文件发送到服务器并支持以下选项：Spring中文文档

  • -R： Recursive — 发送目录和子目录中的所有文件（可能已过滤）Spring中文文档

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

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

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

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

版本 4.3 引入了该属性，可让您在上传后更改远程文件权限。 您可以使用传统的 Unix 八进制格式（例如，仅允许文件所有者进行读写）。 使用 Java 配置适配器时，可以使用 或 .chmod600setChmodOctal("600")setChmod(0600)Spring中文文档

使用命令rm

该命令没有选项。rmSpring中文文档

如果删除操作成功，则生成的消息有效负载为 。 否则，消息有效负载为 。 标头保存远程目录，标头保存文件名。Boolean.TRUEBoolean.FALSEfile_remoteDirectoryfile_remoteFileSpring中文文档

使用命令mv

该命令没有选项。mvSpring中文文档

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

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

其他命令信息

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

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

对于所有命令，网关的“expression”属性保存命令所操作的路径。 对于该命令，表达式的计算结果可能为 ，这意味着检索所有文件、 和其他以 结尾的值。mget*somedirectory/**Spring中文文档

以下示例显示了为命令配置的网关：lsSpring中文文档

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

发送到通道的消息的有效负载是对象列表，每个对象都包含一个文件的名称。 如果省略 ，有效负载将是一个对象列表。 您可以以空格分隔列表的形式提供选项（例如，）。toSplitterStringcommand-options="-1"FileInfocommand-options="-1 -dirs -links"Spring中文文档

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

使用 Java 配置进行配置

以下 Spring Boot 应用程序显示了如何使用 Java 配置出站网关的示例：Spring中文文档

@SpringBootApplication
public class SftpJavaApplication {

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

    @Bean
    @ServiceActivator(inputChannel = "sftpChannel")
    public MessageHandler handler() {
        return new SftpOutboundGateway(ftpSessionFactory(), "ls", "'my_remote_dir/'");
    }

}

使用 Java DSL 进行配置

以下 Spring Boot 应用程序显示了如何使用 Java DSL 配置出站网关的示例：Spring中文文档

@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 sf = new DefaultSftpSessionFactory();
        sf.setHost("localhost");
        sf.setPort(port);
        sf.setUsername("foo");
        sf.setPassword("foo");
        factory.setTestSession(true);
        return new CachingSessionFactory<>(sf);
    }

    @Bean
    public QueueChannelSpec remoteFileOutputChannel() {
        return MessageChannels.queue();
    }

    @Bean
    public IntegrationFlow sftpMGetFlow() {
        return IntegrationFlow.from("sftpMgetInputChannel")
            .handle(Sftp.outboundGateway(sftpSessionFactory(),
                            AbstractRemoteFileOutboundGateway.Command.MGET, "payload")
                    .options(AbstractRemoteFileOutboundGateway.Option.RECURSIVE)
                    .regexFileNameFilter("(subSftpSource|.*1.txt)")
                    .localDirectoryExpression("'myDir/' + #remoteDirectory")
                    .localFilenameExpression("#remoteFileName.replaceFirst('sftpSource', 'localTarget')"))
            .channel("remoteFileOutputChannel")
            .get();
    }

}

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

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

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

在递归的情况下，可能有嵌套的实例。mputPartialSuccessExceptionPartialSuccessExceptionSpring中文文档

请考虑以下目录结构：Spring中文文档

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

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