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();
    }
}

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

@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();
		}
	}

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