此版本仍在开发中，尚不被认为是稳定的。对于最新的稳定版本，请使用 Spring Integration 6.5.1！spring-doc.cadn.net.cn

SMB 支持

Spring Integration 支持使用 SMB 进行文件传输作。spring-doc.cadn.net.cn

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

项目需要此依赖项：spring-doc.cadn.net.cn

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

概述

Java CIFS 客户端库已被选为 CIFS/SMB 网络协议的 Java 实现。 其SmbFile抽象只是包装到 Spring Integration 的“远程文件”基础中，例如SmbSession,SmbRemoteFileTemplate等。spring-doc.cadn.net.cn

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

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

若要使用 SMB 命名空间，请将以下内容添加到 XML 文件的标头：spring-doc.cadn.net.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.cadn.net.cn

这SmbSessionFactory公开了使用 Min/Max 版本设置 SMB 协议的选项。 例如，支持 SMB 2.1 的最低版本和 SMB 3.1.1 的最高版本：spring-doc.cadn.net.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;
}

这SmbSessionFactory可以使用自定义jcifs.CIFSContext.spring-doc.cadn.net.cn

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 会话缓存

这SmbSessionFactory每次Session被要求。 在大多数情况下，这没有必要，而且Session可以缓存。 为此，该SmbSessionFactory如前所述，应该包装到CachingSessionFactory:spring-doc.cadn.net.cn

@Bean
public CachingSessionFactory cachingSessionFactory(SmbSessionFactory smbSessionFactory) {
    cachingSessionFactory cachingSessionFactory = new CachingSessionFactory(smbSessionFactory, 10);
    cachingSessionFactory.setSessionWaitTimeout(1000);
    return cachingSessionFactory;
}

然后可以将其 bean 注入到下面描述的通道适配器中。spring-doc.cadn.net.cn

SMB 入站通道适配器

要在本地下载 SMB 文件，SmbInboundFileSynchronizingMessageSource被提供。 它是AbstractInboundFileSynchronizingMessageSource这需要SmbInboundFileSynchronizer注射。 对于过滤远程文件，您仍然可以使用任何现有的FileListFilter实现，但特别SmbRegexPatternFileListFilter和SmbSimplePatternFileListFilter被提供。spring-doc.cadn.net.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.cadn.net.cn

从版本 6.2 开始，您可以使用以下命令根据上次修改的策略过滤 SMB 文件SmbLastModifiedFileListFilter. 此过滤器可以配置age属性，以便过滤器仅传递早于此值的文件。 年龄默认为 60 秒，但您应该选择足够大的年龄以避免过早拾取文件（例如，由于网络故障）。 查看其 Javadoc 以获取更多信息。spring-doc.cadn.net.cn

相比之下，从 6.5 版开始，SmbRecentFileListFilter已引入仅接受那些不早于提供的文件age.spring-doc.cadn.net.cn

使用 Java DSL 进行配置

以下 Spring Boot 应用程序显示了如何使用 Java DSL 配置入站适配器的示例：spring-doc.cadn.net.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 流式入站通道适配器

此适配器生成一条消息，其中包含类型为InputStream，允许在不写入本地文件系统的情况下获取文件。 由于会话保持打开状态，因此使用应用程序负责在文件使用时关闭会话。 会话在closeableResource标头 （IntegrationMessageHeaderAccessor.CLOSEABLE_RESOURCE). 标准框架组件，例如FileSplitter和StreamTransformer，自动关闭会话。 有关这些组件的更多信息，请参阅文件拆分器和流转换器。 以下示例演示如何配置inbound-streaming-channel-adapter:spring-doc.cadn.net.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-pattern,filename-regex,filter或filter-expression是允许的。spring-doc.cadn.net.cn

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

有关SmbPersistentAcceptOnceFileListFilter及其使用方式，请参阅远程持久文件列表过滤器。spring-doc.cadn.net.cn

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

适配器将远程目录和文件名放在FileHeaders.REMOTE_DIRECTORY和FileHeaders.REMOTE_FILE标头。 这FileHeaders.REMOTE_FILE_INFOheader 提供额外的远程文件信息（默认以 JSON 表示）。 如果您将fileInfoJson属性SmbStreamingMessageSource自false，标头包含一个SmbFileInfo对象。spring-doc.cadn.net.cn

使用 Java 配置进行配置

以下 Spring Boot 应用程序显示了如何使用 Java 配置配置入站适配器的示例：spring-doc.cadn.net.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;
    }

}

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

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

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

