SFTP文件操作

在有些项目组中,会选择使用SFTP做为文件存储的服务器,最近我负责的一个系统接入公司的一个新系统。他们将生成的文件放在SFTP服务器,然后我要去SFTP去取文件。

SFTP搭建

想要在Linux系统中搭建SFTP服务还是很简单的。具体操作步骤请参考:SFTP服务搭建

SFTP集成

任何服务的继承,都需要引入相关的依赖。JSCH为我们提供了Java操作SFTP的客户端。首先我们需要在POM文件中引入jsch的依赖。

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

此外,Spring也为我们提供了和SFTP的集成,其实也是对jsch的封装,如果要使用Spring的封装来和SFTP交互的话,需要引入下面的依赖

<dependency>
     <groupId>org.springframework.integration</groupId>
     <artifactId>spring-integration-sftp</artifactId>
     <version>4.2.2.RELEASE</version>
</dependency>

引入spring-integration-sftp,它会间接依赖jsch。不过这里我不打算使用Spring的封装类来操作jsch,而是通过其原生的API来操作。

自定义一个SFTP的工具类。

public class SftpUtil {

    private static Logger logger = LoggerFactory.getLogger(SftpUtil.class);
    private static ChannelSftp sftp = null;
    private static Session sshSession = null;

    /**
     * 通过SFTP连接服务器
     */
    private static void connect(SftpBean sftpBean) {
        JSch jsch = new JSch();
        Session session;
        try {
            if (sftpBean.getSftpHost()!=null) {
                session = jsch.getSession(sftpBean.getSftpUser(), sftpBean.getSftpHost());
                logger.info("连接sftp {}:{} ,用户【{}】", new Object[] { sftpBean.getSftpHost(),
                        22, sftpBean.getSftpUser() });
            } else {
                session = jsch.getSession(sftpBean.getSftpUser(), sftpBean.getSftpHost(),
                        Integer.parseInt(sftpBean.getSftpPort()));
                logger.info("连接sftp {}:{} ,用户【{}】", new Object[] { sftpBean.getSftpHost(),
                        sftpBean.getSftpPort(), sftpBean.getSftpUser() });
            }

            if (sftpBean.getSftpPassword()!=null) {
                session.setPassword(sftpBean.getSftpPassword());
            }

            session.setConfig("StrictHostKeyChecking", "no");
            session.connect(300000);
            logger.info("连接sftp {}:{} 成功", new Object[] { sftpBean.getSftpHost(), sftpBean.getSftpPort() });
            Channel channel = session.openChannel("sftp");
            // 建立SFTP通道的连接
            channel.connect(10000);
            sftp = (ChannelSftp) channel;

        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    /**
     * 关闭连接
     */
    public static void disconnect(){
        if (sftp != null && sftp.isConnected()) {
            try {
                // 要想关闭sftp的连接,注意一定要关闭ChannelSftp对象中的session
                if (sftp.getSession() != null) {
                    sftp.getSession().disconnect();
                }
            } catch (JSchException e) {
                e.printStackTrace();
            }
            sftp.disconnect();
        }
        if (sshSession != null && sshSession.isConnected()){
            sshSession.disconnect();
        }
    }

    public static InputStream getFileFromSFtp(SftpBean sftpBean, String fileName) throws SftpException {

        connect(sftpBean);

        try {
            sftp.cd(sftpBean.getSftpPath());
        } catch (Exception e) {
            e.printStackTrace();
        }
        InputStream inputStream = sftp.get(fileName);

        return inputStream;
    }

    public static void downloadFileFromSFtp(SftpBean sftpBean, String srcFile, String destFile) throws SftpException {

        connect(sftpBean);

        try {
            sftp.cd(sftpBean.getSftpPath());
        } catch (Exception e) {
            e.printStackTrace();
        }
        sftp.get(srcFile,destFile);
    }

    public boolean uploadFile(String remotePath, String remoteFileName,String localPath, String localFileName){
        try(FileInputStream in = new FileInputStream(new File(localPath + localFileName));) {
            sftp.put(in, remoteFileName);
            return true;
        } catch (FileNotFoundException e){
            e.printStackTrace();
        }catch (SftpException e){
            e.printStackTrace();
        } catch (IOException e) {
            e.printStackTrace();
        }
        return false;
    }

}

注意:关闭连接的时候,一定要先关闭ChannelSftp中的session对象
sftp.getSession().disconnect(); 不然会产生一个现象:程序执行完之后,连接依然不会断开。

一些常用的api方法:

put(): 文件上传
get(): 文件下载
cd(): 进入指定目录
ls(): 得到指定目录下的文件列表
rename(): 重命名指定文件或目录
rm(): 删除指定文件
mkdir(): 创建目录
rmdir(): 删除目录

客户端

public class SftpJavaApplication {

    public static void main(String[] args){

        // handleFileAllInMem();

        // downloadFile();

        handleFileWithBufferLoop();
    }

    private static void handleFileWithBufferLoop() {
        System.out.println(Runtime.getRuntime().maxMemory()/1024/1024);

        SftpBean sftpBean = new SftpBean("192.168.2.200", "mysftp", "mysftp", "/upload");
        try(InputStream inputStream = SftpUtil.getFileFromSFtp(sftpBean, "Spitter.java");) {
            BufferedReader bufferedReader = new BufferedReader(new InputStreamReader(inputStream));
            System.out.println(inputStream.available());
            String line = null;
            while ((line=bufferedReader.readLine())!=null){
                System.out.println(line);
                // other handle (check date, insert DB)
            }
        } catch (Exception e){
            e.printStackTrace();
        } finally {
            SftpUtil.disconnect();
            System.out.println("关闭sftp服务器的连接");
        }
    }


    private static void downloadFile() {
        SftpBean sftpBean = new SftpBean("192.168.2.200", "mysftp", "mysftp", "/upload");
        try {

            SftpUtil.downloadFileFromSFtp(sftpBean, "Spitter.java","D:\\Test\\Test.txt");

        } catch (Exception e){
            e.printStackTrace();
        } finally {

            SftpUtil.disconnect();

            System.out.println("关闭sftp服务器的连接");
        }
    }

    private static void handleFileAllInMem() {
        System.out.println(Runtime.getRuntime().maxMemory()/1024/1024);

        SftpBean sftpBean = new SftpBean("192.168.2.200", "mysftp", "mysftp", "/upload");
        SftpUtil sftpUtil = new SftpUtil();
        InputStream inputStream = null;
        BufferedReader bufferedReader = null;
        try {
            inputStream = SftpUtil.getFileFromSFtp(sftpBean, "Spitter.java");

            //这里实现一次将流全加载到内存中
            byte[] bytes = getBytes(inputStream);

            BufferedInputStream bufferedInputStream = new BufferedInputStream(new ByteArrayInputStream(bytes));
            bufferedReader = new BufferedReader(new InputStreamReader(bufferedInputStream));
            String line = null;
            while((line = bufferedReader.readLine())!= null){
                System.out.println(line);
            }

        } catch (Exception e){
            e.printStackTrace();
        } finally {
            if (inputStream!=null){
                try {
                    inputStream.close();
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
            if(bufferedReader!=null){
                try {
                    bufferedReader.close();
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
            SftpUtil.disconnect();

            System.out.println("关闭sftp服务器的连接");
        }
    }

    private static byte[] getBytes(InputStream in) {
        byte[] buffer = null;
        try{
            byte[] b = new byte[1024];
            int n;
            ByteArrayOutputStream bos = new ByteArrayOutputStream(1024);
            while ((n = in.read(b)) != -1) {
                bos.write(b, 0, n);
            }
            buffer = bos.toByteArray();
        } catch (IOException e) {
            e.printStackTrace();
        }
        return buffer;
    }

}

handleFileAllInMem()一次将文件的流全读到流中,这会产生内存溢出。当然如果能够预知每次处理的文件都会不很大,那么这种写法也没有问题。

downloadFile()方法将文件下载到本地,不会产生内存溢出的问题。这种适合文件较大,网络不是很稳定的情况。如果文件超大的话,我们可以使用多线程实现多点续传的方式来加速。如果HTTP协议通过HttpUrlConnection很好实现,不过SFTP暂时没发现什么好的方法(如果你知道了,烦请告诉我,让我学习一下)。

handleFileWithBufferLoop()方法将网络流每次处理一行,即每次加载一行到内存,这也能解决内存溢出问题。但是如果存在网络波动的情况,此方式没法很好的解决。

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

推荐阅读更多精彩内容