java通過sftp上傳文件（含多級目錄創建）

轉載： https://blog.csdn.net/yhl_jxy/article/details/72633034

Linux操作系統我們經常使用ssh中的ftp,sftp連接服務器，做相應操作。

1、基於maven構建工程，pom.xml加入依賴。

<dependency>
            <groupId>com.jcraft</groupId>
            <artifactId>jsch</artifactId>
            <version>0.1.53</version>
        </dependency>

2、工具類，包含遞歸創建文件夾並采用main方法進行上傳測試，代碼如下

import com.jcraft.jsch.*;
import org.apache.commons.io.IOUtils;
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;

    // FTP 登錄用戶名
    private String userName;
    // FTP 登錄密碼
    private String password;
    // FTP 服務器地址IP地址
    private String host;
    // FTP 端口
    private int port;

    /**
     * 構造基於密碼認證的sftp對象
     *
     * @param userName
     * @param password
     * @param host
     * @param port
     */
    public SFTPUtil(String userName, String password, String host, int port) {
        this.userName = userName;
        this.password = password;
        this.host = host;
        this.port = port;
    }

    public SFTPUtil() {
    }

    /**
     * 連接sftp服務器
     *
     * @throws Exception
     */
    public void login() {
        try {
            JSch jsch = new JSch();
            log.info("sftp connect by host:{} username:{}", host, userName);

            session = jsch.getSession(userName, host, port);
            log.info("Session is build");
            if (password != null) {
                session.setPassword(password);
            }
            Properties config = new Properties();
            config.put("StrictHostKeyChecking", "no");

            session.setConfig(config);
            session.connect();
            log.info("Session is connected");

            Channel channel = session.openChannel("sftp");
            channel.connect();
            log.info("channel is connected");

            sftp = (ChannelSftp) channel;
            log.info(String.format("sftp server host:[%s] port:[%s] is connect successfull", host, port));
        } catch (JSchException e) {
            log.error("Cannot connect to specified sftp server : {}:{} \n Exception message is: {}", new Object[]{host, port, e.getMessage()});
        }
    }

    /**
     * 關閉連接 server
     */
    public void logout() {
        if (sftp != null) {
            if (sftp.isConnected()) {
                sftp.disconnect();
                log.info("sftp is closed already");
            }
        }
        if (session != null) {
            if (session.isConnected()) {
                session.disconnect();
                log.info("sshSession is closed already");
            }
        }
    }

    /**
     * 遞歸根據路徑創建文件夾
     *
     * @param dirs     根據 / 分隔后的數組文件夾名稱
     * @param tempPath 拼接路徑
     * @param length   文件夾的格式
     * @param index    數組下標
     * @return
     */
    public void mkdirDir(String[] dirs, String tempPath, int length, int index) {
        // 以"/a/b/c/d"為例按"/"分隔后,第0位是"";顧下標從1開始
        index++;
        if (index < length) {
            // 目錄不存在，則創建文件夾
            tempPath += "/" + dirs[index];
        }
        try {
            log.info("檢測目錄[" + tempPath + "]");
            sftp.cd(tempPath);
            if (index < length) {
                mkdirDir(dirs, tempPath, length, index);
            }
        } catch (SftpException ex) {
            log.warn("創建目錄[" + tempPath + "]");
            try {
                sftp.mkdir(tempPath);
                sftp.cd(tempPath);
            } catch (SftpException e) {
                e.printStackTrace();
                log.error("創建目錄[" + tempPath + "]失敗,異常信息[" + e.getMessage() + "]");

            }
            log.info("進入目錄[" + tempPath + "]");
            mkdirDir(dirs, tempPath, length, index);
        }
    }

    /**
     * 將輸入流的數據上傳到sftp作為文件（多層目錄）
     *
     * @param directory    上傳到該目錄(多層目錄)
     * @param sftpFileName sftp端文件名
     * @param input        輸入流
     * @throws SftpException
     * @throws Exception
     */
    public void uploadMore(String directory, String sftpFileName, InputStream input) throws SftpException {
        try {
            sftp.cd(directory);
        } catch (SftpException e) {
            // 目錄不存在，則創建文件夾
            String[] dirs = directory.split("/");
            String tempPath = "";
            int index = 0;
            mkdirDir(dirs, tempPath, dirs.length, index);
        }
        sftp.put(input, sftpFileName);// 上傳文件
    }

    /**
     * 將輸入流的數據上傳到sftp作為文件
     *
     * @param directory    上傳到該目錄(單層目錄)
     * @param sftpFileName sftp端文件名
     * @param input        輸入流
     * @throws SftpException
     * @throws Exception
     */
    public void upload(String directory, String sftpFileName, InputStream input) throws SftpException {
        try {
            sftp.cd(directory);
        } catch (SftpException e) {
            log.warn("directory is not exist");
            sftp.mkdir(directory);
            sftp.cd(directory);
        }
        sftp.put(input, sftpFileName);
        log.info("file:{} is upload successful", sftpFileName);
    }

    /**
     * 上傳單個文件
     *
     * @param directory  上傳到sftp目錄
     * @param uploadFile 要上傳的文件,包括路徑
     * @throws FileNotFoundException
     * @throws SftpException
     * @throws Exception
     */
    public void upload(String directory, String uploadFile) throws FileNotFoundException, SftpException {
        File file = new File(uploadFile);
        upload(directory, file.getName(), new FileInputStream(file));
    }

    /**
     * 將byte[]上傳到sftp，作為文件。注意:從String生成byte[]是，要指定字符集。
     *
     * @param directory    上傳到sftp目錄
     * @param sftpFileName 文件在sftp端的命名
     * @param byteArr      要上傳的字節數組
     * @throws SftpException
     * @throws Exception
     */
    public void upload(String directory, String sftpFileName, byte[] byteArr) throws SftpException {
        upload(directory, sftpFileName, new ByteArrayInputStream(byteArr));
    }

    /**
     * 將字符串按照指定的字符編碼上傳到sftp
     *
     * @param directory    上傳到sftp目錄
     * @param sftpFileName 文件在sftp端的命名
     * @param dataStr      待上傳的數據
     * @param charsetName  sftp上的文件，按該字符編碼保存
     * @throws UnsupportedEncodingException
     * @throws SftpException
     * @throws Exception
     */
    public void upload(String directory, String sftpFileName, String dataStr, String charsetName) throws UnsupportedEncodingException, SftpException {
        upload(directory, sftpFileName, new ByteArrayInputStream(dataStr.getBytes(charsetName)));
    }

    /**
     * 下載文件
     *
     * @param directory    下載目錄
     * @param downloadFile 下載的文件
     * @param saveFile     存在本地的路徑
     * @throws SftpException
     * @throws FileNotFoundException
     * @throws Exception
     */
    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));
        log.info("file:{} is download successful", downloadFile);
    }

    /**
     * 下載文件
     *
     * @param directory    下載目錄
     * @param downloadFile 下載的文件名
     * @return 字節數組
     * @throws SftpException
     * @throws IOException
     * @throws Exception
     */
    public byte[] download(String directory, String downloadFile) throws SftpException, IOException {
        if (directory != null && !"".equals(directory)) {
            sftp.cd(directory);
        }
        InputStream is = sftp.get(downloadFile);
        byte[] fileData = IOUtils.toByteArray(is);
        log.info("file:{} is download successful", downloadFile);
        return fileData;
    }

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

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

    public static void main(String[] args) throws SftpException, IOException {
        SFTPUtil sftp = new SFTPUtil("root", "111111", "192.168.1.124", 22);
        sftp.login();
        File file = new File("C:\\Users\\saq\\Desktop\\lt\\1.txt");
        InputStream is = new FileInputStream(file);
        // 多級目錄創建並上傳
        sftp.uploadMore("/a/b/c/d", "test_20200625.dat", is);
        sftp.logout();
    }
}