ftp上傳工具類
阿新 • • 發佈:2018-12-02
pom
<!-- https://mvnrepository.com/artifact/commons-net/commons-net -->
<dependency>
<groupId>commons-net</groupId>
<artifactId>commons-net</artifactId>
<version>3.6</version>
</dependency>
程式碼如下
package fs.basecore.utils; import java.io.File; import java.io.FileOutputStream; import java.io.IOException; import java.io.InputStream; import java.io.OutputStream; import java.net.URLEncoder; import java.time.LocalDateTime; import java.time.format.DateTimeFormatter; import javax.servlet.ServletOutputStream; import javax.servlet.http.HttpServletResponse; import org.apache.commons.net.ftp.FTP; import org.apache.commons.net.ftp.FTPClient; import org.apache.commons.net.ftp.FTPFile; import org.apache.commons.net.ftp.FTPReply; import org.springframework.beans.factory.annotation.Value; /** * ftp工具類 * @author jun *完整路徑 * */ public class FtpUtil { //通過properties檔案自動注入 @Value("${ftp.host}") private String host; //ftp伺服器ip @Value("${ftp.port}") private int port; //ftp伺服器埠 @Value("${ftp.username}") private String username;//使用者名稱 @Value("${ftp.password}") private String password;//密碼 @Value("${ftp.fileBasePath}") private String fileBasePath;//存放檔案的基本路徑 @Value("${ftp.imageBasePath}") private String imageBasePath;//存放圖片的基本路徑 //測試的時候把這個建構函式開啟,設定你的初始值,然後在程式碼後面的main方法執行測試 public FtpUtil() throws Exception { //System.out.println(this.toString()); host="xx.xx.xx.xx"; port=21; username="xxxx"; password="xxxx"; fileBasePath="/lcp/files"; } /** * host+伺服器專案根目錄(根據圖片或檔案有區分)+業務型別程式碼檔案+時間+名字 * 如 * ftp://xx.xx.xx.xx/lcp/images/good_images/20181017/2018101714573200096.png * ftp://xx.xx.xx.xx/lcp/files/good_file/20181017/2018101713380600090.pdf * * @param path 上傳檔案存放在伺服器的路徑 /good_images/20181017/ * @param filename 上傳檔名 2018101714573200096.png * @param input 輸入流 * @param basePath /lcp/images * @return */ public boolean fileUpload(String path,String filename,InputStream input,String basePath) { FTPClient ftp=new FTPClient(); try { ftp.connect(host, port); ftp.login(username, password); //設定檔案編碼格式 ftp.setControlEncoding("UTF-8"); //ftp通訊有兩種模式 //PORT(主動模式)客戶端開通一個新埠(>1024)並通過這個埠傳送命令或傳輸資料,期間服務端只使用他開通的一個埠,例如21 //PASV(被動模式)客戶端向服務端傳送一個PASV命令,服務端開啟一個新埠(>1024),並使用這個埠與客戶端的21埠傳輸資料 //由於客戶端不可控,防火牆等原因,所以需要由服務端開啟埠,需要設定被動模式 ftp.enterLocalPassiveMode(); //設定傳輸方式為流方式 ftp.setFileTransferMode(FTP.STREAM_TRANSFER_MODE); //獲取狀態碼,判斷是否連線成功 if(!FTPReply.isPositiveCompletion(ftp.getReplyCode())) { throw new RuntimeException("FTP伺服器拒絕連線"); } //轉到上傳檔案的根目錄 if(!ftp.changeWorkingDirectory(basePath)) { throw new RuntimeException("根目錄不存在,需要建立"); } //判斷是否存在目錄 if(!ftp.changeWorkingDirectory(path)) { String[] dirs=path.split("/"); //建立目錄 for (String dir : dirs) { if(null==dir||"".equals(dir)) continue; //判斷是否存在目錄 if(!ftp.changeWorkingDirectory(dir)) { //不存在則建立 if(!ftp.makeDirectory(dir)) { throw new RuntimeException("子目錄建立失敗"); } //進入新建立的目錄 ftp.changeWorkingDirectory(dir); } } //設定上傳檔案的型別為二進位制型別 ftp.setFileType(FTP.BINARY_FILE_TYPE); //上傳檔案 if(!ftp.storeFile(filename, input)) { return false; } input.close(); ftp.logout(); return true; } } catch (Exception e) { throw new RuntimeException(e); }finally { if(ftp.isConnected()) { try { ftp.disconnect(); } catch (IOException e) { throw new RuntimeException(e); } } } return false; } /** * 圖片顯示 * @param filename 檔名,注意!此處檔名為加路徑檔名,如:/good_images/20181017/2018101713392600092.jpg * @param baePath /lcp/images * @return */ public Boolean binaryIo(String baePath,String filename,HttpServletResponse response) { FTPClient ftp=new FTPClient(); InputStream inputStream =null; try { ftp.connect(host, port); ftp.login(username, password); //設定檔案編碼格式 ftp.setControlEncoding("UTF-8"); //ftp通訊有兩種模式 //PORT(主動模式)客戶端開通一個新埠(>1024)並通過這個埠傳送命令或傳輸資料,期間服務端只使用他開通的一個埠,例如21 //PASV(被動模式)客戶端向服務端傳送一個PASV命令,服務端開啟一個新埠(>1024),並使用這個埠與客戶端的21埠傳輸資料 //由於客戶端不可控,防火牆等原因,所以需要由服務端開啟埠,需要設定被動模式 ftp.enterLocalPassiveMode(); //設定傳輸方式為流方式 ftp.setFileTransferMode(FTP.STREAM_TRANSFER_MODE); //獲取狀態碼,判斷是否連線成功 if(!FTPReply.isPositiveCompletion(ftp.getReplyCode())) { throw new RuntimeException("FTP伺服器拒絕連線"); } int index=filename.lastIndexOf("/"); //獲取檔案的路徑 String path=filename.substring(0, index); //獲取檔名 String name=filename.substring(index+1); //判斷是否存在目錄 if(!ftp.changeWorkingDirectory(baePath+path)) { throw new RuntimeException("檔案路徑不存在:"+baePath+path); } //獲取該目錄所有檔案 FTPFile[] files=ftp.listFiles(); for (FTPFile file : files) { //判斷是否有目標檔案 //System.out.println("檔名"+file.getName()+"---"+name); if(file.getName().equals(name)) { //如果找到,將目標檔案複製到本地 inputStream = ftp.retrieveFileStream(file.getName()); ServletOutputStream outputStream = response.getOutputStream(); //讀取檔案流 int len = 0; byte[] buffer = new byte[1024 * 10]; while ((len = inputStream.read(buffer)) != -1){ outputStream.write(buffer,0,len); } outputStream.flush(); outputStream.close(); inputStream.close(); } } ftp.logout(); return true; } catch (Exception e) { throw new RuntimeException(e); }finally { if(ftp.isConnected()) { try { ftp.disconnect(); } catch (IOException e) { throw new RuntimeException(e); } } } } /** * 下載 * @param filename 檔名,注意!此處檔名為加路徑檔名,如:/good_images/20181017/2018101714573200096.png * @param localPath 存放到本地第地址 * @param baePath /lcp/images */ public boolean downloadFileWeb(String baePath,String filename,HttpServletResponse response) { FTPClient ftp=new FTPClient(); try { ftp.connect(host, port); ftp.login(username, password); //設定檔案編碼格式 ftp.setControlEncoding("UTF-8"); //ftp通訊有兩種模式 //PORT(主動模式)客戶端開通一個新埠(>1024)並通過這個埠傳送命令或傳輸資料,期間服務端只使用他開通的一個埠,例如21 //PASV(被動模式)客戶端向服務端傳送一個PASV命令,服務端開啟一個新埠(>1024),並使用這個埠與客戶端的21埠傳輸資料 //由於客戶端不可控,防火牆等原因,所以需要由服務端開啟埠,需要設定被動模式 ftp.enterLocalPassiveMode(); //設定傳輸方式為流方式 ftp.setFileTransferMode(FTP.STREAM_TRANSFER_MODE); //獲取狀態碼,判斷是否連線成功 if(!FTPReply.isPositiveCompletion(ftp.getReplyCode())) { throw new RuntimeException("FTP伺服器拒絕連線"); } int index=filename.lastIndexOf("/"); //獲取檔案的路徑 String path=filename.substring(0, index); //獲取檔名 String name=filename.substring(index+1); //判斷是否存在目錄 if(!ftp.changeWorkingDirectory(baePath+path)) { throw new RuntimeException("檔案路徑不存在:"+baePath+path); } //獲取該目錄所有檔案 FTPFile[] files=ftp.listFiles(); for (FTPFile file : files) { //判斷是否有目標檔案 //System.out.println("檔名"+file.getName()+"---"+name); if(file.getName().equals(name)) { //如果找到,將目標檔案複製到本地 response.addHeader("Content-Disposition", "attachment;filename=\"" + URLEncoder.encode(file.getName(), "UTF-8") + "\""); response.setHeader("Accept-Ranges", "bytes"); ServletOutputStream outputStream = response.getOutputStream() ; ftp.retrieveFile(file.getName(), outputStream); outputStream.flush(); outputStream.close(); } } ftp.logout(); return true; } catch (Exception e) { throw new RuntimeException(e); }finally { if(ftp.isConnected()) { try { ftp.disconnect(); } catch (IOException e) { throw new RuntimeException(e); } } } } /** * * @param filename 檔名,注意!此處檔名為加路徑檔名,如:/2015/06/04/aa.jpg * @param localPath 存放到本地第地址 * @return */ public boolean downloadFile(String baePath,String filename,String localPath) { FTPClient ftp=new FTPClient(); try { ftp.connect(host, port); ftp.login(username, password); //設定檔案編碼格式 ftp.setControlEncoding("UTF-8"); //ftp通訊有兩種模式 //PORT(主動模式)客戶端開通一個新埠(>1024)並通過這個埠傳送命令或傳輸資料,期間服務端只使用他開通的一個埠,例如21 //PASV(被動模式)客戶端向服務端傳送一個PASV命令,服務端開啟一個新埠(>1024),並使用這個埠與客戶端的21埠傳輸資料 //由於客戶端不可控,防火牆等原因,所以需要由服務端開啟埠,需要設定被動模式 ftp.enterLocalPassiveMode(); //設定傳輸方式為流方式 ftp.setFileTransferMode(FTP.STREAM_TRANSFER_MODE); //獲取狀態碼,判斷是否連線成功 if(!FTPReply.isPositiveCompletion(ftp.getReplyCode())) { throw new RuntimeException("FTP伺服器拒絕連線"); } int index=filename.lastIndexOf("/"); //獲取檔案的路徑 String path=filename.substring(0, index); //獲取檔名 String name=filename.substring(index+1); //判斷是否存在目錄 if(!ftp.changeWorkingDirectory(baePath+path)) { throw new RuntimeException("檔案路徑不存在:"+baePath+path); } //獲取該目錄所有檔案 FTPFile[] files=ftp.listFiles(); for (FTPFile file : files) { //判斷是否有目標檔案 //System.out.println("檔名"+file.getName()+"---"+name); if(file.getName().equals(name)) { //System.out.println("找到檔案"); //如果找到,將目標檔案複製到本地 File localFile =new File(localPath+"/"+file.getName()); OutputStream out=new FileOutputStream(localFile); ftp.retrieveFile(file.getName(), out); out.close(); } } ftp.logout(); return true; } catch (Exception e) { throw new RuntimeException(e); }finally { if(ftp.isConnected()) { try { ftp.disconnect(); } catch (IOException e) { throw new RuntimeException(e); } } } } /**刪除 * filename檔案相對路徑 * basePath 根路徑 * @param filename * @param basePath * @return */ public boolean deleteFile(String filename,String basePath) { FTPClient ftp=new FTPClient(); try { ftp.connect(host, port); ftp.login(username, password); //設定編碼格式 ftp.setControlEncoding("UTF-8"); ftp.enterLocalPassiveMode(); //獲取狀態碼,判斷是否連線成功 if(!FTPReply.isPositiveCompletion(ftp.getReplyCode())) { throw new RuntimeException("FTP伺服器拒絕連線"); } int index=filename.lastIndexOf("/"); //獲取檔案的路徑 String path=filename.substring(0, index); //獲取檔名 String name=filename.substring(index+1); //判斷是否存在目錄,不存在則說明檔案存在 if(!ftp.changeWorkingDirectory(basePath+path)) { return true; } if(ftp.deleteFile(name)) { clearDirectory(ftp, basePath, path); ftp.logout(); return true; } ftp.logout(); return false; } catch (Exception e) { throw new RuntimeException(e); }finally { if(ftp.isConnected()) { try { ftp.disconnect(); } catch (IOException e) { throw new RuntimeException(e); } } } } /** * * @param ftp * @param fileBasePath * @param path 以path為根,遞迴清除上面所有空的資料夾,直到出現不為空的資料夾停止,最多清除到fileBasePath結束 * @throws IOException */ private void clearDirectory(FTPClient ftp,String fileBasePath,String path) throws IOException { //如果路徑長度小於2,說明到頂了 if(path.length()<2) { return ; } //如果當前目錄檔案數目小於1則刪除此目錄 if(ftp.listNames(fileBasePath+path).length<1) { //刪除目錄 System.out.println("刪除目錄:"+fileBasePath+path); ftp.removeDirectory(fileBasePath+path); int index=path.lastIndexOf("/"); //路徑向上一層 path=path.substring(0, index); //繼續判斷 clearDirectory(ftp, fileBasePath, path); } } //兩個功能其中一個使用的話另一個需要註釋 public static void main(String []args) throws Exception { FtpUtil ftputil=new FtpUtil(); boolean downloadFile = ftputil.deleteFile("/2018/10/16/2018101608342700047.png", "/lcp/images"); LocalDateTime locTime=LocalDateTime.now(); DateTimeFormatter ofPattern = DateTimeFormatter.ofPattern("yyyyMMddHHmmssSSS"); double random = Math.random(); System.out.println(random); String format = locTime.format(ofPattern); System.out.println(format); } public String getHost() { return host; } public void setHost(String host) { this.host = host; } public int getPort() { return port; } public void setPort(int port) { this.port = port; } public String getUsername() { return username; } public void setUsername(String username) { this.username = username; } public String getPassword() { return password; } public void setPassword(String password) { this.password = password; } public String getfileBasePath() { return fileBasePath; } public void setfileBasePath(String fileBasePath) { this.fileBasePath = fileBasePath; } @Override public String toString() { return "FtpUtil [host=" + host + ", port=" + port + ", username=" + username + ", password=" + password + ", fileBasePath=" + fileBasePath + "]"; } }