javascript
channelsftp的put_JSch - Java实现的SFTP（文件上传详解篇）
public void put(String src, String dst)
將本地文件名為src的文件上傳到目標服務器，目標文件名為dst，若dst為目錄，則目標文件名將與src文件名相同。
采用默認的傳輸模式：OVERWRITE
public void put(String src, String dst, int mode)
將本地文件名為src的文件上傳到目標服務器，目標文件名為dst，若dst為目錄，則目標文件名將與src文件名相同。
指定文件傳輸模式為mode(mode可選值為：ChannelSftp.OVERWRITE，ChannelSftp.RESUME，
ChannelSftp.APPEND)
public void put(String src, String dst, SftpProgressMonitor monitor)
將本地文件名為src的文件上傳到目標服務器，目標文件名為dst，若dst為目錄，則目標文件名將與src文件名相同。
采用默認的傳輸模式：OVERWRITE
并使用實現了SftpProgressMonitor接口的monitor對象來監控文件傳輸的進度。
public void put(String src, String dst,
SftpProgressMonitor monitor, int mode)
將本地文件名為src的文件上傳到目標服務器，目標文件名為dst，若dst為目錄，則目標文件名將與src文件名相同。
指定傳輸模式為mode
并使用實現了SftpProgressMonitor接口的monitor對象來監控文件傳輸的進度。
public void put(InputStream src, String dst)
將本地的input stream對象src上傳到目標服務器，目標文件名為dst，dst不能為目錄。
采用默認的傳輸模式：OVERWRITE
public void put(InputStream src, String dst, int mode)
將本地的input stream對象src上傳到目標服務器，目標文件名為dst，dst不能為目錄。
指定文件傳輸模式為mode
public void put(InputStream src, String dst, SftpProgressMonitor monitor)
將本地的input stream對象src上傳到目標服務器，目標文件名為dst，dst不能為目錄。
采用默認的傳輸模式：OVERWRITE
并使用實現了SftpProgressMonitor接口的monitor對象來監控傳輸的進度。
public void put(InputStream src, String dst,
SftpProgressMonitor monitor, int mode)
將本地的input stream對象src上傳到目標服務器，目標文件名為dst，dst不能為目錄。
指定文件傳輸模式為mode
并使用實現了SftpProgressMonitor接口的monitor對象來監控傳輸的進度。
public OutputStream put(String dst)
該方法返回一個輸出流，可以向該輸出流中寫入數據，最終將數據傳輸到目標服務器，目標文件名為dst，dst不能為目錄。
采用默認的傳輸模式：OVERWRITE
public OutputStream put(String dst, final int mode)
該方法返回一個輸出流，可以向該輸出流中寫入數據，最終將數據傳輸到目標服務器，目標文件名為dst，dst不能為目錄。
指定文件傳輸模式為mode
public OutputStream put(String dst, final SftpProgressMonitor monitor, final int mode)
該方法返回一個輸出流，可以向該輸出流中寫入數據，最終將數據傳輸到目標服務器，目標文件名為dst，dst不能為目錄。
指定文件傳輸模式為mode
并使用實現了SftpProgressMonitor接口的monitor對象來監控傳輸的進度。
public OutputStream put(String dst, final SftpProgressMonitor monitor, final int mode, long offset)
該方法返回一個輸出流，可以向該輸出流中寫入數據，最終將數據傳輸到目標服務器，目標文件名為dst，dst不能為目錄。
指定文件傳輸模式為mode
并使用實現了SftpProgressMonitor接口的monitor對象來監控傳輸的進度。
offset指定了一個偏移量，從輸出流偏移offset開始寫入數據。
應用實例：
SFTPTest.java
SFTPTest.java
packagecom.longyg.sftp;importjava.util.HashMap;importjava.util.Map;importcom.jcraft.jsch.ChannelSftp;public classSFTPTest {publicSFTPChannel getSFTPChannel() {return newSFTPChannel();
}/***@paramargs
*@throwsException*/
public static void main(String[] args) throwsException {
SFTPTest test= newSFTPTest();
Map sftpDetails = new HashMap();//設置主機ip，端口，用戶名，密碼
sftpDetails.put(SFTPConstants.SFTP_REQ_HOST, "10.9.167.55");
sftpDetails.put(SFTPConstants.SFTP_REQ_USERNAME,"root");
sftpDetails.put(SFTPConstants.SFTP_REQ_PASSWORD,"arthur");
sftpDetails.put(SFTPConstants.SFTP_REQ_PORT,"22");
String src= "D:\\DevSoft\\HB-SnagIt1001.rar"; //本地文件名
String dst = "/home/omc/ylong/sftp/HB-SnagIt1001.rar"; //目標文件名
SFTPChannel channel=test.getSFTPChannel();
ChannelSftp chSftp= channel.getChannel(sftpDetails, 60000);/*** 代碼段1
OutputStream out = chSftp.put(dst, ChannelSftp.OVERWRITE); // 使用OVERWRITE模式
byte[] buff = new byte[1024 * 256]; // 設定每次傳輸的數據塊大小為256KB
int read;
if (out != null) {
System.out.println("Start to read input stream");
InputStream is = new FileInputStream(src);
do {
read = is.read(buff, 0, buff.length);
if (read > 0) {
out.write(buff, 0, read);
}
out.flush();
} while (read >= 0);
System.out.println("input stream read done.");
}
**/chSftp.put(src, dst, ChannelSftp.OVERWRITE);//代碼段2//chSftp.put(new FileInputStream(src), dst, ChannelSftp.OVERWRITE);//代碼段3
chSftp.quit();
channel.closeChannel();
}
}
注：請分別將代碼段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接口類的定義為：
SftpProgressMonitor.java
packagecom.jcraft.jsch;public interfaceSftpProgressMonitor{public static final int PUT=0;public static final int GET=1;void init(int op, String src, String dest, longmax);boolean count(longcount);voidend();
}
init():當文件開始傳輸時，調用init方法。
count(): 當每次傳輸了一個數據塊后，調用count方法，count方法的參數為這一次傳輸的數據塊大小。
end():當傳輸結束時，調用end方法。
下面是一個簡單的實現：
MyProgressMonitor.java
MyProgressMonitor.java
packagecom.longyg.sftp;importcom.jcraft.jsch.SftpProgressMonitor;public class MyProgressMonitor implementsSftpProgressMonitor {private longtransfered;
@Overridepublic boolean count(longcount) {
transfered= transfered +count;
System.out.println("Currently transferred total size: " + transfered + " bytes");return true;
}
@Overridepublic voidend() {
System.out.println("Transferring done.");
}
@Overridepublic void init(int op, String src, String dest, longmax) {
System.out.println("Transferring begin.");
}
}
此時如果改變SFTPTest main方法里調用的put方法，即可實現監控傳輸進度：
SFTPTest.java
SFTPTest.java
packagecom.longyg.sftp;importjava.util.HashMap;importjava.util.Map;importcom.jcraft.jsch.ChannelSftp;public classSFTPTest {publicSFTPChannel getSFTPChannel() {return newSFTPChannel();
}/***@paramargs
*@throwsException*/
public static void main(String[] args) throwsException {
SFTPTest test= newSFTPTest();
Map sftpDetails = new HashMap();//設置主機ip，端口，用戶名，密碼
sftpDetails.put(SFTPConstants.SFTP_REQ_HOST, "10.9.167.55");
sftpDetails.put(SFTPConstants.SFTP_REQ_USERNAME,"root");
sftpDetails.put(SFTPConstants.SFTP_REQ_PASSWORD,"arthur");
sftpDetails.put(SFTPConstants.SFTP_REQ_PORT,"22");
String src= "D:\\DevSoft\\HB-SnagIt1001.rar"; //本地文件名
String dst = "/home/omc/ylong/sftp/HB-SnagIt1001.rar"; //目標文件名
SFTPChannel channel=test.getSFTPChannel();
ChannelSftp chSftp= channel.getChannel(sftpDetails, 60000);/*** 代碼段1
OutputStream out = chSftp.put(dst, new MyProgressMonitor(), ChannelSftp.OVERWRITE); // 使用OVERWRITE模式
byte[] buff = new byte[1024 * 256]; // 設定每次傳輸的數據塊大小為256KB
int read;
if (out != null) {
System.out.println("Start to read input stream");
InputStream is = new FileInputStream(src);
do {
read = is.read(buff, 0, buff.length);
if (read > 0) {
out.write(buff, 0, read);
}
out.flush();
} while (read >= 0);
System.out.println("input stream read done.");
}
**/chSftp.put(src, dst,new MyProgressMonitor(), ChannelSftp.OVERWRITE); //代碼段2//chSftp.put(new FileInputStream(src), dst, new MyProgressMonitor(), ChannelSftp.OVERWRITE);//代碼段3
chSftp.quit();
channel.closeChannel();
}
}
注意修改的內容僅僅是put方法，在put方法中增加了SftpProgressMonitor的實現類對象monitor作為參數，即添加了對進度監控的支持。
運行，輸出結果如下：
logs
Start to read input stream
Currently transferred total size:262144bytes
Currently transferred total size:524288bytes
Currently transferred total size:786432bytes
Currently transferred total size:1048576bytes
Currently transferred total size:1310720bytes
Currently transferred total size:1572864bytes
Currently transferred total size:1835008bytes
Currently transferred total size:2097152bytes
Currently transferred total size:2359296bytes
Currently transferred total size:2621440bytes
Currently transferred total size:2883584bytes
Currently transferred total size:3145728bytes
Currently transferred total size:3407872bytes
Currently transferred total size:3670016bytes
Currently transferred total size:3848374bytes
input stream read done.
當然這個SftpProgressMonitor的實現實在太簡單。JSch每次傳輸一個數據塊，就會調用count方法來實現主動進度通知。
現在我們希望每間隔一定的時間才獲取一下文件傳輸的進度。。。看看下面的SftpProgressMonitor實現：
FileProgressMonitor.java
packagecom.longyg.sftp;importjava.text.DecimalFormat;importjava.util.Timer;importjava.util.TimerTask;importcom.jcraft.jsch.SftpProgressMonitor;public class FileProgressMonitor extends TimerTask implementsSftpProgressMonitor {private long progressInterval = 5 * 1000; //默認間隔時間為5秒
private boolean isEnd = false; //記錄傳輸是否結束
private long transfered; //記錄已傳輸的數據總大小
private long fileSize; //記錄文件總大小
private Timer timer; //定時器對象
private boolean isScheduled = false; //記錄是否已啟動timer記時器
public FileProgressMonitor(longfileSize) {this.fileSize =fileSize;
}
@Overridepublic voidrun() {if (!isEnd()) { //判斷傳輸是否已結束
System.out.println("Transfering is in progress.");long transfered =getTransfered();if (transfered != fileSize) { //判斷當前已傳輸數據大小是否等于文件總大小
System.out.println("Current transfered: " + transfered + " bytes");
sendProgressMessage(transfered);
}else{
System.out.println("File transfering is done.");
setEnd(true); //如果當前已傳輸數據大小等于文件總大小，說明已完成，設置end
}
}else{
System.out.println("Transfering done. Cancel timer.");
stop();//如果傳輸結束，停止timer記時器
return;
}
}public voidstop() {
System.out.println("Try to stop progress monitor.");if (timer != null) {
timer.cancel();
timer.purge();
timer= null;
isScheduled= false;
}
System.out.println("Progress monitor stoped.");
}public voidstart() {
System.out.println("Try to start progress monitor.");if (timer == null) {
timer= newTimer();
}
timer.schedule(this, 1000, progressInterval);
isScheduled= true;
System.out.println("Progress monitor started.");
}/*** 打印progress信息
*@paramtransfered*/
private void sendProgressMessage(longtransfered) {if (fileSize != 0) {double d = ((double)transfered * 100)/(double)fileSize;
DecimalFormat df= new DecimalFormat( "#.##");
System.out.println("Sending progress message: " + df.format(d) + "%");
}else{
System.out.println("Sending progress message: " +transfered);
}
}/*** 實現了SftpProgressMonitor接口的count方法*/
public boolean count(longcount) {if (isEnd()) return false;if (!isScheduled) {
start();
}
add(count);return true;
}/*** 實現了SftpProgressMonitor接口的end方法*/
public voidend() {
setEnd(true);
System.out.println("transfering end.");
}private synchronized void add(longcount) {
transfered= transfered +count;
}private synchronized longgetTransfered() {returntransfered;
}public synchronized void setTransfered(longtransfered) {this.transfered =transfered;
}private synchronized void setEnd(booleanisEnd) {this.isEnd =isEnd;
}private synchronized booleanisEnd() {returnisEnd;
}public void init(int op, String src, String dest, longmax) {//Not used for putting InputStream
}
}
再次修改SFTPTest main方法里的put方法，改為使用新的SftpProgressMonitor的實現類對象monitor作為參數，注意新的monitor對象的構造函數需要傳入文件大小作為參數：
SFTPTest.java
packagecom.longyg.sftp;importjava.io.File;importjava.util.HashMap;importjava.util.Map;importcom.jcraft.jsch.ChannelSftp;public classSFTPTest {publicSFTPChannel getSFTPChannel() {return newSFTPChannel();
}/***@paramargs
*@throwsException*/
public static void main(String[] args) throwsException {
SFTPTest test= newSFTPTest();
Map sftpDetails = new HashMap();//設置主機ip，端口，用戶名，密碼
sftpDetails.put(SFTPConstants.SFTP_REQ_HOST, "10.9.167.55");
sftpDetails.put(SFTPConstants.SFTP_REQ_USERNAME,"root");
sftpDetails.put(SFTPConstants.SFTP_REQ_PASSWORD,"arthur");
sftpDetails.put(SFTPConstants.SFTP_REQ_PORT,"22");
String src= "D:\\DevSoft\\HB-SnagIt1001.rar"; //本地文件名
String dst = "/home/omc/ylong/sftp/HB-SnagIt1001.rar"; //目標文件名
SFTPChannel channel=test.getSFTPChannel();
ChannelSftp chSftp= channel.getChannel(sftpDetails, 60000);
File file= newFile(src);long fileSize =file.length();/*** 代碼段1
OutputStream out = chSftp.put(dst, new FileProgressMonitor(fileSize), ChannelSftp.OVERWRITE); // 使用OVERWRITE模式
byte[] buff = new byte[1024 * 256]; // 設定每次傳輸的數據塊大小為256KB
int read;
if (out != null) {
System.out.println("Start to read input stream");
InputStream is = new FileInputStream(src);
do {
read = is.read(buff, 0, buff.length);
if (read > 0) {
out.write(buff, 0, read);
}
out.flush();
} while (read >= 0);
System.out.println("input stream read done.");
}
**/chSftp.put(src, dst,new FileProgressMonitor(fileSize), ChannelSftp.OVERWRITE); //代碼段2//chSftp.put(new FileInputStream(src), dst, new FileProgressMonitor(fileSize), ChannelSftp.OVERWRITE);//代碼段3
chSftp.quit();
channel.closeChannel();
}
}
再次運行，結果輸出為：
logs
Try to start progress monitor.
Progress monitor started.
Transfering is in progress.
Current transfered: 98019 bytes
Sending progress message: 2.55%
Transfering is in progress.
Current transfered: 751479 bytes
Sending progress message: 19.53%
Transfering is in progress.
Current transfered: 1078209 bytes
Sending progress message: 28.02%
......
Transfering is in progress.
Current transfered: 3430665 bytes
Sending progress message: 89.15%
transfering end.
Transfering done. Cancel timer.
Try to stop progress monitor.
Progress monitor stoped.
現在，程序每隔5秒鐘才會打印一下進度信息。可以修改FileProgressMonitor類里的progressInterval變量的值，來修改默認的間隔時間。
總結
以上是生活随笔為你收集整理的channelsftp的put_JSch - Java实现的SFTP（文件上传详解篇）的全部內容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： python3实用编程技巧_6.pyth
- 下一篇： gradle idea java ssm