sftp方式下载、上传、删除_sftp下载

注意：在实际使用中，如果SFTP有中文名件名，部分LINUX系统会出现报错情况，找不到文件 No such file
// 可利用反射修改版本编号，从而可修改编码，解决中文文件名不能下载的问题
Class cl = ChannelSftp.class;
Field field = cl.getDeclaredField(“server_version”);
field.setAccessible(true);
field.set(sftp, 2);
sftp.setFilenameEncoding(“GBK”);

import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.Properties;
import java.util.Vector;

import org.apache.commons.io.IOUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.jcraft.jsch.Channel;
import com.jcraft.jsch.ChannelSftp;
import com.jcraft.jsch.JSch;
import com.jcraft.jsch.JSchException;
import com.jcraft.jsch.Session;
import com.jcraft.jsch.SftpException;
/**
 * 类说明 sftp工具类
 */
public class SFTPUtil {
    private transient Logger log = LoggerFactory.getLogger(this.getClass());

    private ChannelSftp sftp;

    private Session session;
    /** SFTP 登录用户名*/
    private String username;
    /** SFTP 登录密码*/
    private String password;
    /** 私钥 */
    private String privateKey;
    /** SFTP 服务器地址IP地址*/
    private String host;
    /** SFTP 端口*/
    private int port;

    /**
     * 构造基于密码认证的sftp对象
     */
    public SFTPUtil(String username, String password, String host, int port) {
        this.username = username;
        this.password = password;
        this.host = host;
        this.port = port;
    }

    /**
     * 构造基于秘钥认证的sftp对象
     */
    public SFTPUtil(String username, String host, int port, String privateKey) {
        this.username = username;
        this.host = host;
        this.port = port;
        this.privateKey = privateKey;
    }

    public SFTPUtil(){}

    /**
     * 连接sftp服务器
     */
    public void login(){
        try {
            JSch jsch = new JSch();
            if (privateKey != null) {
                jsch.addIdentity(privateKey);// 设置私钥
            }

            session = jsch.getSession(username, host, port);

            if (password != null) {
                session.setPassword(password);
            }
            Properties config = new Properties();
            config.put("StrictHostKeyChecking", "no");

            session.setConfig(config);
            session.connect();

            Channel channel = session.openChannel("sftp");
            channel.connect();

            sftp = (ChannelSftp) channel;
        } catch (JSchException e) {
            e.printStackTrace();
        }
    }

    /**
     * 关闭连接 server
     */
    public void logout(){
        if (sftp != null) {
            if (sftp.isConnected()) {
                sftp.disconnect();
            }
        }
        if (session != null) {
            if (session.isConnected()) {
                session.disconnect();
            }
        }
    }

    /**
     * 将输入流的数据上传到sftp作为文件。文件完整路径=basePath+directory
     * @param basePath  服务器的基础路径
     * @param directory  上传到该目录
     * @param sftpFileName  sftp端文件名
     * @param input  输入流
     */
    public void upload(String basePath,String directory, String sftpFileName, InputStream input) throws SftpException{
        try {
            sftp.cd(basePath);
            sftp.cd(directory);
        } catch (SftpException e) {
            //目录不存在，则创建文件夹
            String [] dirs=directory.split("/");
            String tempPath=basePath;
            for(String dir:dirs){
                if(null== dir || "".equals(dir)) continue;
                tempPath+="/"+dir;
                try{
                    sftp.cd(tempPath);
                }catch(SftpException ex){
                    sftp.mkdir(tempPath);
                    sftp.cd(tempPath);
                }
            }
        }
        sftp.put(input, sftpFileName);  //上传文件
    }

    /**
     * 下载文件。
     * @param directory 下载目录
     * @param downloadFile 下载的文件
     * @param saveFile 存在本地的路径
     */
    public void download(String directory, String downloadFile, String saveFile) throws SftpException, FileNotFoundException{
        if (directory != null && !"".equals(directory)) {
            sftp.cd(directory);
        }
        File file = new File(saveFile);
        sftp.get(downloadFile, new FileOutputStream(file));
    }

