1、前言

最近一直在做數據遷移接口的開發，涉及到大文件的遠程下載與上傳，其實倒沒有什么原理可言，無非就是兩臺機器互連之后，獲得文件流然后進行傳輸，不過在這過程也遇到過一些小坑，故記錄下。

2、搭建SFTP服務器

我這里就在本地搭建一個SFTP服務器進行測試，最簡單的辦法就是通過軟件來實現，我這里推薦FreeSSHd，可以通過我的藍奏云網盤進行下載：

https://wwr.lanzoui.com/igWkqqoczjg
密碼:aqge

首先下載安裝后之后進行配置

1）點擊“Users”-“Add”，新增賬號，開發時需要通過賬號和密碼連接上SFTP服務器。

2）點擊“SSH”，修改端口號，默認是22端口，以防22被其他應用占用了，我這里改成了23端口，也可以自行修改成其他端口號，并且將下面兩個選項的√去掉，不然會出現問題。

3）點擊“Telnet”，這里也需要修改端口號。

4）點擊“Authentication”，這里把權限也改一下。

5）點擊“SFTP”，這里選擇的目錄就是我們要上傳文件的根目錄。

6）點擊“Server status”-“Click here to stop it”，至此，SFTP服務器啟動成功。

3、開發實現

開發過程中遇到的坑就是創建文件夾，如果文件夾不存在，就會報錯，而且文件夾不能多級創建，比如/A/B/C這三個文件夾，不能一次性創建，必須單個單個創建，不然就會報權限不足的錯誤，一開始我就是被這個報錯誤解了，一直在權限的問題上糾結，實則不是，我這里通過切割“/”的形式將字符串分割成數組，然后再通過遍歷依次創建文件夾，注意還要判斷文件夾是否已經存在，不然也會報錯。

import java.io.ByteArrayInputStream; import java.io.File; import java.io.FileInputStream; import java.io.FileNotFoundException; import java.io.FileOutputStream; import java.io.IOException; import java.io.InputStream; import java.io.UnsupportedEncodingException; import java.net.URL; import java.util.Properties; import java.util.Vector; import org.apache.commons.io.IOUtils; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import com.jcraft.jsch.Channel; import com.jcraft.jsch.ChannelSftp; import com.jcraft.jsch.JSch; import com.jcraft.jsch.JSchException; import com.jcraft.jsch.Session; import com.jcraft.jsch.SftpException; /*** sftp工具類* @author chen**/ public class SFTPUtils { private transient Logger log = LoggerFactory.getLogger(this.getClass()); 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; /** * 構造基于密碼認證的sftp對象 * @param userName * @param password * @param host * @param port */ public SFTPUtils(String username, String password, String host, int port) { this.username = username; this.password = password; this.host = host; this.port = port; } /** * 構造基于秘鑰認證的sftp對象 * @param userName * @param host * @param port * @param privateKey */ public SFTPUtils(String username, String host, int port, String privateKey) { this.username = username; this.host = host; this.port = port; this.privateKey = privateKey; } public SFTPUtils(){} /** * 連接sftp服務器 * * @throws Exception */ public void login(){ try { JSch jsch = new JSch(); if (privateKey != null) { jsch.addIdentity(privateKey);// 設置私鑰 log.info("sftp connect,path of private key file：{}" , privateKey); } 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"); } } } /** * 將輸入流的數據上傳到sftp作為文件 * * @param directory * 上傳到該目錄 * @param sftpFileName * sftp端文件名 * @param in * 輸入流 * @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);String[] split = directory.split("/");String directoryStr = "";for(int i = 0;i<split.length;i++) {directoryStr+="/"+split[i];if(!isDirectory(directoryStr)) {sftp.mkdir(directoryStr);}}sftp.cd(directoryStr);}sftp.put(input, sftpFileName);log.info("file:{} is upload successful" , sftpFileName); } public boolean isDirectory(String directoryStr) throws SftpException {try {if(directoryStr=="") {return true;}sftp.cd(directoryStr);} catch (Exception e) {// TODO: handle exceptionreturn false;} return true;}/** * 上傳單個文件 * * @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 * 要列出的目錄 * @param sftp * @return * @throws SftpException */ public Vector<?> listFiles(String directory) throws SftpException { return sftp.ls(directory); } public static void main(String[] args) throws SftpException, IOException {SFTPUtils sftp = new SFTPUtils("root", "123456", "192.168.1.XXX", 23); sftp.login(); File file = new File("G:\\a.txt"); InputStream is = new FileInputStream(file);sftp.upload("/", "a.txt", is);sftp.logout(); } }

總結

以上是生活随笔為你收集整理的搭建SFTP服务器实现文件上传的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。