SFTP 会话工厂 (SFTP Session Factory) _ Spring Integration6.4.0-M3中文文档(官方文档中文翻译)|Spring 教程 —

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

从版本 3.0 开始，默认情况下不再缓存会话。请参阅 SFTP 会话缓存。

在配置 SFTP 适配器之前，必须配置 SFTP 会话工厂。您可以使用常规 bean 定义配置 SFTP 会话工厂，如下例所示：spring-doc.cn

<beans:bean id="sftpSessionFactory"
    class="org.springframework.integration.sftp.session.DefaultSftpSessionFactory">
    <beans:property name="host" value="localhost"/>
    <beans:property name="privateKey" value="classpath:META-INF/keys/sftpTest"/>
    <beans:property name="privateKeyPassphrase" value="springIntegration"/>
    <beans:property name="port" value="22"/>
    <beans:property name="user" value="kermit"/>
</beans:bean>

每次适配器从其请求会话对象时，都会创建一个新的 SFTP 会话。实际上，SFTP Session Factory 依赖于 Apache MINA SSHD 库来提供 SFTP 功能。SessionFactoryspring-doc.cn

但是， Spring 集成还支持 SFTP 会话的缓存。有关更多信息，请参阅 SFTP 会话缓存。spring-doc.cn

可以使用外部配置或扩展的 . 例如，库中的扩展可用于提供对 HTTP/SOCKS 代理的支持。DefaultSftpSessionFactorySshClientorg.eclipse.jgit.internal.transport.sshd.JGitSshClientorg.eclipse.jgit:org.eclipse.jgit.ssh.apache

支持通过与服务器的连接使用多个通道（操作）。默认情况下， Spring 集成会话工厂为每个通道使用单独的物理连接。从 Spring Integration 3.0 开始，您可以配置会话工厂（使用布尔构造函数 arg - default ）以使用与服务器的单个连接，并在该单个连接上创建多个实例。SshClientfalseSftpClientspring-doc.cn

使用此功能时，必须将 session factory 包装在缓存 session factory 中，如下所述，以便在操作完成时不会物理关闭连接。spring-doc.cn

如果重置缓存，则仅当最后一个通道关闭时，会话才会断开连接。spring-doc.cn

如果在新操作获取会话时断开连接，则会刷新连接。spring-doc.cn

现在您需要做的就是将此 SFTP 会话工厂注入到您的适配器中。spring-doc.cn

为 SFTP 会话工厂提供值的更实用的方法是使用 Spring 的属性占位符支持。

从版本 6.1.3 开始，引入了 a 以支持自定义 . 请参阅下面的示例，了解如何覆盖自定义中的方法，以添加一些自定义，例如 SFTP 子系统请求和回复：DefaultSftpSessionFactorycreateSftpClient(…)SftpClientcreateSftpChannelSubsystem()SftpClientRequestHandlerspring-doc.cn

@Override
protected ChannelSubsystem createSftpChannelSubsystem(ClientSession clientSession) {
    ChannelSubsystem sftpChannelSubsystem = super.createSftpChannelSubsystem(clientSession);
    sftpChannelSubsystem.addRequestHandler((channel, request, wantReply, buffer) -> ...);
    return sftpChannelSubsystem;
}

从版本 3.0 开始，默认情况下不再缓存会话。请参阅 SFTP 会话缓存。

使用此功能时，必须将 session factory 包装在缓存 session factory 中，如下所述，以便在操作完成时不会物理关闭连接。spring-doc.cn

如果重置缓存，则仅当最后一个通道关闭时，会话才会断开连接。spring-doc.cn

如果在新操作获取会话时断开连接，则会刷新连接。spring-doc.cn

为 SFTP 会话工厂提供值的更实用的方法是使用 Spring 的属性占位符支持。

配置属性

以下列表描述了 DefaultSftpSessionFactory 公开的所有属性。spring-doc.cn

isSharedSession（constructor argument）：：当，则 single 用于所有请求的实例。它默认为 .trueSftpClientSftpSessionfalsespring-doc.cn

sftpVersionSelector：：用于 SFTP 协议选择的实例。默认值为 .SftpVersionSelectorSftpVersionSelector.CURRENTspring-doc.cn

host：：要连接到的主机的 URL。必填。spring-doc.cn

hostConfig：：作为 user/host/port 选项的替代实例。可以使用代理跳转属性进行配置。org.apache.sshd.client.config.hosts.HostConfigEntryspring-doc.cn

port：：应通过其建立 SFTP 连接的端口。如果未指定，则此值默认为。如果指定，则此属性必须为正数。22spring-doc.cn

user：：要使用的远程用户。必填。spring-doc.cn

knownHostsResource：：用于主机密钥存储库的 An。资源的内容必须与 OpenSSH 文件的格式相同，并且是必需的，如果为 false，则必须预先填充。org.springframework.core.io.Resourceknown_hostsallowUnknownKeysspring-doc.cn

password：：用于对远程主机进行身份验证的密码。如果未提供密码，则该属性是必需的。privateKeyspring-doc.cn

privateKey：：表示用于对远程主机进行身份验证的私钥的位置。如果未提供 the，则 property 是必需的。org.springframework.core.io.ResourceprivateKeypasswordspring-doc.cn

privateKeyPassphrase：：私钥的密码。如果设置，则不允许。密码是从该对象获取的。自选。userInfoprivateKeyPassphrasespring-doc.cn

timeout：：timeout 属性用作套接字超时参数，以及默认连接超时。默认为。设置为表示无超时;to - 无限等待。30 seconds0nullspring-doc.cn

allowUnknownKeys：：设置为以允许连接到具有未知（或更改）键的主机。它的默认值是 'false'。如果，则需要预填充的文件。truefalseknownHostsspring-doc.cn

userInteraction：：身份验证期间使用的自定义。org.apache.sshd.client.auth.keyboard.UserInteractionspring-doc.cn

从版本 6.4 开始，公开 configurer 属性以进一步自定义内部 . 例如，以下是更改客户端的默认 NIO 工作线程数量和数据包大小的方法：DefaultSftpSessionFactoryConsumer<SshClient>SshClientspring-doc.cn

sftpSessionFactory.setSshClientConfigurer((sshClient) -> {
    sshClient.setNioWorkers(27);
    PropertyResolverUtils.updateProperty(sshClient, CoreModuleProperties.MAX_PACKET_SIZE.getName(), 48 * 1024);
});