SFTP 出站网关 (SFTP Outbound Gateway) | Spring Integration6.3.5-SNAPSHOT中文文档|Spring官方文档|SpringBoot 教程|Spring中文网

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

SFTP 出站网关提供了一组有限的命令，允许您与远程 SFTP 服务器进行交互：spring-doc.cn

ls（列出文件）spring-doc.cn
nlst（列出文件名）spring-doc.cn
get（检索文件）spring-doc.cn
mget（检索多个文件）spring-doc.cn
rm（删除文件）spring-doc.cn
mv（移动和重命名文件）spring-doc.cn
put（发送文件）spring-doc.cn
mput（发送多个文件）spring-doc.cn

使用命令`ls`

ls列出远程文件并支持以下选项：spring-doc.cn

-1：检索文件名列表。默认值是检索对象列表FileInfospring-doc.cn
-a：包括所有文件（包括以“.”开头的文件）spring-doc.cn
-f：不对列表进行排序spring-doc.cn
-dirs：包括目录（默认排除）spring-doc.cn
-links：包括符号链接（默认排除）spring-doc.cn
-R：递归列出远程目录spring-doc.cn

此外，文件名筛选的提供方式与 .inbound-channel-adapterspring-doc.cn

操作产生的消息有效负载是文件名列表或对象列表（取决于是否使用 switch）。这些对象提供修改时间、权限等信息。lsFileInfo-1spring-doc.cn

标头中提供了命令操作的远程目录。lsfile_remoteDirectoryspring-doc.cn

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

如果 remote path to list 以符号开头，则 SFTP 会将其视为绝对路径;without - 作为当前用户 home 中的相对路径。/spring-doc.cn

使用命令`nlst`

版本 5 引入了对该命令的支持。nlstspring-doc.cn

nlst列出远程文件名，并且仅支持一个选项：spring-doc.cn

-f：不对列表进行排序spring-doc.cn

操作生成的消息有效负载是文件名列表。nlstspring-doc.cn

标头包含命令所作用于的远程目录。file_remoteDirectorynlstspring-doc.cn

SFTP 协议不提供列出名称的功能。此命令等效于带有 option 的命令，为方便起见，在此处添加。ls-1spring-doc.cn

使用命令`get`

get检索远程文件并支持以下选项：spring-doc.cn

-P：保留远程文件的时间戳。spring-doc.cn
-stream：将远程文件作为流检索。spring-doc.cn
-D：传输成功后删除远程文件。如果忽略传输，则不会删除远程文件，因为 is 和本地文件已存在。FileExistsModeIGNOREspring-doc.cn

header 包含远程目录，header 包含文件名。file_remoteDirectoryfile_remoteFilespring-doc.cn

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

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

框架组件（如 File Splitter 和 Stream Transformer）在传输数据后自动关闭会话。spring-doc.cn

以下示例演示如何将文件作为流使用：spring-doc.cn

<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" />

如果您在自定义组件中使用输入流，则必须关闭 . 你可以在自定义代码中执行此操作，也可以将消息的副本路由到 a 并使用 SPEL，如下例所示：Sessionservice-activator

<int:service-activator input-channel="closeSession"
    expression="headers['closeableResource'].close()" />

使用命令`mget`

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

-P：保留远程文件的时间戳。spring-doc.cn
-R：递归检索整个目录树。spring-doc.cn
-x：如果没有文件与模式匹配，则引发异常（否则，返回空列表）。spring-doc.cn
-D：传输成功后删除每个远程文件。如果忽略传输，则不会删除远程文件，因为 is 和本地文件已存在。FileExistsModeIGNOREspring-doc.cn

操作生成的消息有效负载是一个对象（即一个对象，每个对象表示一个检索到的文件）。mgetList<File>ListFilespring-doc.cn

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

