【转】JSch - Java实现的SFTP（文件上传详解篇）

 1 package com.longyg.sftp;
 2 
 3 import java.util.Map;
 4 import java.util.Properties;
 5 import org.apache.log4j.Logger;
 6 import com.jcraft.jsch.Channel;
 7 import com.jcraft.jsch.ChannelSftp;
 8 import com.jcraft.jsch.JSch;
 9 import com.jcraft.jsch.JSchException;
10 import com.jcraft.jsch.Session;
11 public class SFTPChannel {
12     Session session = null;
13     Channel channel = null;
14     private static final Logger LOG = Logger.getLogger(SFTPChannel.class.getName());
15     public ChannelSftp getChannel(Map<String, String> sftpDetails, int timeout) throws JSchException {
16         String ftpHost = sftpDetails.get(SFTPConstants.SFTP_REQ_HOST);
17         String port = sftpDetails.get(SFTPConstants.SFTP_REQ_PORT);
18         String ftpUserName = sftpDetails.get(SFTPConstants.SFTP_REQ_USERNAME);
19         String ftpPassword = sftpDetails.get(SFTPConstants.SFTP_REQ_PASSWORD);
20         int ftpPort = SFTPConstants.SFTP_DEFAULT_PORT;
21         if (port != null && !port.equals("")) {
22             ftpPort = Integer.valueOf(port);
23         }
24         JSch jsch = new JSch(); // 创建JSch对象
25         session = jsch.getSession(ftpUserName, ftpHost, ftpPort); // 根据用户名，主机ip，端口获取一个Session对象
26         LOG.debug("Session created.");
27         if (ftpPassword != null) {
28             session.setPassword(ftpPassword); // 设置密码
29         }
30         Properties config = new Properties();
31         config.put("StrictHostKeyChecking", "no");
32         session.setConfig(config); // 为Session对象设置properties
33         session.setTimeout(timeout); // 设置timeout时间
34         session.connect(); // 通过Session建立链接
35         LOG.debug("Session connected.");
36         LOG.debug("Opening Channel.");
37         channel = session.openChannel("sftp"); // 打开SFTP通道
38         channel.connect(); // 建立SFTP通道的连接
39         LOG.debug("Connected successfully to ftpHost = " + ftpHost + ",as ftpUserName = " + ftpUserName
40                 + ", returning: " + channel);
41         return (ChannelSftp) channel;
42     }
43     public void closeChannel() throws Exception {
44         if (channel != null) {
45             channel.disconnect();
46         }
47         if (session != null) {
48             session.disconnect();
49         }
50     }
51 }

 1 package com.longyg.sftp;
 2 
 3 public class SFTPConstants {
 4     public static final String SFTP_REQ_HOST = "host";
 5     public static final String SFTP_REQ_PORT = "port";
 6     public static final String SFTP_REQ_USERNAME = "username";
 7     public static final String SFTP_REQ_PASSWORD = "password";
 8     public static final int SFTP_DEFAULT_PORT = 22;
 9     public static final String SFTP_REQ_LOC = "location";
10 }

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

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

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

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

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

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