SFTP文件操作

在有些項目組中,會選擇使用SFTP做為文件存儲的服務(wù)器,最近我負(fù)責(zé)的一個系統(tǒng)接入公司的一個新系統(tǒng)。他們將生成的文件放在SFTP服務(wù)器,然后我要去SFTP去取文件。

SFTP搭建

想要在Linux系統(tǒng)中搭建SFTP服務(wù)還是很簡單的。具體操作步驟請參考:SFTP服務(wù)搭建

SFTP集成

任何服務(wù)的繼承,都需要引入相關(guān)的依賴。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連接服務(wù)器
     */
    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();
        }
    }

    /**
     * 關(guān)閉連接
     */
    public static void disconnect(){
        if (sftp != null && sftp.isConnected()) {
            try {
                // 要想關(guān)閉sftp的連接,注意一定要關(guān)閉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;
    }

}

注意:關(guān)閉連接的時候,一定要先關(guān)閉ChannelSftp中的session對象
sftp.getSession().disconnect(); 不然會產(chǎn)生一個現(xiàn)象:程序執(zhí)行完之后,連接依然不會斷開。

一些常用的api方法:

put(): 文件上傳
get(): 文件下載
cd(): 進入指定目錄
ls(): 得到指定目錄下的文件列表
rename(): 重命名指定文件或目錄
rm(): 刪除指定文件
mkdir(): 創(chuàng)建目錄
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("關(guān)閉sftp服務(wù)器的連接");
        }
    }


    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("關(guān)閉sftp服務(wù)器的連接");
        }
    }

    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");

            //這里實現(xiàn)一次將流全加載到內(nèi)存中
            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("關(guān)閉sftp服務(wù)器的連接");
        }
    }

    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()一次將文件的流全讀到流中,這會產(chǎn)生內(nèi)存溢出。當(dāng)然如果能夠預(yù)知每次處理的文件都會不很大,那么這種寫法也沒有問題。

downloadFile()方法將文件下載到本地,不會產(chǎn)生內(nèi)存溢出的問題。這種適合文件較大,網(wǎng)絡(luò)不是很穩(wěn)定的情況。如果文件超大的話,我們可以使用多線程實現(xiàn)多點續(xù)傳的方式來加速。如果HTTP協(xié)議通過HttpUrlConnection很好實現(xiàn),不過SFTP暫時沒發(fā)現(xiàn)什么好的方法(如果你知道了,煩請告訴我,讓我學(xué)習(xí)一下)。

handleFileWithBufferLoop()方法將網(wǎng)絡(luò)流每次處理一行,即每次加載一行到內(nèi)存,這也能解決內(nèi)存溢出問題。但是如果存在網(wǎng)絡(luò)波動的情況,此方式?jīng)]法很好的解決。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容