SMB 支持

Spring Integration 提供对使用 SMB 进行文件传输操作的支持。

Server Message Block (SMB) 是一种简单的网络协议，允许您将文件传输到共享文件服务器。

您需要在项目中包含此依赖项：

  • Maven

  • Gradle

<dependency>
    <groupId>org.springframework.integration</groupId>
    <artifactId>spring-integration-smb</artifactId>
    <version>6.4.4</version>
</dependency>
compile "org.springframework.integration:spring-integration-smb:6.4.4"

概述

我们选择 Java CIFS 客户端库作为 CIFS/SMB 网络协议的 Java 实现。它的 SmbFile 抽象被简单地封装到 Spring Integration 的“远程文件”基础中，例如 SmbSession、SmbRemoteFileTemplate 等。

SMB 通道适配器和支持类实现与现有的 (S)FTP 或 AWS S3 协议组件完全相似。因此，如果您熟悉这些组件，使用起来非常简单。

Spring Integration 通过提供三种客户端端点来支持通过 SMB 发送和接收文件：入站通道适配器、出站通道适配器和出站网关。它还提供了方便的基于命名空间的配置选项来定义这些客户端组件。

要使用 SMB 命名空间，请将以下内容添加到 XML 文件头部：

xmlns:int-smb="http://www.springframework.org/schema/integration/smb"
xsi:schemaLocation="http://www.springframework.org/schema/integration/smb
    https://www.springframework.org/schema/integration/smb/spring-integration-smb.xsd"

SMB 会话工厂

在配置 SMB 适配器之前，必须配置一个 SMB 会话工厂。您可以使用常规的 Bean 定义来配置 SMB 会话工厂，如下例所示：

SmbSessionFactory 暴露了设置 SMB 协议最小/最大版本的选项。例如，支持最低 SMB 版本 2.1 和最高 SMB 版本 3.1.1。

@Bean
public SmbSessionFactory smbSessionFactory() {
    SmbSessionFactory smbSession = new SmbSessionFactory();
    smbSession.setHost("myHost");
    smbSession.setPort(445);
    smbSession.setDomain("myDomain");
    smbSession.setUsername("myUser");
    smbSession.setPassword("myPassword");
    smbSession.setShareAndDir("myShareAndDir");
    smbSession.setSmbMinVersion(DialectVersion.SMB210);
    smbSession.setSmbMaxVersion(DialectVersion.SMB311);
    return smbSession;
}

SmbSessionFactory 可以使用自定义的 jcifs.CIFSContext 进行初始化。

SMB 协议最小/最大版本的设置必须在您实现 jcifs.CIFSContext 中完成。 
@Bean
public SmbSessionFactory smbSessionFactory() {
    SmbSessionFactory smbSession = new SmbSessionFactory(new MyCIFSContext());
    smbSession.setHost("myHost");
    smbSession.setPort(445);
    smbSession.setDomain("myDomain");
    smbSession.setUsername("myUser");
    smbSession.setPassword("myPassword");
    smbSession.setShareAndDir("myShareAndDir");
    return smbSession;
}

SMB 入站通道适配器

为了在本地下载 SMB 文件，提供了 SmbInboundFileSynchronizingMessageSource。它是 AbstractInboundFileSynchronizingMessageSource 的简单扩展，需要注入 SmbInboundFileSynchronizer。对于过滤远程文件，您仍然可以使用任何现有的 FileListFilter 实现，但也提供了特定的 SmbRegexPatternFileListFilter 和 SmbSimplePatternFileListFilter。

@Bean
public SmbInboundFileSynchronizer smbInboundFileSynchronizer() {
    SmbInboundFileSynchronizer fileSynchronizer =
        new SmbInboundFileSynchronizer(smbSessionFactory());
    fileSynchronizer.setFilter(compositeFileListFilter());
    fileSynchronizer.setRemoteDirectory("mySharedDirectoryPath");
    fileSynchronizer.setDeleteRemoteFiles(true);
    return fileSynchronizer;
}

@Bean
public CompositeFileListFilter<SmbFile> compositeFileListFilter() {
    CompositeFileListFilter<SmbFile> filters = new CompositeFileListFilter<>();
    filters.addFilter(new SmbRegexPatternFileListFilter("^(?i).+((\\.txt))$"));
    return filters;
}

@Bean
public MessageChannel smbFileInputChannel() {
    return new DirectChannel();
}

