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

服务器消息块 （SMB） 是一个简单的网络协议，可用于将文件传输到共享文件服务器。

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

  • Maven

  • Gradle

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

概述

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

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 会话工厂，如以下示例所示：

公开用于设置具有最小/最大版本的 SMB 协议的选项。 例如，支持 SMB 2.1 的最低版本和 SMB 3.1.1 的最高版本：SmbSessionFactory

@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;
}

可以使用自定义 .SmbSessionFactoryjcifs.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 协议最小/最大版本。jcifs.CIFSContext

SMB 入站通道适配器

要在本地下载 SMB 文件，请提供。 它是需要注射的简单扩展。 对于筛选远程文件，您仍然可以使用任何现有实现，但特定且已提供。SmbInboundFileSynchronizingMessageSourceAbstractInboundFileSynchronizingMessageSourceSmbInboundFileSynchronizerFileListFilterSmbRegexPatternFileListFilterSmbSimplePatternFileListFilter

@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 开始，可以使用 根据上次修改的策略筛选 SMB 文件。 可以使用属性配置此筛选器，以便筛选器仅传递早于此值的文件。 期限默认为 60 秒，但您应该选择一个足够大的期限，以避免过早拿起文件（例如，由于网络故障）。 查看其 Javadoc 以获取更多信息。SmbLastModifiedFileListFilterage

使用 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 流式处理入站通道适配器

此适配器生成具有有效负载类型的消息，允许在不写入本地文件系统的情况下获取文件。 由于会话保持打开状态，因此使用应用程序负责在文件被使用时关闭会话。 会话在标头 （） 中提供。 标准框架组件（如 和 ）会自动关闭会话。 有关这些组件的更多信息，请参阅文件拆分器和流转换器。 以下示例演示如何配置：InputStreamcloseableResourceIntegrationMessageHeaderAccessor.CLOSEABLE_RESOURCEFileSplitterStreamTransformerinbound-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-patternfilename-regexfilterfilter-expression

适配器可防止远程文件的重复，基于内存中 . 默认情况下，此筛选器也与文件名模式（或正则表达式）一起应用。 如果需要允许重复项，可以使用 . 任何其他用例都可以由 （或 ） 处理。 Java 配置（在本文档后面）展示了一种在处理后删除远程文件以避免重复的技术。SmbStreamingMessageSourceSmbPersistentAcceptOnceFileListFilterSimpleMetadataStoreAcceptAllFileListFilterCompositeFileListFilterChainFileListFilter

有关 及其使用方式的详细信息，请参阅远程持久性文件列表筛选器。SmbPersistentAcceptOnceFileListFilter

当需要提取时，使用该属性限制每次轮询中提取的文件数。 将其设置为在群集环境中运行时使用持久性筛选器。 有关详细信息，请参阅入站通道适配器：控制远程文件提取。max-fetch-size1

适配器将远程目录和文件名分别放在 和 标头中。 标头提供其他远程文件信息（默认以 JSON 表示）。 如果将属性设置为 to ，则标头包含一个对象。FileHeaders.REMOTE_DIRECTORYFileHeaders.REMOTE_FILEFileHeaders.REMOTE_FILE_INFOfileInfoJsonSmbStreamingMessageSourcefalseSmbFileInfo

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

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

同步器可以配备 . 这在限制使用 .Comparator<SmbFile>maxFetchSize

当您部署应用程序的多个实例时，我们建议使用小型实例，以避免一个实例“抓取”所有文件并导致其他实例挨饿。max-fetch-size

SMB 出站通道适配器

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

@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

操作生成的消息有效负载是文件名列表或对象列表（取决于是否使用交换机）。 这些对象提供修改时间、权限等信息。lsFileInfo-1

标头中提供了命令所操作的远程目录。lsfile_remoteDirectory

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

使用命令nlst

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

  • -f：不对列表进行排序

操作生成的消息有效负载是文件名列表。nlst

标头包含命令对其执行操作的远程目录。file_remoteDirectorynlst

使用命令get

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

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

  • -stream：以流的形式检索远程文件。

  • -D：传输成功后删除远程文件。 如果忽略传输，则不会删除远程文件，因为 is 和本地文件已存在。FileExistsModeIGNORE

标头保存远程目录，标头保存文件名。file_remoteDirectoryfile_remoteFile

操作生成的消息有效负载是表示检索到的文件的对象。 如果使用该选项，则有效负载是 而不是 . 对于文本文件，常见的用例是将此操作与文件拆分器或流转换器结合使用。 当将远程文件作为流使用时，您负责在流使用后关闭。 为方便起见，在标题中提供了 ，并提供方便的方法：getFile-streamInputStreamFileSessionSessioncloseableResourceIntegrationMessageHeaderAccessor

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" />
如果在自定义组件中使用输入流，则必须关闭 . 您可以在自定义代码中执行此操作，也可以将消息的副本路由到 并使用 SpEL，如以下示例所示：Sessionservice-activator 
<int:service-activator input-channel="closeSession"
    expression="headers['closeableResource'].close()" />

