|
该版本仍在开发中，尚未被视为稳定。对于最新的稳定版本，请使用 Spring Integration 7.0.0！ |
FTP出站网关
FTP出站网关提供有限的命令集，用于与远程FTP或FTPS服务器交互。 支持的命令有：
-
LS（列表文件） -
NLST（国家标准）（列表文件名） -
获取（检索文件） -
MGET（检索文件） -
RM（删除文件） -
MV（移动/重命名文件） -
放（发送文件） -
mput（发送多个文件）
使用LS命令
LS列出远程文件并支持以下选项：
-
-1检索文件名列表。 默认情况下，检索的是文件信息对象。 -
-一个：包含所有文件（包括以'.'开头的文件） -
-f：不要排序列表 -
-导弹：包含目录（默认排除） -
-链接：包含符号链接（默认排除） -
-R：递归地列出远程目录
此外，还提供了文件名过滤，方式与入站信道适配器.
参见FTP入站信道适配器。
消息有效载荷由LS作是文件名的列表，或是文件信息对象。
这些对象提供修改时间、权限及其他详细信息。
远程目录LS执行命令由file_remoteDirectory页眉。
使用递归选项时 （-R），文件名包含任何子目录元素，表示文件相对于远程目录的相对路径。
如果-导弹包含了选项，每个递归目录也会作为列表中的元素返回。
在这种情况下，建议你不要使用-1因为你无法区分文件和目录，而这可以通过文件信息对象。
从4.3版本开始，FtpSession支持零对于列表（）和列表名称（）方法。
因此，你可以省略表达属性。
为了方便起见，Java 配置有两个构造函数，它们不具备表达论点。
或LS,NLST,放和MPUT命令零根据FTP协议，被视为客户端工作目录。
所有其他命令必须附带表达以根据请求消息评估远程路径。
你可以用FTPClient.changeWorkingDirectory（）当你扩展DefaultFtpSessionFactory并实现postProcessClientAfterConnect（）回调。
使用NLST（国家标准）命令
第5版引入了对NLST（国家标准）命令。
NLST（国家标准）列出远程文件名，仅支持一个选项：
-
-f：不要排序列表
消息有效载荷由NLST（国家标准）作是文件名列表。
远程目录NLST（国家标准）执行命令由file_remoteDirectory页眉。
与-1选项LS命令，利用列表命令，NLST（国家标准）命令发送NLST命令指向目标 FTP 服务器。
当服务器不支持时，该命令非常有用列表（例如由于安全限制）。
结果NLST（国家标准）作仅是名称，没有其他细节。
因此，框架无法判断实体是否为目录，以执行过滤或递归列表等作。
使用获取命令
获取检索远程文件。
它支持以下选项：
-
-P保留远程文件的时间戳。 -
-流： 以流形式检索远程文件。 -
-D：成功传输后删除远程文件。 如果传输被忽略，远程文件不会被删除，因为FileExistsMode是忽视而且本地文件已经存在。
这file_remoteDirectory头部提供远程目录名称，以及file_remoteFile头部提供文件名。
消息有效载荷由获取作是文件表示检索文件或输入流当你使用-流选择。
这-流选项允许以流形式检索文件。
对于文本文件，常见的使用场景是将此作与文件分流器或流变换器结合使用。
当以流形式消费远程文件时，你有责任关闭会期在流被消耗后。
为了方便起见，会期在可关闭资源你可以通过方便方法访问该头部集成消息头访问器以下示例展示了如何使用便利法：
Closeable closeable = new IntegrationMessageHeaderAccessor(message).getCloseableResource();
if (closeable != null) {
closeable.close();
}以下示例展示了如何将文件作为流消费：
<int-ftp: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是忽视输出消息的有效载荷不再包含因文件已存在而未被取用的文件。
此前，该列表包含所有文件，包括已存在的文件。 |
用于确定远端路径的表达式应得到以- 例如：somedir/将取出完整的树索梅迪尔.
从5.0版本开始，递归式MGET，与新的FileExistsMode.REPLACE_IF_MODIFIED模式，可用于周期性地在本地同步整个远程目录树。
该模式将本地文件的最后修改时间戳替换为远程时间戳，无论-P（保留时间戳）选项。
|
使用递归（
-R)这种模式被忽略，被默认。
默认情况下，整个远程树都会被检索。
然而，树中的文件可以通过提供 如果子目录被过滤，则不会对该子目录进行额外的遍历。 这 通常，你会使用 |
持久文件列表过滤器现在具有布尔属性递归.
将该属性设置为true，也设alwaysAccept目录，这意味着对出站网关的递归作（LS和MGET）现在每次都会遍历整个目录树。
这是为了解决目录树深层变更未被检测到的问题。
另外forRecursion=真使得文件的完整路径被用作元数据存储键;这解决了当同名文件在不同目录中多次出现时，过滤器无法正常工作的问题。
重要提示：这意味着在持久的元数据存储中，无法找到顶层目录以下文件的现有密钥。
因此，该性质为false默认情况下;未来发布可能会有所变化。
从5.0版本开始，FtpSimplePatternFileListFilter和FtpRegexPatternFileListFilter可以通过设置alwaysAccept目录属性到true.
这样做可以对简单模式进行递归，如下示例所示：
<bean id="starDotTxtFilter"
class="org.springframework.integration.ftp.filters.FtpSimplePatternFileListFilter">
<constructor-arg value="*.txt" />
<property name="alwaysAcceptDirectories" value="true" />
</bean>
<bean id="dotStarDotTxtFilter"
class="org.springframework.integration.ftp.filters.FtpRegexPatternFileListFilter">
<constructor-arg value="^.*\.txt$" />
<property name="alwaysAcceptDirectories" value="true" />
</bean>一旦你定义了像前面示例那样的过滤器，可以通过设置Filter门口的财产。
使用放命令
这放命令向远程服务器发送文件。
消息的有效载荷可以是java.io.file一个字节[]，或字符串.
一个远程文件名生成器（或表达式）用于为远程文件命名。
其他可用的属性包括远程目录,临时-远程-目录， 以及他们的*-表达等价物：使用临时文件名和自动创建目录.
更多信息请参见模式文档。
消息有效载荷由放作是字符串代表传输后文件在服务器上的完整路径。
5.2 版本引入了CHMODattribute，它在上传后会改变远程文件权限。
你可以使用传统的Unix八进制格式（例如，600仅允许文件所有者读写）。
用 Java 配置适配器时，你可以用setChmod（0600）.
只有当你的FTP服务器支持以下条件时才适用网站CHMOD副指挥部。
使用mput命令
这mput向服务器发送多个文件，且仅支持一种选项：
-
-R：递归的。 发送目录及其子目录中的所有文件（可能经过过滤）。
消息有效载荷必须是java.io.file（或字符串）表示一个本地目录。
自5.1版本起，包含文件或字符串也支持。
该命令支持与放命令.
此外，本地目录中的文件可以通过以下一种方式进行过滤mput模式,mput正则表达式,mputFilter或mput-filter-expression.
过滤器与递归一起工作，只要子目录本身通过过滤。
未通过过滤器的子目录不会被递归。
消息有效载荷由mput作是List<String>对象（即列表传输产生的远程文件路径）。
5.2 版本引入了CHMOD属性，允许你在上传后更改远程文件权限。
你可以使用传统的Unix八进制格式（例如，600仅允许文件所有者读写）。
用Java配置适配器时，你可以用setChmodOctal（“600”）或setChmod（0600）.
只有当你的FTP服务器支持以下条件时才适用网站CHMOD副指挥部。
使用RM命令
这RM命令删除文件。
这RM指挥部没有任何选项。
消息有效载荷由RM运算为布林。正确如果移除成功，或者布尔值。错误否则。
这file_remoteDirectory头部提供远程目录，以及file_remoteFile头部提供文件名。
使用MV命令
这MV指令移动文件。
这MV指挥部没有任何选项。
这表达属性定义了“出发”路径，且重命名表达式属性定义了“去”路径。
默认情况下，重命名表达式是标题['file_renameTo'].
该表达式不得取零值或空值字符串.
如有必要，会创建任何必要的远程目录。
结果消息的有效载荷为布林。正确.
这file_remoteDirectory头部提供原始的远程目录，file_remoteFile头部提供文件名。
新路径在file_renameTo页眉。
从5.5.6版本开始，remoteDirectoryExpression可用于MV为了方便而命令。
如果“from”文件不是完整的文件路径，结果是remoteDirectoryExpression作为远程目录使用。
例如，如果任务只是重命名某个目录中的远程文件，“to”文件也是同样的道理。
关于FTP出站网关命令的额外信息
这获取和MGET指挥支持本地文件名生成器表达式属性。
它定义了一个 SpEL 表达式，在传输过程中生成本地文件的名称。
评估上下文的根对象是请求消息。
这remoteFileName变量，特别有用MGET，也可用——例如，local-filename-generator-expression=“#remoteFileName.toUpperCase（） + headers.something”.
这获取和MGET指挥支持本地目录表达式属性。
它定义了一个 SpEL 表达式，用于在传输过程中生成本地目录的名称。
评估上下文的根对象是请求消息 but。
这remoteDirectory变量，特别有用MGET，也可用——例如：local-directory-expression=“'/tmp/local/' + #remoteDirectory.toUpperCase（） + headers.something”.
该属性与本地目录属性。
对于所有命令，网关的“表达式”属性提供了命令作用的路径。
对于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频道是字符串每个对象都包含一个文件的名称。
如果命令-选项属性被省略了，成立文件信息对象。
它使用空间划分选项——例如，command-options=“-1 -dirs -links”.
从4.2版本开始，获取,MGET,放和MPUT命令支持FileExistsMode性质 （模式使用命名空间支持时）。
这会影响本地文件存在时的行为（获取和MGET）或远程文件存在（放和MPUT).
支持的模式有取代,附加,失败和忽视.
为了向下兼容，默认模式为放和MPUT运算为取代.
为获取和MGET作，默认为失败.
从5.0版本开始，setWorkingDirExpression（） (工作指令表达式在 XML 中提供选项Ftp外发网关 (<int-ftp：outbound-gateway>以XML形式）。
它允许你在运行时更改客户端工作目录。
表达式会根据请求消息进行评估。
每次网关作后，之前的工作目录都会被恢复。
使用 Java 配置配置
以下 Spring Boot 应用程序展示了如何用 Java 配置配置出站网关的示例：
@SpringBootApplication
public class FtpJavaApplication {
public static void main(String[] args) {
new SpringApplicationBuilder(FtpJavaApplication.class)
.web(false)
.run(args);
}
@Bean
public SessionFactory<FTPFile> ftpSessionFactory() {
DefaultFtpSessionFactory sf = new DefaultFtpSessionFactory();
sf.setHost("localhost");
sf.setPort(port);
sf.setUsername("foo");
sf.setPassword("foo");
sf.setTestSession(true);
return new CachingSessionFactory<FTPFile>(sf);
}
@Bean
@ServiceActivator(inputChannel = "ftpChannel")
public MessageHandler handler() {
FtpOutboundGateway ftpOutboundGateway =
new FtpOutboundGateway(ftpSessionFactory(), "ls", "'my_remote_dir/'");
ftpOutboundGateway.setOutputChannelName("lsReplyChannel");
return ftpOutboundGateway;
}
}使用 Java DSL 配置
以下 Spring Boot 应用程序展示了如何用 Java DSL 配置出站网关的示例：
@SpringBootApplication
public class FtpJavaApplication {
public static void main(String[] args) {
new SpringApplicationBuilder(FtpJavaApplication.class)
.web(false)
.run(args);
}
@Bean
public SessionFactory<FTPFile> ftpSessionFactory() {
DefaultFtpSessionFactory sf = new DefaultFtpSessionFactory();
sf.setHost("localhost");
sf.setPort(port);
sf.setUsername("foo");
sf.setPassword("foo");
sf.setTestSession(true);
return new CachingSessionFactory<FTPFile>(sf);
}
@Bean
public FtpOutboundGatewaySpec ftpOutboundGateway() {
return Ftp.outboundGateway(ftpSessionFactory(),
AbstractRemoteFileOutboundGateway.Command.MGET, "payload")
.options(AbstractRemoteFileOutboundGateway.Option.RECURSIVE)
.regexFileNameFilter("(subFtpSource|.*1.txt)")
.localDirectoryExpression("'localDirectory/' + #remoteDirectory")
.localFilenameExpression("#remoteFileName.replaceFirst('ftpSource', 'localTarget')");
}
@Bean
public IntegrationFlow ftpMGetFlow(AbstractRemoteFileOutboundGateway<FTPFile> ftpOutboundGateway) {
return f -> f
.handle(ftpOutboundGateway)
.channel(c -> c.queue("remoteFileOutputChannel"));
}
}出站网关部分成功（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.