|
如需使用最新稳定版本，请使用 Spring Integration 7.0.4！ |
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且本地文件已存在。
The file_remoteDirectory 表头保存远程目录，file_remoteFile 表头保存文件名。
由 get 操作生成的消息负载是一个表示已检索文件的 File 对象。
如果您使用 -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)该模式将被忽略，并假定为 如果过滤了子目录，则不会对该子目录执行额外的遍历。 不允许使用 通常，您会在 |
持久化文件列表过滤器现在有一个布尔属性 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 命令以方便使用。
如果“from”文件不是完整文件路径，则使用 remoteDirectoryExpression 的结果作为远程目录。
“to”文件也适用同样的规则，例如，如果任务只是重命名某个目录中的远程文件。
附加命令信息
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 是另一个带有 derivedInput 的 file2.txt 和 file3.txt，以及 partialResults 的 file2.txt 的 PartialSuccessException。