使用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。