Java 使用sftp 进行上传下载文件
基于JSch的Sftp工具类
本Sftp工具类的API如下所示。
1）构造方法摘要
|
参数：
|
2）方法摘要
boolean |
changeDir(String pathName) 切换工作目录 |
| boolean | changeToHomeDir() 切换到根目录 |
| boolean | changeToParentDir() 切换到上一级目录 |
| String | currentDir() 当前工作目录 |
| boolean | delDir(String dirName) 删除文件夹 |
| boolean | delFile(String fileName) 删除文件 |
| boolean | downloadFile(String remotePath, String fileName,String localPath) 下载文件 |
| boolean | exist(String name) 当前目录是否存在文件或文件夹 |
| boolean | exist(String path, String name) 指定目录下，是否存在文件或文件夹 |
| boolean | existDir(String name) 当前目录是否存在文件夹 |
| boolean | existDir(String path, String name) 指定目录下，是否存在文件夹 |
| boolean | existFile(String name) 当前目录是否存在文件 |
| boolean | existFile(String path, String name) 指定目录下，是否存在文件 |
| boolean | login() 登陆SFTP服务器 |
| void | logout() 登出 |
| String[] | ls() 当前目录下文件及文件夹名称列表 |
| String[] | ls(String pathName) 指定目录下文件及文件夹名称列表 |
| String[] | lsDirs() 当前目录下文件夹名称列表 |
| String[] | lsDirs(String pathName) 指定目录下文件夹名称列表 |
| String[] | lsFiles() 当前目录下文件名称列表 |
| String[] | lsFiles(String pathName) 指定目录下文件名称列表 |
boolean |
makeDir(String dirName) 创建目录 |
| boolean | uploadFile(String pathName,String fileName,InputStream input) 上传文件 |
| boolean | uploadFile(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)，安全文件传送协议。
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服务器IP地址 */
29 private String host;
30 /** SFTP服务器端口 */
31 private int port;
32 /** 连接超时时间，单位毫秒 */
33 private int timeout;
34
35 /** 用户名 */
36 private String username;
37 /** 密码 */
38 private String password;
39
40 /**
41 * SFTP 安全文件传送协议
42 * @param host SFTP服务器IP地址
43 * @param port SFTP服务器端口
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服务器
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 *
90 * 使用示例，SFTP服务器上的目录结构如下：/testA/testA_B/
91 *
| 当前目录 | 方法 | 参数：绝对路径/相对路径 | 上传后 |
| / | uploadFile("testA","upload.txt",new FileInputStream(new File("up.txt"))) | 相对路径 | /testA/upload.txt |
| / | uploadFile("testA/testA_B","upload.txt",new FileInputStream(new File("up.txt"))) | 相对路径 | /testA/testA_B/upload.txt |
| / | uploadFile("/testA/testA_B","upload.txt",new FileInputStream(new File("up.txt"))) | 绝对路径 | /testA/testA_B/upload.txt |
129 * 使用示例，SFTP服务器上的目录结构如下：/testA/testA_B/ 130 *
| 当前目录 | 方法 | 参数：绝对路径/相对路径 | 上传后 |
| / | uploadFile("testA","upload.txt","up.txt") | 相对路径 | /testA/upload.txt |
| / | uploadFile("testA/testA_B","upload.txt","up.txt") | 相对路径 | /testA/testA_B/upload.txt |
| / | uploadFile("/testA/testA_B","upload.txt","up.txt") | 绝对路径 | /testA/testA_B/upload.txt |
168 * 使用示例，SFTP服务器上的目录结构如下：/testA/testA_B/ 169 *
| 当前目录 | 方法 | 参数：绝对路径/相对路径 | 下载后 |
| / | downloadFile("testA","down.txt","D:\\downDir") | 相对路径 | D:\\downDir\\down.txt |
| / | downloadFile("testA/testA_B","down.txt","D:\\downDir") | 相对路径 | D:\\downDir\\down.txt |
| / | downloadFile("/testA/testA_B","down.txt","D:\\downDir") | 绝对路径 | D:\\downDir\\down.txt |
210 * 使用示例，SFTP服务器上的目录结构如下：/testA/testA_B/ 211 *
| 当前目录 | 方法 | 参数(绝对路径/相对路径) | 切换后的目录 |
| / | changeDir("testA") | 相对路径 | /testA/ |
| / | changeDir("testA/testA_B") | 相对路径 | /testA/testA_B/ |
| / | changeDir("/testA") | 绝对路径 | /testA/ |
| /testA/testA_B/ | changeDir("/testA") | 绝对路径 | /testA/ |
241 * 使用示例，SFTP服务器上的目录结构如下：/testA/testA_B/ 242 *
| 当前目录 | 方法 | 切换后的目录 |
| /testA/ | changeToParentDir() | / |
| /testA/testA_B/ | changeToParentDir() | /testA/ |
272 * 使用示例，SFTP服务器上的目录结构如下：/testA/testA_B/ 273 *
| 当前目录 | 方法 | 参数(绝对路径/相对路径) | 创建成功后的目录 |
| /testA/testA_B/ | makeDir("testA_B_C") | 相对路径 | /testA/testA_B/testA_B_C/ |
| / | makeDir("/testA/testA_B/testA_B_D") | 绝对路径 | /testA/testA_B/testA_B_D/ |
279 * 注意，当中间目录不存在的情况下，不能够使用绝对路径的方式期望创建中间目录及目标目录。 280 * 例如makeDir("/testNOEXIST1/testNOEXIST2/testNOEXIST3")，这是错误的。 281 * 282 * @param dirName 目录 283 * @return boolean 284 */ 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 dirName 299 * @return boolean 300 */ 301 @SuppressWarnings("unchecked") 302 public boolean delDir(String dirName){ 303 if(!changeDir(dirName)){ 304 return false; 305 } 306 307 Vector
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(){ //OK
100 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(){ //OK
113 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(){ //OK
125 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(){ //OK
137 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 }
参考自 https://www.cnblogs.com/dongliyang/p/4173583.html