|
该版本仍在开发中，尚未被视为稳定。对于最新的稳定版本，请使用 Spring Integration 7.0.0！ |
SFTP出站网关
SFTP 出站网关提供有限的命令集，允许您与远程 SFTP 服务器交互：
-
LS（列表文件） -
NLST（国家标准）（列表文件名） -
获取（检索文件） -
MGET（检索多个文件） -
RM（删除文件） -
MV（移动并重命名文件） -
放（发送文件） -
mput（发送多个文件）
使用LS命令
LS列出远程文件并支持以下选项：
-
-1：检索文件名列表。 默认情况下，检索的是文件信息对象 -
-一个：包含所有文件（包括以'.'开头的文件） -
-f：不要排序列表 -
-导弹：包含目录（默认排除） -
-链接：包含符号链接（默认排除） -
-R：递归地列出远程目录
此外，文件名过滤的提供方式与入站信道适配器.
消息有效载荷由LS作是文件名的列表，或是文件信息对象（取决于你是否使用-1切换）。
这些对象提供诸如修改时间、权限等信息。
远程目录LS执行命令由file_remoteDirectory页眉。
使用递归选项时 （-R），文件名包含任何子目录元素，并表示文件相对于远程目录的相对路径。
如果你使用了-导弹选项中，每个递归目录也会作为列表中的元素返回。
在这种情况下，我们建议你不要使用-1因为你无法区分文件和目录，而在使用时可以做到这一点文件信息对象。
如果远端路径列表以符号开头，SFTP将其视为绝对路径;在当前用户家中，没有 - 作为相对路径。/
用NLST（国家标准）命令
第5版引入了对NLST（国家标准）命令。
NLST（国家标准）列出远程文件名，仅支持一个选项：
-
-f：不要排序列表
消息有效载荷由NLST（国家标准）作是文件名列表。
这file_remoteDirectory头部存储了NLST（国家标准）指挥部采取了行动。
SFTP协议不支持列出名称的功能。
该命令相当于LS与-1为了方便，这里添加了选项和。
使用获取命令
获取检索远程文件并支持以下选项：
-
-P保留远程文件的时间戳。 -
-流： 以流形式检索远程文件。 -
-D：成功传输后删除远程文件。 如果传输被忽略，远程文件不会被删除，因为FileExistsMode是忽视而且本地文件已经存在。
这file_remoteDirectory头部存储远程目录，且file_remoteFile头部存储文件名。
消息有效载荷由获取作是文件表示检索到的文件的对象。
如果你使用了-流选项中，有效载荷是输入流而不是文件.
对于文本文件，常见的使用场景是将此作与文件分流器或流变换器结合使用。
当以流形式消费远程文件时，你有责任关闭会期在流被消耗后。
为了方便起见，会期在可关闭资源头部，以及集成消息头访问器提供便捷的方法：
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" />如果你在自定义组件中消费输入流，你必须关闭会期.
你可以在自定义代码里这样做，或者把消息的副本发送到服务激活器并使用SpEL，如下示例所示： |
<int:service-activator input-channel="closeSession"
expression="headers['closeableResource'].close()" />使用MGET命令
MGET基于模式检索多个远程文件，并支持以下选项：
-
-P：保留远程文件的时间戳。 -
-R递归地检索整个目录树。 -
-x：如果没有文件匹配该模式，则抛出异常（否则返回空列表）。 -
-D：成功传输后删除每个远程文件。 如果传输被忽略，远程文件不会被删除，因为FileExistsMode是忽视而且本地文件已经存在。
消息有效载荷由MGET作是列表<文件>对象（即列表之文件每个对象表示一个检索到的文件）。
从5.0版本开始，如果FileExistsMode是忽视输出消息的有效载荷不再包含因文件已存在而未被取用的文件。
此前，数组包含所有文件，包括已存在的文件。 |
你用的“确定远端路径”表达式应该得到的结果，例如以以下形式结尾*我的档案/*获取完整的家谱树我的档案.
从5.0版本开始，你可以使用递归MGET，与FileExistsMode.REPLACE_IF_MODIFIED模式，用于定期在本地同步整个远程目录树。
该模式将本地文件的最后修改时间戳设置为远程文件的时间戳，无论-P（保留时间戳）选项。
|
使用递归时的注意事项（
-R)这种模式被忽视，大家默认了。
默认情况下，整个远程树都会被检索。
不过，你可以通过提供 如果你筛选一个子目录，就不会对该子目录进行额外的遍历。 这 通常，你会使用 |
持久文件列表过滤器现在具有布尔属性递归.
将该属性设置为true，也设alwaysAccept目录，这意味着对出站网关的递归作（LS和MGET）现在每次都会遍历整个目录树。
这是为了解决目录树深层变更未被检测到的问题。
另外forRecursion=真使得文件的完整路径被用作元数据存储键;这解决了当同名文件在不同目录中多次出现时，过滤器无法正常工作的问题。
重要提示：这意味着在持久的元数据存储中，无法找到顶层目录以下文件的现有密钥。
因此，该性质为false默认情况下;未来发布可能会有所变化。
从5.0版本开始，你可以配置SftpSimplePatternFileListFilter和SftpRegexPatternFileListFilter通过设置alwaysAcceptDirectorties自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门口的财产。
使用放命令
放向远程服务器发送文件。
消息的有效载荷可以是java.io.file一个字节[]，或字符串.
一个远程文件名生成器（或表达式）用于为远程文件命名。
其他可用的属性包括远程目录,临时-远程-目录以及他们的*-表达等价物：使用临时文件名和自动创建目录.
更多信息请参见模式文档。
消息有效载荷由放作是字符串该路径包含传输后服务器文件的完整路径。
4.3 版本引入了CHMODattribute，它在上传后会改变远程文件权限。
你可以使用传统的Unix八进制格式（例如，600仅允许文件所有者读写）。使用 Java 配置适配器时，你可以使用setChmod（0600）.
使用mput命令
mput向服务器发送多个文件，并支持以下选项：
-
-R： 递归 — 发送目录和子目录中的所有文件（可能已过滤）
消息有效载荷必须是java.io.file（或字符串）表示一个本地目录。
自5.1版本起，包含文件或字符串也支持。
与放命令是支持的。
此外，你还可以用以下方法过滤本地目录中的文件mput模式,mput正则表达式,mputFilter或mput-filter-expression.
过滤器与递归一起工作，只要子目录本身通过过滤。
未通过过滤器的子目录不会被递归。
消息有效载荷由mput作是List<String>对象（即列表传输产生的远程文件路径）。
4.3 版本引入了CHMOD属性，允许你在上传后更改远程文件权限。
你可以使用传统的Unix八进制格式（例如，600仅允许文件所有者读写）。
用Java配置适配器时，你可以用setChmodOctal（“600”）或setChmod（0600）.
使用RM命令
这RM指挥部没有任何选项。
如果移除作成功，所得消息载荷为布林。正确.
否则，消息有效载荷为布尔值。错误.
这file_remoteDirectory头部存储远程目录，且file_remoteFile头部存储文件名。
使用MV命令
这MV指挥部没有任何选项。
这表达属性定义了“出发”路径，且重命名表达式属性定义了“去”路径。
默认情况下，重命名表达式是标题['file_renameTo'].
该表达式不得取零值或空值字符串.
如有必要，会创建所需的远程目录。
结果消息的有效载荷为布林。正确.
这file_remoteDirectory头部存储原始的远程目录，且file_remoteFile头部存储文件名。
这file_renameTo头部存储新路径。
从5.5.6版本开始，remoteDirectoryExpression可用于MV为了方便而命令。
如果“from”文件不是完整的文件路径，结果是remoteDirectoryExpression作为远程目录使用。
例如，如果任务只是重命名某个目录中的远程文件，“to”文件也是同样的道理。
附加指挥信息
这获取和MGET指挥支持本地文件名生成器表达式属性。
它定义了一个 SpEL 表达式，用于在传输过程中生成本地文件的名称。
评估上下文的根对象是请求消息。
这remoteFileName变量也可用。
它特别有用MGET（例如：local-filename-generator-expression=“#remoteFileName.toUpperCase（） + headers.foo”).
这获取和MGET指挥支持本地目录表达式属性。
它定义了一个 SpEL 表达式，用于在传输过程中生成本地目录的名称。
评估上下文的根对象是请求消息。
这remoteDirectory变量也可用。
它对mget（例如：local-directory-expression=“'/tmp/local/' + #remoteDirectory.toUpperCase（） + headers.myheader”).
该属性与本地目录属性。
对于所有命令，网关的“表达式”属性包含命令作用的路径。
对于MGET命令，表达式可能评估为 ，表示检索所有文件，*某目录/*，以及其他以 为结尾的值。*
以下示例展示了为LS命令：
<int-ftp:outbound-gateway id="gateway1"
session-factory="ftpSessionFactory"
request-channel="inbound1"
command="ls"
command-options="-1"
expression="payload"
reply-channel="toSplitter"/>发送给toSplitter频道是字符串每个对象都包含一个文件的名称。
如果你省略了command-options=“-1”，有效载荷将是文件信息对象。
你可以以空间分隔列表的形式提供选项（例如，command-options=“-1 -dirs -links”).
从4.2版本开始，获取,MGET,放和MPUT命令支持FileExistsMode性质 （模式使用命名空间支持时）。
这会影响本地文件存在时的行为（获取和MGET）或远程文件存在（放和MPUT).
支持的模式有取代,附加,失败和忽视.
为了向下兼容，默认模式为放和MPUT运算为取代.
为获取和MGET作，默认为失败.
使用 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开始），一个部分成功例外被抛出。
还有常见的消息异常性质（失败消息和原因），该例外还有两个额外性质：
-
部分结果：转会成功的结果。 -
衍生输入： 由请求消息生成的文件列表（例如本地文件，用于传输mput).
这些属性可以帮助你判断哪些文件被成功传输，哪些没有。
递归情况下mput这部分成功例外可能已经筑巢部分成功例外实例。
考虑以下目录结构：
root/
|- file1.txt
|- subdir/
| - file2.txt
| - file3.txt
|- zoo.txt如果异常发生在file3.txt这部分成功例外被门扔出去衍生输入之file1.txt,副导演和zoo.txt和部分结果之file1.txt.
其原因是另一个部分成功例外跟衍生输入之file2.txt和file3.txt和部分结果之file2.txt.