java 連線ftp伺服器 從頁面進行下載
阿新 • • 發佈：2019-01-28
昨天來的個需求，我們的客戶需要下載對賬檔案的話，需要自己去登入ftp 伺服器去進行下載
本身是有商戶後臺，所以想吧這個功能直接新增到商戶後臺頁面上，web進行下載。這是背景。
之前沒有了解過這個，所以還是在網上查找了一番 ，找到了這篇部落格
我看了一下這個裡面的方法，有個返回流的，我就看到希望了，所以，進行了一番修改
在這匯入工具類之前，我們需要匯入個jar包
commons-net-3.6.jar
看自己用的什麼框架，引入方法我就不說了，需要下載的話，點選紅框的jar就可以了
下面是修改完後的工具類
工具類裡只需要修改 兩 處地方
ftp_address=“你自己ftp伺服器地址”
ftp_port=“ftp伺服器的埠”
其他都不用動
介紹在下面（工具類很長）所以使勁往下拉
package com.ecard.products.utils; import org.apache.commons.net.ftp.FTPClient; import org.apache.commons.net.ftp.FTPReply; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import java.io.*; import java.util.HashMap; import java.util.Map; /** * FTP服務工具類 * * @author： DangYangFei * @time： 2018年6月12日 14:36:37 * @version： V1.0.0 */ public class FTPUtil { /** 日誌物件 **/ private static final Logger LOGGER = LoggerFactory.getLogger(FTPUtil.class); /** FTP地址 **/ private String FTP_ADDRESS = ""; /** FTP埠 **/ private int FTP_PORT = 0; /** FTP使用者名稱 **/ private String FTP_USERNAME = ""; /** FTP密碼 **/ private String FTP_PASSWORD = ""; /** FTP基礎目錄 **/ private String BASE_PATH = ""; /** 初始化登入ftp 預設false 登入成功返回true **/ private Boolean b=false; public Boolean getB() { return b; } /** * 2018-6-13 12:39:55 * 新添，初始化登入ftp，連線失敗 返回b 為：false ,成功 為 ：true * @param FTP_USERNAME * @param FTP_PASSWORD * @param BASE_PATH */ public FTPUtil(String FTP_ADDRESS, int FTP_PORT, String FTP_USERNAME, String FTP_PASSWORD, String BASE_PATH) { this.FTP_ADDRESS = FTP_ADDRESS; this.FTP_PORT = FTP_PORT; this.FTP_USERNAME = FTP_USERNAME; this.FTP_PASSWORD = FTP_PASSWORD; this.BASE_PATH = BASE_PATH; b = login(FTP_ADDRESS, FTP_PORT, this.FTP_USERNAME, this.FTP_PASSWORD); } /** 本地字元編碼 **/ private static String localCharset = "GBK"; /** FTP協議裡面，規定檔名編碼為iso-8859-1 **/ private static String serverCharset = "ISO-8859-1"; /** UTF-8字元編碼 **/ private static final String CHARSET_UTF8 = "UTF-8"; /** OPTS UTF8字串常量 **/ private static final String OPTS_UTF8 = "OPTS UTF8"; /** 設定緩衝區大小4M **/ private static final int BUFFER_SIZE = 1024 * 1024 * 4; /** FTPClient物件 **/ private static FTPClient ftpClient = null; /** * 下載指定檔案到本地 * * @param ftpPath FTP伺服器檔案相對路徑，例如：test/123 * @param fileName 要下載的檔名，例如：test.txt * @param savePath 儲存檔案到本地的路徑，例如：D:/test * @return 成功返回true，否則返回false */ public boolean downloadFile(String ftpPath, String fileName, String savePath) { // 登入 boolean flag = false; if (ftpClient != null) { try { String path = changeEncoding(BASE_PATH + ftpPath); // 判斷是否存在該目錄 if (!ftpClient.changeWorkingDirectory(path)) { System.out.println(BASE_PATH + ftpPath + "該目錄不存在"); LOGGER.error(BASE_PATH + ftpPath + "該目錄不存在"); return flag; } ftpClient.enterLocalPassiveMode(); // 設定被動模式，開通一個埠來傳輸資料 String[] fs = ftpClient.listNames(); // 判斷該目錄下是否有檔案 if (fs == null || fs.length == 0) { System.out.println(BASE_PATH + ftpPath + "該目錄不存在"); LOGGER.error(BASE_PATH + ftpPath + "該目錄下沒有檔案"); return flag; } for (String ff : fs) { String ftpName = new String(ff.getBytes(serverCharset), localCharset); if (ftpName.equals(fileName)) { File file = new File(savePath + '/' + ftpName); try { OutputStream os = new FileOutputStream(file); flag = ftpClient.retrieveFile(ff, os); } catch (Exception e) { System.out.println(e.getMessage()); LOGGER.error(e.getMessage(), e); } break; } } } catch (IOException e) { System.out.println("下載檔案失敗"+e); LOGGER.error("下載檔案失敗", e); }finally { Boolean close = closeConnect(); System.out.println("連線是否關閉："+close); } } return flag; } /** * 下載該目錄下所有檔案到本地 * * @param ftpPath FTP伺服器上的相對路徑，例如：test/123 * @param savePath 儲存檔案到本地的路徑，例如：D:/test * @return 成功返回true，否則返回false */ public boolean downloadFiles(String ftpPath, String savePath) { // 登入 boolean flag = false; if (ftpClient != null) { try { String path = changeEncoding(BASE_PATH + ftpPath); // 判斷是否存在該目錄 if (!ftpClient.changeWorkingDirectory(path)) { System.out.println(BASE_PATH + ftpPath + "該目錄不存在"); LOGGER.error(BASE_PATH + ftpPath + "該目錄不存在"); return flag; } ftpClient.enterLocalPassiveMode(); // 設定被動模式，開通一個埠來傳輸資料 String[] fs = ftpClient.listNames(); // 判斷該目錄下是否有檔案 if (fs == null || fs.length == 0) { System.out.println(BASE_PATH + ftpPath + "該目錄下沒有檔案"); LOGGER.error(BASE_PATH + ftpPath + "該目錄下沒有檔案"); return flag; } for (String ff : fs) { String ftpName = new String(ff.getBytes(serverCharset), localCharset); File file = new File(savePath + '/' + ftpName); try { OutputStream os = new FileOutputStream(file); ftpClient.retrieveFile(ff, os); } catch (Exception e) { System.out.println(e.getMessage()+e); LOGGER.error(e.getMessage(), e); } } flag = true; } catch (IOException e) { System.out.println("下載檔案失敗"+e); LOGGER.error("下載檔案失敗", e); }finally { Boolean close = closeConnect(); System.out.println("連線是否關閉："+close); } } return flag; } /** * 獲取該目錄下所有檔案,以位元組陣列返回 * * @param ftpPath FTP伺服器上檔案所在相對路徑，例如：test/123 * @return Map<String, Object> 其中key為檔名，value為位元組陣列物件 */ public Map<String, byte[]> getFileBytes(String ftpPath) { // 登入 Map<String, byte[]> map = new HashMap<String, byte[]>(); if (ftpClient != null) { try { String path = changeEncoding(BASE_PATH + ftpPath); // 判斷是否存在該目錄 if (!ftpClient.changeWorkingDirectory(path)) { System.out.println(BASE_PATH + ftpPath + "該目錄不存在"); LOGGER.error(BASE_PATH + ftpPath + "該目錄不存在"); return map; } ftpClient.enterLocalPassiveMode(); // 設定被動模式，開通一個埠來傳輸資料 String[] fs = ftpClient.listNames(); // 判斷該目錄下是否有檔案 if (fs == null || fs.length == 0) { System.out.println(BASE_PATH + ftpPath + "該目錄下沒有檔案"); LOGGER.error(BASE_PATH + ftpPath + "該目錄下沒有檔案"); return map; } for (String ff : fs) { try { InputStream is = ftpClient.retrieveFileStream(ff); String ftpName = new String(ff.getBytes(serverCharset), localCharset); ByteArrayOutputStream byteStream = new ByteArrayOutputStream(); byte[] buffer = new byte[BUFFER_SIZE]; int readLength = 0; while ((readLength = is.read(buffer, 0, BUFFER_SIZE)) > 0) { byteStream.write(buffer, 0, readLength); } map.put(ftpName, byteStream.toByteArray()); ftpClient.completePendingCommand(); // 處理多個檔案 } catch (Exception e) { System.out.println(e.getMessage()); LOGGER.error(e.getMessage(), e); } } } catch (IOException e) { System.out.println("獲取檔案失敗"+e); LOGGER.error("獲取檔案失敗", e); }finally { Boolean close = closeConnect(); System.out.println("連線是否關閉："+close); } } return map; } /** * 根據名稱獲取檔案，以位元組陣列返回 * * @param ftpPath FTP伺服器檔案相對路徑，例如：test/123 * @param fileName 檔名，例如：test.xls * @return byte[] 位元組陣列物件 */ public byte[] getFileBytesByName(String ftpPath, String fileName) { // 登入 ByteArrayOutputStream byteStream = new ByteArrayOutputStream(); if (ftpClient != null) { try { String path = changeEncoding(BASE_PATH + ftpPath); // 判斷是否存在該目錄 if (!ftpClient.changeWorkingDirectory(path)) { System.out.println(BASE_PATH + ftpPath + "該目錄不存在"); LOGGER.error(BASE_PATH + ftpPath + "該目錄不存在"); return byteStream.toByteArray(); } ftpClient.enterLocalPassiveMode(); // 設定被動模式，開通一個埠來傳輸資料 String[] fs = ftpClient.listNames(); // 判斷該目錄下是否有檔案 if (fs == null || fs.length == 0) { System.out.println(BASE_PATH + ftpPath + "該目錄下沒有檔案"); LOGGER.error(BASE_PATH + ftpPath + "該目錄下沒有檔案"); return byteStream.toByteArray(); } for (String ff : fs) { String ftpName = new String(ff.getBytes(serverCharset), localCharset); if (ftpName.equals(fileName)) { try { InputStream is = ftpClient.retrieveFileStream(ff); byte[] buffer = new byte[BUFFER_SIZE]; int len = -1; while ((len = is.read(buffer, 0, BUFFER_SIZE)) != -1) { byteStream.write(buffer, 0, len); } } catch (Exception e) { System.out.println(e.getMessage()+e); LOGGER.error(e.getMessage(), e); } break; } } } catch (IOException e) { System.out.println("獲取檔案失敗"+e); LOGGER.error("獲取檔案失敗", e); }finally { Boolean close = closeConnect(); System.out.println("連線是否關閉："+close); } } return byteStream.toByteArray(); } /** * 獲取該目錄下所有檔案,以輸入流返回 * * @param ftpPath FTP伺服器上檔案相對路徑，例如：test/123 * @return Map<String, InputStream> 其中key為檔名，value為輸入流物件 */ public Map<String, InputStream> getFileInputStream(String ftpPath) { // 登入 Map<String, InputStream> map = new HashMap<String, InputStream>(); if (ftpClient != null) { try { String path = changeEncoding(BASE_PATH + ftpPath); // 判斷是否存在該目錄 if (!ftpClient.changeWorkingDirectory(path)) { System.out.println(BASE_PATH + ftpPath + "該目錄不存在"); LOGGER.error(BASE_PATH + ftpPath + "該目錄不存在"); return map; } ftpClient.enterLocalPassiveMode(); // 設定被動模式，開通一個埠來傳輸資料 String[] fs = ftpClient.listNames(); // 判斷該目錄下是否有檔案 if (fs == null || fs.length == 0) { System.out.println(BASE_PATH + ftpPath + "該目錄下沒有檔案"); LOGGER.error(BASE_PATH + ftpPath + "該目錄下沒有檔案"); return map; } for (String ff : fs) { String ftpName = new String(ff.getBytes(serverCharset), localCharset); InputStream is = ftpClient.retrieveFileStream(ff); map.put(ftpName, is); ftpClient.completePendingCommand(); // 處理多個檔案 } } catch (IOException e) { System.out.println("獲取檔案失敗"+e); LOGGER.error("獲取檔案失敗", e); }finally { Boolean close = closeConnect(); System.out.println("連線是否關閉："+close); } } return map; } /** * 根據名稱獲取檔案，以輸入流返回 * * @param ftpPath FTP伺服器上檔案相對路徑，例如：test/123 * @param fileName 檔名，例如：test.txt * @return InputStream 輸入流物件 */ public InputStream getInputStreamByName(String ftpPath, String fileName) { // 登入 InputStream input = null; if (ftpClient != null) { try { String path = changeEncoding(BASE_PATH + ftpPath); // 判斷是否存在該目錄 if (!ftpClient.changeWorkingDirectory(path)) { System.out.println(BASE_PATH + ftpPath + "該目錄不存在"); LOGGER.error(BASE_PATH + ftpPath + "該目錄不存在"); return input; } ftpClient.enterLocalPassiveMode(); // 設定被動模式，開通一個埠來傳輸資料 String[] fs = ftpClient.listNames(); // 判斷該目錄下是否有檔案 if (fs == null || fs.length == 0) { System.out.println(BASE_PATH + ftpPath + "該目錄下沒有檔案"); LOGGER.error(BASE_PATH + ftpPath + "該目錄下沒有檔案"); return input; } for (String ff : fs) { String ftpName = new String(ff.getBytes(serverCharset), localCharset); if (ftpName.equals(fileName)) { input = ftpClient.retrieveFileStream(ff); break; } } } catch (IOException e) { System.out.println("獲取檔案失敗"+e); LOGGER.error("獲取檔案失敗", e); }finally { Boolean connect = closeConnect(); System.out.println("連線關閉狀態：" + connect); } } return input; } /** * 根據資料夾，檔案 名稱，判斷是否存在 * * @param ftpPath FTP伺服器上檔案相對路徑，例如：test/123 * @param fileName 檔名，例如：test.txt * @return map */ public Map checkoutFtpPathAndFileName(String ftpPath, String fileName) { // 登入 Map<String,Boolean> map = new HashMap<String, Boolean>(); map.put("filePath",false); map.put("fileName",false); if (ftpClient != null) { try { String path = changeEncoding(BASE_PATH + ftpPath); // 判斷是否存在該目錄 if (!ftpClient.changeWorkingDirectory(path)) { System.out.println(BASE_PATH + ftpPath + "該目錄不存在"); map.put("filePath",false); }else { map.put("filePath",true); } ftpClient.enterLocalPassiveMode(); // 設定被動模式，開通一個埠來傳輸資料 String[] fs = ftpClient.listNames(); // 判斷該目錄下是否有檔案 if (fs == null || fs.length == 0) { System.out.println(BASE_PATH + ftpPath + "該目錄下沒有檔案"); map.put("fileName",false); } for (String ff : fs) { String ftpName = new String(ff.getBytes(serverCharset), localCharset); if (ftpName.equals(fileName)) { map.put("fileName",true); } } } catch (IOException e) { System.out.println("獲取檔案失敗"+e); LOGGER.error("獲取檔案失敗", e); } } return map; } /** * 刪除指定檔案 * * @param filePath 檔案相對路徑，例如：test/123/test.txt * @return 成功返回true，否則返回false */ public boolean deleteFile(String filePath) { // 登入 boolean flag = false; if (ftpClient != null) { try { String path = changeEncoding(BASE_PATH + filePath); flag = ftpClient.deleteFile(path); } catch (IOException e) { System.out.println("刪除檔案失敗"+e); LOGGER.error("刪除檔案失敗", e); } finally { Boolean close = closeConnect(); System.out.println("連線是否關閉："+close); } } return flag; } /** * 刪除目錄下所有檔案 * * @param dirPath 檔案相對路徑，例如：test/123 * @return 成功返回true，否則返回false */ public boolean deleteFiles(String dirPath) { // 登入 boolean flag = false; if (ftpClient != null) { try { ftpClient.enterLocalPassiveMode(); // 設定被動模式，開通一個埠來傳輸資料 String path = changeEncoding(BASE_PATH + dirPath); String[] fs = ftpClient.listNames(path); // 判斷該目錄下是否有檔案 if (fs == null || fs.length == 0) { System.out.println(BASE_PATH + dirPath + "該目錄下沒有檔案"); LOGGER.error(BASE_PATH + dirPath + "該目錄下沒有檔案"); return flag; } for (String ftpFile : fs) { ftpClient.deleteFile(ftpFile); } flag = true; } catch (IOException e) { System.out.println("刪除檔案失敗"+e); LOGGER.error("刪除檔案失敗", e); }finally { Boolean close = closeConnect(); System.out.println("連線是否關閉："+close); } } return flag; } /** * 連線FTP伺服器 * * @param address 地址，如：127.0.0.1 * @param port 埠，如：21 * @param username 使用者名稱，如：root * @param password 密碼，如：root */ private Boolean login(String address, int port, String username, String password) { ftpClient = new FTPClient(); try { ftpClient.connect(address, port); ftpClient.login(username, password); ftpClient.setFileType(FTPClient.BINARY_FILE_TYPE); int reply = ftpClient.getReplyCode(); if (!FTPReply.isPositiveCompletion(reply)) { closeConnect(); System.out.println("FTP伺服器連線失敗："+"地址："+address+" 埠："+port+" 使用者名稱："+username+" 密碼："+password); LOGGER.error("FTP伺服器連線失敗"); }else { b=true; } } catch (Exception e) { System.out.println("FTP登入失敗"+e); LOGGER.error("FTP登入失敗", e); } return b; } /** * 關閉FTP連線 * */ public Boolean closeConnect() { Boolean b=false; if (ftpClient != null && ftpClient.isConnected()) { try { ftpClient.logout(); b=true; } catch (IOException e) { System.out.println("關閉FTP連線失敗"+e); LOGGER.error("關閉FTP連線失敗", e); } } return b; } /** * FTP伺服器路徑編碼轉換 * * @param ftpPath FTP伺服器路徑 * @return String */ private static String changeEncoding(String ftpPath) { String directory = null; try { if (FTPReply.isPositiveCompletion(ftpClient.sendCommand(OPTS_UTF8, "ON"))) { localCharset = CHARSET_UTF8; } directory = new String(ftpPath.getBytes(localCharset), serverCharset); } catch (Exception e) { System.out.println("路徑編碼轉換失敗"+e); LOGGER.error("路徑編碼轉換失敗", e); } return directory; } /** * 在伺服器上遞迴建立目錄 * * @param dirPath 上傳目錄路徑 * @return */ private void createDirectorys(String dirPath) { try { if (!dirPath.endsWith("/")) { dirPath += "/"; } String directory = dirPath.substring(0, dirPath.lastIndexOf("/") + 1); ftpClient.makeDirectory("/"); int start = 0; int end = 0; if (directory.startsWith("/")) { start = 1; }else{ start = 0; } end = directory.indexOf("/", start); while(true) { String subDirectory = new String(dirPath.substring(start, end)); if (!ftpClient.changeWorkingDirectory(subDirectory)) { if (ftpClient.makeDirectory(subDirectory)) { ftpClient.changeWorkingDirectory(subDirectory); } else { System.out.println("建立目錄失敗"); LOGGER.info("建立目錄失敗"); return; } } start = end + 1; end = directory.indexOf("/", start); //檢查所有目錄是否建立完畢 if (end <= start) { break; } } } catch (Exception e) { System.out.println("上傳目錄建立失敗"+e); LOGGER.error("上傳目錄建立失敗", e); } } }
這裡有很多方法，但是現在我的這個需要返回流的形式，所以只用的這個
開始介紹用法
利用有參構造 進行初始化登入ftp 如果登入成功了會返回true 否則返回false
有參構造最後面的ftp_base_path 這個引數說一下
這個引數傳的是你當前賬號登入以後所能看到的當前路徑，也就是說直接給他個空串就可以了
連結成功以後呢，b 返回的就是true ，我們就可以繼續往下進行操作了
String ftpUserName = ""; String ftpPassword = ""; String ftpPath = "/"+"資料夾名"+"/"; String fileName = "檔名"; FTPUtil ftpUtil = new FTPUtil(ftpUserName, ftpPassword, ""); Boolean b = ftpUtil.getB();
校驗一下資料夾和檔案是否存在, 這個是我自己改了一下，你們可以自己去工具類裡進行修改成自己想要的欄位
這裡的返回也是，兩個引數 ，false 代表不存在，true代表存在
新增這個方法是因為實際業務需要進行判斷返回前端進行提示，所以故此新增
Map map = ftpUtil.checkoutFtpPathAndFileName(ftpPath, fileName)
Boolean filePahtBoolean = map.get("filePath")
Boolean fileNameBoolean = map.get("fileName")這個方法需要手動自己關閉連線，所以 ftpUtil.closeConnect(),成功返回true， 失敗返回false
上面的都齊全了，下面我們開始頁面進行下載了
這個方法只需要把檔案所在的 路徑 和 檔名 傳進去就可以了，返回的是一個InputStream
InputStream inputStream = ftpUtil.getInputStreamByName(ftpPath, fileName)頁面進行下載彈出框
這個就不多介紹了， 彈出框檔案的名稱 修改成功自己的命名規則就可以了
/**
*
* @param fileName 檔名稱
* @param inputStream 讀取檔案返回流
* @param response
*/
public static void downloadFtpFile(String fileName,InputStream inputStream ,HttpServletResponse response) {
try {
BufferedInputStream br = new BufferedInputStream(inputStream);
byte[] buf = new byte[1024];
int len = 0;
response.reset();
response.setContentType("application/x-msdownload");
response.setHeader("Content-Disposition", "attachment; filename=" + fileName);
OutputStream out = response.getOutputStream();
while ((len = br.read(buf)) > 0) out.write(buf, 0, len);
br.close();
out.close();
} catch (IOException e) {
System.out.println("檔案讀取錯誤。");
}
}