JSch

文章来源：http://www.VEVb.com/longyg/archive/2012/06/25/2556576.html

JSch是Java Secure Channel的缩写。JSch是一个SSH2的纯Java实现。它允许你连接到一个SSH服务器，并且可以使用端口转发，X11转发，文件传输等，当然你也可以集成它的功能到你自己的应用程序。

编写一个工具类，根据ip，用户名及密码得到一个SFTP channel对象，即ChannelSftp的实例对象，在应用程序中就可以使用该对象来调用SFTP的各种操作方法。

SFTPConstants是一个静态成员变量类：

实现文件上传可以调用ChannelSftp对象的put方法。ChannelSftp中有12个put方法的重载方法：

应用实例：

SFTPTest.java

注：请分别将代码段1，代码段2，代码段3取消注释，运行程序来进行测试。这三段代码分别演示了如何使用JSch的不同的put方法来进行文件上传。

代码段1：采用向put方法返回的输出流中写入数据的方式来传输文件。需要由程序来决定写入什么样的数据，这里是将本地文件的输入流写入输出流。采用这种方式的好处是，可以自行设定每次写入输出流的数据块大小，如本示例中的语句：

byte[] buff = new byte[1024 * 256]; // 设定每次传输的数据块大小为256KB

代码段2：直接将本地文件名为src的文件上传到目标服务器，目标文件名为dst。（注：使用这个方法时，dst可以是目录，当dst是目录时，上传后的目标文件名将与src文件名相同）

代码段3：将本地文件名为src的文件输入流上传到目标服务器，目标文件名为dst。

这三段代码实现的功能是一样的，都是将本地的文件src上传到了服务器的dst文件。使用时可根据具体情况选择使用哪种实现方式。

从前面的介绍中知道，JSch支持在文件传输时对传输进度的监控。可以实现JSch提供的SftpProgressMonitor接口来完成这个功能。

SftpProgressMonitor接口类的定义为：

 1 SftpProgressMonitor.java  2  3 package com.jcraft.jsch; 4  5 public interface SftpProgressMonitor{ 6   public static final int PUT=0; 7   public static final int GET=1; 8   void init(int op, String src, String dest, long max); 9   boolean count(long count);10   void end();11 }

init():当文件开始传输时，调用init方法。

count(): 当每次传输了一个数据块后，调用count方法，count方法的参数为这一次传输的数据块大小。

end():当传输结束时，调用end方法。

下面是一个简单的实现：

 1 MyProgressMonitor.java  2  3 package com.longyg.sftp; 4  5 import com.jcraft.jsch.SftpProgressMonitor; 6  7 public class MyProgressMonitor implements SftpProgressMonitor { 8     private long transfered; 9 10     @Override11     public boolean count(long count) {12         transfered = transfered + count;13         System.out.println("Currently transferred total size: " + transfered + " bytes");14         return true;15     }16 17     @Override18     public void end() {19         System.out.println("Transferring done.");20     }21 22     @Override23     public void init(int op, String src, String dest, long max) {24         System.out.println("Transferring begin.");25     }26 }