@Bean
@InboundChannelAdapter(value = "smbFileInputChannel",
                       poller = @Poller(fixedDelay = "2000"))
public MessageSource<File> smbMessageSource() {
    SmbInboundFileSynchronizingMessageSource messageSource =
        new SmbInboundFileSynchronizingMessageSource(smbInboundFileSynchronizer());
    messageSource.setLocalDirectory(new File("myLocalDirectoryPath"));
    messageSource.setAutoCreateLocalDirectory(true);
    return messageSource;
}

对于 XML 配置，提供了 <int-smb:inbound-channel-adapter> 组件。

从版本 6.2 开始，您可以使用 SmbLastModifiedFileListFilter 基于文件最后修改时间策略过滤 SMB 文件。此过滤器可以配置一个 age 属性，以便只有比该值旧的文件才能通过过滤器。默认 age 为 60 秒，但您应该选择一个足够大的 age 值，以避免过早选取文件（例如，由于网络故障）。有关更多信息，请查阅其 Javadoc。

使用 Java DSL 配置

以下 Spring Boot 应用程序示例展示了如何使用 Java DSL 配置入站适配器：

@SpringBootApplication
public class SmbJavaApplication {

    public static void main(String[] args) {
        new SpringApplicationBuilder(SmbJavaApplication.class)
            .web(false)
            .run(args);
    }

    @Bean
    public SmbSessionFactory smbSessionFactory() {
        SmbSessionFactory smbSession = new SmbSessionFactory();
        smbSession.setHost("myHost");
        smbSession.setPort(445);
        smbSession.setDomain("myDomain");
        smbSession.setUsername("myUser");
        smbSession.setPassword("myPassword");
        smbSession.setShareAndDir("myShareAndDir");
        smbSession.setSmbMinVersion(DialectVersion.SMB210);
        smbSession.setSmbMaxVersion(DialectVersion.SMB311);
        return smbSession;
    }

    @Bean
    public IntegrationFlow smbInboundFlow() {
        return IntegrationFlow
            .from(Smb.inboundAdapter(smbSessionFactory())
                    .preserveTimestamp(true)
                    .remoteDirectory("smbSource")
                    .regexFilter(".*\\.txt$")
                    .localFilename(f -> f.toUpperCase() + ".a")
                    .localDirectory(new File("d:\\smb_files")),
                        e -> e.id("smbInboundAdapter")
                    .autoStartup(true)
                    .poller(Pollers.fixedDelay(5000)))
            .handle(m -> System.out.println(m.getPayload()))
            .get();
    }
}

SMB 流式入站通道适配器

此适配器生成载荷类型为 InputStream 的消息，允许无需写入本地文件系统即可获取文件。由于会话保持打开状态，消费应用程序负责在文件被消费后关闭会话。会话在 closeableResource 头 (IntegrationMessageHeaderAccessor.CLOSEABLE_RESOURCE) 中提供。标准框架组件，例如 FileSplitter 和 StreamTransformer，会自动关闭会话。有关这些组件的更多信息，请参阅 文件拆分器 和 流转换器。以下示例展示了如何配置 inbound-streaming-channel-adapter：

<int-smb:inbound-streaming-channel-adapter id="smbInbound"
            channel="smbChannel"
            session-factory="sessionFactory"
            filename-pattern="*.txt"
            filename-regex=".*\.txt"
            filter="filter"
            filter-expression="@myFilterBean.check(#root)"
            remote-file-separator="/"
            comparator="comparator"
            max-fetch-size="1"
            remote-directory-expression="'foo/bar'">
        <int:poller fixed-rate="1000" />
</int-smb:inbound-streaming-channel-adapter>

只能使用 filename-pattern、filename-regex、filter 或 filter-expression 中的一个。

SmbStreamingMessageSource 适配器使用基于内存 SimpleMetadataStore 的 SmbPersistentAcceptOnceFileListFilter 来防止远程文件重复。默认情况下，此过滤器也应用于文件名模式（或正则表达式）。如果您需要允许重复，可以使用 AcceptAllFileListFilter。任何其他用例都可以通过 CompositeFileListFilter（或 ChainFileListFilter）处理。Java 配置（文档稍后）展示了一种在处理后删除远程文件以避免重复的技术。

有关 SmbPersistentAcceptOnceFileListFilter 及其使用方法的更多信息，请参阅 远程持久化文件列表过滤器。

