spring-integration-sftp 5.5.12频繁创建SFTP连接失败问题咨询

环境与代码 #

使用spring-integration-sftp 5.5.12版本，会话工厂创建代码如下：

DefaultSftpSessionFactory factory = new DefaultSftpSessionFactory(true);
factory.setHost(myConfig.getHost());
factory.setPort(myConfig.getPort());
factory.setUser(myConfig.getUser());
if (myConfig.getPrivateKey() != null) {
  factory.setPrivateKey(myConfig.getPrivateKey());
  factory.setPrivateKeyPassphrase(myConfig.getPrivateKeyPassphrase());
} else {
  factory.setPassword(myConfig.getPassword());
}
factory.setAllowUnknownKeys(true);
factory.setSessionConfig(buildSessionProperties(myConfig));
factory.setTimeout(5000);
factory.setChannelConnectTimeout(Duration.ofSeconds(5));

错误现象 #

频繁遇到failed to create SFTP connection. IllegalStateException错误，异常原因包括输入流关闭、读取超时等，其中一次报错堆栈：

[SFTP_CONNECTION_FAILED] Error while connecting to the sftp org.springframework.messaging.MessagingException: Failed to execute on session; nested exception is java.lang.IllegalStateException: failed to create SFTP Session
    at org.springframework.integration.file.remote.RemoteFileTemplate.execute(RemoteFileTemplate.java:461)
    at org.springframework.integration.file.remote.RemoteFileTemplate.list(RemoteFileTemplate.java:422)
    at net.javacrumbs.shedlock.core.DefaultLockingTaskExecutor.lambda$executeWithLock$0(DefaultLockingTaskExecutor.java:55)
    at net.javacrumbs.shedlock.core.DefaultLockingTaskExecutor.executeWithLock(DefaultLockingTaskExecutor.java:74)
    at net.javacrumbs.shedlock.core.DefaultLockingTaskExecutor.executeWithLock(DefaultLockingTaskExecutor.java:54)
    at net.javacrumbs.shedlock.core.DefaultLockingTaskExecutor.executeWithLock(DefaultLockingTaskExecutor.java:43)
    at org.springframework.scheduling.support.DelegatingErrorHandlingRunnable.run(DelegatingErrorHandlingRunnable.java:54)
    at java.base/java.util.concurrent.Executors$RunnableAdapter.call(Executors.java:539)
    at java.base/java.util.concurrent.FutureTask.runAndReset(FutureTask.java:305)
    at java.base/java.util.concurrent.ScheduledThreadPoolExecutor$ScheduledFutureTask.run(ScheduledThreadPoolExecutor.java:305)
    at java.base/java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1136)
    at java.base/java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:635)
    at java.base/java.lang.Thread.run(Thread.java:833)
Caused by: java.lang.IllegalStateException: failed to create SFTP Session
    at org.springframework.integration.sftp.session.DefaultSftpSessionFactory.getSession(DefaultSftpSessionFactory.java:404)
    at org.springframework.integration.sftp.session.DefaultSftpSessionFactory.getSession(DefaultSftpSessionFactory.java:61)
    at org.springframework.integration.file.remote.RemoteFileTemplate.execute(RemoteFileTemplate.java:447)
    ... 17 common frames omitted
Caused by: java.lang.IllegalStateException: failed to connect
    at org.springframework.integration.sftp.session.SftpSession.connect(SftpSession.java:303)
    at org.springframework.integration.sftp.session.DefaultSftpSessionFactory.getSession(DefaultSftpSessionFactory.java:398)
    ... 19 common frames omitted
Caused by: com.jcraft.jsch.JSchException: Session.connect: java.net.SocketTimeoutException: Read timed out
    at com.jcraft.jsch.Session.connect(Session.java:565)
    at com.jcraft.jsch.Session.connect(Session.java:183)
    at org.springframework.integration.sftp.session.SftpSession.connect(SftpSession.java:294)
    ... 20 common frames omitted

