此版本仍在开发中，尚未被视为稳定版本。对于最新的稳定版本，请使用 Spring Integration 6.4.0！spring-doc.cn

SMB 支持

Spring 集成支持使用 SMB 进行文件传输操作。spring-doc.cn

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

您需要将此依赖项包含在您的项目中：spring-doc.cn

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

概述

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

SMB 通道适配器和支持类的实现与 （S）FTP 或 AWS S3 协议的现有组件完全相似。 因此，如果您熟悉这些组件，那么它很容易使用。spring-doc.cn

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

要使用 SMB 命名空间，请将以下内容添加到 XML 文件的标头中：spring-doc.cn

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 会话工厂，如下例所示：spring-doc.cn

公开选项以使用 Min/Max 版本设置 SMB 协议。 例如，支持 SMB 2.1 的最低版本和 SMB 3.1.1 的最高版本：SmbSessionFactoryspring-doc.cn

@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.CIFSContextspring-doc.cn

必须在 的实现中设置 SMB 协议 Min/Max 版本。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 文件，提供了 。 它是需要注射的简单扩展。 对于过滤远程文件，您仍然可以使用任何现有的 implementations，但 special 和 are provided。SmbInboundFileSynchronizingMessageSourceAbstractInboundFileSynchronizingMessageSourceSmbInboundFileSynchronizerFileListFilterSmbRegexPatternFileListFilterSmbSimplePatternFileListFilterspring-doc.cn

@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>spring-doc.cn

从版本 6.2 开始，您可以使用 根据上次修改的策略筛选 SMB 文件。 可以使用属性配置此过滤器，以便过滤器仅传递早于此值的文件。 该年龄默认为 60 秒，但您应该选择一个足够大的年龄，以避免过早地选取文件（例如，由于网络故障）。 有关详细信息，请查看其 Javadoc。SmbLastModifiedFileListFilteragespring-doc.cn

使用 Java DSL 进行配置

Spring 下面的 Boot 应用程序显示了如何使用 Java DSL 配置入站适配器的示例：spring-doc.cn

@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 流式处理入站频道适配器

此适配器生成 payloads 类型的 message ，允许获取文件而无需写入本地文件系统。 由于会话保持打开状态，因此使用应用程序负责在使用文件时关闭会话。 会话在标头 （） 中提供。 标准框架组件（如 和 ）会自动关闭会话。 有关这些组件的更多信息，请参见File Splitter 和 Stream Transformer。 以下示例说明如何配置 ：InputStreamcloseableResourceIntegrationMessageHeaderAccessor.CLOSEABLE_RESOURCEFileSplitterStreamTransformerinbound-streaming-channel-adapterspring-doc.cn

<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-expressionspring-doc.cn

该适配器使用 based on the in-memory 防止远程文件重复。 默认情况下，此过滤器也与文件名模式（或 regex）一起应用。 如果需要允许重复项，可以使用 . 任何其他用例都可以由 （或 ） 处理。 Java 配置（本文档后面部分）显示了一种在处理后删除远程文件以避免重复的技术。SmbStreamingMessageSourceSmbPersistentAcceptOnceFileListFilterSimpleMetadataStoreAcceptAllFileListFilterCompositeFileListFilterChainFileListFilterspring-doc.cn

有关 的更多信息，请参见远程持久性文件列表过滤器。SmbPersistentAcceptOnceFileListFilterspring-doc.cn

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

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

使用 Java 配置进行配置

Spring 下面的 Boot 应用程序显示了如何使用 Java 配置配置入站适配器的示例：spring-doc.cn

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

}

请注意，在此示例中，转换器下游的消息处理程序具有一个，该处理程序在处理后删除远程文件。advicespring-doc.cn

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

在配置入站通道适配器时，应考虑两个属性。与所有 Poller 一样，可用于限制每次轮询时发出的消息数（如果已准备好超过配置的值）。 可以限制一次从远程服务器检索的文件数。max-messages-per-pollmax-fetch-sizespring-doc.cn

以下场景假定起始状态为空的本地目录：spring-doc.cn

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

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

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

  • max-messages-per-poll=2和 not specified：适配器获取所有远程文件并发出前两个（如果至少有两个）。 后续文件将在后续轮询时发出（一次两个）。 当所有文件都被消耗时，将再次尝试远程获取以获取任何新文件。max-fetch-sizespring-doc.cn

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

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

同步器可以配备 . 这在限制使用 获取的文件数量时非常有用。Comparator<SmbFile>maxFetchSizespring-doc.cn

SMB 出站通道适配器

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

@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 配置出站适配器的示例：spring-doc.cn

@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 服务器交互。 支持的命令包括：spring-doc.cn

使用命令ls

ls列出远程文件并支持以下选项：spring-doc.cn

此外，文件名筛选的提供方式与 .inbound-channel-adapterspring-doc.cn

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

标头中提供了命令操作的远程目录。lsfile_remoteDirectoryspring-doc.cn

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

使用命令nlst

nlst列出远程文件名，并且仅支持一个选项：spring-doc.cn

操作生成的消息有效负载是文件名列表。nlstspring-doc.cn

标头包含命令所作用于的远程目录。file_remoteDirectorynlstspring-doc.cn

使用命令get

get检索远程文件并支持以下选项：spring-doc.cn

  • -P：保留远程文件的时间戳。spring-doc.cn

  • -stream：将远程文件作为流检索。spring-doc.cn

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

