|
对于最新的稳定版本，请使用 Spring Integration 6.5.1！ |
FTP 入站通道适配器
FTP 入站通道适配器是一个特殊的侦听器，它连接到 FTP 服务器并侦听远程目录事件（例如，创建的新文件），此时它启动文件传输。
以下示例演示如何配置inbound-channel-adapter:
<int-ftp:inbound-channel-adapter id="ftpInbound"
channel="ftpChannel"
session-factory="ftpSessionFactory"
auto-create-local-directory="true"
delete-remote-files="true"
filename-pattern="*.txt"
remote-directory="some/remote/path"
remote-file-separator="/"
preserve-timestamp="true"
local-filename-generator-expression="#this.toUpperCase() + '.a'"
scanner="myDirScanner"
local-filter="myFilter"
temporary-file-suffix=".writing"
max-fetch-size="-1"
local-directory=".">
<int:poller fixed-rate="1000"/>
</int-ftp:inbound-channel-adapter>如上述配置所示，您可以使用inbound-channel-adapter元素，同时还为各种属性提供值，例如local-directory,filename-pattern（基于简单的模式匹配，而不是正则表达式），以及对session-factory.
默认情况下，传输的文件与原始文件具有相同的名称。
如果要覆盖此行为，可以将local-filename-generator-expression属性，它允许您提供 SpEL 表达式来生成本地文件的名称。
与出站网关和适配器不同，其中 SpEL 评估上下文的根对象是Message，则此入站适配器在评估时尚未收到该消息，因为这是它最终生成的将传输的文件作为其有效负载的内容。
因此，SpEL 求值上下文的根对象是远程文件的原始名称 （String).
入站通道适配器首先检索File对象，然后根据轮询器配置发出每个文件。
从 5.0 版开始，现在可以限制在需要检索新文件时从 FTP 服务器获取的文件数量。
当目标文件非常大时，或者当您在具有持久性文件列表过滤器的群集系统中运行时，这可能会很有用，稍后将讨论。
用max-fetch-size为此目的。
负值（默认值）表示没有限制，并且会检索所有匹配的文件。
有关更多信息，请参阅入站通道适配器：控制远程文件获取。
从 5.0 版本开始，您还可以提供自定义DirectoryScanner实现到inbound-channel-adapter通过将scanner属性。
从 Spring Integration 3.0 开始，您可以指定preserve-timestamp属性（其默认值为false).
什么时候true，则本地文件的修改时间戳设置为从服务器检索的值。
否则，它设置为当前时间。
从 4.2 版开始，您可以指定remote-directory-expression而不是remote-directory，让您动态确定每次轮询的目录 — 例如remote-directory-expression="@myBean.determineRemoteDir()".
从 4.3 版开始，您可以省略remote-directory和remote-directory-expression属性。
它们默认为null.
在这种情况下，根据FTP协议，客户端工作目录被用作默认的远程目录。
有时，基于filename-pattern属性可能不够。
如果是这种情况，您可以使用filename-regex属性来指定正则表达式（例如filename-regex=".*\.test$").
此外，如果您需要完全控制，您可以使用filter属性，并提供对o.s.i.file.filters.FileListFilter，用于过滤文件列表的策略接口。
此过滤器确定要检索哪些远程文件。
您还可以将基于模式的过滤器与其他过滤器（例如AcceptOnceFileListFilter以避免同步以前获取的文件），使用CompositeFileListFilter.
这AcceptOnceFileListFilter将其状态存储在内存中。
如果您希望状态在系统重新启动后继续存在，请考虑使用FtpPersistentAcceptOnceFileListFilter相反。
此过滤器将接受的文件名存储在MetadataStore策略（请参阅元数据存储）。
此过滤器与文件名和远程修改时间相匹配。
从 4.0 版开始，此过滤器需要ConcurrentMetadataStore.
与共享数据存储（例如Redis使用RedisMetadataStore），它允许在多个应用程序或服务器实例之间共享过滤器键。
从 5.0 版开始，FtpPersistentAcceptOnceFileListFilter带内存SimpleMetadataStore默认情况下应用于FtpInboundFileSynchronizer.
此过滤器还与regex或pattern选项以及FtpInboundChannelAdapterSpec在 Java DSL 中。
任何其他用例都可以通过CompositeFileListFilter（或ChainFileListFilter).
前面的讨论是指在检索文件之前对其进行过滤。
检索文件后，将对文件系统上的文件应用额外的过滤器。
默认情况下，这是一个AcceptOnceFileListFilter如前所述，它将状态保留在内存中，并且不考虑文件的修改时间。
除非应用程序在处理后删除文件，否则适配器将在应用程序重新启动后默认重新处理磁盘上的文件。
此外，如果您配置filter使用FtpPersistentAcceptOnceFileListFilter并且远程文件时间戳更改（导致它被重新获取），默认的本地过滤器不允许处理这个新文件。
有关此筛选器及其使用方式的详细信息，请参阅远程持久文件列表筛选器。
您可以使用local-filter属性来配置本地文件系统过滤器的行为。
从 4.3.8 版本开始，FileSystemPersistentAcceptOnceFileListFilter默认配置。
此过滤器将接受的文件名和修改的时间戳存储在MetadataStore策略（请参阅元数据存储）并检测对本地文件修改时间的更改。
默认值MetadataStore是一个SimpleMetadataStore，将状态存储在内存中。
从版本 4.1.5 开始，这些过滤器有一个新属性 （flushOnUpdate），导致它们冲洗
元数据存储（如果存储实现Flushable).
此外，如果您使用分布式MetadataStore（例如 Redis），您可以拥有同一适配器或应用程序的多个实例，并确保每个文件仅处理一次。 |
实际的本地过滤器是CompositeFileListFilter包含提供的过滤器和模式过滤器，该过滤器可防止处理正在下载的文件（基于temporary-file-suffix).
下载带有此后缀的文件（默认值为.writing），并且传输完成后文件将重命名为其最终名称，使其对过滤器“可见”。
这remote-file-separator属性允许您配置文件分隔符，以便在默认“/”不适用于您的特定环境时使用。
有关这些属性的更多详细信息，请参阅架构。
您还应该了解 FTP 入站通道适配器是轮询使用者。
因此，您必须配置轮询器（通过使用全局默认值或本地子元素）。
传输文件后，将收到一条带有java.io.File当其有效负载被生成并发送到由channel属性。
从 6.2 版开始，您可以使用以下命令根据上次修改的策略过滤 FTP 文件FtpLastModifiedFileListFilter.
此过滤器可以配置age属性，以便过滤器仅传递早于此值的文件。
年龄默认为 60 秒，但您应该选择足够大的年龄以避免提前拾取文件（例如，由于网络故障）。
查看其 Javadoc 以获取更多信息。
有关文件过滤和不完整文件的更多信息
有时，刚刚出现在受监控（远程）目录中的文件不完整。
通常，此类文件是使用临时扩展名（例如somefile.txt.writing），然后在写入过程完成后重命名。
在大多数情况下，您只对完整的文件感兴趣，并且只想筛选完整的文件。
若要处理这些方案，可以使用filename-pattern,filename-regex和filter属性。
以下示例使用自定义筛选器实现：
<int-ftp:inbound-channel-adapter
channel="ftpChannel"
session-factory="ftpSessionFactory"
filter="customFilter"
local-directory="file:/my_transfers">
remote-directory="some/remote/path"
<int:poller fixed-rate="1000"/>
</int-ftp:inbound-channel-adapter>
<bean id="customFilter" class="org.example.CustomFilter"/>入站 FTP 适配器的轮询器配置说明
入站 FTP 适配器的作业包括两个任务：
-
与远程服务器通信，以便将文件从远程目录传输到本地目录。
-
对于每个传输的文件，生成一条消息，其中包含该文件作为有效负载，并将其发送到由“channel”属性标识的通道。 这就是为什么它们被称为“'通道适配器'”而不仅仅是“'适配器'”。 此类适配器的主要工作是生成要发送到消息通道的消息。 从本质上讲，第二个任务优先于此，如果您的本地目录已经有一个或多个文件，它首先从这些文件生成消息。 只有当所有本地文件都处理完毕后，它才会启动远程通信以检索更多文件。
此外，在轮询器上配置触发器时，应密切注意max-messages-per-poll属性。
其默认值为1对于所有人SourcePollingChannelAdapter实例（包括 FTP）。
这意味着，一旦处理了一个文件，它就会等待由触发器配置确定的下一个执行时间。
如果您碰巧有一个或多个文件位于local-directory，它将在启动与远程 FTP 服务器的通信之前处理这些文件。
此外，如果max-messages-per-poll设置为1（默认值），它一次只处理一个文件，间隔由触发器定义，本质上是“one-poll === one-file”。
对于典型的文件传输用例，您很可能希望采取相反的行为：为每次轮询处理所有文件，然后才等待下一次轮询。
如果是这种情况，请将max-messages-per-poll设置为 -1。
然后，在每次轮询时，适配器都会尝试生成尽可能多的消息。
换句话说，它处理本地目录中的所有内容，然后连接到远程目录以传输那里可用的所有内容以在本地处理。
只有这样，轮询作才被视为完成，轮询器等待下一个执行时间。
或者，您可以将“每次轮询的 max-messages”值设置为正值，该值指示每次轮询时要从文件创建的消息的上限。
例如，值10表示在每次轮询时，它尝试处理不超过十个文件。
从故障中恢复
了解适配器的体系结构非常重要。有一个用于获取文件的文件同步器和一个FileReadingMessageSource为每个同步文件发出一条消息。如前所述，涉及两个过滤器。 这filter属性（和模式）是指远程 （FTP） 文件列表，以避免获取已经被获取。 这local-filter由FileReadingMessageSource以确定哪些文件将作为消息发送。
同步器列出远程文件并查阅其过滤器。然后传输文件。如果在文件传输过程中发生 IO 错误，则删除已添加到过滤器中的任何文件，以便它们有资格在下一次轮询时重新获取。这仅适用于过滤器实现ReversibleFileListFilter（例如AcceptOnceFileListFilter).
如果在同步文件后，处理文件的下游流发生错误，则不会发生过滤器的自动回滚，因此默认情况下不会重新处理失败的文件。
如果希望在失败后重新处理此类文件，可以使用类似于以下的配置来方便 从过滤器中删除失败的文件：
<int-ftp:inbound-channel-adapter id="ftpAdapter"
session-factory="ftpSessionFactory"
channel="requestChannel"
remote-directory-expression="'/ftpSource'"
local-directory="file:myLocalDir"
auto-create-local-directory="true"
filename-pattern="*.txt">
<int:poller fixed-rate="1000">
<int:transactional synchronization-factory="syncFactory" />
</int:poller>
</int-ftp:inbound-channel-adapter>
<bean id="acceptOnceFilter"
class="org.springframework.integration.file.filters.AcceptOnceFileListFilter" />
<int:transaction-synchronization-factory id="syncFactory">
<int:after-rollback expression="payload.delete()" />
</int:transaction-synchronization-factory>
<bean id="transactionManager"
class="org.springframework.integration.transaction.PseudoTransactionManager" />上述配置适用于任何ResettableFileListFilter.
从 V5.0 开始，入站通道适配器可以在本地构建与生成的本地文件名相对应的子目录。
这也可以是一个远程子路径。
为了能够递归地读取本地目录以根据层次结构支持进行修改，您现在可以提供一个内部FileReadingMessageSource使用新的RecursiveDirectoryScanner基于Files.walk()算法。
看AbstractInboundFileSynchronizingMessageSource.setScanner()了解更多信息。
此外，您现在可以将AbstractInboundFileSynchronizingMessageSource到WatchService-基于DirectoryScanner通过使用setUseWatchService()选择。
它还配置为所有WatchEventType实例对本地目录中的任何修改做出反应。
前面显示的重新处理示例基于FileReadingMessageSource.WatchServiceDirectoryScanner执行ResettableFileListFilter.remove()删除文件时 （StandardWatchEventKinds.ENTRY_DELETE） 从本地目录中。
看WatchServiceDirectoryScanner了解更多信息。
使用 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
public FtpInboundFileSynchronizer ftpInboundFileSynchronizer() {
FtpInboundFileSynchronizer fileSynchronizer = new FtpInboundFileSynchronizer(ftpSessionFactory());
fileSynchronizer.setDeleteRemoteFiles(false);
fileSynchronizer.setRemoteDirectory("foo");
fileSynchronizer.setFilter(new FtpSimplePatternFileListFilter("*.xml"));
return fileSynchronizer;
}
@Bean
@InboundChannelAdapter(channel = "ftpChannel", poller = @Poller(fixedDelay = "5000"))
public MessageSource<File> ftpMessageSource() {
FtpInboundFileSynchronizingMessageSource source =
new FtpInboundFileSynchronizingMessageSource(ftpInboundFileSynchronizer());
source.setLocalDirectory(new File("ftp-inbound"));
source.setAutoCreateLocalDirectory(true);
source.setLocalFilter(new AcceptOnceFileListFilter<File>());
source.setMaxFetchSize(1);
return source;
}
@Bean
@ServiceActivator(inputChannel = "ftpChannel")
public MessageHandler handler() {
return new MessageHandler() {
@Override
public void handleMessage(Message<?> message) throws MessagingException {
System.out.println(message.getPayload());
}
};
}
}使用 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 IntegrationFlow ftpInboundFlow() {
return IntegrationFlow
.from(Ftp.inboundAdapter(this.ftpSessionFactory)
.preserveTimestamp(true)
.remoteDirectory("foo")
.regexFilter(".*\\.txt$")
.localFilename(f -> f.toUpperCase() + ".a")
.localDirectory(new File("d:\\ftp_files")),
e -> e.id("ftpInboundAdapter")
.autoStartup(true)
.poller(Pollers.fixedDelay(5000)))
.handle(m -> System.out.println(m.getPayload()))
.get();
}
}