您使用的表达式 determine the remote path 应生成一个结果，该结果以例如，fetches the complete tree under 结尾。*myfiles/*myfilesspring-doc.cn

从版本 5.0 开始，您可以将 recursive 与模式结合使用，以定期在本地同步整个远程目录树。此模式将本地文件的上次修改时间戳设置为远程文件的时间戳，而不考虑（preserve timestamp）选项。MGETFileExistsMode.REPLACE_IF_MODIFIED-Pspring-doc.cn

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

该模式将被忽略并被假定。默认情况下，将检索整个远程树。但是，您可以通过提供 . 您还可以通过这种方式筛选树中的目录。 A 可以通过 reference 或 by 或 attribute 提供。例如，检索 remote directory 和 subdirectory 中以结尾的所有文件。但是，我们将在本说明之后介绍可用的替代方法。*FileListFilterFileListFilterfilename-patternfilename-regexfilename-regex="(subDir|.*1.txt)"1.txtsubDirspring-doc.cn

如果筛选一个子目录，则不会对该子目录执行额外的遍历。spring-doc.cn

不允许使用该选项（递归使用递归获取目录树，并且目录本身不能包含在列表中）。-dirsmgetlsspring-doc.cn

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

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

从版本 5.0 开始，您可以通过将和设置为来配置和以始终传递目录。这样做允许对简单模式进行递归，如下例所示：SftpSimplePatternFileListFilterSftpRegexPatternFileListFilteralwaysAcceptDirectortiestruespring-doc.cn

<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-doc.cn

另请参阅出站网关部分成功（mget 和 mput）。spring-doc.cn

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

如果筛选一个子目录，则不会对该子目录执行额外的遍历。spring-doc.cn

不允许使用该选项（递归使用递归获取目录树，并且目录本身不能包含在列表中）。-dirsmgetlsspring-doc.cn

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

使用命令`put`

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

操作生成的消息有效负载是 a，其中包含传输后服务器上文件的完整路径。putStringspring-doc.cn

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

使用命令`mput`

mput将多个文件发送到服务器并支持以下选项：spring-doc.cn

-R： Recursive — 发送目录和子目录中的所有文件（可能已过滤）spring-doc.cn

消息有效负载必须是表示本地目录的（或）。从版本 5.1 开始，还支持 or 的集合。java.io.FileStringFileStringspring-doc.cn

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

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

另请参阅出站网关部分成功（mget 和 mput）。spring-doc.cn

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

使用命令`rm`

该命令没有选项。rmspring-doc.cn

如果 remove 操作成功，则生成的消息负载为 . 否则，消息负载为。 header 包含远程目录，header 包含文件名。Boolean.TRUEBoolean.FALSEfile_remoteDirectoryfile_remoteFilespring-doc.cn

使用命令`mv`

该命令没有选项。mvspring-doc.cn

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

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

其他命令信息

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

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

对于所有命令，网关的 'expression' 属性保存命令操作的路径。对于该命令，表达式的计算结果可能为，表示检索所有文件、以及以 .mget*somedirectory/**spring-doc.cn

以下示例显示了为命令配置的网关：lsspring-doc.cn

<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-doc.cn

从版本 4.2 开始，，，和命令支持属性（使用命名空间支持时）。这会影响本地文件存在（和）或远程文件存在（和）时的行为。支持的模式包括、、和。为了向后兼容，和 operations 的默认模式为 . 对于和 operations，默认值为 .GETMGETPUTMPUTFileExistsModemodeGETMGETPUTMPUTREPLACEAPPENDFAILIGNOREPUTMPUTREPLACEGETMGETFAILspring-doc.cn

使用 Java 配置进行配置

以下 Spring Boot 应用程序显示了如何使用 Java 配置出站网关的示例：spring-doc.cn

@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-doc.cn

@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-doc.cn

partialResults：传输成功的结果。spring-doc.cn
derivedInput：从请求消息生成的文件列表（例如要传输的本地文件）。mputspring-doc.cn

这些属性允许您确定哪些文件已成功传输，哪些文件未成功传输。spring-doc.cn

在 recursive 的情况下，可能具有嵌套实例。mputPartialSuccessExceptionPartialSuccessExceptionspring-doc.cn

请考虑以下目录结构：spring-doc.cn

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

如果异常发生在，则网关引发的具有、和和的。它是另一个具有 of 和 and 的。file3.txtPartialSuccessExceptionderivedInputfile1.txtsubdirzoo.txtpartialResultsfile1.txtcausePartialSuccessExceptionderivedInputfile2.txtfile3.txtpartialResultsfile2.txtspring-doc.cn

使用命令ls

使用命令nlst

使用命令get

使用命令mget

使用命令put

使用命令mput

使用命令rm

使用命令mv