SFTP 出站网关

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

  • ls（列出文件）

  • nlst（列出文件名）

  • get（检索文件）

  • mget（检索多个文件）

  • rm（删除文件）

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

  • put（发送文件）

  • mput（发送多个文件）

使用 ls 命令

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

  • -1：检索文件名列表。默认情况下，检索 FileInfo 对象列表

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

  • -f：不排序列表

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

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

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

此外，文件名筛选以与 inbound-channel-adapter 相同的方式提供。

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

ls 命令所作用的远程目录在 file_remoteDirectory 标头中提供。

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

如果以 / 符号开头的远程路径列表，则 SFTP 将其视为绝对路径；如果没有，则视为当前用户主页中的相对路径。

使用 nlst 命令

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

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

  • -f：不排序列表

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

file_remoteDirectory 头部保存 nlst 命令作用的远程目录。

SFTP 协议不提供列出名称的功能。此命令等同于带有 -1 选项的 ls 命令，并且在此处添加以方便使用。

使用 get 命令

get 检索远程文件，并支持以下选项

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

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

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

file_remoteDirectory 头部保存远程目录，file_remoteFile 头部保存文件名。

get 操作产生的消息有效负载是表示已检索文件的文件对象。如果您使用 -stream 选项，则有效负载是 InputStream 而不是 File。对于文本文件，常见用例是将此操作与 文件拆分器 或 流转换器 结合使用。在以流的形式使用远程文件时，您负责在使用流后关闭 Session。为了方便起见，Session 在 closeableResource 头部中提供，并且 IntegrationMessageHeaderAccessor 提供方便的方法

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

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

以下示例显示如何以流的形式使用文件

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

使用 mget 命令

mget 基于模式检索多个远程文件，并支持以下选项

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

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

  • -x：如果没有任何文件与模式匹配，则抛出异常（否则，将返回一个空列表）。

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

由 mget 操作产生的消息有效负载是一个 List<File> 对象（即 File 对象的 List，每个对象都表示一个已检索的文件）。

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

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

从版本 5.0 开始，您可以使用递归 MGET，结合 FileExistsMode.REPLACE_IF_MODIFIED 模式，定期在本地同步整个远程目录树。此模式将本地文件的上次修改时间戳设置为远程文件的时间戳，无论 -P（保留时间戳）选项如何。

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

忽略该模式并假定为 *。默认情况下，将检索整个远程树。但是，您可以通过提供 FileListFilter 来过滤树中的文件。您还可以通过这种方式过滤树中的目录。FileListFilter 可以通过引用或 filename-pattern 或 filename-regex 属性提供。例如，filename-regex="(subDir|.*1.txt)" 检索远程目录中所有以 1.txt 结尾的文件和子目录 subDir。但是，我们将在本注释之后描述可用的替代方法。

如果您过滤子目录，则不会对该子目录执行其他遍历。

不允许使用 -dirs 选项（递归 mget 使用递归 ls 获取目录树，并且目录本身不能包含在列表中）。

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

持久文件列表过滤器现在有一个布尔属性 forRecursion。将此属性设置为 true，还会设置 alwaysAcceptDirectories，这意味着出站网关（ls 和 mget）上的递归操作现在将始终每次遍历整个目录树。这是为了解决目录树深处未检测到更改的问题。此外，forRecursion=true 会导致将文件的完整路径用作元数据存储键；这解决了如果在不同目录中多次出现同名文件，则过滤器无法正常工作的问题。重要提示：这意味着持久元数据存储中现有的键将不会在顶级目录下的文件中找到。因此，该属性默认值为 false；这可能会在未来版本中更改。

从版本 5.0 开始，你可以通过将 alwaysAcceptDirectorties 设置为 true 来配置 SftpSimplePatternFileListFilter 和 SftpRegexPatternFileListFilter 以始终传递目录。这样做允许对简单模式进行递归，如下例所示

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

你可以使用网关上的 filter 属性提供其中一个过滤器。

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

使用 put 命令

put 将文件发送到远程服务器。消息的有效负载可以是 java.io.File、byte[] 或 String。remote-filename-generator（或表达式）用于命名远程文件。其他可用属性包括 remote-directory、temporary-remote-directory 及其 *-expression 等效项：use-temporary-file-name 和 auto-create-directory。有关更多信息，请参阅 架构文档。

put 操作产生的消息有效负载是一个 String，其中包含传输后服务器上文件的完整路径。

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

使用 mput 命令

mput 将多个文件发送到服务器，并支持以下选项

  • -R：递归 - 发送目录和子目录中所有文件（可能经过筛选）

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

支持与 put 命令 相同的属性。此外，你可以使用 mput-pattern、mput-regex、mput-filter 或 mput-filter-expression 中的一个来筛选本地目录中的文件。只要子目录本身通过筛选，筛选器就可以与递归一起使用。未通过筛选的子目录不会进行递归。

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

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

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

使用 rm 命令

rm 命令没有选项。

如果删除操作成功，则产生的消息负载为 Boolean.TRUE。否则，消息负载为 Boolean.FALSE。file_remoteDirectory 标头保存远程目录，而 file_remoteFile 标头保存文件名。

使用 mv 命令

mv 命令没有选项。

expression 属性定义“从”路径，而 rename-expression 属性定义“到”路径。默认情况下，rename-expression 为 headers['file_renameTo']。此表达式不得求值为 null 或空 String。如有必要，将创建所需的任何远程目录。结果消息的负载为 Boolean.TRUE。file_remoteDirectory 标头保存原始远程目录，而 file_remoteFile 标头保存文件名。file_renameTo 标头保存新路径。

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

其他命令信息

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

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

对于所有命令，网关的“expression”属性保存命令作用于其上的路径。对于 mget 命令，表达式可能会评估为 *，表示检索所有文件，somedirectory/*，以及以 * 结尾的其他值。

以下示例显示了针对 ls 命令配置的网关

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

发送到 toSplitter 通道的消息的有效负载是一个 String 对象列表，每个对象都包含一个文件名。如果您省略了 command-options="-1"，则有效负载将是 FileInfo 对象的列表。您可以将选项作为空格分隔的列表提供（例如，command-options="-1 -dirs -links"）。

从版本 4.2 开始，GET、MGET、PUT 和 MPUT 命令支持 FileExistsMode 属性（使用命名空间支持时为 mode）。当本地文件存在（GET 和 MGET）或远程文件存在（PUT 和 MPUT）时，这会影响行为。支持的模式为 REPLACE、APPEND、FAIL 和 IGNORE。为了向后兼容，PUT 和 MPUT 操作的默认模式为 REPLACE。对于 GET 和 MGET 操作，默认值为 FAIL。

使用 Java 配置进行配置

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

@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 配置出站网关的示例

@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();
    }

}

出站网关部分成功（mget 和 mput）

在对多个文件执行操作（通过使用 mget 和 mput）时，在传输了一个或多个文件之后，可能会发生异常。在这种情况下（从版本 4.2 开始），将抛出 PartialSuccessException。除了通常的 MessagingException 属性（failedMessage 和 cause）之外，此异常还有两个附加属性

  • partialResults：成功的传输结果。

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

这些属性可用于确定哪些文件已成功传输，哪些文件未成功传输。

对于递归mput，PartialSuccessException 可能具有嵌套的PartialSuccessException 实例。

考虑以下目录结构

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

如果异常发生在file3.txt 上，则网关抛出的PartialSuccessException 具有derivedInput，即file1.txt、subdir和zoo.txt，以及partialResults，即file1.txt。其cause是另一个PartialSuccessException，具有derivedInput，即file2.txt和file3.txt，以及partialResults，即file2.txt。