咨询问题 #

1. 该问题是否与连接超时或创建SFTP连接时使用的共享状态标志为true有关？
2. 将spring-integration-sftp升级到6.x.x版本（JSch替换为Apache MINA）是否能解决此问题？
3. 由于5.x.x到6.x.x版本迁移存在会话工厂相关的重大破坏性变更，我对此有所顾虑，是否有配置调整方案可以解决当前问题？

1. 与连接超时和共享状态标志的关系 #

• 连接超时：从堆栈信息看，直接触发异常的原因是SocketTimeoutException: Read timed out，说明当前5秒的连接超时设置可能无法匹配目标SFTP服务器的响应速度，网络波动、服务器负载过高都会导致这类超时问题。
• 共享状态标志（构造参数true）：该参数表示工厂使用ThreadLocal存储会话，即每个线程复用同一个会话。如果应用是多线程环境（比如定时任务通过线程池执行），共享会话会引发线程安全问题——例如一个线程关闭会话后，另一个线程复用该会话时就会出现输入流关闭的错误，这是导致部分异常的明确原因。

2. 升级到6.x.x版本的作用 #

Spring Integration 6.x用Apache MINA SSHD替代了JSch作为SFTP客户端实现，MINA在连接稳定性、线程安全、现代SSH特性支持上比JSch更优，能解决不少JSch遗留的老问题。但升级无法完全消除网络层面的超时问题，仅能降低客户端侧的异常概率。另外，6.x版本确实存在会话工厂API重构等重大变更，需要针对性调整代码适配。

3. 5.x版本下的配置调整方案 #

方案一：关闭会话共享 #

将DefaultSftpSessionFactory的构造参数改为false，禁用线程本地会话共享，每次获取新会话：

DefaultSftpSessionFactory factory = new DefaultSftpSessionFactory(false);

此方式让每个请求使用独立的SFTP会话，彻底避免线程间的会话状态干扰，解决输入流关闭这类共享会话导致的异常。

方案二：调整超时与心跳参数 #

适当增大连接超时时间，并添加服务器心跳配置防止连接被主动断开：

// 调整基础超时
factory.setTimeout(10000);
factory.setChannelConnectTimeout(Duration.ofSeconds(10));

// 添加JSch层面的超时与心跳配置
Properties sessionConfig = new Properties();
sessionConfig.put("connect.timeout", "10000"); // JSch自身连接超时
sessionConfig.put("serverAliveInterval", "30000"); // 每30秒发送一次心跳，维持连接
factory.setSessionConfig(sessionConfig);

方案三：使用会话池管理 #

通过CachingSessionFactory实现会话池化，既复用有效会话提升性能，又避免共享会话的线程安全问题：

DefaultSftpSessionFactory rawFactory = new DefaultSftpSessionFactory(false);
// 配置rawFactory的host、port、用户信息等参数...

CachingSessionFactory<SftpSession> factory = new CachingSessionFactory<>(rawFactory);
factory.setSessionCacheSize(10); // 设置会话池大小
factory.setSessionWaitTimeout(30000); // 获取会话的等待超时时间

方案四：添加重试机制 #

针对连接超时这类临时性异常，在SFTP操作外层添加重试逻辑（以Spring Retry为例）：

RetryTemplate retryTemplate = new RetryTemplate();
// 最多重试3次
SimpleRetryPolicy retryPolicy = new SimpleRetryPolicy();
retryPolicy.setMaxAttempts(3);
retryTemplate.setRetryPolicy(retryPolicy);

// 重试间隔1秒
FixedBackOffPolicy backOffPolicy = new FixedBackOffPolicy();
backOffPolicy.setBackOffPeriod(1000);
retryTemplate.setBackOffPolicy(backOffPolicy);

// 包裹SFTP操作执行重试
retryTemplate.execute(context -> {
    remoteFileTemplate.list("/target/path");
    return null;
});

内容的提问来源于stack exchange，提问作者Poorva Gokhale