一、SFTP简述
二、SFTP服务配置(基于CentOS 7)
三、SFTP常用命令
四、Java代码实现SFTP操作(JSch实现上传、下载、监视器)
五、踩坑记录
一、SFTP简述
二、SFTP服务配置(基于Centos 7)
ssh -V // 如果版本过低,可以使用 yun update 进行更新
2、使用root用户创建用户组,组名为sftpgroup;创建sftp用户,用户名为sftpuser,并设置密码
groupadd sftpgroup // 创建sftp组
useradd -g sftpgroup -M -s /sbin/nologin sftpuser //-M 表示创建用户时不生成对应home目录,-s /sbin/nologin 表示sftp用户不能登录系统
passwd sftpuser // 修改sftp用户密码
3、修改配置文件sshd_config
vi /etc/ssh/sshd_config
修改如下:
4、使用root用户新建目录/home/sftpfile,将其设置为sftpuser的home目录,并指定目录权限
5、重启SSH
systemctl restart sshd.service
6、验证:切换到sftpuser用户进行验证
sftp sftpuser@127.0.0.1

三、SFTP常用命令
sftp的常用命令和ftp基本相同,使用help命令即可查询

四、Java代码实现SFTP操作
Java操作sftp需要使用一个开源包jsch,官网地址为 http://www.jcraft.com/jsch/,Maven项目中通过在pom.xml中引入如下依赖,如果需要其他版本,可在Maven中央仓库http://mvnrepository.com/ 查询。
com.jcraft
jsch
0.1.54
Jsch提供了sftp的各类操作的Java实现,ChannelSftp类是实现SFTP操作的核心类,sftp的命令即为该类中的方法,可以对比上图的sftp常用命令,如:sftp命令中ls为展示目录下的文件列表,则ChannelSftp类中有 ls() 方法与其对应。
#1、sftp服务连接和关闭
private void connect(SFTPConfig sftpConfig) { try { // 通过JSch对象获取session对象 session = new JSch().getSession( sftpConfig.getSftpUserName(), // sftp用户名 sftpConfig.getSftpHost(), // sftp主机IP sftpConfig.getSftpPort()); // sftp端口 if (null != sftpConfig.getSftpPassword()) { session.setPassword(sftpConfig.getSftpPassword()); // sftp用户密码 } if (null != sftpConfig.getTimeout()) { session.setTimeout(sftpConfig.getTimeout()); // 超时时间 } session.setConfig("StrictHostKeyChecking", "no"); // 让ssh客户端自动接受新主机的hostkey session.connect(); this.channelSftp = (ChannelSftp) session.openChannel("sftp"); // 打开sftp渠道,除sftp外还有shell、X11等类型 this.channelSftp.connect(); } catch (JSchException e) { this.close(); e.printStackTrace(); } } public void close() { channelSftp.quit(); if (null != channelSftp) { channelSftp.disconnect(); } if (null != session) { session.disconnect(); } }
/ * @param sftpParams * @param channelSftpModel 调用的模式: ChannelSftp.OVERWRITE,ChannelSftp.APPEND,ChannelSftp.RESUME * @throws SFTPException */ public void upload(SFTPParams sftpParams, int channelSftpModel) throws SFTPException { try { channelSftp.put(sftpParams.getLocalFilepath(), sftpParams.getRemoteFilepath(), channelSftpModel); } catch (SftpException e) { throw new SFTPException("Upload [" + sftpParams.getLocalFilepath() + "] to SFTP " + sftpConfig.getSftpHost() + ":" + sftpConfig.getSftpPort() + "[" + sftpParams.getRemoteFilepath() + "]" + " error.", e); } }
/ * * @param sftpParams * @param channelSftpModel 调用的模式: ChannelSftp.OVERWRITE,ChannelSftp.APPEND,ChannelSftp.RESUME * @param src 输入流 * @throws SFTPException */ public void upload(SFTPParams sftpParams, int channelSftpModel, InputStream src) throws SFTPException { try { channelSftp.put(src, sftpParams.getRemoteFilepath(), channelSftpModel); } catch (SftpException e) { throw new SFTPException("Upload [" + sftpParams.getLocalFilepath() + "] to SFTP " + sftpConfig.getSftpHost() + ":" + sftpConfig.getSftpPort() + "[" + sftpParams.getRemoteFilepath() + "]" + " error.", e); } }
/ * @param sftpParams * @param channelSftpModel 调用的模式: ChannelSftp.OVERWRITE,ChannelSftp.APPEND,ChannelSftp.RESUME * @param src 输入流 * @param bufferSize 数据块大小 * @throws SFTPException */ public void upload(SFTPParams sftpParams, int channelSftpModel, InputStream src, int bufferSize) throws SFTPException { OutputStream out = null; try { out = channelSftp.put(sftpParams.getRemoteFilepath(), channelSftpModel); byte[] buff = new byte[bufferSize]; // 设定每次传输的数据块大小 int read; if (out != null) { do { read = src.read(buff, 0, buff.length); if (read > 0) { out.write(buff, 0, read); } out.flush(); } while (read >= 0); } } catch (IOException e) { throw new SFTPException("Upload [" + sftpParams.getLocalFilepath() + "] to SFTP " + sftpConfig.getSftpHost() + ":" + sftpConfig.getSftpPort() + "[" + sftpParams.getRemoteFilepath() + "]" + " error.", e); } catch (SftpException e) { throw new SFTPException("Upload [" + sftpParams.getLocalFilepath() + "] to SFTP " + sftpConfig.getSftpHost() + ":" + sftpConfig.getSftpPort() + "[" + sftpParams.getRemoteFilepath() + "]" + " error.", e); } finally { if (null != out) { try { out.close(); } catch (IOException e) { e.printStackTrace(); } } } }
public void download(SFTPParams sftpParams) throws SFTPException { try { channelSftp.get(sftpParams.getRemoteFilepath(), sftpParams.getLocalFilepath()); } catch (SftpException e) { throw new SFTPException("Download [" + sftpParams.getRemoteFilepath() + "] from SFTP " + sftpConfig.getSftpHost() + ":" + sftpConfig.getSftpPort() + " error.", e); } }
public void download(SFTPParams sftpParams, OutputStream os) throws SFTPException { try { channelSftp.get(sftpParams.getRemoteFilepath(), os); } catch (SftpException e) { throw new SFTPException("Download [" + sftpParams.getRemoteFilepath() + "] from SFTP " + sftpConfig.getSftpHost() + ":" + sftpConfig.getSftpPort() + " error.", e); } }
public InputStream download2InputStream(SFTPParams sftpParams) throws SFTPException { try { return channelSftp.get(sftpParams.getRemoteFilepath()); } catch (SftpException e) { throw new SFTPException("Download [" + sftpParams.getRemoteFilepath() + "] from SFTP " + sftpConfig.getSftpHost() + ":" + sftpConfig.getSftpPort() + " error.", e); } }
package com.jcraft.jsch; public interface SftpProgressMonitor{ public static final int PUT=0; public static final int GET=1; public static final long UNKNOWN_SIZE = -1L; // 传输开始时,调用init方法。其中op为操作类型,即为上面定义的PUT/GET,max为文件的大小 void init(int op, String src, String dest, long max); // 当每次传输一个数据块后,调用count方法,参数为这一次传输的数据块大小 boolean count(long count); // 传输结束时,调用end方法 void end(); }
现在实现一个每隔1秒,获取上传的进度的功能
public class TimerSFTPProgressMonitor implements SftpProgressMonitor { private boolean isTransEnd = false; // 是否传输完成 private long fileTotalSize; // 需要传输文件的大小 private long fileTransferedSize; // 已传输的大小 private ScheduledExecutorService service = Executors.newScheduledThreadPool(1); public void init(int op, String src, String dest, long max) { System.out.println("Begin transferring."); fileTotalSize = max; if (fileTotalSize != 0) { final DecimalFormat df = new DecimalFormat("#."); service.scheduleAtFixedRate(new Runnable() { public void run() { if (!isTransEnd) { if (fileTransferedSize != fileTotalSize) { double d = ((double) fileTransferedSize * 100) / (double) fileTotalSize; System.out.println("Current progress: " + df.format(d) + "%"); } else { isTransEnd = true; // 已传输大小等于文件总大小,则已完成 } } } }, 0, 1, TimeUnit.SECONDS); } } public boolean count(final long count) { fileTransferedSize = fileTransferedSize + count; return true; } public void end() { service.shutdown(); System.out.println("End transferring, transferedSize : " + fileTransferedSize); } }
最后效果如下


原因:在SFTP服务配置一节中,我们将文件上传到/sftp/sftpuser/upload,但是在代码中不能直接写入这个路径,而需要写入 /upload 这个路径,因为对于sftpuser来说,它是没有/sftp/sftpuser/这个路径的。可以通过sftp的 ls / 命令来查看

发布者:全栈程序员-站长,转载请注明出处:https://javaforall.net/177742.html原文链接:https://javaforall.net