此时如果改变SFTPTest main方法里调用的put方法，即可实现监控传输进度：

 1 SFTPTest.java  2  3 package com.longyg.sftp; 4  5 import java.util.HashMap; 6 import java.util.Map; 7  8 import com.jcraft.jsch.ChannelSftp; 9 10 public class SFTPTest {11 12     public SFTPChannel getSFTPChannel() {13         return new SFTPChannel();14     }15 16     /**17      * @param args18      * @throws Exception19      */20     public static void main(String[] args) throws Exception {21         SFTPTest test = new SFTPTest();22 23         Map<String, String> sftpDetails = new HashMap<String, String>();24         // 设置主机ip，端口，用户名，密码25         sftpDetails.put(SFTPConstants.SFTP_REQ_HOST, "10.9.167.55");26         sftpDetails.put(SFTPConstants.SFTP_REQ_USERNAME, "root");27         sftpDetails.put(SFTPConstants.SFTP_REQ_PASSWORD, "arthur");28         sftpDetails.put(SFTPConstants.SFTP_REQ_PORT, "22");29         30         String src = "D://DevSoft//HB-SnagIt1001.rar"; // 本地文件名31         String dst = "/home/omc/ylong/sftp/HB-SnagIt1001.rar"; // 目标文件名32               33         SFTPChannel channel = test.getSFTPChannel();34         ChannelSftp chSftp = channel.getChannel(sftpDetails, 60000);35         36         /**37          * 代码段138         OutputStream out = chSftp.put(dst, new MyProgressMonitor(), ChannelSftp.OVERWRITE); // 使用OVERWRITE模式39         byte[] buff = new byte[1024 * 256]; // 设定每次传输的数据块大小为256KB40         int read;41         if (out != null) {42             System.out.println("Start to read input stream");43             InputStream is = new FileInputStream(src);44             do {45                 read = is.read(buff, 0, buff.length);46                 if (read > 0) {47                     out.write(buff, 0, read);48                 }49                 out.flush();50             } while (read >= 0);51             System.out.println("input stream read done.");52         }53         **/54         55         chSftp.put(src, dst, new MyProgressMonitor(), ChannelSftp.OVERWRITE); // 代码段256         57         // chSftp.put(new FileInputStream(src), dst, new MyProgressMonitor(), ChannelSftp.OVERWRITE); // 代码段358         59         chSftp.quit();60         channel.closeChannel();61     }62 }

 1 logs  2  3 Start to read input stream 4 Currently transferred total size: 262144 bytes 5 Currently transferred total size: 524288 bytes 6 Currently transferred total size: 786432 bytes 7 Currently transferred total size: 1048576 bytes 8 Currently transferred total size: 1310720 bytes 9 Currently transferred total size: 1572864 bytes10 Currently transferred total size: 1835008 bytes11 Currently transferred total size: 2097152 bytes12 Currently transferred total size: 2359296 bytes13 Currently transferred total size: 2621440 bytes14 Currently transferred total size: 2883584 bytes15 Currently transferred total size: 3145728 bytes16 Currently transferred total size: 3407872 bytes17 Currently transferred total size: 3670016 bytes18 Currently transferred total size: 3848374 bytes19 input stream read done.

当然这个SftpProgressMonitor的实现实在太简单。JSch每次传输一个数据块，就会调用count方法来实现主动进度通知。

现在我们希望每间隔一定的时间才获取一下文件传输的进度。。。看看下面的SftpProgressMonitor实现：

  1 FileProgressMonitor.java   2   3 package com.longyg.sftp;  4   5 import java.text.DecimalFormat;  6 import java.util.Timer;  7 import java.util.TimerTask;  8   9 import com.jcraft.jsch.SftpProgressMonitor; 10  11 public class FileProgressMonitor extends TimerTask implements SftpProgressMonitor { 12      13     private long progressInterval = 5 * 1000; // 默认间隔时间为5秒 14      15     private boolean isEnd = false; // 记录传输是否结束 16      17     private long transfered; // 记录已传输的数据总大小 18      19     private long fileSize; // 记录文件总大小 20      21     private Timer timer; // 定时器对象 22      23     private boolean isScheduled = false; // 记录是否已启动timer记时器 24      25     public FileProgressMonitor(long fileSize) { 26         this.fileSize = fileSize; 27     } 28      29     @Override 30     public void run() { 31         if (!isEnd()) { // 判断传输是否已结束 32             System.out.println("Transfering is in progress."); 33             long transfered = getTransfered(); 34             if (transfered != fileSize) { // 判断当前已传输数据大小是否等于文件总大小 35                 System.out.println("Current transfered: " + transfered + " bytes"); 36                 sendProgressMessage(transfered); 37             } else { 38                 System.out.println("File transfering is done."); 39                 setEnd(true); // 如果当前已传输数据大小等于文件总大小，说明已完成，设置end 40             } 41         } else { 42             System.out.println("Transfering done. Cancel timer."); 43             stop(); // 如果传输结束，停止timer记时器 44             return; 45         } 46     } 47      48     public void stop() { 49         System.out.println("Try to stop progress monitor."); 50         if (timer != null) { 51             timer.cancel(); 52             timer.purge(); 53             timer = null; 54             isScheduled = false; 55         } 56         System.out.println("Progress monitor stoped."); 57     } 58      59     public void start() { 60         System.out.println("Try to start progress monitor."); 61         if (timer == null) { 62             timer = new Timer(); 63         } 64         timer.schedule(this, 1000, progressInterval); 65         isScheduled = true; 66         System.out.println("Progress monitor started."); 67     } 68      69     /** 70      * 打印progress信息 71      * @param transfered 72      */ 73     private void sendProgressMessage(long transfered) { 74         if (fileSize != 0) { 75             double d = ((double)transfered * 100)/(double)fileSize; 76             DecimalFormat df = new DecimalFormat( "#.##");  77             System.out.println("Sending progress message: " + df.format(d) + "%"); 78         } else { 79             System.out.println("Sending progress message: " + transfered); 80         } 81     } 82  83     /** 84      * 实现了SftpProgressMonitor接口的count方法 85      */ 86     public boolean count(long count) { 87         if (isEnd()) return false; 88         if (!isScheduled) { 89             start(); 90         } 91         add(count); 92         return true; 93     } 94  95     /** 96      * 实现了SftpProgressMonitor接口的end方法 97      */ 98     public void end() { 99         setEnd(true);100         System.out.println("transfering end.");101     }102     103     private synchronized void add(long count) {104         transfered = transfered + count;105     }106     107     private synchronized long getTransfered() {108         return transfered;109     }110     111     public synchronized void setTransfered(long transfered) {112         this.transfered = transfered;113     }114     115     private synchronized void setEnd(boolean isEnd) {116         this.isEnd = isEnd;117     }118     119     private synchronized boolean isEnd() {120         return isEnd;121     }122 123     public void init(int op, String src, String dest, long max) {124         // Not used for putting InputStream125     }126 }

再次修改SFTPTest main方法里的put方法，改为使用新的SftpProgressMonitor的实现类对象monitor作为参数，注意新的monitor对象的构造函数需要传入文件大小作为参数：

 1 SFTPTest.java  2  3 package com.longyg.sftp; 4  5 import java.io.File; 6 import java.util.HashMap; 7 import java.util.Map; 8  9 import com.jcraft.jsch.ChannelSftp;10 11 public class SFTPTest {12 13     public SFTPChannel getSFTPChannel() {14         return new SFTPChannel();15     }16 17     /**18      * @param args19      * @throws Exception20      */21     public static void main(String[] args) throws Exception {22         SFTPTest test = new SFTPTest();23 24         Map<String, String> sftpDetails = new HashMap<String, String>();25         // 设置主机ip，端口，用户名，密码26         sftpDetails.put(SFTPConstants.SFTP_REQ_HOST, "10.9.167.55");27         sftpDetails.put(SFTPConstants.SFTP_REQ_USERNAME, "root");28         sftpDetails.put(SFTPConstants.SFTP_REQ_PASSWORD, "arthur");29         sftpDetails.put(SFTPConstants.SFTP_REQ_PORT, "22");30         31         String src = "D://DevSoft//HB-SnagIt1001.rar"; // 本地文件名32         String dst = "/home/omc/ylong/sftp/HB-SnagIt1001.rar"; // 目标文件名33               34         SFTPChannel channel = test.getSFTPChannel();35         ChannelSftp chSftp = channel.getChannel(sftpDetails, 60000);36         37         File file = new File(src);38         long fileSize = file.length();39         40         /**41          * 代码段142         OutputStream out = chSftp.put(dst, new FileProgressMonitor(fileSize), ChannelSftp.OVERWRITE); // 使用OVERWRITE模式43         byte[] buff = new byte[1024 * 256]; // 设定每次传输的数据块大小为256KB44         int read;45         if (out != null) {46             System.out.println("Start to read input stream");47             InputStream is = new FileInputStream(src);48             do {49                 read = is.read(buff, 0, buff.length);50                 if (read > 0) {51                     out.write(buff, 0, read);52                 }53                 out.flush();54             } while (read >= 0);55             System.out.println("input stream read done.");56         }57         **/58         59         chSftp.put(src, dst, new FileProgressMonitor(fileSize), ChannelSftp.OVERWRITE); // 代码段260         61         // chSftp.put(new FileInputStream(src), dst, new FileProgressMonitor(fileSize), ChannelSftp.OVERWRITE); // 代码段362         63         chSftp.quit();64         channel.closeChannel();65     }66 }

再次运行，结果输出为：

 1 logs  2  3 Try to start progress monitor. 4 Progress monitor started. 5 Transfering is in progress. 6 Current transfered: 98019 bytes 7 Sending progress message: 2.55% 8 Transfering is in progress. 9 Current transfered: 751479 bytes10 Sending progress message: 19.53%11 Transfering is in progress.12 Current transfered: 1078209 bytes13 Sending progress message: 28.02%14 ......15 Transfering is in progress.16 Current transfered: 3430665 bytes17 Sending progress message: 89.15%18 transfering end.19 Transfering done. Cancel timer.20 Try to stop progress monitor.21 Progress monitor stoped.

现在，程序每隔5秒钟才会打印一下进度信息。可以修改FileProgressMonitor类里的progressInterval变量的值，来修改默认的间隔时间。