SpringBoot 2.7.x SFTP适配器SSH隧道传输的优化方案咨询

直接利用Spring Integration SFTP的SSH隧道支持 #

不需要手动用JSch做端口转发，Spring Integration SFTP本身可通过配置SftpSessionFactory结合JSch的Proxy实现SSH隧道，这是更优雅的方案，无需暴露本地端口。

核心配置示例 #

1. 依赖配置（pom.xml）

确保引入必要依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-integration</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.integration</groupId>
    <artifactId>spring-integration-sftp</artifactId>
</dependency>
<dependency>
    <groupId>com.jcraft</groupId>
    <artifactId>jsch</artifactId>
    <version>0.1.55</version> <!-- 适配SpringBoot 2.7.x的兼容版本 -->
</dependency>

2. 自定义SftpSessionFactory配置类

创建配置类，注入SSH隧道（跳板机）和目标SFTP服务器信息：

import com.jcraft.jsch.JSch;
import com.jcraft.jsch.ProxySSH;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.integration.sftp.session.DefaultSftpSessionFactory;

@Configuration
public class SftpTunnelConfig {

    @Bean
    public DefaultSftpSessionFactory sftpSessionFactory() {
        DefaultSftpSessionFactory factory = new DefaultSftpSessionFactory(true);
        
        // 目标SFTP服务器信息（通过隧道访问的真实服务器）
        factory.setHost("target-sftp-host");
        factory.setPort(22);
        factory.setUser("target-sftp-username");
        factory.setPassword("target-sftp-password"); // 可替换为密钥认证
        
        // 配置SSH隧道（跳板机/堡垒机信息）
        JSch jSch = new JSch();
        ProxySSH proxy = new ProxySSH("jump-host", 22);
        proxy.setUser("jump-username");
        proxy.setPassword("jump-password"); // 可替换为密钥认证
        
        // 将代理注入JSch Session
        factory.setSessionFactory(jSchSession -> {
            jSchSession.setProxy(proxy);
            return jSchSession;
        });
        
        return factory;
    }
}

3. 集成SFTP适配器（以文件下载为例）

使用配置好的sessionFactory实现文件同步：

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.integration.dsl.IntegrationFlow;
import org.springframework.integration.dsl.IntegrationFlows;
import org.springframework.integration.sftp.dsl.Sftp;
import org.springframework.integration.sftp.session.DefaultSftpSessionFactory;
import java.io.File;

@Configuration
public class SftpIntegrationConfig {

    @Bean
    public IntegrationFlow sftpInboundFlow(DefaultSftpSessionFactory sftpSessionFactory) {
        return IntegrationFlows.from(Sftp.inboundAdapter(sftpSessionFactory)
                        .remoteDirectory("/remote/target/path")
                        .localDirectory(new File("/local/save/path"))
                        .deleteRemoteFiles(false),
                e -> e.poller(p -> p.fixedDelay(5000)))
                .handle(message -> {
                    // 处理下载完成后的文件逻辑
                    System.out.println("文件已下载：" + message.getPayload());
                })
                .get();
    }
}

优势对比 #

• 无需手动维护端口转发，避免本地端口占用冲突
• 配置集中在Spring容器内，符合Spring生态的统一管理方式
• 天然支持Spring生命周期管理，无需手动处理JSch连接的关闭

注意事项 #

• 确保跳板机与目标SFTP服务器的网络连通性
• 密钥认证可替换密码：通过jSch.addIdentity()加载私钥文件，无需设置密码参数
• SpringBoot 2.7.x对应spring-integration-sftp版本为5.5.x，需保证JSch版本兼容

内容的提问来源于stack exchange，提问作者Sergio Panico