java项目利用jsch下载ftp文件

pom

1. <dependency>
2.     <groupId>com.jcraft</groupId>
3.     <artifactId>jsch</artifactId>
4.     <version>0.1.55</version>
5. </dependency>

复制代码

demo1：main方法直接下载

1. package com.example.controller;
3. import com.jcraft.jsch.*;
4. import java.io.File;
5. import java.io.InputStream;
6. import java.io.OutputStream;
8. public class JSchSFTPFileTransfer {
9.     public static void main(String[] args) {
10.         String host = "10.*.*.*";//服务器地址
11.         String user = "";//用户
12.         String password = "";//密码
13.         int port = 22;//端口
14.         String remoteFilePath = "/home/*/*/ps.xlsx";//拉取文件的路径
15.         String localFilePath = "C:\\Users\\*\\Downloads\\ps.xlsx";//下载到本地路径
16.         JSch jsch = new JSch();
17.         // 初始化对象
18.         Session session = null;
19.         ChannelSftp sftpChannel = null;
20.         InputStream inputStream = null;
21.         OutputStream outputStream = null;
22.         try {
23.             // 创建会话
24.             session = jsch.getSession(user, host, port);
25.             session.setConfig("StrictHostKeyChecking", "no");
26.             session.setPassword(password);
27.             session.connect();
28.             // 打开 SFTP 通道
29.             sftpChannel = (ChannelSftp) session.openChannel("sftp");
30.             sftpChannel.connect();
31.             //创建本地路径
32.             int lastSlashIndex = remoteFilePath.lastIndexOf("/");
33.             String path = remoteFilePath.substring(0, lastSlashIndex);
34.             File file = new File(path);
35.             if (!file.exists()) {
36.                 try {
37.                     file.mkdirs();
38.                 } catch (Exception e) {
39.                     System.out.println("=====jSchSFTPFileTransfer创建文件夹失败！====");
40.                 }
41.             }
42.             // 下载文件
43.             inputStream = sftpChannel.get(remoteFilePath);
44.             // 上传文件到本地
45.             outputStream = new java.io.FileOutputStream(localFilePath);
46.             byte[] buffer = new byte[1024];
47.             int bytesRead;
48.             while ((bytesRead = inputStream.read(buffer)) != -1) {
49.                 outputStream.write(buffer, 0, bytesRead);
50.             }
51.             System.out.println("=====jSchSFTPFileTransfer文件下载成功！===="+localFilePath);
52.         } catch (JSchException | SftpException | java.io.IOException e) {
53.             e.printStackTrace();
54.         } finally {
55.             // 关闭流、通道和会话
56.             if (inputStream != null) {
57.                 try {
58.                     inputStream.close();
59.                 } catch (java.io.IOException e) {
60.                     e.printStackTrace();
61.                 }
62.             }
63.             if (outputStream != null) {
64.                 try {
65.                     outputStream.close();
66.                 } catch (java.io.IOException e) {
67.                     e.printStackTrace();
68.                 }
69.             }
70.             if (sftpChannel != null && sftpChannel.isConnected()) {
71.                 sftpChannel.disconnect();
72.             }
73.             if (session != null && session.isConnected()) {
74.                 session.disconnect();
75.             }
76.         }
77.     }
78. }

复制代码

demo2：页面按钮调接口下载

后端

1. package com.example.controller;
3. import com.example.common.utils.SFTPUtil;
4. import com.jcraft.jsch.SftpException;
5. import org.springframework.http.ResponseEntity;
6. import org.springframework.http.HttpHeaders;
7. import org.springframework.http.MediaType;
8. import org.springframework.web.bind.annotation.GetMapping;
9. import org.springframework.web.bind.annotation.RestController;
10. @RestController
11. public class testController {
12.     @GetMapping(value = "/export")
13.     public ResponseEntity<byte[]> empController(String remotePath) throws Exception {
14. //        remotePath = "/home/fr/zycpzb/ps.xlsx";
15.         String host = "10.1.16.92";
16.         int port = 22;
17.         String userName = "fr";
18.         String password = "Lnbi#0Fr";
19.         SFTPUtil sftp = new SFTPUtil(userName, password, host, port);
20.         sftp.login();
21.         try {
22.             byte[] buff = sftp.download(remotePath);
23.             HttpHeaders headers = new HttpHeaders();
24.             headers.setContentType(MediaType.APPLICATION_OCTET_STREAM);
25.             headers.setContentDispositionFormData("attachment", "ps.xlsx");
26.             return ResponseEntity.ok().headers(headers).body(buff);
27.         } catch (SftpException e) {
28.             e.printStackTrace();
29.             return ResponseEntity.status(500).body(null);
30.         }finally {
31.             sftp.logout();
32.         }
33.     }
34. }

复制代码

SFTPUtil

