|
此版本仍在开发中，尚未被视为稳定版本。对于最新的稳定版本，请使用 Spring Integration 6.4.0！ |
SFTP 出站网关
SFTP 出站网关提供了一组有限的命令，允许您与远程 SFTP 服务器进行交互：
-
ls（列出文件） -
nlst（列出文件名） -
get（检索文件） -
mget（检索多个文件） -
rm（删除文件） -
mv（移动和重命名文件） -
put（发送文件） -
mput（发送多个文件）
使用ls命令
ls列出远程文件并支持以下选项：
-
-1：检索文件名列表。 默认是检索FileInfo对象 -
-a：包括所有文件（包括以“.”开头的文件） -
-f：不对列表进行排序 -
-dirs：包括目录（默认排除） -
-links：包括符号链接（默认排除） -
-R：递归列出远程目录
此外，文件名过滤的提供方式与inbound-channel-adapter.
由lsoperation 是文件名列表或FileInfo对象（取决于您是否使用-1switch） 的
这些对象提供修改时间、权限等信息。
远程目录ls执行 action on 的命令在file_remoteDirectory页眉。
当使用递归选项 （-R）、fileName包含任何 subdirectory 元素，并表示文件的相对路径（相对于远程目录）。
如果您使用-dirs选项，则每个递归目录也会作为列表中的一个元素返回。
在这种情况下，我们建议您不要使用-1选项，因为您无法区分文件和目录，而使用FileInfo对象。
如果 remote path to list 以符号开头，则 SFTP 会将其视为绝对路径;without - 作为当前用户 home 中的相对路径。/
用nlst命令
版本 5 引入了对nlst命令。
nlst列出远程文件名，并且仅支持一个选项：
-
-f：不对列表进行排序
由nlstoperation 是文件名列表。
这file_remoteDirectoryheader 包含远程目录，其中nlst命令起作用。
SFTP 协议不提供列出名称的功能。
此命令相当于ls命令与-1选项，为方便起见，在此处添加。
使用get命令
get检索远程文件并支持以下选项：
-
-P：保留远程文件的时间戳。 -
-stream：将远程文件作为流检索。 -
-D：传输成功后删除远程文件。 如果忽略传输，则不会删除远程文件，因为FileExistsMode是IGNORE并且本地文件已存在。
这file_remoteDirectoryheader 包含远程目录，而file_remoteFileheader 包含文件名。
由get作是File对象表示检索到的文件。
如果您使用-stream选项，则 payload 是一个InputStream而不是File.
对于文本文件，一个常见的用例是将此作与文件拆分器或流转换器结合使用。
将远程文件作为流使用时，您负责关闭Session在流被消费后。
为方便起见，Session在closeableResourceheader 和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()" />使用mget命令
mget根据模式检索多个远程文件，并支持以下选项：
-
-P：保留远程文件的时间戳。 -
-R：递归检索整个目录树。 -
-x：如果没有文件与模式匹配，则引发异常（否则，返回空列表）。 -
-D：传输成功后删除每个远程文件。 如果忽略传输，则不会删除远程文件，因为FileExistsMode是IGNORE并且本地文件已存在。
由mget作是List<File>object（即List之File对象，每个对象代表一个检索到的文件）。
从版本 5.0 开始，如果FileExistsMode是IGNORE，则输出消息的有效负载不再包含由于文件已存在而未获取的文件。
以前，该数组包含所有文件，包括已存在的文件。 |
您使用的表达式 determine the remote path 应生成一个结果，例如，该*myfiles/*在myfiles.
从版本 5.0 开始，您可以使用递归MGET与FileExistsMode.REPLACE_IF_MODIFIED模式，以定期在本地同步整个远程目录树。
此模式将本地文件的上次修改时间戳设置为远程文件的时间戳，而不管-P（保留时间戳）选项。
|
使用递归时的注意事项 （
-R)该模式将被忽略并被假定。
默认情况下，将检索整个远程树。
但是，您可以通过提供 如果筛选一个子目录，则不会对该子目录执行额外的遍历。 这 通常，您会使用 |
持久文件列表过滤器现在具有布尔属性forRecursion.
将此属性设置为true，还会设置alwaysAcceptDirectories，这意味着出站网关 （ls和mget） 现在每次都始终遍历完整的目录树。
这是为了解决未检测到目录树深处更改的问题。
另外forRecursion=true使文件的完整路径用作元数据存储键;这解决了以下问题：如果具有相同名称的文件在不同目录中多次出现，则过滤器无法正常工作。
重要说明：这意味着对于顶级目录下的文件，将无法找到持久性元数据存储中的现有键。
因此，该属性为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属性。
另请参阅出站网关部分成功 （mget和mput).
使用put命令
put将文件发送到远程服务器。
消息的有效负载可以是java.io.File一个byte[]或String.
一个remote-filename-generator（或 expression） 用于命名远程文件。
其他可用属性包括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).
使用mput命令
mput将多个文件发送到服务器并支持以下选项：
-
-R： Recursive — 发送目录和子目录中的所有文件（可能已过滤）
消息负载必须是java.io.File（或String） 表示本地目录。
从 5.1 版本开始，一组File或String也受支持。
与put命令受支持。
此外，您可以使用mput-pattern,mput-regex,mput-filter或mput-filter-expression.
只要子目录本身通过过滤器，过滤器就可以使用递归。
未通过过滤器的子目录不会递归。
由mput作是List<String>object（即List传输产生的远程文件路径）。
另请参阅出站网关部分成功 （mget和mput).
版本 4.3 引入了chmod属性，该属性允许您在上传后更改远程文件权限。
您可以使用传统的 Unix 八进制格式（例如600仅允许文件所有者的读写）。
使用 Java 配置适配器时，您可以使用setChmodOctal("600")或setChmod(0600).
使用rm命令
这rm命令中没有选项。
如果 remove作成功，则生成的消息有效负载为Boolean.TRUE.
否则，消息负载为Boolean.FALSE.
这file_remoteDirectoryheader 包含远程目录，而file_remoteFileheader 保存文件名。
使用mv命令
这mv命令中没有选项。
这expression属性定义 “from” 路径，而rename-expressionattribute 定义 “to” 路径。
默认情况下，rename-expression是headers['file_renameTo'].
此表达式的计算结果不得为 null 或空String.
如有必要，将创建所需的任何远程目录。
结果消息的有效负载为Boolean.TRUE.
这file_remoteDirectoryheader 包含原始远程目录，而file_remoteFileheader 包含文件名。
这file_renameToheader 包含新路径。
从版本 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"/>发送到toSplitterchannel 是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和MPUToperations 为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由 gateway 抛出的derivedInput之file1.txt,subdir和zoo.txt和partialResults之file1.txt.
其cause是另一个PartialSuccessException跟derivedInput之file2.txt和file3.txt和partialResults之file2.txt.