Java代碼獲取SFTP服務器文件

與下游聯調時遇到的問題, 一般我們會使用ftp來傳遞文件, 因為sftp的傳輸效率很低. 所以為了兼容,引用了網上的方法.

步驟

• 導入所需Jar包
• 編寫工具類
• 代碼中運用

 

1. 導入 Jsch-0.1.54.jar

直接去maven庫中下載即可

 

2. 編寫工具類--SFTPUtil.java

/**
 * @author shansm
 * @date 2020/3/18 -17:27
 */
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;


    /**
     * 構造基於密碼認證的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(){}

    /**
     * 初始化ftp參數
     * @param resultFileURL
     */
    public SFTPUtil(String resultFileURL , String keys) throws Exception {
        Map<String, String> map = URLUtil.parseSftp(resultFileURL);
        init(map.get("ipAddress"),map.get("ipPort"),map.get("userName"),map.get("passWord"),keys);
        log.info("ip: "+map.get("ipAddress"));
        log.info("port: "+map.get("ipPort"));
        log.info("userName: "+map.get("userName"));
        log.info("PassWord: "+map.get("passWord"));
    }

    /**初始化參數**/
    private void init(String ip, String portN, String userName, String passWord,String keys)
            throws Exception {
        if(StringUtils.isNotEmpty(portN)){
            port=Integer.parseInt(portN);
        }else{
            port = 21;
        }

        if(StringUtils.isNotEmpty(keys)){
            privateKey = keys;
        }

        host = new String(ip);
        sftp = new ChannelSftp();
        username = new String(userName);
        password = new String(passWord);
    }


    /**
     * 連接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;
            log.info("登陸 Sftp Server Success");
        } catch (JSchException e) {
            e.printStackTrace();
            log.error(e.getMessage());
        }
    }

    /**
     * 關閉連接 server
     */
    public void logout(){
        if (sftp != null) {
            if (sftp.isConnected()) {
                sftp.disconnect();
            }
        }
        if (session != null) {
            if (session.isConnected()) {
                session.disconnect();
            }
        }
    }

    /**
     * 將輸入流的數據上傳到sftp作為文件。文件完整路徑=basePath+directory
     * @param basePath  服務器的基礎路徑
     * @param directory  上傳到該目錄
     * @param sftpFileName  sftp端文件名
     */
    public void upload(String basePath,String directory, String sftpFileName, InputStream input) throws SftpException{
        try {
            sftp.cd(basePath);
            sftp.cd(directory);
        } catch (SftpException e) {
            //目錄不存在，則創建文件夾
            String [] dirs=directory.split("/");
            String tempPath=basePath;
            for(String dir:dirs){
                if(null== dir || "".equals(dir)) continue;
                tempPath+="/"+dir;
                try{
                    sftp.cd(tempPath);
                }catch(SftpException ex){
                    sftp.mkdir(tempPath);
                    sftp.cd(tempPath);
                }
            }
        }
        sftp.put(input, sftpFileName);  //上傳文件
    }


    /**
     * 下載文件。
     * @param directory 下載目錄
     * @param downloadFile 下載的文件
     * @param saveFile 存在本地的路徑
     */
    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));
    }

    /**
     * 下載文件
     * @param directory 下載目錄
     * @param downloadFile 下載的文件名
     * @return 字節數組
     */
    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);

        return fileData;
    }


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


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

    //上傳文件測試
    public static void main(String[] args) throws SftpException, IOException {
        SFTPUtil sftp = new SFTPUtil("用戶名", "密碼", "ip地址", 22);
        sftp.login();
        File file = new File("D:\\圖片\\t0124dd095ceb042322.jpg");
        InputStream is = new FileInputStream(file);

        sftp.upload("基礎路徑","文件路徑", "test_sftp.jpg", is);
        sftp.logout();
    }

    /***
     * 獲取ftp內容
     * @param resultFileURL
     * @return
     */
    public String getFtpContent(String resultFileURL) {
        String str=null;
        log.info("SFTP getFtpContent Start");
        try {
            Map<String, String> map = URLUtil.parseSftp(resultFileURL);
            String ipAdress = map.get("ipAddress");
            int ipPort = SafeUtils.getInt(map.get("ipPort"),21);
            String userName = map.get("userName");
            String passWord = map.get("passWord");
            log.info("sftp ipAdress="+ipAdress+",ipPort="+ipPort+",userName="+userName+",passWord="+passWord);
            login();
            String path = map.get("path");
            path=path.replace("//","/"); //防止雙杠導致目錄失敗
            log.info("ftp path="+path);

            /*String changePath = path.substring(0, path.lastIndexOf("/")+1);
            log.info("ftp changePath="+changePath);*/

            InputStream inputStream = sftp.get(path);

            BufferedReader br = new BufferedReader(new InputStreamReader(inputStream,"utf-8"));
            String data = null;
            StringBuffer resultBuffer = new StringBuffer();
            while ((data = br.readLine()) != null) {
                resultBuffer.append(data + "\n");
            }
            str = resultBuffer.toString();
            log.info("ftp content:"+str);
            logout();
        } catch (Exception e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
            log.error("ftp error:",e);
        }
        return str;
    }
}

2. 調用URLUtil.java 來幫助解析Url地址

public  URLUtil class{
    /***
     * 用解析sftp
     * @param url
     * @return
     * @throws Exception
     */
    public static Map<String, String> parseSftp(String url) throws Exception{
        Map<String, String> temp = new HashMap<String, String>();
        String ipPort= "21";
        //由於 URL類解析 sftp地址會報錯, 所以截取掉前面的s
        url = url.substring(1);
        URL urltemp = new URL(url);
        String ipAddress = urltemp.getHost();
        if (urltemp.getPort()!=-1) {
            ipPort = urltemp.getPort()+"";
        };
        String path = urltemp.getPath();
        String userInfo = urltemp.getUserInfo();
        String userName = "";
        String userPwd = "";
        if(StringUtils.isNotEmpty(userInfo)){
            String[] array = userInfo.split(":");
            if(array.length>0){
                userName = array[0];
            }

            if(array.length>=1){
                userPwd = array[1];
            }
        }
        temp.put("userName", userName);
        temp.put("passWord", userPwd);
        temp.put("ipAddress", ipAddress);
        temp.put("ipPort", ipPort);
        temp.put("path", path);

        return temp;
    }
}

 

3 代碼中調用方法

SFTPUtil sftpUtil = new SFTPUtil(resultFileURL,"");        //初始化工具類, 第二個參數為密鑰,沒有就不填
cont = sftpUtil.getFtpContent(resultFileURL);            //返回讀取的string 字符串, 根據雙方約定解析成不同格式即可