header 包含远程目录，header 包含文件名。file_remoteDirectoryfile_remoteFilespring-doc.cn

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

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

框架组件（如 File Splitter 和 Stream Transformer）在传输数据后自动关闭会话。spring-doc.cn

以下示例演示如何将文件作为流使用：spring-doc.cn

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

使用命令mget

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

  • -P：保留远程文件的时间戳。spring-doc.cn

  • -R：递归检索整个目录树。spring-doc.cn

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

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

操作生成的消息有效负载是一个对象（即一个对象，每个对象表示一个检索到的文件）。mgetList<File>ListFilespring-doc.cn

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

您使用的表达式 determine the remote path 应生成一个结果，该结果以 myfiles/ fetches the complete tree under 结尾。myfilesspring-doc.cn

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

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

该模式将被忽略并被假定。 默认情况下，将检索整个远程树。 但是，您可以通过提供 . 您还可以通过这种方式筛选树中的目录。 A 可以通过 reference 或 by 或 attribute 提供。 例如，检索 remote directory 和 subdirectory 中以 结尾的所有文件。 但是，我们将在本说明之后介绍可用的替代方法。*FileListFilterFileListFilterfilename-patternfilename-regexfilename-regex="(subDir|.*1.txt)"1.txtsubDirspring-doc.cn

如果筛选一个子目录，则不会对该子目录执行额外的遍历。spring-doc.cn

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

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

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

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

<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>

您可以使用网关上的属性来提供这些过滤器之一。filterspring-doc.cn

另请参阅出站网关部分成功（mget 和 mput）。spring-doc.cn

使用命令put

put将文件发送到远程服务器。 消息的有效负载可以是 、 或 。 一个 （或表达式） 用于命名远程文件。 其他可用属性包括 ，及其等效项：和 . 有关更多信息，请参阅 schema documentation.java.io.Filebyte[]Stringremote-filename-generatorremote-directorytemporary-remote-directory*-expressionuse-temporary-file-nameauto-create-directoryspring-doc.cn

操作生成的消息有效负载是 a，其中包含传输后服务器上文件的完整路径。putStringspring-doc.cn

使用命令mput

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

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

消息有效负载必须是表示本地目录的 （或 ）。 还支持 or 的集合。java.io.FileStringFileStringspring-doc.cn

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

操作生成的消息有效负载是一个对象（即传输产生的远程文件路径）。mputList<String>Listspring-doc.cn

另请参阅出站网关部分成功（mget 和 mput）。spring-doc.cn

使用命令rm

该命令没有选项。rmspring-doc.cn

如果 remove 操作成功，则生成的消息负载为 . 否则，消息负载为 。 header 包含远程目录，header 包含文件名。Boolean.TRUEBoolean.FALSEfile_remoteDirectoryfile_remoteFilespring-doc.cn

使用命令mv

该命令没有选项。mvspring-doc.cn

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

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

其他命令信息

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

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

对于所有命令，网关的 'expression' 属性保存命令操作的路径。 对于该命令，表达式的计算结果可能为 ，表示检索所有文件、somedirectory/ 和其他以 .mget*spring-doc.cn

以下示例显示了为命令配置的网关：lsspring-doc.cn

<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"spring-doc.cn

、 、 和 命令支持属性（使用命名空间支持时）。 这会影响本地文件存在（ 和 ）或远程文件存在（ 和 ）时的行为。 支持的模式包括 、 、 和 。 为了向后兼容，和 operations 的默认模式为 . 对于 和 operations，默认值为 .GETMGETPUTMPUTFileExistsModemodeGETMGETPUTMPUTREPLACEAPPENDFAILIGNOREPUTMPUTREPLACEGETMGETFAILspring-doc.cn

使用 Java 配置进行配置

Spring 以下 Boot 应用程序显示了如何使用 Java 配置配置出站网关的示例：spring-doc.cn

@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 配置出站网关的示例：spring-doc.cn

@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。 除了通常的属性 （ 和 ），此异常还具有两个附加属性：mgetmputPartialSuccessExceptionMessagingExceptionfailedMessagecausespring-doc.cn

  • partialResults：传输成功的结果。spring-doc.cn

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

这些属性允许您确定哪些文件已成功传输，哪些文件未成功传输。spring-doc.cn

在 recursive 的情况下，可能具有嵌套实例。mputPartialSuccessExceptionPartialSuccessExceptionspring-doc.cn

请考虑以下目录结构：spring-doc.cn

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

如果异常发生在 ，则网关引发的 具有 、 和 和 的 。 它是另一个具有 of 和 and 的 。file3.txtPartialSuccessExceptionderivedInputfile1.txtsubdirzoo.txtpartialResultsfile1.txtcausePartialSuccessExceptionderivedInputfile2.txtfile3.txtpartialResultsfile2.txtspring-doc.cn

远程文件信息

（SMB Outbound Gateway） 的 （SMB Streaming Inbound Channel Adapter）、（SMB Inbound Channel Adapter） 和 “read” 命令在消息中提供了额外的标头，以生成有关远程文件的信息：SmbStreamingMessageSourceSmbInboundFileSynchronizingMessageSourceSmbOutboundGatewayspring-doc.cn

  • FileHeaders.REMOTE_HOST_PORT- 在文件传输操作期间，远程会话已连接到的 host：port 对;spring-doc.cn

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

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

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