SFTP Outbound Gateway

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

  • ls (list files)

  • nlst (list file names)

  • get (retrieve a file)

  • mget (retrieve multiple files)

  • rm (remove file(s))

  • `mv`移动和重命名文件

  • put (send a file)

  • mput (send multiple files)

Using the ls Command

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

  • -1: 检索文件名列表。默认检索 FileInfo 对象的列表

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

  • -f：不按清单排序

  • -dirs: 包含目录（默认情况下不包含目录）

  • -links: 包含符号链接（默认情况下不包含符号链接）

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

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

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

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

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

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

Using nlst Command

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

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

  • -f：不按清单排序

nlst 操作返回的消息有效负载是一个文件名列表。

file_remoteDirectory 标头包含 nlst 命令对其执行操作的远程目录。

SFTP 协议无法列出名称。该命令与带有 -1 选项的 ls 命令等效，并且为方便添加在这里。

Using the get Command

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

  • -P: 保留远程文件的显式时间戳。

  • -stream: 将远程文件作为流检索。

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

file_remoteDirectory 标头包含远程目录，file_remoteFile 标头包含文件名。

由`get`操作产生的消息有效负载是一个表示已检索文件的`File`对象。如果您使用`-stream`选项，则有效负载将是`InputStream`，而不是`File`。对于文本文件，一种常见用例是将此操作与file splitter或stream transformer结合使用。在将远程文件作为流使用时，您应负责在使用流后关闭`Session`。为方便起见，`Session`在`closeableResource`标头中提供，而`IntegrationMessageHeaderAccessor`提供便利方法：

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

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

以下示例显示了如何将文件作为流使用：

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

Using the mget Command

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（保留时间戳）选项如何，此模式都将本地文件的最后修改时间戳设置为远程文件的时间戳。

Example 1. Notes for when using recursion (-R)

模式会被忽略，而假定为 *。默认情况下，将检索整个远程树。但是，您可以通过提供 FileListFilter 来筛选树中的文件。您还可以通过此方式筛选树中的目录。可以通过引用或 filename-pattern 或 filename-regex 属性来提供 FileListFilter。例如，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 开始，你可以将 SftpSimplePatternFileListFilter 和 SftpRegexPatternFileListFilter 配置为始终通过目录，方法是将 alwaysAcceptDirectories 设置为 true。这样做允许对简单模式进行递归，如下面的示例所示：

<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 属性提供其中一个过滤器。

另请参见 Outbound Gateway Partial Success (mget and mput)。

Using the put Command

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

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

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

Using the mput Command

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

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

消息负载必须是一个表示本地目录的 java.io.File（或 String）。自 5.1 版本起，也支持一个 File 或 String 集合。

支持与 xref:sftp/outbound-gateway.adoc#sftp-put-command[put 命令相同的属性。此外，你还可以使用 mput-pattern、mput-regex、mput-filter 或 mput-filter-expression 中的一个过滤本地目录中的文件。只要子目录本身通过过滤器，该过滤器就会使用递归。不通过过滤器的子目录不会进行递归。

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

另请参见 Outbound Gateway Partial Success (mget and mput)。

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

Using the rm Command

rm 命令没有选项。

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

Using the mv Command

mv 命令没有选项。

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

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

Additional Command Information

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。

Configuring with Java Configuration

以下 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/'");
    }

}

Configuring with the 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();
    }

}

Outbound Gateway Partial Success (mget and 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 具有 file1.txt、subdir 和 zoo.txt 的 derivedInput，以及 file1.txt 的 partialResults。其 cause 是另一个具有 file2.txt 和 file3.txt 的 derivedInput 和 file2.txt 的 partialResults 的 PartialSuccessException。