1. package com.example.common.utils;
3. import java.io.File;
4. import java.io.FileNotFoundException;
5. import java.io.FileOutputStream;
6. import java.io.IOException;
7. import java.io.InputStream;
8. import java.util.*;
9. import com.jcraft.jsch.*;
10. import org.apache.commons.io.IOUtils;
11. import org.slf4j.Logger;
12. import org.slf4j.LoggerFactory;
13. /**
14. *
15. * @ClassName: SFTPUtil
16. * @Description: sftp连接工具类
17. * @version 1.0.0
18. */
19. public class SFTPUtil {
20.     private transient Logger log = LoggerFactory.getLogger(this.getClass());
21.     private ChannelSftp sftp;
22.     private Session session;
23.     /**
24.      * FTP 登录用户名
25.      */
26.     private String username;
27.     /**
28.      * FTP 登录密码
29.      */
30.     private String password;
31.     /**
32.      * 私钥
33.      */
34.     private String privateKey;
35.     /**
36.      * FTP 服务器地址IP地址
37.      */
38.     private String host;
39.     /**
40.      * FTP 端口
41.      */
42.     private int port;
44.     /**
45.      * 构造基于密码认证的sftp对象
46.      *
47.      * @param username
48.      * @param password
49.      * @param host
50.      * @param port
51.      */
52.     public SFTPUtil(String username, String password, String host, int port) {
53.         this.username = username;
54.         this.password = password;
55.         this.host = host;
56.         this.port = port;
57.     }
59.     /**
60.      * 构造基于秘钥认证的sftp对象
61.      *
62.      * @param username
63.      * @param host
64.      * @param port
65.      * @param privateKey
66.      */
67.     public SFTPUtil(String username, String host, int port, String privateKey) {
68.         this.username = username;
69.         this.host = host;
70.         this.port = port;
71.         this.privateKey = privateKey;
72.     }
74.     public SFTPUtil() {
75.     }
77.     /**
78.      * 连接sftp服务器
79.      *
80.      * @throws Exception
81.      */
82.     public void login() {
83.         try {
84.             JSch jsch = new JSch();
85.             if (privateKey != null) {
86.                 jsch.addIdentity(privateKey);// 设置私钥
87.                 log.info("sftp connect,path of private key file：{}", privateKey);
88.             }
89.             log.info("sftp connect by host:{} username:{}", host, username);
90.             session = jsch.getSession(username, host, port);
91.             log.info("Session is build");
92.             if (password != null) {
93.                 session.setPassword(password);
94.             }
95.             Properties config = new Properties();
96.             config.put("StrictHostKeyChecking", "no");
97.             session.setConfig(config);
98.             session.connect();
99.             log.info("Session is connected");
100.             Channel channel = session.openChannel("sftp");
101.             channel.connect();
102.             log.info("channel is connected");
103.             sftp = (ChannelSftp) channel;
104.             log.info(String.format("sftp server host:[%s] port:[%s] is connect successfull", host, port));
105.         } catch (JSchException e) {
106.             log.error("Cannot connect to specified sftp server : {}:{} \n Exception message is: {}", new Object[]{host, port, e.getMessage()});
107.         }
108.     }
110.     /**
111.      * 关闭连接 server
112.      */
113.     public void logout() {
114.         if (sftp != null) {
115.             if (sftp.isConnected()) {
116.                 sftp.disconnect();
117.                 log.info("sftp is closed already");
118.             }
119.         }
120.         if (session != null) {
121.             if (session.isConnected()) {
122.                 session.disconnect();
123.                 log.info("sshSession is closed already");
124.             }
125.         }
126.     }
127.     /**
128.      * 下载文件
129.      *
130.      * @param directory
131.      *            下载目录
132.      * @param downloadFile
133.      *            下载的文件
134.      * @param saveFile
135.      *            存在本地的路径
136.      * @throws SftpException
137.      * @throws FileNotFoundException
138.      * @throws Exception
139.      */
140.     public void download(String directory, String downloadFile, String saveFile) throws SftpException, FileNotFoundException{
141.         if (directory != null && !"".equals(directory)) {
142.             sftp.cd(directory);
143.         }
144.         File file = new File(saveFile);
145.         sftp.get(downloadFile, new FileOutputStream(file));
146.         log.info("file:{} is download successful" , downloadFile);
147.     }
148.     /**
149.      * 下载文件
150.      * @param directory 下载目录
151.      * @param downloadFile 下载的文件名
152.      * @return 字节数组
153.      * @throws SftpException
154.      * @throws IOException
155.      * @throws Exception
156.      */
157.     public byte[] download(String directory, String downloadFile) throws SftpException, IOException{
158.         if (directory != null && !"".equals(directory)) {
159.             sftp.cd(directory);
160.         }
161.         InputStream is = sftp.get(downloadFile);
162.         byte[] fileData = IOUtils.toByteArray(is);
163.         log.info("file:{} is download successful" , downloadFile);
164.         return fileData;
165.     }
166.     /**
167.      * 下载文件
168.      * @param directory 下载的文件名
169.      * @return 字节数组
170.      * @throws SftpException
171.      * @throws IOException
172.      * @throws Exception
173.      */
174.     public byte[] download(String directory) throws SftpException, IOException{
176.         InputStream is = sftp.get(directory);
177.         byte[] fileData = IOUtils.toByteArray(is);
178.         log.info("file:{} is download successful" , directory);
179.         is.close();
180.         return fileData;
181.     }
182. }

复制代码

前端jQuery

1. function downloadFile(filePath) {
2.     $.ajax({
3.         url: '/download',
4.         type: 'GET',
5.         data: { filePath: filePath },
6.         xhrFields: {
7.             responseType: 'blob'  // Important to handle binary data
8.         },
9.         success: function(data, status, xhr) {
10.             // Create a download link for the blob data
11.             var blob = new Blob([data], { type: xhr.getResponseHeader('Content-Type') });
12.             var link = document.createElement('a');
13.             link.href = window.URL.createObjectURL(blob);
14.             link.download = 'filename.ext'; // You can set the default file name here
15.             document.body.appendChild(link);
16.             link.click();
17.             document.body.removeChild(link);
18.         },
19.         error: function(xhr, status, error) {
20.             console.error('File download failed:', status, error);
21.         }
22.     });
23. }

复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。