使用 RemoteFileTemplate
从 Spring Integration 3.0 开始,在 FtpSession
对象之上提供了一个新的抽象。该模板提供了发送、检索(作为 InputStream
)、删除和重命名文件的方法。此外,还提供了一个 execute
方法,允许调用者在会话上执行多个操作。在所有情况下,模板都会负责可靠地关闭会话。更多信息,请参阅 RemoteFileTemplate
的 Javadoc。FTP 有一个子类:FtpRemoteFileTemplate
。
版本 4.1 添加了其他方法,包括 getClientInstance()
,它提供了对底层 FTPClient
的访问,从而使您能够访问低级 API。
并非所有 FTP 服务器都正确实现了 STAT <path>
命令。有些服务器对不存在的路径返回肯定结果。当路径是文件且存在时,NLST
命令可以可靠地返回名称。但是,它不支持检查空目录是否存在,因为当路径是目录时,NLST
总是返回一个空列表。由于模板不知道路径是否表示目录,因此当路径似乎不存在时(使用 NLST
时),它必须执行额外的检查。这会增加开销,需要向服务器发送多个请求。从版本 4.1.9 开始,FtpRemoteFileTemplate
提供了 FtpRemoteFileTemplate.ExistsMode
属性,该属性具有以下选项
-
STAT
: 执行STAT
FTP 命令 (FTPClient.getStatus(path)
) 来检查路径是否存在。这是默认选项,要求您的 FTP 服务器正确支持STAT
命令(带路径)。 -
NLST
: 执行NLST
FTP 命令 —FTPClient.listName(path)
。如果您正在测试文件的完整路径,请使用此选项。它不适用于空目录。 -
NLST_AND_DIRS
: 首先执行NLST
命令,如果它没有返回文件,则回退到一种通过使用FTPClient.changeWorkingDirectory(path)
临时切换工作目录的技术。更多信息,请参阅FtpSession.exists()
。
由于我们知道 FileExistsMode.FAIL
情况始终只查找文件(而不是目录),因此我们可以安全地对 FtpMessageHandler
和 FtpOutboundGateway
组件使用 NLST
模式。
对于其他任何情况,可以扩展 FtpRemoteFileTemplate
以在覆盖的 exist()
方法中实现自定义逻辑。
从版本 5.0 开始,新增了 RemoteFileOperations.invoke(OperationsCallback<F, T> action)
方法。此方法允许在同一个线程绑定的 Session
范围内调用多个 RemoteFileOperations
。当您需要将 RemoteFileTemplate
的多个高级操作作为一个工作单元执行时,这非常有用。例如,AbstractRemoteFileOutboundGateway
在 mput
命令实现中使用了它,我们在提供的目录中为每个文件及其子目录递归地执行 put
操作。更多信息,请参阅 Javadoc。