ssslinppp

  博客园 :: 首页 :: 新随笔 :: 联系 :: 订阅 :: 管理 ::
【SFTP】使用Jsch实现Sftp文件下载-支持断点续传和进程监控
参考上篇文章：
《【SFTP】使用Jsch实现Sftp文件下载-支持断点续传和进程监控》：http://www.cnblogs.com/ssslinppp/p/6248763.html 

文件下载

测试断点续传



完整程序

  1. package com.sssppp.Communication;
  3. /**
  4.  * This program will demonstrate the sftp protocol support.
  5.  *   $ CLASSPATH=.:../build javac Sftp.java
  6.  *   $ CLASSPATH=.:../build java Sftp
  7.  * You will be asked username, host and passwd. 
  8.  * If everything works fine, you will get a prompt 'sftp>'. 
  9.  * 'help' command will show available command.
  10.  * In current implementation, the destination path for 'get' and 'put'
  11.  * commands must be a file, not a directory.
  12.  *
  13.  */
  14. import java.util.HashMap;
  15. import java.util.Map;
  16. import java.util.Properties;
  18. import javax.swing.ProgressMonitor;
  20. import com.jcraft.jsch.Channel;
  21. import com.jcraft.jsch.ChannelSftp;
  22. import com.jcraft.jsch.JSch;
  23. import com.jcraft.jsch.JSchException;
  24. import com.jcraft.jsch.Session;
  25. import com.jcraft.jsch.SftpProgressMonitor;
  27. /**
  28.  * <pre>
  29.  *  ----------命令集合---------------------
  30.  *  可参考链接(官方示例程序)：http://www.jcraft.com/jsch/examples/Sftp.java
  31.  *  ChannelSftp c = (ChannelSftp) channel;
  32.  *  c.quit();
  33.  *  c.exit();
  34.  *  c.cd("/home/example");
  35.  *  c.lcd("/home/example");
  36.  *  c.rm("/home/example.gz");
  37.  *  c.rmdir("/home/example");
  38.  *  c.mkdir("/home/example");
  39.  *  c.chgrp(777, "/home/example");
  40.  *  c.chown(777, "/home/example");
  41.  *  c.chmod(777, "/home/example");
  42.  *  c.pwd();
  43.  *  c.lpwd();
  44.  *  c.ls("/home/example");
  45.  *  
  46.  *  SftpProgressMonitor monitor = new MyProgressMonitor(); //显示进度
  47.  *  //文件下载
  48.  *  c.get("srcPath", "dstPath", monitor, ChannelSftp.OVERWRITE);
  49.  *  c.get("srcPath", "dstPath", monitor, ChannelSftp.RESUME); //断点续传
  50.  *  c.get("srcPath", "dstPath", monitor, ChannelSftp.APPEND);
  51.  *  //文件上传
  52.  *  c.put("srcPath", "dstPath", monitor, ChannelSftp.APPEND);
  53.  *  c.put("srcPath", "dstPath", monitor, ChannelSftp.APPEND);
  54.  *  c.put("srcPath", "dstPath", monitor, ChannelSftp.APPEND);
  55.  * 
  56.  *  c.hardlink("oldPath", "newPath");
  57.  *  c.rename("oldPath", "newPath");
  58.  *  c.symlink("oldPath", "newPath");
  59.  *  c.readlink("Path");
  60.  *  c.realpath("Path");
  61.  *  c.version();
  62.  *  
  63.  *  SftpStatVFS stat = c.statVFS("path");  //df 命令
  64.  *  long size = stat.getSize();
  65.  *  long used = stat.getUsed();
  66.  *  long avail = stat.getAvailForNonRoot();
  67.  *  long root_avail = stat.getAvail();
  68.  *  long capacity = stat.getCapacity();
  69.  *  
  70.  *  c.stat("path");
  71.  *  c.lstat("path");
  72.  * ----------------------------------------------------------------------
  73.  * </pre>
  74.  * 
  75.  */
  76. public class SftpUtil {
  78.   Session session = null;
  79.   Channel channel = null;
  80.   public static final String SFTP_REQ_HOST = "host";
  81.   public static final String SFTP_REQ_PORT = "port";
  82.   public static final String SFTP_REQ_USERNAME = "username";
  83.   public static final String SFTP_REQ_PASSWORD = "password";
  84.   public static final int SFTP_DEFAULT_PORT = 22;
  85.   public static final String SFTP_REQ_LOC = "location";
  87.   /**
  88.    * 测试程序
  89.    * @param arg
  90.    * @throws Exception 
  91.    */
  92.   public static void main(String[] arg) throws Exception {
  93.     // 设置主机ip，端口，用户名，密码
  94.     Map<String, String> sftpDetails = new HashMap<String, String>();
  95.     sftpDetails.put(SFTP_REQ_HOST, "10.180.137.221");
  96.     sftpDetails.put(SFTP_REQ_USERNAME, "root");
  97.     sftpDetails.put(SFTP_REQ_PASSWORD, "xxxx");
  98.     sftpDetails.put(SFTP_REQ_PORT, "22");
  99.     
  100.     //测试文件上传
  101.     String src = "C:\\xxx\\TMP\\site-1.10.4.zip"; // 本地文件名
  102.       String dst = "/tmp/sftp/"; // 目标文件名
  103.       uploadFile(src, dst, sftpDetails);
  104.     
  105.         //测试文件下载
  106.         String srcFilename = "/tmp/sftp/site-1.10.4.zip";
  107.         String dstFilename = "C:\\tmp\\site-1.10.4-new.zip";
  108.         downloadFile(srcFilename, dstFilename, sftpDetails);
  109.               
  110.   }
  111.   
  112.   public static void downloadFile(String src, String dst,
  113.       Map<String, String> sftpDetails) throws Exception {
  114.     SftpUtil sftpUtil = new SftpUtil();
  115.     ChannelSftp chSftp = sftpUtil.getChannel(sftpDetails, 160000);
  117.     // Retrieves the file attributes of a file or directory
  118.     // SftpATTRS attr = chSftp.stat(src);
  119.     // long fileSize = attr.getSize();
  121.     //代码段1/代码段2/代码段3:分别演示了如何使用JSch的各种put方法来进行文件下载
  122.     try {
  123.       // 代码段1:使用这个方法时，dst可以是目录，若dst为目录，则下载到本地的文件名将与src文件名相同
  124.       chSftp.get(src, dst, new MyProgressMonitor(),ChannelSftp.RESUME); //断点续传
  126.       /***
  127.       OutputStream out = new FileOutputStream(dst);
  128.       // 代码段2:将目标服务器上文件名为src的文件下载到本地的一个输出流对象，该输出流为一个文件输出流
  129.       chSftp.get(src, out, new MyProgressMonitor()); 
  130.       
  131.       // 代码段3:采用读取get方法返回的输入流数据的方式来下载文件
  132.       InputStream is = chSftp.get(src, new MyProgressMonitor(),ChannelSftp.RESUME);
  133.       byte[] buff = new byte[1024 * 2];
  134.       int read;
  135.       if (is != null) {
  136.         do {
  137.           read = is.read(buff, 0, buff.length);
  138.           if (read > 0) {
  139.             out.write(buff, 0, read);
  140.           }
  141.           out.flush();
  142.         } while (read >= 0);
  143.       }
  144.       **/
  145.       
  146.     } catch (Exception e) {
  147.       e.printStackTrace();
  148.     } finally {
  149.       chSftp.quit();
  150.       sftpUtil.closeChannel();
  151.     }
  152.   }
  153.   
  154.   public static void uploadFile(String src, String dst,
  155.       Map<String, String> sftpDetails) throws Exception {
  156.     SftpUtil sftpUtil = new SftpUtil();
  157.     ChannelSftp chSftp = sftpUtil.getChannel(sftpDetails, 60000);
  159.     /**
  160.      * 代码段1/代码段2/代码段3分别演示了如何使用JSch的不同的put方法来进行文件上传。这三段代码实现的功能是一样的，
  161.      * 都是将本地的文件src上传到了服务器的dst文件
  162.      */
  164.     /**代码段1 
  165.         OutputStream out = chSftp.put(dst,new MyProgressMonitor2(), ChannelSftp.OVERWRITE); // 使用OVERWRITE模式
  166.         byte[] buff = new byte[1024 * 256]; // 设定每次传输的数据块大小为256KB
  167.         int read;
  168.         if (out != null) {
  169.             InputStream is = new FileInputStream(src);
  170.             do {
  171.                 read = is.read(buff, 0, buff.length);
  172.                 if (read > 0) {
  173.                     out.write(buff, 0, read);
  174.                 }
  175.                 out.flush();
  176.             } while (read >= 0);
  177.         }
  178.         **/
  179.         
  180.     // 使用这个方法时，dst可以是目录，当dst是目录时，上传后的目标文件名将与src文件名相同
  181.     // ChannelSftp.RESUME：断点续传
  182.     chSftp.put(src, dst, new MyProgressMonitor(), ChannelSftp.RESUME); // 代码段2
  184.     // 将本地文件名为src的文件输入流上传到目标服务器，目标文件名为dst。
  185.     // chSftp.put(new FileInputStream(src), dst,new MyProgressMonitor2(), ChannelSftp.OVERWRITE); // 代码段3
  186.         
  187.         chSftp.quit();
  188.         sftpUtil.closeChannel();
  189.   }
  191.   /**
  192.    * 根据ip，用户名及密码得到一个SFTP
  193.    * channel对象，即ChannelSftp的实例对象，在应用程序中就可以使用该对象来调用SFTP的各种操作方法
  194.    * 
  195.    * @param sftpDetails
  196.    * @param timeout
  197.    * @return
  198.    * @throws JSchException
  199.    */
  200.   public ChannelSftp getChannel(Map<String, String> sftpDetails, int timeout)
  201.       throws JSchException {
  202.     String ftpHost = sftpDetails.get(SFTP_REQ_HOST);
  203.     String port = sftpDetails.get(SFTP_REQ_PORT);
  204.     String ftpUserName = sftpDetails.get(SFTP_REQ_USERNAME);
  205.     String ftpPassword = sftpDetails.get(SFTP_REQ_PASSWORD);
  207.     int ftpPort = SFTP_DEFAULT_PORT;
  208.     if (port != null && !port.equals("")) {
  209.       ftpPort = Integer.valueOf(port);
  210.     }
  212.     JSch jsch = new JSch(); // 创建JSch对象
  213.     session = jsch.getSession(ftpUserName, ftpHost, ftpPort); // 根据用户名，主机ip，端口获取一个Session对象
  214.     if (ftpPassword != null) {
  215.       session.setPassword(ftpPassword); // 设置密码
  216.     }
  217.     Properties config = new Properties();
  218.     config.put("StrictHostKeyChecking", "no");
  219.     session.setConfig(config); // 为Session对象设置properties
  220.     session.setTimeout(timeout); // 设置timeout时间
  221.     session.connect(5000); // 通过Session建立链接
  222.     channel = session.openChannel("sftp"); // 打开SFTP通道
  223.     channel.connect(); // 建立SFTP通道的连接
  224.     return (ChannelSftp) channel;
  225.   }
  227.   public void closeChannel() throws Exception {
  228.     if (channel != null) {
  229.       channel.disconnect();
  230.     }
  231.     if (session != null) {
  232.       session.disconnect();
  233.     }
  234.   }
  237.   /**
  238.    * 进度监控器-JSch每次传输一个数据块，就会调用count方法来实现主动进度通知
  239.    * 
  240.    */
  241.   public static class MyProgressMonitor implements SftpProgressMonitor {
  242.       private long count = 0;     //当前接收的总字节数
  243.       private long max = 0;       //最终文件大小
  244.       private long percent = -1;  //进度
  246.       /**
  247.        * 当每次传输了一个数据块后，调用count方法，count方法的参数为这一次传输的数据块大小
  248.        */
  249.       @Override
  250.     public boolean count(long count) {
  251.       this.count += count;
  252.       if (percent >= this.count * 100 / max) {
  253.         return true;
  254.       }
  255.       percent = this.count * 100 / max;
  257.       System.out.println("Completed " + this.count + "(" + percent
  258.           + "%) out of " + max + ".");
  259.       return true;
  260.     }
  262.       /**
  263.        * 当传输结束时，调用end方法
  264.        */
  265.       @Override
  266.       public void end() {
  267.           System.out.println("Transferring done.");
  268.       }
  270.       /**
  271.        * 当文件开始传输时，调用init方法
  272.        */
  273.       @Override
  274.       public void init(int op, String src, String dest, long max) {
  275.         if (op==SftpProgressMonitor.PUT) {
  276.           System.out.println("Upload file begin.");
  277.       }else {
  278.         System.out.println("Download file begin.");
  279.       }
  280.           
  281.           this.max = max;  
  282.           this.count = 0;
  283.           this.percent = -1;
  284.       }
  285.   }
  286.   
  287.   /**
  288.    * 官方提供的进度监控器
  289.    *
  290.    */
  291.   public static class DemoProgressMonitor implements SftpProgressMonitor {
  292.     ProgressMonitor monitor;
  293.     long count = 0;
  294.     long max = 0;
  296.     /**
  297.      * 当文件开始传输时，调用init方法。
  298.      */
  299.     public void init(int op, String src, String dest, long max) {
  300.       this.max = max;
  301.       monitor = new ProgressMonitor(null,
  302.           ((op == SftpProgressMonitor.PUT) ? "put" : "get") + ": "
  303.               + src, "", 0, (int) max);
  304.       count = 0;
  305.       percent = -1;
  306.       monitor.setProgress((int) this.count);
  307.       monitor.setMillisToDecideToPopup(1000);
  308.     }
  310.     private long percent = -1;
  312.     /**
  313.      * 当每次传输了一个数据块后，调用count方法，count方法的参数为这一次传输的数据块大小。
  314.      */
  315.     public boolean count(long count) {
  316.       this.count += count;
  318.       if (percent >= this.count * 100 / max) {
  319.         return true;
  320.       }
  321.       percent = this.count * 100 / max;
  323.       monitor.setNote("Completed " + this.count + "(" + percent
  324.           + "%) out of " + max + ".");
  325.       monitor.setProgress((int) this.count);
  327.       return !(monitor.isCanceled());
  328.     }
  330.     /**
  331.      * 当传输结束时，调用end方法。
  332.      */
  333.     public void end() {
  334.       monitor.close();
  335.     }
  336.   }
  337. }

参考链接






posted on 2017-01-04 16:42  ssslinppp  阅读(3055)  评论(0)    收藏  举报