当需要获取文件时，使用 max-fetch-size 属性限制每次轮询获取的文件数量。在集群环境中运行时，将其设置为 1 并使用持久化过滤器。有关更多信息，请参阅 入站通道适配器：控制远程文件获取。

适配器将远程目录和文件名分别放入 FileHeaders.REMOTE_DIRECTORY 和 FileHeaders.REMOTE_FILE 头中。FileHeaders.REMOTE_FILE_INFO 头提供额外的远程文件信息（默认为 JSON 表示）。如果您将 SmbStreamingMessageSource 的 fileInfoJson 属性设置为 false，则头包含一个 SmbFileInfo 对象。

使用 Java 配置

以下 Spring Boot 应用程序示例展示了如何使用 Java 配置入站适配器：

@SpringBootApplication
public class SmbJavaApplication {

    public static void main(String[] args) {
        new SpringApplicationBuilder(SmbJavaApplication.class)
            .web(false)
            .run(args);
    }

    @Bean
    @InboundChannelAdapter(channel = "stream")
    public MessageSource<InputStream> smbMessageSource() {
        SmbStreamingMessageSource messageSource = new SmbStreamingMessageSource(template());
        messageSource.setRemoteDirectory("smbSource/");
        messageSource.setFilter(new AcceptAllFileListFilter<>());
        messageSource.setMaxFetchSize(1);
        return messageSource;
    }

    @Bean
    @Transformer(inputChannel = "stream", outputChannel = "data")
    public org.springframework.integration.transformer.Transformer transformer() {
        return new StreamTransformer("UTF-8");
    }

    @Bean
    public SmbRemoteFileTemplate template() {
        return new SmbRemoteFileTemplate(smbSessionFactory());
    }

    @ServiceActivator(inputChannel = "data", adviceChain = "after")
    @Bean
    public MessageHandler handle() {
        return System.out::println;
    }

    @Bean
    public ExpressionEvaluatingRequestHandlerAdvice after() {
        ExpressionEvaluatingRequestHandlerAdvice advice = new ExpressionEvaluatingRequestHandlerAdvice();
        advice.setOnSuccessExpression(
                "@template.remove(headers['file_remoteDirectory'] + headers['file_remoteFile'])");
        advice.setPropagateEvaluationFailures(true);
        return advice;
    }

}

请注意，在此示例中，转换器下游的消息处理器包含一个 advice，该 advice 在处理后删除远程文件。

入站通道适配器：控制远程文件获取

配置入站通道适配器时，有两个属性需要考虑。与其他轮询器一样，max-messages-per-poll 可用于限制每次轮询发出的消息数量（如果准备就绪的消息数量超过配置值）。max-fetch-size 可以限制一次从远程服务器检索的文件数量。

以下场景假定起始状态是本地目录为空：

  • max-messages-per-poll=2 和 max-fetch-size=1：适配器获取一个文件，发出，然后获取下一个文件，发出，然后休眠直到下一次轮询。

  • max-messages-per-poll=2 和 max-fetch-size=2：适配器获取这两个文件，然后发出每个文件。

  • max-messages-per-poll=2 和 max-fetch-size=4：适配器最多获取四个文件（如果可用），并发出前两个（如果至少有两个）。接下来的两个文件将在下一次轮询时发出。

  • max-messages-per-poll=2 且 max-fetch-size 未指定：适配器获取所有远程文件，并发出前两个（如果至少有两个）。后续文件在随后的轮询中发出（每次两个）。当所有文件都消费完毕后，会再次尝试远程获取，以获取任何新文件。

当部署应用程序的多个实例时，我们建议使用较小的 max-fetch-size，以避免一个实例“抢占”所有文件而使其他实例饥饿。

max-fetch-size 的另一种用途是，如果您想停止获取远程文件但继续处理已获取的文件。通过在 MessageSource 上设置 maxFetchSize 属性（通过编程、JMX 或 控制总线）可以有效阻止适配器获取更多文件，但允许轮询器继续为之前已获取的文件发出消息。如果属性更改时轮询器处于活动状态，则更改将在下一次轮询时生效。

可以为同步器提供一个 Comparator<SmbFile>。当使用 maxFetchSize 限制获取的文件数量时，这非常有用。

SMB 出站通道适配器

