SFTP上传下载

SFTP实现文件上传/下载功能
maven依赖:
    com.jcraft 0.1.55
    commons-io 2.6

文件传输协议: FTP、SFTP和SCP

package com.example.demo.ftp;

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;

/**
 * @Author: Andy.han
 * @Description: SFTPUtils {
 * <dependency>
 * <groupId>com.jcraft</groupId>
 * <artifactId>jsch</artifactId>
 * <version>0.1.55</version>
 * </dependency>
 * <dependency>
 * <groupId>commons-io</groupId>
 * <artifactId>commons-io</artifactId>
 * <version>2.6</version>
 * </dependency>
 * }
 * @Date: Created in 13:45 2019/5/30.
 * @Modified By:
 */

public class SFTPUtils {
    private transient Logger log = LoggerFactory.getLogger(this.getClass());

    private String logId;

    private ChannelSftp sftp;

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

    /**
     * @param username
     * @param password
     * @param host
     * @param port
     * @param logId
     * @Author: Andy.han
     * @Description: 构造基于密码认证的sftp对象
     * @Return: SFTPUtils
     * @Date: 2019/5/30 13:54
     */
    public SFTPUtils(String username, String password, String host, int port, String logId) {
        this.username = username;
        this.password = password;
        this.host = host;
        this.port = port;
        this.logId = logId;
    }

    /**
     * @param username
     * @param host
     * @param port
     * @param privateKey
     * @param logId
     * @Author: Andy.han
     * @Description: 构造基于秘钥认证的sftp对象
     * @Return: SFTPUtils
     * @Date: 2019/5/30 13:55
     */
    public SFTPUtils(String username, String host, int port, String privateKey, String logId) {
        this.username = username;
        this.host = host;
        this.port = port;
        this.privateKey = privateKey;
        this.logId = logId;
    }

    public SFTPUtils() {
    }

    /**
     * @param
     * @Author: Andy.han
     * @Description: 连接sftp服务器
     * @Return: void
     * @Date: 2019/5/30 13:56
     */
    public void login() {
        try {
            JSch jsch = new JSch();
            if (privateKey != null) {
                jsch.addIdentity(privateKey);// 设置私钥
                log.info("sftp connect,path of private key file:{}, logId:{}", privateKey, logId);
            }
            log.info("sftp connect by host:{} username:{}, logId:{}", host, username, logId);
            session = jsch.getSession(username, host, port);
            log.info("Session is build, logId:{}", logId);
            if (password != null) {
                session.setPassword(password);
            }
            Properties config = new Properties();
            config.put("StrictHostKeyChecking", "no");
            session.setConfig(config);
            session.connect();
            log.info("Session is connected, logId:{}", logId);
            Channel channel = session.openChannel("sftp");
            channel.connect();
            log.info("channel is connected, logId:{}", logId);
            sftp = (ChannelSftp) channel;
            log.info(String.format("sftp server host:[%s] port:[%s] is connect successfull, logId:{}", host, port, logId));
        } catch (JSchException e) {
            log.error("Cannot connect to specified sftp server : {}:{} \n Exception message is: {} logId: {}", new Object[]{host, port, e.getMessage(), logId});
        }
    }

    /**
     * @param
     * @Author: Andy.han
     * @Description: 关闭连接 server
     * @Return: void
     * @Date: 2019/5/30 13:58
     */
    public void logout() {
        if (sftp != null) {
            if (sftp.isConnected()) {
                sftp.disconnect();
                log.info("sftp is closed already, logId:{}", logId);
            }
        }
        if (session != null) {
            if (session.isConnected()) {
                session.disconnect();
                log.info("sshSession is closed already, logId:{}", logId);
            }
        }
    }

