SMB 支持

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

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

您需要将此依赖项包含到您的项目中

Maven
Gradle

<dependency>
    <groupId>org.springframework.integration</groupId>
    <artifactId>spring-integration-smb</artifactId>
    <version>6.3.0</version>
</dependency>

compile "org.springframework.integration:spring-integration-smb:6.3.0"

概述

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

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

Spring 集成通过提供三个客户端端点来支持通过 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 初始化。

必须在您的 jcifs.CIFSContext 实现中设置 SMB 协议的最小/最大版本。

@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 属性进行配置，以便仅传递比此值旧的文件。年龄默认为 60 秒，但您应该选择一个足够大的年龄，以避免过早地获取文件（例如，由于网络故障。查看其 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，它在处理后删除远程文件。

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

在配置入站通道适配器时，您应该考虑两个属性。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 配置的情况下，应使用 SmbSessionFactory（或 SmbRemoteFileTemplate）提供 SmbMessageHandler。

@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 对象的 List，每个对象代表一个检索到的文件）。

如果 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> 对象（即，传输产生的远程文件路径的 List）。

另请参阅出站网关部分成功 (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 在同步操作期间将有关远程文件的信息存储在 MetadataStore（可以在外部配置）中，以 URI 样式（protocol://host:port/remoteDirectory#remoteFileName）。此元数据在轮询本地文件时由 SmbInboundFileSynchronizingMessageSource 检索。当本地文件被删除时，建议删除其元数据条目。AbstractInboundFileSynchronizer 为此目的提供了一个 removeRemoteFileMetadata() 回调。此外，还有一个 setMetadataStorePrefix() 用于元数据键。建议此前缀与 MetadataStore 中基于 FileListFilter 实现使用的前缀不同，当同一个 MetadataStore 实例在这些组件之间共享时，以避免条目覆盖，因为过滤器和 AbstractInboundFileSynchronizer 都使用相同的本地文件名作为元数据条目键。

SMB 支持

概述

SMB 会话工厂

SMB 入站通道适配器

使用 Java DSL 配置

SMB 流式入站通道适配器

使用 Java 配置进行配置

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

SMB 出站通道适配器

使用 Java DSL 配置

SMB 出站网关

使用 ls 命令

使用 nlst 命令

使用 get 命令

使用 mget 命令

使用 put 命令

使用 mput 命令

使用 rm 命令

使用 mv 命令

其他命令信息

使用 Java 配置进行配置

使用 Java DSL 进行配置

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

远程文件信息

使用 `ls` 命令

使用 `nlst` 命令

使用 `get` 命令

使用 `mget` 命令

使用 `put` 命令

使用 `mput` 命令

使用 `rm` 命令

使用 `mv` 命令

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