为了将文件写入 SMB 共享，对于 XML <int-smb:outbound-channel-adapter> 组件，我们使用 SmbMessageHandler。在 Java 配置的情况下，需要为 SmbMessageHandler 提供 SmbSessionFactory（或 SmbRemoteFileTemplate）。

@Bean
@ServiceActivator(inputChannel = "storeToSmbShare")
public MessageHandler smbMessageHandler(SmbSessionFactory smbSessionFactory) {
    SmbMessageHandler handler = new SmbMessageHandler(smbSessionFactory);
    handler.setRemoteDirectoryExpression(
        new LiteralExpression("remote-target-dir"));
    handler.setFileNameGenerator(m ->
        m.getHeaders().get(FileHeaders.FILENAME, String.class) + ".test");
    handler.setAutoCreateDirectory(true);
    return handler;
}

使用 Java DSL 配置

以下 Spring Boot 应用程序示例展示了如何使用 Java DSL 配置出站适配器：

@SpringBootApplication
@IntegrationComponentScan
public class SmbJavaApplication {

    public static void main(String[] args) {
        ConfigurableApplicationContext context =
            new SpringApplicationBuilder(SmbJavaApplication.class)
                .web(false)
                .run(args);
        MyGateway gateway = context.getBean(MyGateway.class);
        gateway.sendToSmb(new File("/foo/bar.txt"));
    }

    @Bean
    public SmbSessionFactory smbSessionFactory() {
        SmbSessionFactory smbSession = new SmbSessionFactory();
        smbSession.setHost("myHost");
        smbSession.setPort(445);
        smbSession.setDomain("myDomain");
        smbSession.setUsername("myUser");
        smbSession.setPassword("myPassword");
        smbSession.setShareAndDir("myShareAndDir");
        smbSession.setSmbMinVersion(DialectVersion.SMB210);
        smbSession.setSmbMaxVersion(DialectVersion.SMB311);
        return smbSession;
    }

    @Bean
    public IntegrationFlow smbOutboundFlow() {
        return IntegrationFlow.from("toSmbChannel")
                .handle(Smb.outboundAdapter(smbSessionFactory(), FileExistsMode.REPLACE)
                        .useTemporaryFileName(false)
                        .fileNameExpression("headers['" + FileHeaders.FILENAME + "']")
                        .remoteDirectory("smbTarget")
                ).get();
    }

    @MessagingGateway
    public interface MyGateway {

         @Gateway(requestChannel = "toSmbChannel")
         void sendToSmb(File file);
    }

}

SMB 出站网关

SMB 出站网关提供一组有限的命令与远程 SMB 服务器交互。支持的命令有：

  • ls (列出文件)

  • nlst (列出文件名)

  • get (检索文件)

  • mget (检索文件集)

  • rm (删除文件集)

  • mv (移动/重命名文件)

  • put (发送文件)

  • mput (发送多个文件)

使用 ls 命令

ls 列出远程文件并支持以下选项：

  • -1: 检索文件名列表。默认是检索 FileInfo 对象列表。

  • -a: 包含所有文件（包括以 '.' 开头的文件）。

  • -f: 不对列表进行排序。

  • -dirs: 包含目录（默认排除）。

  • -links: 包含符号链接（默认排除）。

  • -R: 递归列出远程目录。

此外，还以与 inbound-channel-adapter 相同的方式提供了文件名过滤功能。

ls 操作产生的消息载荷是一个文件名列表或 FileInfo 对象列表（取决于是否使用 -1 开关）。这些对象提供修改时间、权限等信息。

ls 命令作用的远程目录在 file_remoteDirectory 头中提供。

使用递归选项 (-R) 时，fileName 包含任何子目录元素，表示相对于远程目录的文件相对路径。如果使用 -dirs 选项，每个递归目录也会作为列表中的一个元素返回。在这种情况下，建议不要使用 -1 选项，因为您将无法区分文件和目录，而使用 FileInfo 对象可以做到这一点。

使用 nlst 命令

nlst 列出远程文件名，仅支持一个选项：

  • -f: 不对列表进行排序。

nlst 操作产生的消息载荷是一个文件名列表。

file_remoteDirectory 头包含 nlst 命令作用的远程目录。

使用 get 命令

get 检索远程文件，支持以下选项：

  • -P: 保留远程文件的时间戳。

  • -stream: 将远程文件检索为流。

  • -D: 成功传输后删除远程文件。如果传输被忽略（因为 FileExistsMode 是 IGNORE 且本地文件已存在），则不删除远程文件。