    /**
     * @param directory    上传到该目录
     * @param sftpFileName sftp端文件名
     * @param input        输入流
     * @Author: Andy.han
     * @Description: 将输入流的数据上传到sftp作为文件
     * @Return: void
     * @Date: 2019/5/30 13:58
     */
    public void upload(String directory, String sftpFileName, InputStream input) throws SftpException {
        try {
            sftp.cd(directory);
        } catch (SftpException e) {
            log.warn("directory is not exist, logId:{}", logId);
            sftp.mkdir(directory);
            sftp.cd(directory);
        }
        sftp.put(input, sftpFileName);
        log.info("file:{} is upload successful, logId:{}", sftpFileName, logId);
    }

    /**
     * @param directory  上传到sftp目录
     * @param uploadFile 要上传的文件,包括路径
     * @throws FileNotFoundException
     * @throws SftpException
     * @Author: Andy.han
     * @Description: 上传单个文件
     * @Return: void
     * @Date: 2019/5/30 13:59
     */
    public void upload(String directory, String uploadFile, String fileName) throws FileNotFoundException, SftpException {
        File file = new File(uploadFile);
        upload(directory, fileName, new FileInputStream(file));
    }

    /**
     * @param directory    上传到sftp目录
     * @param sftpFileName 文件在sftp端的命名
     * @param byteArr      要上传的字节数组
     * @throws SftpException
     * @Author: Andy.han
     * @Description: 将byte[]上传到sftp,作为文件。注意:从String生成byte[]是,要指定字符集。
     * @Return: void
     * @Date: 2019/5/30 14:02
     */
    public void upload(String directory, String sftpFileName, byte[] byteArr) throws SftpException {
        upload(directory, sftpFileName, new ByteArrayInputStream(byteArr));
    }

    /**
     * @param directory    上传到sftp目录
     * @param sftpFileName 文件在sftp端的命名
     * @param dataStr      待上传的数据
     * @param charsetName  sftp上的文件,按该字符编码保存
     * @throws UnsupportedEncodingException
     * @throws SftpException
     * @Author: Andy.han
     * @Description: 将字符串按照指定的字符编码上传到sftp
     * @Return: void
     * @Date: 2019/5/30 14:03
     */
    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
     * @Author: Andy.han
     * @Description: 下载文件
     * @Return: void
     * @Date: 2019/5/30 14:05
     */
    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, logId:{}", downloadFile, logId);
    }

    /**
     * @param directory    下载目录
     * @param downloadFile 下载的文件名
     * @throws SftpException
     * @throws IOException
     * @Author: Andy.han
     * @Description: 下载文件
     * @Return: byte[]
     * @Date: 2019/5/30 14:06
     */
    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, logId:{}", downloadFile, logId);
        return fileData;
    }

    /**
     * @param directory  要删除文件所在目录
     * @param deleteFile 要删除的文件
     * @throws SftpException
     * @Author: Andy.han
     * @Description: 删除文件
     * @Return: void
     * @Date: 2019/5/30 14:07
     */
    public void delete(String directory, String deleteFile) throws SftpException {
        sftp.cd(directory);
        sftp.rm(deleteFile);
    }

    /**
     * @param directory
     * @throws SftpException
     * @Author: Andy.han
     * @Description: 列出目录下的文件
     * @Return: Vector<?>
     * @Date: 2019/5/30 14:08
     */
    public Vector<?> listFiles(String directory) throws SftpException {
        return sftp.ls(directory);
    }

    public static void main(String[] args) throws Exception {
        SFTPUtils sftp = new SFTPUtils("****", "****", "****", 22, null);
        sftp.login();
        File file = new File("D:\\test.txt");
        InputStream is = new FileInputStream(file);
        sftp.upload("/home/SFTP/**/**/**/", "zj.txt", is);
        sftp.logout();

    }

}
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 220,295评论 6 512
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,928评论 3 396
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 166,682评论 0 357
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 59,209评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,237评论 6 397
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,965评论 1 308
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,586评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,487评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 46,016评论 1 319
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,136评论 3 340
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,271评论 1 352
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,948评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,619评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,139评论 0 23
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,252评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,598评论 3 375
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,267评论 2 358

推荐阅读更多精彩内容