以下方案假定启动状态为空的本地目录：spring-doc.cadn.net.cn

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

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

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

  • max-messages-per-poll=2和max-fetch-size未指定：适配器获取所有远程文件并发出前两个文件（如果至少有两个）。 后续文件在以后的轮询中发出（一次两个）。 当所有文件都被使用时，将再次尝试远程获取以选取任何新文件。spring-doc.cadn.net.cn

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

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

同步器可以配备一个Comparator<SmbFile>. 这在限制使用maxFetchSize.spring-doc.cadn.net.cn

SMB 出站通道适配器

用于将文件写入 SMB 共享和 XML<int-smb:outbound-channel-adapter>组件，我们使用SmbMessageHandler. 在 Java 配置的情况下，aSmbMessageHandler应与SmbSessionFactory（或SmbRemoteFileTemplate).spring-doc.cadn.net.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.cadn.net.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.cadn.net.cn

使用ls命令

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

此外，文件名过滤的提供方式与inbound-channel-adapter.spring-doc.cadn.net.cn

由ls作是文件名列表或FileInfo对象（取决于您是否使用-1开关）。 这些对象提供修改时间、权限等信息。spring-doc.cadn.net.cn

远程目录ls命令在file_remoteDirectory页眉。spring-doc.cadn.net.cn

使用递归选项 （-R）、fileName包含任何子目录元素，并表示文件的相对路径（相对于远程目录）。 如果您使用-dirs选项，则每个递归目录也将作为列表中的元素返回。 在这种情况下，我们建议您不要使用-1选项，因为您将无法区分文件与目录，而您可以在使用FileInfo对象。spring-doc.cadn.net.cn

用nlst命令

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

由nlst作是文件名的列表。spring-doc.cadn.net.cn

这file_remoteDirectory标头保存远程目录，其上nlst指挥部采取行动。spring-doc.cadn.net.cn

使用get命令

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

这file_remoteDirectory标头保存远程目录，而file_remoteFileheader 保存文件名。spring-doc.cadn.net.cn

由get作是一个File表示检索到的文件的对象。 如果您使用-stream选项，则有效负载是InputStream而不是File. 对于文本文件，一个常见的用例是将此作与文件拆分器或流转换器相结合。 当将远程文件作为流使用时，您负责关闭Session在流被消耗后。 为方便起见，该Session在closeableResourceheader 和IntegrationMessageHeaderAccessor提供便捷方法：spring-doc.cadn.net.cn

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

框架组件（例如文件拆分器和流转换器）在传输数据后自动关闭会话。spring-doc.cadn.net.cn

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

使用mget命令

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

由mget作是一个List<File>对象（即List之File对象，每个对象代表一个检索到的文件）。spring-doc.cadn.net.cn

如果FileExistsMode是IGNORE，则输出消息的有效负载不再包含由于文件已存在而未获取的文件。 以前，数组包含所有文件，包括那些已经存在的文件。