file_remoteDirectory 头包含远程目录，file_remoteFile 头包含文件名。

get 操作产生的消息载荷是一个 File 对象，表示检索到的文件。如果使用 -stream 选项，载荷是一个 InputStream 而不是 File。对于文本文件，一个常见的用例是将此操作与 文件拆分器 或 流转换器 结合使用。以流方式消费远程文件时，您负责在消费流后关闭 Session。为方便起见，Session 在 closeableResource 头中提供，IntegrationMessageHeaderAccessor 提供便捷方法：

Closeable closeable = new IntegrationMessageHeaderAccessor(message).getCloseableResource();
if (closeable != null) {
    closeable.close();
}

框架组件，例如 文件拆分器 和 流转换器，在数据传输后会自动关闭会话。

以下示例展示了如何以流方式消费文件：

<int-smb:outbound-gateway session-factory="smbSessionFactory"
                            request-channel="inboundGetStream"
                            command="get"
                            command-options="-stream"
                            expression="payload"
                            remote-directory="smbTarget"
                            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> 对象（即 File 对象列表，每个对象代表一个检索到的文件）。

如果 FileExistsMode 是 IGNORE，则输出消息的载荷不再包含因文件已存在而被忽略的文件。之前，数组包含所有文件，包括已存在的文件。

您用于确定远程路径的表达式应生成以 结尾的结果，例如 myfiles/ 获取 myfiles 下的整个树。

您可以将递归 MGET 与 FileExistsMode.REPLACE_IF_MODIFIED 模式结合使用，以定期在本地同步整个远程目录树。此模式将本地文件的最后修改时间戳设置为远程文件的时间戳，无论是否使用 -P（保留时间戳）选项。

使用递归 (-R) 的注意事项：

模式将被忽略，并假定为 *。默认情况下，检索整个远程树。但是，您可以通过提供 FileListFilter 来过滤树中的文件。您也可以通过这种方式过滤树中的目录。可以通过引用或通过 filename-pattern 或 filename-regex 属性提供 FileListFilter。例如，filename-regex="(subDir|.*1.txt)" 将检索远程目录和子目录 subDir 中所有以 1.txt 结尾的文件。但是，我们将在本注释之后描述一种替代方法。

如果您过滤了子目录，则不会对该子目录执行额外的遍历。

不允许使用 -dirs 选项（递归 mget 使用递归 ls 获取目录树，并且目录本身不能包含在列表中）。

通常，您会在 local-directory-expression 中使用 #remoteDirectory 变量，以便在本地保留远程目录结构。

持久化文件列表过滤器现在有一个布尔属性 forRecursion。将此属性设置为 true，也会设置 alwaysAcceptDirectories，这意味着出站网关上的递归操作（ls 和 mget）现在每次都会始终遍历完整的目录树。这是为了解决目录树深处变更未被检测到的问题。此外，forRecursion=true 会将文件的完整路径用作元数据存储键；这解决了如果同一名称的文件在不同目录中多次出现时过滤器无法正常工作的问题。重要：这意味着在持久化元数据存储中，顶级目录下的文件将无法找到现有键。因此，此属性默认为 false；这可能会在未来的版本中更改。

您可以配置 SmbSimplePatternFileListFilter 和 SmbRegexPatternFileListFilter 通过将 alwaysAcceptDirectorties 设置为 true 来始终允许目录通过。这样做允许对简单模式进行递归，如下例所示：

<bean id="starDotTxtFilter"
            class="org.springframework.integration.smb.filters.SmbSimplePatternFileListFilter">
    <constructor-arg value="*.txt" />
    <property name="alwaysAcceptDirectories" value="true" />
</bean>

<bean id="dotStarDotTxtFilter"
            class="org.springframework.integration.smb.filters.SmbRegexPatternFileListFilter">
    <constructor-arg value="^.*\.txt$" />
    <property name="alwaysAcceptDirectories" value="true" />
</bean>

您可以通过网关上的 filter 属性提供这些过滤器之一。

另请参阅 出站网关部分成功 (mget 和 mput)。

使用 put 命令

