SMB 支持

QWen Plus 中英对照 SMB Support

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

服务器消息块 (SMB) 是一个简单的网络协议，它让你可以将文件传输到共享文件服务器。

你需要将这个依赖项添加到你的项目中：

Maven

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

xml

Gradle

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

groovy

概述

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

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

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

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

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

xml

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

java

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

备注

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

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

java

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

java

对于 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();
    }
}

java

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>

xml

只允许使用 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;
    }

}

java

请注意，在这个例子中，转换器下游的消息处理程序有一个 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：适配器获取所有远程文件，并发出前两个文件（如果有至少两个）。后续文件将在后续轮询中发出（每次两个）。当所有文件都被消费后，将再次尝试远程获取，以获取任何新文件。

important

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

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

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

SMB 外发通道适配器

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

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

java

使用 Java DSL 配置

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

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

}

java

SMB 外发网关

SMB outbound 网关提供了一组有限的命令来与远程 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();
}

java

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

以下示例展示了如何将文件作为流进行消费：

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

xml

备注

如果您在自定义组件中消费输入流，则必须关闭 Session。您可以在自定义代码中执行此操作，或者将消息的副本路由到 service-activator 并使用 SpEL，如下例所示：

<int:service-activator input-channel="closeSession"
    expression="headers['closeableResource'].close()" />

xml

使用 mget 命令

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

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

• -R: 递归检索整个目录树。

• -x: 如果没有文件匹配模式，则抛出异常（否则，返回空列表）。

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

mget 操作产生的消息有效负载是一个 List<File> 对象（即，一个 File 对象的 List，每个 File 对象表示一个已检索的文件）。

important

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

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

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

important

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

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

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

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

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

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

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

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

xml

你可以通过在网关上使用 filter 属性来提供这些过滤器之一。

另请参阅 Outbound Gateway 部分成功 (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 属性定义了 “from” 路径，rename-expression 属性定义了 “to” 路径。默认情况下，rename-expression 是 headers['file_renameTo']。此表达式不能评估为 null 或空的 String。如有必要，会创建所需的任何远程目录。结果消息的有效载荷是 Boolean.TRUE。file_remoteDirectory 标头持有原始远程目录，file_remoteFile 标头持有文件名。file_renameTo 标头持有新路径。

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

额外命令信息

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

xml

发送到 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 配置来配置 outbound gateway 的示例：

@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

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

}

java

外发网关部分成功 (mget 和 mput)

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

• partialResults: 成功的传输结果。

• derivedInput: 从请求消息生成的文件列表（例如，用于 mput 的本地文件）。

这些属性让你确定哪些文件成功传输，哪些没有成功传输。

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

考虑以下目录结构：

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

none

如果异常发生在 file3.txt 上，网关抛出的 PartialSuccessException 具有 derivedInput，包括 file1.txt、subdir 和 zoo.txt，以及 partialResults 为 file1.txt。其 cause 是另一个 PartialSuccessException，该异常的 derivedInput 包括 file2.txt 和 file3.txt，partialResults 为 file2.txt。

远程文件信息

SmbStreamingMessageSource (SMB 流式传入通道适配器)、SmbInboundFileSynchronizingMessageSource (SMB 流入通道适配器) 和 SmbOutboundGateway (SMB 流出网关) 的 "读取" 命令在消息中提供了额外的标题，以提供有关远程文件的信息：

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

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

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

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