您使用的表达式确定远程路径应生成以*myfiles/*在myfiles.spring-doc.cadn.net.cn

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

使用递归（-R)

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

如果过滤子目录，则不会对该子目录执行其他遍历。spring-doc.cadn.net.cn

这-dirs选项不允许（递归mget使用递归ls获取目录树，目录本身不能包含在列表中）。spring-doc.cadn.net.cn

通常，您可以使用#remoteDirectory变量local-directory-expression以便远程目录结构在本地保留。spring-doc.cadn.net.cn

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

您可以配置SmbSimplePatternFileListFilter和SmbRegexPatternFileListFilter通过设置alwaysAcceptDirectorties自true. 这样做允许简单模式的递归，如以下示例所示：spring-doc.cadn.net.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>

您可以使用filter网关上的属性。spring-doc.cadn.net.cn

也可以看看出站网关部分成功 （mget和mput).spring-doc.cadn.net.cn

使用put命令

put将文件发送到远程服务器。 消息的有效负载可以是java.io.File一个byte[]或String. 一个remote-filename-generator（或表达式）用于命名远程文件。 其他可用属性包括remote-directory,temporary-remote-directory和他们的*-expression等价物：use-temporary-file-name和auto-create-directory. 有关更多信息，请参阅架构文档。spring-doc.cadn.net.cn

由put作是一个String其中包含传输后服务器上文件的完整路径。spring-doc.cadn.net.cn

使用mput命令

mput向服务器发送多个文件，并支持以下选项：spring-doc.cadn.net.cn

消息有效负载必须是java.io.File（或String） 表示本地目录。 集合File或String也受支持。spring-doc.cadn.net.cn

与put命令被支持。 此外，您可以使用以下选项之一过滤本地目录中的文件mput-pattern,mput-regex,mput-filter或mput-filter-expression. 过滤器与递归一起工作，只要子目录本身通过过滤器即可。 未通过过滤器的子目录不会递归。spring-doc.cadn.net.cn

由mput作是一个List<String>对象（即List传输产生的远程文件路径）。spring-doc.cadn.net.cn

也可以看看出站网关部分成功 （mget和mput).spring-doc.cadn.net.cn

使用rm命令

这rm命令没有选项。spring-doc.cadn.net.cn

如果删除作成功，则生成的消息有效负载为Boolean.TRUE. 否则，消息有效负载为Boolean.FALSE. 这file_remoteDirectory标头保存远程目录，而file_remoteFileheader 保存文件名。spring-doc.cadn.net.cn

使用mv命令

这mv命令没有选项。spring-doc.cadn.net.cn

这expression属性定义了“from”路径，而rename-expression属性定义“to”路径。 默认情况下，rename-expression是headers['file_renameTo']. 此表达式的计算结果不得为 null 或空String. 如有必要，将创建所需的任何远程目录。 结果消息的有效负载为Boolean.TRUE. 这file_remoteDirectory标头保存原始远程目录，而file_remoteFileheader 保存文件名。 这file_renameToheader 保存新路径。spring-doc.cadn.net.cn

这remoteDirectoryExpression可用于mv为了方便起见，命令。 如果“from”文件不是完整的文件路径，则remoteDirectoryExpression用作远程目录。 这同样适用于“to”文件，例如，如果任务只是重命名某个目录中的远程文件。spring-doc.cadn.net.cn

其他命令信息

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

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

对于所有命令，网关的“expression”属性保存命令执行的路径。 对于mget命令，则表达式的计算结果可能为 ，这意味着检索所有文件，*somedirectory/\*以及以 结尾的其他值。*spring-doc.cadn.net.cn

以下示例显示了为ls命令：spring-doc.cadn.net.cn

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

发送到toSplitterchannel 是String对象，每个对象都包含一个文件名。 如果您省略了command-options="-1"，则有效负载将是FileInfo对象。 您可以将选项作为空格分隔的列表提供，例如command-options="-1 -dirs -links".spring-doc.cadn.net.cn

这GET,MGET,PUT和MPUT命令支持FileExistsMode属性 （mode使用命名空间支持时）。 这会影响本地文件存在时的行为 （GET和MGET） 或远程文件存在 （PUT和MPUT). 支持的模式包括REPLACE,APPEND,FAIL和IGNORE. 为了向后兼容，默认模式PUT和MPUT作是REPLACE. 为GET和MGET作，默认值为FAIL.spring-doc.cadn.net.cn

使用 Java 配置进行配置

以下 Spring Boot 应用程序显示了如何使用 Java 配置配置出站网关的示例：spring-doc.cadn.net.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.cadn.net.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"));
    }

}

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

对多个文件执行作时（使用mget和mput） 在传输一个或多个文件后一段时间可能会发生异常。 在这种情况下，一个PartialSuccessException被抛出。 以及通常的MessagingException属性 （failedMessage和cause），则此异常具有两个附加属性：spring-doc.cadn.net.cn

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

在递归的情况下mput这PartialSuccessException可能已经嵌套PartialSuccessException实例。spring-doc.cadn.net.cn

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

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

远程文件信息

这SmbStreamingMessageSource (SMB 流式入站通道适配器），SmbInboundFileSynchronizingMessageSource (SMB 入站通道适配器，）和 “read”命令SmbOutboundGateway (SMB 出站网关）在消息中提供其他标头以生成有关远程文件的信息：spring-doc.cadn.net.cn

由于SmbInboundFileSynchronizingMessageSource不会针对远程文件生成消息，但使用本地副本，AbstractInboundFileSynchronizer将有关远程文件的信息存储在MetadataStore（可以在外部配置）的 URI 样式 （protocol://host:port/remoteDirectory#remoteFileName） 在同步作期间。 此元数据由SmbInboundFileSynchronizingMessageSource轮询本地文件时。 删除本地文件时，建议删除其元数据条目。 这AbstractInboundFileSynchronizer提供一个removeRemoteFileMetadata()回调。 此外，还有一个setMetadataStorePrefix()用于元数据键。 建议将此前缀与MetadataStore-基于FileListFilter实现，当相同时MetadataStoreinstance 在这些组件之间共享，以避免条目覆盖，因为 filter 和AbstractInboundFileSynchronizer对元数据条目键使用相同的本地文件名。spring-doc.cadn.net.cn