put 将文件发送到远程服务器。消息的载荷可以是 java.io.File、byte[] 或 String。使用 remote-filename-generator（或表达式）命名远程文件。其他可用属性包括 remote-directory、temporary-remote-directory 及其对应的 *-expression：use-temporary-file-name 和 auto-create-directory。有关更多信息，请参阅模式文档。

put 操作产生的消息载荷是一个 String，其中包含文件传输后在服务器上的完整路径。

使用 mput 命令

mput 将多个文件发送到服务器，支持以下选项：

  • -R: 递归 - 发送目录和子目录中所有（可能已过滤的）文件。

消息载荷必须是一个 java.io.File（或 String），代表一个本地目录。也支持 File 或 String 的集合。

支持与 put 命令 相同的属性。此外，您可以使用 mput-pattern、mput-regex、mput-filter 或 mput-filter-expression 中的一个来过滤本地目录中的文件。只要子目录本身通过过滤器，该过滤器就支持递归。未通过过滤器的子目录将不会被递归。

mput 操作产生的消息载荷是一个 List<String> 对象（即传输后生成的远程文件路径列表）。

另请参阅 出站网关部分成功 (mget 和 mput)。

使用 rm 命令

rm 命令没有选项。

如果删除操作成功，则生成的消息载荷为 Boolean.TRUE。否则，消息载荷为 Boolean.FALSE。file_remoteDirectory 头包含远程目录，file_remoteFile 头包含文件名。

使用 mv 命令

mv 命令没有选项。

expression 属性定义“源”路径，rename-expression 属性定义“目标”路径。默认情况下，rename-expression 为 headers['file_renameTo']。此表达式不得求值为 null 或空 String。如果需要，会创建所需的远程目录。结果消息的载荷是 Boolean.TRUE。file_remoteDirectory 头包含原始远程目录，file_remoteFile 头包含文件名。file_renameTo 头包含新路径。

remoteDirectoryExpression 可用于 mv 命令，以方便使用。如果“源”文件不是完整的 文件路径，则 remoteDirectoryExpression 的结果将用作远程目录。这同样适用于“目标”文件，例如，如果任务只是重命名某个目录中的远程文件。

附加命令信息

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-smb:outbound-gateway id="gateway1"
        session-factory="smbSessionFactory"
        request-channel="inbound1"
        command="ls"
        command-options="-1"
        expression="payload"
        reply-channel="toSplitter"/>

发送到 toSplitter 通道的消息的载荷是一个 String 对象列表，每个对象都包含一个文件的名称。如果您省略 command-options="-1"，则载荷将是 FileInfo 对象列表。您可以将选项作为空格分隔列表提供（例如，command-options="-1 -dirs -links"）。

GET、MGET、PUT 和 MPUT 命令支持一个 FileExistsMode 属性（使用命名空间支持时是 mode）。这会影响当本地文件存在（GET 和 MGET）或远程文件存在（PUT 和 MPUT）时的行为。支持的模式有 REPLACE、APPEND、FAIL 和 IGNORE。为了向后兼容，PUT 和 MPUT 操作的默认模式是 REPLACE。对于 GET 和 MGET 操作，默认模式是 FAIL。

使用 Java 配置进行配置

以下 Spring Boot 应用展示了如何使用 Java 配置来配置出站网关的示例

@SpringBootApplication
public class SmbJavaApplication {

    public static void main(String[] args) {
        new SpringApplicationBuilder(SmbJavaApplication.class)
            .web(false)
            .run(args);
    }

    @Bean
    public SmbSessionFactory smbSessionFactory() {
        SmbSessionFactory smbSession = new SmbSessionFactory();
        smbSession.setHost("myHost");
        smbSession.setPort(445);
        smbSession.setDomain("myDomain");
        smbSession.setUsername("myUser");
        smbSession.setPassword("myPassword");
        smbSession.setShareAndDir("myShareAndDir");
        smbSession.setSmbMinVersion(DialectVersion.SMB210);
        smbSession.setSmbMaxVersion(DialectVersion.SMB311);
        return smbSession;
    }

    @Bean
    @ServiceActivator(inputChannel = "smbChannel")
    public MessageHandler handler() {
        SmbOutboundGateway smbOutboundGateway =
            new SmbOutboundGateway(smbSessionFactory(), "'my_remote_dir/'");
        smbOutboundGateway.setOutputChannelName("replyChannel");
        return smbOutboundGateway;
    }

}

使用 Java DSL 进行配置