使用命令mget

mget根据模式检索多个远程文件，并支持以下选项：

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

  • -R：以递归方式检索整个目录树。

  • -x：如果没有与模式匹配的文件，则引发异常（否则将返回空列表）。

  • -D：成功传输后删除每个远程文件。 如果忽略传输，则不会删除远程文件，因为 is 和本地文件已存在。FileExistsModeIGNORE

操作生成的消息有效负载是一个对象（即对象的 a，每个对象代表一个检索到的文件）。mgetList<File>ListFile

如果 是 ，则输出消息的有效负载不再包含由于文件已存在而未提取的文件。 以前，该数组包含所有文件，包括已存在的文件。FileExistsModeIGNORE

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

您可以将递归 与模式结合使用，以定期在本地同步整个远程目录树。 此模式将本地文件的上次修改时间戳设置为远程文件的时间戳，而不考虑 （保留时间戳） 选项。MGETFileExistsMode.REPLACE_IF_MODIFIED-P

使用递归时的注意事项 （-R)

该模式将被忽略并被假定。 默认情况下，将检索整个远程树。 但是，您可以通过提供 . 您也可以通过这种方式过滤树中的目录。 A 可以通过引用或 or 属性提供。 例如，检索远程目录和子目录中所有以 结尾的文件。 但是，我们在此说明之后描述了可用的替代方案。*FileListFilterFileListFilterfilename-patternfilename-regexfilename-regex="(subDir|.*1.txt)"1.txtsubDir

如果筛选子目录，则不会执行该子目录的额外遍历。

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

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

持久性文件列表筛选器现在具有 boolean 属性。 将此属性设置为 也会设置 ，这意味着出站网关 （ 和 ） 上的递归操作现在每次都将始终遍历整个目录树。 这是为了解决未检测到目录树深处的更改的问题。 此外，还会导致文件的完整路径用作元数据存储键;这解决了一个问题，即如果具有相同名称的文件在不同目录中多次出现，则筛选器无法正常工作。 重要说明：这意味着在顶级目录下的文件中找不到持久性元数据存储中的现有键。 因此，默认情况下，该属性是;这在将来的版本中可能会发生变化。forRecursiontruealwaysAcceptDirectorieslsmgetforRecursion=truefalse

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

<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将文件发送到远程服务器。 消息的有效负载可以是 、 a 或 。 （或表达式）用于命名远程文件。 其他可用属性包括 ，及其等效项： 和 。 有关详细信息，请参阅架构文档。java.io.Filebyte[]Stringremote-filename-generatorremote-directorytemporary-remote-directory*-expressionuse-temporary-file-nameauto-create-directory

操作生成的消息有效负载是包含传输后服务器上文件的完整路径。putString

使用命令mput

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

  • -R： Recursive — 发送目录和子目录中的所有文件（可能已过滤）

邮件负载必须是表示本地目录的（或）。 还支持 or 的集合。java.io.FileStringFileString

支持与 put 命令相同的属性。 此外，还可以使用 、 、 或 之一筛选本地目录中的文件。 只要子目录本身通过过滤器，过滤器就适用于递归。 未通过筛选器的子目录不会被递归。mput-patternmput-regexmput-filtermput-filter-expression

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

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

使用命令rm

该命令没有选项。rm

如果删除操作成功，则生成的消息有效负载为 。 否则，消息有效负载为 。 标头保存远程目录，标头保存文件名。Boolean.TRUEBoolean.FALSEfile_remoteDirectoryfile_remoteFile

使用命令mv

该命令没有选项。mv

属性定义“from”路径，属性定义“to”路径。 默认情况下，是 . 此表达式的计算结果不得为 null 或空 。 如有必要，将创建所需的任何远程目录。 结果消息的有效负载为 。 标头保存原始远程目录，标头保存文件名。 标头包含新路径。expressionrename-expressionrename-expressionheaders['file_renameTo']StringBoolean.TRUEfile_remoteDirectoryfile_remoteFilefile_renameTo

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

其他命令信息

and 命令支持该属性。 它定义了一个 SpEL 表达式，用于在传输过程中生成本地文件的名称。 评估上下文的根对象是请求消息。 该变量也可用。 它对（例如：）特别有用。getmgetlocal-filename-generator-expressionremoteFileNamemgetlocal-filename-generator-expression="#remoteFileName.toUpperCase() + headers.foo"