    /**
     * 下载文件
     * @param directory 下载目录
     * @param downloadFile 下载的文件名
     * @return 字节数组
     */
    public byte[] download(String directory, String downloadFile) throws SftpException, IOException{
        if (directory != null && !"".equals(directory)) {
            sftp.cd(directory);
        }
        InputStream is = null;
        try {
            is = sftp.get(downloadFile);
        } catch (Exception e) {
            log.error("SftpUtil download exceptin:------" + e.getMessage());
            if(e.getMessage().indexOf("No such file")>-1) {
               // 利用反射修改版本编号，从而可修改编码，解决中文文件名不能下载的问题
                Class cl = ChannelSftp.class;
                Field field = cl.getDeclaredField("server_version");
                field.setAccessible(true);
                field.set(sftp, 2);
                sftp.setFilenameEncoding("GBK");
                is = sftp.get(downloadFile);
            }
        }
        byte[] fileData = IOUtils.toByteArray(is);
        return fileData;
    }

    /**
     * 删除文件
     * @param directory 要删除文件所在目录
     * @param deleteFile 要删除的文件
     */
    public void delete(String directory, String deleteFile) throws SftpException{
        sftp.cd(directory);
        sftp.rm(deleteFile);
    }

    /**
     * 列出目录下的文件
     * @param directory 要列出的目录
     */
    public Vector<?> listFiles(String directory) throws SftpException {
        return sftp.ls(directory);
    }

    //上传文件测试
    public static void main(String[] args) throws SftpException, IOException {
//      SFTPUtil sftp = new SFTPUtil("用户名", "密码", "ip地址", 22);
        SFTPUtil sftp = new SFTPUtil("kingfu", "123456", "localhost", 2022);
        sftp.login();
        byte[] bytes = sftp.download("/","abc.txt");
        System.out.println(bytes.length);

        sftp.logout();
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208

------------------ 调用 ------------------

@RequestMapping("downloadSftp")
	@ResponseBody
	public void downloadSftp(HttpServletRequest request, HttpServletResponse response) throws Exception {
		ServletOutputStream fos = null;
		SFTPUtil sftp = null;
		try {
			String ftpUrl = PropertyUtil.getProperty("bossFtp.url");
			String ftpPath = PropertyUtil.getProperty("bossFtp.path");
			String ftpUsername = PropertyUtil.getProperty("bossFtp.username");
			String ftpPassword = PropertyUtil.getProperty("bossFtp.password");
			String ftpPort = PropertyUtil.getProperty("bossFtp.port");

			String name = request.getParameter("name");
			String fileName = request.getParameter("fileName");
			String type = new MimetypesFileTypeMap().getContentType(fileName);

			response.reset();
			response.setContentType("application/x-download");
			response.setCharacterEncoding("UTF-8");
			response.setHeader("Access-Control-Allow-Origin", "*");
			response.setContentType(type);			
			response.setHeader("Content-Disposition", "attachment;filename=\"" + URLEncoder.encode(name, "utf-8") + "\"");
			logger.debug("path----:"+ftpUrl+","+ftpPath+":"+ftpPort+","+ftpUsername+","+ftpPassword
					+",name:"+name+","+fileName+","+type);

			sftp = new SFTPUtil(ftpUsername, ftpPassword, ftpUrl, ftpPort);
			sftp.login();
			logger.info("路径文件数量：{}", sftp.listFiles(ftpPath).size() );
			byte[] buff = sftp.download(ftpPath, fileName);
			fos = response.getOutputStream();
			fos.write(buff);

		} catch (Exception e) {
			ByteArrayOutputStream baos = new ByteArrayOutputStream();
			e.printStackTrace(new PrintStream(baos));
			logger.error("downloadSftp exceptin:------" + baos.toString());
		} finally {
			fos.close();
			bos.close();
			sftp.logout();
		}
	}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

------------------ 前端 ------------------
window.location.href = url