SFTP工具类

SFTP工具类，结合前人的博客https://www.cnblogs.com/raphael5200/p/8663797.html与实际要求，所调整

import com.jcraft.jsch.*;
import com.zjhg.bank.exception.BusinessException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.*;
import java.util.Properties;
import java.util.Vector;

/**
 * @version 1.0.0
 * @ClassName: SFTPUtil
 * @Description: 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;

    /**
     * 初始目录
     */
    private String basePath;


    public static void main(String[] args) throws SftpException, IOException {

    }

    /**
     * 构造基于密码认证的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() {
        this.username = "root";
        this.password = "root";
        this.host = "127.0.0.1";
        this.port = 8899;
    }


    /**
     * 连接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) {
            log.error("sftp login fail :" + e.toString());
        }
    }

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


    /**
     * 将输入流的数据上传到sftp作为文件。文件完整路径=basePath+directory
     *
     * @param directory    上传到该目录
     * @param sftpFileName sftp端文件名,此方法已经进入具体上传的目录，此处sftpFileName不需要加目录路径
     */
    public void upload(String directory, String sftpFileName, InputStream input) throws SftpException {
        try {
            sftp.cd(basePath);
            sftp.cd(directory);
        } catch (SftpException e) {
            //目录不存在，则创建并进入文件夹
            String[] dirs = directory.split("/");
            for (String dir : dirs) {
                if (null == dir || "".equals(dir)) {
                    continue;
                }
                try {
                    //这里一定要一个一个目录的进，否则会报找不到文件目录
                    sftp.cd(dir);
                } catch (SftpException ex) {
                    // 2: no such file
                    // 4: Can't change directory
                    //当抛出找不到目录时异常，创建目录
                    if (ChannelSftp.SSH_FX_NO_SUCH_FILE == ex.id) {
                        log.info("----当前目录" + sftp.pwd() + "----创建目录" + dir);
                        sftp.mkdir(dir);
                        sftp.cd(dir);
                    } else {
                        throw new BusinessException(ex.getMessage());
                    }
                }
            }
        }
        log.info("最终上传的文件目录" + sftp.pwd());
        sftp.put(input, sftpFileName);  //上传文件

    }


    /**
     * 下载文件。
     *
     * @param directory    下载目录
     * @param downloadFile 下载的文件
     * @param saveFile     存在本地的路径
     */
    public void download(String directory, String downloadFile, String saveFile) {
        try {
            if (directory != null && !"".equals(directory)) {
                sftp.cd(basePath);
                sftp.cd(directory);
            }
            File file = new File(saveFile);
            if (!file.exists()) {
                file.mkdirs();
            }
            sftp.get(downloadFile, new FileOutputStream(file));
        } catch (SftpException e) {
            throw new BusinessException("download error :" + e.toString());
        } catch (FileNotFoundException e) {
            throw new BusinessException("download error :" + e.getMessage());
        }
    }

    /**
     * 下载文件
     *
     * @param directory    下载目录
     * @param downloadFile 下载的文件名
     * @return InputStream
     */
    public InputStream download(String directory, String downloadFile) {
        InputStream is = null;
        //有可能文件不存在，会报错，所以捕获异常同时返回空
        try {
            if (directory != null && !"".equals(directory)) {
                sftp.cd(directory);
                log.info(sftp.pwd());
            }
            is = sftp.get(downloadFile);
        } catch (SftpException e) {
            throw new BusinessException("download error :" + e.getMessage());
        }
        return is;
    }

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

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