本Sftp工具類的API如下所示。
1）構(gòu)造方法摘要
(String host, int port, int timeout, String username, String password)
參數(shù)：
host - SFTP服務(wù)器IP地址
port - SFTP服務(wù)器端口
timeout - 連接超時時間，單位毫秒
username - 用戶名
password - 密碼
2）方法摘要
boolean
(String pathName)
切換工作目錄
boolean()
切換到根目錄
boolean()
切換到上一級目錄
String()
當前工作目錄
boolean(String dirName)
刪除文件夾
boolean(String fileName)
刪除文件
boolean(String remotePath, String fileName,String localPath)
下載文件
boolean(String name)
當前目錄是否存在文件或文件夾
boolean(String path, String name)
指定目錄下，是否存在文件或文件夾
boolean(String name)
當前目錄是否存在文件夾
boolean(String path, String name)
指定目錄下，是否存在文件夾
boolean(String name)
當前目錄是否存在文件
boolean(String path, String name)
指定目錄下，是否存在文件
boolean()
登陸SFTP服務(wù)器
void()
登出
String[]()
當前目錄下文件及文件夾名稱列表
String[](String pathName)
指定目錄下文件及文件夾名稱列表
String[]()
當前目錄下文件夾名稱列表
String[](String pathName)
指定目錄下文件夾名稱列表
String[]()
當前目錄下文件名稱列表
String[](String pathName)
指定目錄下文件名稱列表
boolean(String dirName)
創(chuàng)建目錄
boolean(String pathName,String fileName,InputStream input)
上傳文件
boolean(String pathName, String fileName, String localFile)
上傳文件
3）源代碼
1 import java.io.File; 2 import java.io.InputStream; 3 import java.util.ArrayList; 4 import java.util.List; 5 import java.util.Properties; 6 import java.util.Vector; 7 import org.apache.log4j.Logger; 8 import com.jcraft.jsch.ChannelSftp; 9 import com.jcraft.jsch.JSch; 10 import com.jcraft.jsch.JSchException; 11 import com.jcraft.jsch.Session; 12 import com.jcraft.jsch.SftpException; 13 import com.jcraft.jsch.ChannelSftp.LsEntry; 14 15 /** 16 * SFTP(Secure File Transfer Protocol)，安全文件傳送協(xié)議。 17 * @version 1.0 2014/12/18 18 * @author dongliyang 19 */ 20 public class Sftp { 21 22 /** 日志記錄器 */ 23 private Logger logger = Logger.getLogger(Sftp.class); 24 /** Session */ 25 private Session session = null; 26 /** Channel */ 27 private ChannelSftp channel = null; 28 /** SFTP服務(wù)器IP地址 */ 29 private String host; 30 /** SFTP服務(wù)器端口 */ 31 private int port; 32 /** 連接超時時間，單位毫秒 */ 33 private int timeout; 34 35 /** 用戶名 */ 36 private String username; 37 /** 密碼 */ 38 private String password; 39 40 /** 41 * SFTP 安全文件傳送協(xié)議 42 * @param host SFTP服務(wù)器IP地址 43 * @param port SFTP服務(wù)器端口 44 * @param timeout 連接超時時間，單位毫秒 45 * @param username 用戶名 46 * @param password 密碼 47 */ 48 public Sftp(String host,int port,int timeout,String username,String password){ 49 this.host = host; 50 this.port = port; 51 this.timeout = timeout; 52 this.username = username; 53 this.password = password; 54 } 55 56 /** 57 * 登陸SFTP服務(wù)器 58 * @return boolean 59 */ 60 public boolean login() { 61 62 try { 63 JSch jsch = new JSch(); 64 session = jsch.getSession(username, host, port); 65 if(password != null){ 66 session.setPassword(password); 67 } 68 Properties config = new Properties(); 69 config.put("StrictHostKeyChecking", "no"); 70 session.setConfig(config); 71 session.setTimeout(timeout); 72 session.connect(); 73 logger.debug("sftp session connected"); 74 75 logger.debug("opening channel"); 76 channel = (ChannelSftp)session.openChannel("sftp"); 77 channel.connect(); 78 79 logger.debug("connected successfully"); 80 return true; 81 } catch (JSchException e) { 82 logger.error("sftp login failed",e); 83 return false; 84 } 85 } 86 87 /** 88 * 上傳文件 89 * <p> 90 * 使用示例，SFTP服務(wù)器上的目錄結(jié)構(gòu)如下：/testA/testA_B/ 91 * <table border="1"> 92 * <tr><td>當前目錄</td><td>方法</td><td>參數(shù)：絕對路徑/相對路徑</td><td>上傳后</td></tr> 93 * <tr><td>/</td><td>uploadFile("testA","upload.txt",new FileInputStream(new File("up.txt")))</td><td>相對路徑</td><td>/testA/upload.txt</td></tr> 94 * <tr><td>/</td><td>uploadFile("testA/testA_B","upload.txt",new FileInputStream(new File("up.txt")))</td><td>相對路徑</td><td>/testA/testA_B/upload.txt</td></tr> 95 * <tr><td>/</td><td>uploadFile("/testA/testA_B","upload.txt",new FileInputStream(new File("up.txt")))</td><td>絕對路徑</td><td>/testA/testA_B/upload.txt</td></tr> 96 * </table> 97 * </p> 98 * @param pathName SFTP服務(wù)器目錄 99 * @param fileName 服務(wù)器上保存的文件名100 * @param input 輸入文件流101 * @return boolean102 */103 public boolean uploadFile(String pathName,String fileName,InputStream input){104 105 String currentDir = currentDir();106 if(!changeDir(pathName)){107 return false;108 }109 110 try {111 channel.put(input,fileName,ChannelSftp.OVERWRITE);112 if(!existFile(fileName)){113 logger.debug("upload failed");114 return false;115 }116 logger.debug("upload successful");117 return true;118 } catch (SftpException e) {119 logger.error("upload failed",e);120 return false;121 } finally {122 changeDir(currentDir);123 }124 }125 126 /**127 * 上傳文件128 * <p>129 * 使用示例，SFTP服務(wù)器上的目錄結(jié)構(gòu)如下：/testA/testA_B/130 * <table border="1">131 * <tr><td>當前目錄</td><td>方法</td><td>參數(shù)：絕對路徑/相對路徑</td><td>上傳后</td></tr>132 * <tr><td>/</td><td>uploadFile("testA","upload.txt","up.txt")</td><td>相對路徑</td><td>/testA/upload.txt</td></tr>133 * <tr><td>/</td><td>uploadFile("testA/testA_B","upload.txt","up.txt")</td><td>相對路徑</td><td>/testA/testA_B/upload.txt</td></tr>134 * <tr><td>/</td><td>uploadFile("/testA/testA_B","upload.txt","up.txt")</td><td>絕對路徑</td><td>/testA/testA_B/upload.txt</td></tr>135 * </table>136 * </p>137 * @param pathName SFTP服務(wù)器目錄138 * @param fileName 服務(wù)器上保存的文件名139 * @param localFile 本地文件140 * @return boolean141 */142 public boolean uploadFile(String pathName,String fileName,String localFile){143 144 String currentDir = currentDir();145 if(!changeDir(pathName)){146 return false;147 }148 149 try {150 channel.put(localFile,fileName,ChannelSftp.OVERWRITE);151 if(!existFile(fileName)){152 logger.debug("upload failed");153 return false;154 }155 logger.debug("upload successful");156 return true;157 } catch (SftpException e) {158 logger.error("upload failed",e);159 return false;160 } finally {161 changeDir(currentDir);162 }163 }164 165 /**166 * 下載文件167 * <p>168 * 使用示例，SFTP服務(wù)器上的目錄結(jié)構(gòu)如下：/testA/testA_B/169 * <table border="1">170 * <tr><td>當前目錄</td><td>方法</td><td>參數(shù)：絕對路徑/相對路徑</td><td>下載后</td></tr>171 * <tr><td>/</td><td>downloadFile("testA","down.txt","D:\\downDir")</td><td>相對路徑</td><td>D:\\downDir\\down.txt</td></tr>172 * <tr><td>/</td><td>downloadFile("testA/testA_B","down.txt","D:\\downDir")</td><td>相對路徑</td><td>D:\\downDir\\down.txt</td></tr>173 * <tr><td>/</td><td>downloadFile("/testA/testA_B","down.txt","D:\\downDir")</td><td>絕對路徑</td><td>D:\\downDir\\down.txt</td></tr>174 * </table>175 * </p>176 * @param remotePath SFTP服務(wù)器目錄177 * @param fileName 服務(wù)器上需要下載的文件名178 * @param localPath 本地保存路徑179 * @return boolean180 */181 public boolean downloadFile(String remotePath,String fileName,String localPath){182 183 String currentDir = currentDir();184 if(!changeDir(remotePath)){185 return false;186 }187 188 try {189 String localFilePath = localPath + File.separator + fileName;190 channel.get(fileName,localFilePath);191 192 File localFile = new File(localFilePath);193 if(!localFile.exists()){194 logger.debug("download file failed");195 return false;196 }197 logger.debug("download successful");198 return true;199 } catch (SftpException e) {200 logger.error("download file failed",e);201 return false;202 } finally {203 changeDir(currentDir);204 }205 }206 207 /**208 * 切換工作目錄209 * <p>210 * 使用示例，SFTP服務(wù)器上的目錄結(jié)構(gòu)如下：/testA/testA_B/211 * <table border="1">212 * <tr><td>當前目錄</td><td>方法</td><td>參數(shù)(絕對路徑/相對路徑)</td><td>切換后的目錄</td></tr>213 * <tr><td>/</td><td>changeDir("testA")</td><td>相對路徑</td><td>/testA/</td></tr>214 * <tr><td>/</td><td>changeDir("testA/testA_B")</td><td>相對路徑</td><td>/testA/testA_B/</td></tr>215 * <tr><td>/</td><td>changeDir("/testA")</td><td>絕對路徑</td><td>/testA/</td></tr>216 * <tr><td>/testA/testA_B/</td><td>changeDir("/testA")</td><td>絕對路徑</td><td>/testA/</td></tr>217 * </table>218 * </p>219 * @param pathName 路徑220 * @return boolean221 */222 public boolean changeDir(String pathName){223 if(pathName == null || pathName.trim().equals("")){224 logger.debug("invalid pathName");225 return false;226 }227 228 try {229 channel.cd(pathName.replaceAll("\\\\", "/"));230 logger.debug("directory successfully changed,current dir=" + channel.pwd());231 return true;232 } catch (SftpException e) {233 logger.error("failed to change directory",e);234 return false;235 }236 }237 238 /**239 * 切換到上一級目錄240 * <p>241 * 使用示例，SFTP服務(wù)器上的目錄結(jié)構(gòu)如下：/testA/testA_B/242 * <table border="1">243 * <tr><td>當前目錄</td><td>方法</td><td>切換后的目錄</td></tr>244 * <tr><td>/testA/</td><td>changeToParentDir()</td><td>/</td></tr>245 * <tr><td>/testA/testA_B/</td><td>changeToParentDir()</td><td>/testA/</td></tr>246 * </table>247 * </p>248 * @return boolean249 */250 public boolean changeToParentDir(){251 return changeDir("..");252 }253 254 /**255 * 切換到根目錄256 * @return boolean257 */258 public boolean changeToHomeDir(){259 String homeDir = null;260 try {261 homeDir = channel.getHome();262 } catch (SftpException e) {263 logger.error("can not get home directory",e);264 return false;265 }266 return changeDir(homeDir);267 }268 269 /**270 * 創(chuàng)建目錄271 * <p>272 * 使用示例，SFTP服務(wù)器上的目錄結(jié)構(gòu)如下：/testA/testA_B/273 * <table border="1">274 * <tr><td>當前目錄</td><td>方法</td><td>參數(shù)(絕對路徑/相對路徑)</td><td>創(chuàng)建成功后的目錄</td></tr>275 * <tr><td>/testA/testA_B/</td><td>makeDir("testA_B_C")</td><td>相對路徑</td><td>/testA/testA_B/testA_B_C/</td></tr>276 * <tr><td>/</td><td>makeDir("/testA/testA_B/testA_B_D")</td><td>絕對路徑</td><td>/testA/testA_B/testA_B_D/</td></tr>277 * </table>278 * <br/>279 * <b>注意</b>，當<b>中間目錄不存在</b>的情況下，不能夠使用絕對路徑的方式期望創(chuàng)建中間目錄及目標目錄。280 * 例如makeDir("/testNOEXIST1/testNOEXIST2/testNOEXIST3")，這是錯誤的。281 * </p>282 * @param dirName 目錄283 * @return boolean284 */285 public boolean makeDir(String dirName){286 try {287 channel.mkdir(dirName);288 logger.debug("directory successfully created,dir=" + dirName);289 return true;290 } catch (SftpException e) {291 logger.error("failed to create directory", e);292 return false;293 }294 }295 296 /**297 * 刪除文件夾298 * @param dirName299 * @return boolean300 */301 @SuppressWarnings("unchecked")302 public boolean delDir(String dirName){303 if(!changeDir(dirName)){304 return false;305 }306 307 Vector<LsEntry> list = null;308 try {309 list = channel.ls(channel.pwd());310 } catch (SftpException e) {311 logger.error("can not list directory",e);312 return false;313 }314 315 for(LsEntry entry : list){316 String fileName = entry.getFilename();317 if(!fileName.equals(".") && !fileName.equals("..")){318 if(entry.getAttrs().isDir()){319 delDir(fileName);320 } else {321 delFile(fileName);322 }323 }324 }325 326 if(!changeToParentDir()){327 return false;328 }329 330 try {331 channel.rmdir(dirName);332 logger.debug("directory " + dirName + " successfully deleted");333 return true;334 } catch (SftpException e) {335 logger.error("failed to delete directory " + dirName,e);336 return false;337 }338 }339 340 /**341 * 刪除文件342 * @param fileName 文件名343 * @return boolean344 */345 public boolean delFile(String fileName){346 if(fileName == null || fileName.trim().equals("")){347 logger.debug("invalid filename");348 return false;349 }350 351 try {352 channel.rm(fileName);353 logger.debug("file " + fileName + " successfully deleted");354 return true;355 } catch (SftpException e) {356 logger.error("failed to delete file " + fileName,e);357 return false;358 }359 }360361 /**362 * 當前目錄下文件及文件夾名稱列表363 * @return String[]364 */365 public String[] ls(){366 return list(Filter.ALL);367 }368 369 /**370 * 指定目錄下文件及文件夾名稱列表371 * @return String[]372 */373 public String[] ls(String pathName){374 String currentDir = currentDir();375 if(!changeDir(pathName)){376 return new String[0];377 };378 String[] result = list(Filter.ALL);379 if(!changeDir(currentDir)){380 return new String[0];381 }382 return result;383 }384 385 /**386 * 當前目錄下文件名稱列表387 * @return String[]388 */389 public String[] lsFiles(){390 return list(Filter.FILE);391 }392 393 /**394 * 指定目錄下文件名稱列表395 * @return String[]396 */397 public String[] lsFiles(String pathName){398 String currentDir = currentDir();399 if(!changeDir(pathName)){400 return new String[0];401 };402 String[] result = list(Filter.FILE);403 if(!changeDir(currentDir)){404 return new String[0];405 }406 return result;407 }408 409 /**410 * 當前目錄下文件夾名稱列表411 * @return String[]412 */413 public String[] lsDirs(){414 return list(Filter.DIR);415 }416 417 /**418 * 指定目錄下文件夾名稱列表419 * @return String[]420 */421 public String[] lsDirs(String pathName){422 String currentDir = currentDir();423 if(!changeDir(pathName)){424 return new String[0];425 };426 String[] result = list(Filter.DIR);427 if(!changeDir(currentDir)){428 return new String[0];429 }430 return result;431 }432 433 /**434 * 當前目錄是否存在文件或文件夾435 * @param name 名稱436 * @return boolean437 */438 public boolean exist(String name){439 return exist(ls(), name);440 }441 442 /**443 * 指定目錄下，是否存在文件或文件夾444 * @param path 目錄445 * @param name 名稱446 * @return boolean447 */448 public boolean exist(String path,String name){449 return exist(ls(path),name);450 }451 452 /**453 * 當前目錄是否存在文件454 * @param name 文件名455 * @return boolean456 */457 public boolean existFile(String name){458 return exist(lsFiles(),name);459 }460 461 /**462 * 指定目錄下，是否存在文件463 * @param path 目錄464 * @param name 文件名465 * @return boolean466 */467 public boolean existFile(String path,String name){468 return exist(lsFiles(path), name);469 }470 471 /**472 * 當前目錄是否存在文件夾473 * @param name 文件夾名稱474 * @return boolean475 */476 public boolean existDir(String name){477 return exist(lsDirs(), name);478 }479 480 /**481 * 指定目錄下，是否存在文件夾482 * @param path 目錄483 * @param name 文家夾名稱484 * @return boolean485 */486 public boolean existDir(String path,String name){487 return exist(lsDirs(path), name);488 }489 490 /**491 * 當前工作目錄492 * @return String493 */494 public String currentDir(){495 try {496 return channel.pwd();497 } catch (SftpException e) {498 logger.error("failed to get current dir",e);499 return homeDir();500 }501 }502 503 /**504 * 登出505 */506 public void logout(){507 if(channel != null){508 channel.quit();509 channel.disconnect();510 }511 if(session != null){512 session.disconnect();513 }514 logger.debug("logout successfully");515 }516 517 518 //------private method ------519 520 /** 枚舉，用于過濾文件和文件夾 */521 private enum Filter {/** 文件及文件夾 */ ALL ,/** 文件 */ FILE ,/** 文件夾 */ DIR };522 523 /**524 * 列出當前目錄下的文件及文件夾525 * @param filter 過濾參數(shù)526 * @return String[] 527 */528 @SuppressWarnings("unchecked")529 private String[] list(Filter filter){530 Vector<LsEntry> list = null;531 try {532 //ls方法會返回兩個特殊的目錄，當前目錄(.)和父目錄(..)533 list = channel.ls(channel.pwd());534 } catch (SftpException e) {535 logger.error("can not list directory",e);536 return new String[0];537 }538 539 List<String> resultList = new ArrayList<String>();540 for(LsEntry entry : list){541 if(filter(entry, filter)){542 resultList.add(entry.getFilename());543 }544 }545 return resultList.toArray(new String[0]);546 }547 548 /**549 * 判斷是否是否過濾條件550 * @param entry LsEntry551 * @param f 過濾參數(shù)552 * @return boolean553 */554 private boolean filter(LsEntry entry,Filter f){555 if(f.equals(Filter.ALL)){556 return !entry.getFilename().equals(".") && !entry.getFilename().equals("..");557 } else if(f.equals(Filter.FILE)){558 return !entry.getFilename().equals(".") && !entry.getFilename().equals("..") && !entry.getAttrs().isDir();559 } else if(f.equals(Filter.DIR)){560 return !entry.getFilename().equals(".") && !entry.getFilename().equals("..") && entry.getAttrs().isDir();561 }562 return false;563 }564 565 /**566 * 根目錄567 * @return String568 */569 private String homeDir(){570 try {571 return channel.getHome();572 } catch (SftpException e) {573 return "/";574 }575 }576 577 /**578 * 判斷字符串是否存在于數(shù)組中579 * @param strArr 字符串數(shù)組580 * @param str 字符串581 * @return boolean582 */583 private boolean exist(String[] strArr,String str){584 if(strArr == null || strArr.length == 0){585 return false;586 }587 if(str == null || str.trim().equals("")){588 return false;589 }590 for(String s : strArr){591 if(s.equalsIgnoreCase(str)){592 return true;593 }594 }595 return false;596 }597 598 599 //------private method ------600 }
4）測試類
1 import java.io.FileInputStream; 2 import java.io.FileNotFoundException; 3 import java.util.Arrays; 4 5 public class SftpTest { 6 public static void main(String[] args) { 7 // testLogin(); 8 // testMakeDir(); 9 // testDelFile(); 10 // testDelEmptyDir(); 11 // testDir(); 12 // testLs(); 13 // testParamLs(); 14 // testChangeDir(); 15 // testExist(); 16 // testParamExist(); 17 // testUploadFile(); 18 // testUploadFile2(); 19 // testDownload(); 20 } 21 22 public static void testLogin(){ //OK 23 Sftp sftp = getSftp(); 24 25 sftp.login(); 26 sftp.logout(); 27 } 28 29 public static void testMakeDir(){ //OK 30 Sftp sftp = getSftp(); 31 sftp.login(); 32 sftp.makeDir("test2"); 33 sftp.changeDir("test2"); 34 sftp.makeDir("/test2/test2_1"); 35 sftp.logout(); 36 } 37 38 public static void testDelFile(){ //OK 39 Sftp sftp = getSftp(); 40 sftp.login(); 41 sftp.delFile("file1.txt"); 42 sftp.logout(); 43 } 44 45 public static void testDelEmptyDir(){ //OK 46 Sftp sftp = getSftp(); 47 sftp.login(); 48 sftp.delDir("test3"); 49 sftp.logout(); 50 } 51 52 public static void testDir(){ //OK 53 Sftp sftp = getSftp(); 54 sftp.login(); 55 sftp.delDir("test4"); 56 sftp.logout(); 57 } 58 59 public static void testLs(){ //OK 60 Sftp sftp = getSftp(); 61 sftp.login(); 62 System.out.println(Arrays.toString(sftp.ls())); 63 System.out.println(Arrays.toString(sftp.lsFiles())); 64 System.out.println(Arrays.toString(sftp.lsDirs())); 65 sftp.logout(); 66 } 67 68 public static void testParamLs(){ //OK 69 Sftp sftp = getSftp(); 70 sftp.login(); 71 System.out.println(Arrays.toString(sftp.ls("test1/test4"))); 72 System.out.println(Arrays.toString(sftp.lsFiles("test1/test4"))); 73 System.out.println(Arrays.toString(sftp.lsDirs("test1/test4"))); 74 sftp.logout(); 75 } 76 77 public static void testChangeDir(){ //OK 78 Sftp sftp = getSftp(); 79 sftp.login(); 80 sftp.changeDir("test1"); 81 sftp.changeDir("/test1/test4"); 82 sftp.changeToParentDir(); 83 sftp.changeToHomeDir(); 84 sftp.logout(); 85 } 86 87 public static void testExist(){ //OK 88 Sftp sftp = getSftp(); 89 sftp.login(); 90 System.out.println(sftp.exist("2fs.docx")); 91 System.out.println(sftp.exist("test1")); 92 System.out.println(sftp.existDir("test2")); 93 System.out.println(sftp.existDir("2sfs.txt")); 94 System.out.println(sftp.existFile("2sfs.txt")); 95 System.out.println(sftp.existFile("test2")); 96 sftp.logout(); 97 } 98 99 public static void testParamExist(){ //OK100 Sftp sftp = getSftp();101 sftp.login();102 System.out.println(sftp.exist("test1","test4"));103 System.out.println(sftp.exist("test1","test_bak.jpg"));104 System.out.println(sftp.existDir("/test1","test3"));105 System.out.println(sftp.existDir("/test1","test_bak.jpg"));106 System.out.println(sftp.existFile("test1","test_bak.jpg"));107 System.out.println(sftp.existFile("test1","test2"));108 sftp.logout();109 }110 111 112 public static void testUploadFile(){ //OK113 Sftp sftp = getSftp();114 sftp.login();115 sftp.uploadFile("/test1/test3", "test_bak2.jpg", "D:\\test.jpg");116 try {117 sftp.uploadFile("/test1/test2", "test_bak3.jpg", new FileInputStream("D:\\test.jpg"));118 } catch (FileNotFoundException e) {119 e.printStackTrace();120 }121 sftp.logout();122 }123 124 public static void testUploadFile2(){ //OK125 Sftp sftp = getSftp();126 sftp.login();127 sftp.uploadFile("test1/test3", "test_bak2.jpg", "D:\\test.jpg");128 try {129 sftp.uploadFile("test1/test2", "test_bak3.jpg", new FileInputStream("D:\\test.jpg"));130 } catch (FileNotFoundException e) {131 e.printStackTrace();132 }133 sftp.logout();134 }135 136 public static void testDownload(){ //OK137 Sftp sftp = getSftp();138 sftp.login();139 sftp.downloadFile("test1", "test_bak.jpg", "D:\\testdown");140 sftp.downloadFile("/", "2fs.docx", "D:\\testdown");141 sftp.logout();142 }143 144 private static Sftp getSftp(){145 146 String host = "192.168.10.252";147 int port = 22;148 int timeout = 60000;149 String username = "dongliyang";150 String password = "dongliyang";151 152 Sftp sftp = new Sftp(host, port, timeout, username, password);153 154 return sftp;155 }156 }
