Jsch 使用过程中遇到的问题及解决方法

使用版本

//maven
<dependency><groupId>com.jcraft</groupId><artifactId>jsch</artifactId><version>0.1.55</version>
</dependency>//gradle
implementation 'com.jcraft:jsch:0.1.55'

以上的版本是笔者正在使用的，目前没有发现有安全漏洞，但是，该项目已经有很长时间没有维护了。如果因为下面这些原因，可以验证使用这个Jsch。当然，这需要你自己去验证

起源于 JSch-0.1.55 的子项目
OpenSSH 在 8.8 版本中默认禁用了 ssh-rsa，需要一个支持 rsa-sha2-256 和 rsa-sha2-512 的库。
项目更新维护频繁

运行环境

Jdk 1.8

存在问题

session 连接失效，无法下载文件的问题？

使用缓存将已获取的 session 连接存储起来，每次都从缓存中获取，使用前都验证下看 session 连接是否失效。
多线程同时使用 session 连接，下载文件造成的竞争问题？

每次获取 session 连接时，从缓存中获取，如果 session 连接失效，(该步加锁，避免竞争问题)则从缓存中删除连接，并重新获取并放到缓存中。

代码示例

	/*** session缓存*/private static final Map<String, Session> cache = new HashMap<>();private SftpConfig SftpConfig;public SftpUtils(SftpConfig SftpConfig) {this.SftpConfig = SftpConfig;}/*** 打开 Session 连接*/public Session openSession() throws JSchException {String key = this.SftpConfig.getHost() + this.SftpConfig.getUsername() + this.SftpConfig.getPort();Session session = cache.get(key);if (ObjectUtils.isEmpty(session)) {JSch jSch = new JSch();session = jSch.getSession(this.SftpConfig.getUsername(), this.SftpConfig.getHost(), this.SftpConfig.getPort());session.setConfig("StrictHostKeyChecking", "no");session.setPassword(this.SftpConfig.getPassword());session.connect(this.SftpConfig.getTimeOut());if (session.isConnected()) {log.info("session connect host:{} port:{} success", this.SftpConfig.getHost(), this.SftpConfig.getPort());}cache.put(key, session);} else {//判断session是否失效if (testSessionIsDown(key)) {//session is downcloseLongSessionByKey(key);//重新生成sessionsession = openSession();}}return session;}/*** 销毁 session** @param key*/public synchronized void closeLongSessionByKey(String key) {Session session = cache.get(key);if (session != null) {session.disconnect();cache.remove(key);}}/*** 测试session是否失效** @return*/public boolean testSessionIsDown(String key) {Session session = cache.get(key);if (session == null) {return true;}ChannelExec channelExec = null;try {channelExec = openChannelExec(session);channelExec.setCommand("true");channelExec.connect();return false;} catch (Throwable e) {//session is downreturn true;} finally {if (channelExec != null) {channelExec.disconnect();}}}/*** 新建一个 exec 通道** @return* @throws JSchException*/public ChannelExec openChannelExec(Session session) throws JSchException {ChannelExec channelExec = (ChannelExec) session.openChannel("exec");return channelExec;}/*** 打开 channel 通道*/public ChannelSftp openChannel(Session session) throws JSchException {ChannelSftp sftp = (ChannelSftp) session.openChannel("sftp");sftp.connect();if (sftp.isConnected()) {log.info("sftp channel open success");}return sftp;}/*** 关闭 channel 通道*/public void closeChannel(ChannelSftp sftp) {if (sftp != null) {sftp.disconnect();}log.info("channel closed");}

注意：笔者是通过用户名+密码的方式，获取连接，也可以通过公私钥的方式获取，就不再进行代码演示。此处的 SftpConfig 对象是自定义对象，交由 Spring 管理，将 SFTP的配置信息加载到 SftpConfig 对象中。

使用示例

	/*** 下载文件到本地* <li>srcFile 示例：/20231017/test001.txt</li>* <li>dstFile 示例：/download/file/test001.txt</li>** @param session* @param srcFile 源文件路径* @param dstFile 本地文件路径* @return true-成功 false-失败*/public boolean downloadFile(Session session, String srcFile, String dstFile) throws SftpException, JSchException {ChannelSftp sftp = null;try {sftp = openChannel(session);if (ObjectUtils.isEmpty(sftp)) {log.error("SFTP channel or session disconnect ");return false;}log.info("begin download file");sftp.get(srcFile, dstFile);log.info("download file finished");} finally {closeChannel(sftp);}return true;}