and 命令支持该属性。 它定义了一个 SpEL 表达式，用于在传输过程中生成本地目录的名称。 评估上下文的根对象是请求消息。 该变量也可用。 它对 mget 特别有用（例如：）。 此属性与属性互斥。getmgetlocal-directory-expressionremoteDirectorylocal-directory-expression="'/tmp/local/' + #remoteDirectory.toUpperCase() + headers.myheader"local-directory

对于所有命令，网关的“expression”属性保存命令所操作的路径。 对于该命令，表达式的计算结果可能为 ，这意味着检索所有文件、somedirectory/ 和其他以 . 结尾的值。mget*

以下示例显示了为命令配置的网关：ls

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

发送到通道的消息的有效负载是对象列表，每个对象都包含一个文件的名称。 如果省略 ，有效负载将是一个对象列表。 您可以以空格分隔列表的形式提供选项（例如，）。toSplitterStringcommand-options="-1"FileInfocommand-options="-1 -dirs -links"

、 、 和 命令支持属性（使用命名空间支持时）。 这会影响本地文件存在 （ 和 ） 或远程文件存在 （ 和 ） 时的行为。 支持的模式有 、 、 和 。 为了向后兼容，和 操作的默认模式是 。 对于 和 操作，默认值为 。GETMGETPUTMPUTFileExistsModemodeGETMGETPUTMPUTREPLACEAPPENDFAILIGNOREPUTMPUTREPLACEGETMGETFAIL

使用 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"));
    }

}

出站网关部分成功 （ 和mgetmput)

在对多个文件执行操作（通过使用 和 ）时，在传输一个或多个文件后的一段时间内可能会发生异常。 在这种情况下，将抛出 a。 除了通常的属性 （ 和 ），此异常还有两个附加属性：mgetmputPartialSuccessExceptionMessagingExceptionfailedMessagecause

  • partialResults：成功转移结果。

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

通过这些属性，您可以确定哪些文件已成功传输，哪些文件未成功传输。

在递归的情况下，可能有嵌套的实例。mputPartialSuccessExceptionPartialSuccessException

请考虑以下目录结构：

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

如果异常发生在 上，则网关抛出的 有 、 和 和 。 它是另一个 of 和 和 。file3.txtPartialSuccessExceptionderivedInputfile1.txtsubdirzoo.txtpartialResultsfile1.txtcausePartialSuccessExceptionderivedInputfile2.txtfile3.txtpartialResultsfile2.txt

如果在自定义组件中使用输入流，则必须关闭 . 您可以在自定义代码中执行此操作，也可以将消息的副本路由到 并使用 SpEL，如以下示例所示：Sessionservice-activator
如果 是 ，则输出消息的有效负载不再包含由于文件已存在而未提取的文件。 以前，该数组包含所有文件，包括已存在的文件。FileExistsModeIGNORE
使用递归时的注意事项 （-R)

该模式将被忽略并被假定。 默认情况下，将检索整个远程树。 但是，您可以通过提供 . 您也可以通过这种方式过滤树中的目录。 A 可以通过引用或 or 属性提供。 例如，检索远程目录和子目录中所有以 结尾的文件。 但是，我们在此说明之后描述了可用的替代方案。*FileListFilterFileListFilterfilename-patternfilename-regexfilename-regex="(subDir|.*1.txt)"1.txtsubDir

如果筛选子目录，则不会执行该子目录的额外遍历。

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

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

远程文件信息

（SMB 出站网关）的 （SMB 流入站通道适配器）、（SMB 入站通道适配器）和“read”-命令在消息中提供其他标头，以生成有关远程文件的信息：SmbStreamingMessageSourceSmbInboundFileSynchronizingMessageSourceSmbOutboundGateway

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

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

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

由于不会针对远程文件生成消息，而是使用本地副本，因此在同步操作期间，将有关远程文件的信息存储在 （可以在外部配置） 的 URI 样式 （） 中。 轮询本地文件时，将检索此元数据。 删除本地文件时，建议删除其元数据条目。 为此目的提供回调。 此外，在元数据键中还有一个要用到的。 当这些组件之间共享同一实例时，建议将此前缀与基于 -的实现中使用的前缀不同，以避免条目覆盖，因为两者都筛选并使用相同的本地文件名作为元数据条目键。SmbInboundFileSynchronizingMessageSourceAbstractInboundFileSynchronizerMetadataStoreprotocol://host:port/remoteDirectory#remoteFileNameSmbInboundFileSynchronizingMessageSourceAbstractInboundFileSynchronizerremoveRemoteFileMetadata()setMetadataStorePrefix()MetadataStoreFileListFilterMetadataStoreAbstractInboundFileSynchronizer