以下 Spring Boot 应用展示了如何使用 Java DSL 来配置出站网关的示例

@SpringBootApplication
public class SmbJavaApplication {

    public static void main(String[] args) {
        new SpringApplicationBuilder(SmbJavaApplication.class)
            .web(false)
            .run(args);
    }

    @Bean
    public SmbSessionFactory smbSessionFactory() {
        SmbSessionFactory smbSession = new SmbSessionFactory();
        smbSession.setHost("myHost");
        smbSession.setPort(445);
        smbSession.setDomain("myDomain");
        smbSession.setUsername("myUser");
        smbSession.setPassword("myPassword");
        smbSession.setShareAndDir("myShareAndDir");
        smbSession.setSmbMinVersion(DialectVersion.SMB210);
        smbSession.setSmbMaxVersion(DialectVersion.SMB311);
        return smbSession;
    }

    @Bean
    public SmbOutboundGatewaySpec smbOutboundGateway() {
        return Smb.outboundGateway(smbSessionFactory(),
            AbstractRemoteFileOutboundGateway.Command.MGET, "payload")
            .options(AbstractRemoteFileOutboundGateway.Option.RECURSIVE)
            .regexFileNameFilter("(subSmbSource|.*.txt)")
            .localDirectoryExpression("'localDirectory/' + #remoteDirectory")
            .localFilenameExpression("#remoteFileName.replaceFirst('smbSource', 'localTarget')");
    }

    @Bean
    public IntegrationFlow smbFlow(AbstractRemoteFileOutboundGateway<SmbFile> smbOutboundGateway) {
        return f -> f
            .handle(smbOutboundGateway)
            .channel(c -> c.queue("remoteFileOutputChannel"));
    }

}

出站网关部分成功（mget 和 mput）

当对多个文件执行操作（使用 mget 和 mput）时，在传输一个或多个文件后可能会发生异常。在这种情况下，会抛出 PartialSuccessException。除了通常的 MessagingException 属性（failedMessage 和 cause）之外，此异常还有两个额外的属性

  • partialResults：成功的传输结果。

  • derivedInput：根据请求消息生成的文件列表（例如 mput 要传输的本地文件）。

这些属性使您能够确定哪些文件成功传输，哪些文件未能成功传输。

在递归的 mput 情况下，PartialSuccessException 可能包含嵌套的 PartialSuccessException 实例。

考虑以下目录结构

root/
|- file1.txt
|- subdir/
   | - file2.txt
   | - file3.txt
|- zoo.txt

如果异常发生在 file3.txt 上，则网关抛出的 PartialSuccessException 的 derivedInput 为 file1.txt、subdir 和 zoo.txt，partialResults 为 file1.txt。它的 cause 是另一个 PartialSuccessException，其 derivedInput 为 file2.txt 和 file3.txt，partialResults 为 file2.txt。

远程文件信息

SmbStreamingMessageSource（SMB 流式入站通道适配器）、SmbInboundFileSynchronizingMessageSource（SMB 入站通道适配器）以及 SmbOutboundGateway（SMB 出站网关）的“读取”命令在生成的消息中提供关于远程文件的附加消息头

  • FileHeaders.REMOTE_HOST_PORT - 文件传输操作期间远程会话连接到的主机:端口 对；

  • FileHeaders.REMOTE_DIRECTORY - 执行操作的远程目录；

  • FileHeaders.REMOTE_FILE - 远程文件名；仅适用于单个文件操作。

由于 SmbInboundFileSynchronizingMessageSource 不直接针对远程文件生成消息，而是使用本地副本，AbstractInboundFileSynchronizer 在同步操作期间以 URI 风格（protocol://host:port/remoteDirectory#remoteFileName）将远程文件的信息存储在 MetadataStore（可外部配置）中。当轮询本地文件时，SmbInboundFileSynchronizingMessageSource 会检索此元数据。当删除本地文件时，建议移除其元数据条目。为此，AbstractInboundFileSynchronizer 提供了一个 removeRemoteFileMetadata() 回调。此外，还有一个用于元数据键的 setMetadataStorePrefix()。当在这些组件之间共享同一个 MetadataStore 实例时，建议使此前缀与基于 MetadataStore 的 FileListFilter 实现中使用的前缀不同，以避免条目覆盖，因为过滤器和 AbstractInboundFileSynchronizer 都使用相同的本地文件名作为元数据条目键。