java FTP 工具類 同步文件夾 下載文件..等操作(FtpHelper 需要commons-net-3.5.jar)

package com.esb.component;


import java.io.BufferedOutputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Date;
import java.util.List;


import org.apache.commons.net.ftp.FTPClient;
import org.apache.commons.net.ftp.FTPClientConfig;
import org.apache.commons.net.ftp.FTPFile;
import org.apache.commons.net.ftp.FTPFileFilter;
import org.apache.commons.net.ftp.FTPReply;
/*import org.dom4j.Document;
import org.dom4j.DocumentHelper;
import org.dom4j.Element;
import org.dom4j.io.OutputFormat;
import org.dom4j.io.XMLWriter;
*/
public class FtpHelper {


private FTPClient ftp = null;
/**
* Ftp服務器
*/
private String server;
/**
* 用戶名
*/
private String uname;
/**
* 密碼
*/
private String password;
/**
* 連接端口，默認21
*/
private int port = 21;

//private Document document ;


public FtpHelper(String server, int port, String uname,
String password){
this.server = server;
if (this.port > 0){
this.port = port;
}
this.uname = uname;
this.password = password;
//初始化
ftp = new FTPClient();
}
/**
* 連接FTP服務器
* 
* @param server
* @param uname
* @param password
* @return
* @throws Exception
*/
public FTPClient connectFTPServer() throws Exception {
try {
ftp.setControlEncoding("GBK");
//ftp.setControlEncoding("UTF-8");

ftp.configure(getFTPClientConfig());
ftp.connect(this.server, this.port);
if (!ftp.login(this.uname, this.password)) {
ftp.logout();
ftp = null;
return ftp;
}


// 文件類型,默認是ASCII
ftp.setFileType(FTPClient.BINARY_FILE_TYPE);

// 設置被動模式
ftp.enterLocalPassiveMode();
ftp.setConnectTimeout(10000);
ftp.setBufferSize(1024);
// 響應信息
int replyCode = ftp.getReplyCode();
if ((!FTPReply.isPositiveCompletion(replyCode))) {
// 關閉Ftp連接
closeFTPClient();
// 釋放空間
ftp = null;
throw new Exception("登錄FTP服務器失敗,請檢查![Server:" + server + "、"
+ "User:" + uname + "、" + "Password:" + password);
} else {
return ftp;
}
} catch (Exception e) {
ftp.disconnect();
ftp = null;
throw e;
}
}


/**
* 配置FTP連接參數
* 
* @return
* @throws Exception
*/
public FTPClientConfig getFTPClientConfig() throws Exception {
String systemKey = FTPClientConfig.SYST_UNIX;//FTPClientConfig.SYST_NT;
String serverLanguageCode = "zh";
FTPClientConfig conf = new FTPClientConfig(systemKey);
conf.setServerLanguageCode(serverLanguageCode);
conf.setDefaultDateFormatStr("yyyy-MM-dd");
return conf;
}


/**
* 向FTP根目錄上傳文件
* 
* @param localFile
* @param newName
*            新文件名
* @throws Exception
*/
public Boolean uploadFile(String localFile, String newName)
throws Exception {
InputStream input = null;
boolean success = false;
try {
File file = null;
if (checkFileExist(localFile)) {
file = new File(localFile);
}
input = new FileInputStream(file);
success = ftp.storeFile(newName, input);
if (!success) {
throw new Exception("文件上傳失敗!");
}
} catch (Exception e) {
throw e;
} finally {
if (input != null) {
input.close();
}
}
return success;
}


/**
* 向FTP根目錄上傳文件
* 
* @param input
* @param newName
*            新文件名
* @throws Exception
*/
public Boolean uploadFile(InputStream input, String newName)
throws Exception {
boolean success = false;
try {
success = ftp.storeFile(newName, input);
if (!success) {
throw new Exception("文件上傳失敗!");
}
} catch (Exception e) {
throw e;
} finally {
if (input != null) {
input.close();
}
}
return success;
}


/**
* 向FTP指定路徑上傳文件
* 
* @param localFile
* @param newName
*            新文件名
* @param remoteFoldPath
* @throws Exception
*/
public Boolean uploadFile(String localFile, String newName,
String remoteFoldPath) throws Exception {


InputStream input = null;
boolean success = false;
try {
File file = null;
if (checkFileExist(localFile)) {
file = new File(localFile);
}
input = new FileInputStream(file);


// 改變當前路徑到指定路徑
if (!this.changeDirectory(remoteFoldPath)) {
System.out.println("服務器路徑不存!");
return false;
}
success = ftp.storeFile(newName, input);
if (!success) {
throw new Exception("文件上傳失敗!");
}
} catch (Exception e) {
throw e;
} finally {
if (input != null) {
input.close();
}
}
return success;
}


/**
* 向FTP指定路徑上傳文件
* 
* @param input
* @param newName
*            新文件名
* @param remoteFoldPath
* @throws Exception
*/
public Boolean uploadFile(InputStream input, String newName,
String remoteFoldPath) throws Exception {
boolean success = false;
try {
// 改變當前路徑到指定路徑
if (!this.changeDirectory(remoteFoldPath)) {
System.out.println("服務器路徑不存!");
return false;
}
success = ftp.storeFile(newName, input);
if (!success) {
throw new Exception("文件上傳失敗!");
}
} catch (Exception e) {
throw e;
} finally {
if (input != null) {
input.close();
}
}
return success;
}
/**
* 從FTP服務器下載文件
* 
* @param remotePath
*            FTP路徑(不包含文件名)
* @param fileName
*            下載文件名
* @param localPath
*            本地路徑
*/
public Boolean downloadFile(String remotePath, String fileName,
String localPath) throws Exception {
Date begin=new Date();
BufferedOutputStream output = null;
boolean success = false;
try {
File dir =new File(localPath);
if(!dir.exists())
dir.mkdirs();

// 檢查本地路徑
this.checkFileExist(localPath);
// 改變工作路徑
if (!this.changeDirectory(remotePath)) {
System.out.println("當前路徑 "+ftp.printWorkingDirectory()+" 服務器路徑"+remotePath+"不存在");
return false;
}
// 列出當前工作路徑下的文件列表
List<FTPFile> fileList = this.getFileList();
if (fileList == null || fileList.size() == 0) {
System.out.println("服務器當前路徑下不存在文件！");
return success;
}


File localFilePath = new File(localPath + File.separator
+ fileName);
output = new BufferedOutputStream(new FileOutputStream(
localFilePath));
success = ftp.retrieveFile(fileName, output);
if(!success){
System.err.println("文件下載失敗:"+remotePath+" "+fileName);
}else{
System.out.println("下載成功 (耗時:"+(System.currentTimeMillis()-begin.getTime())/1000d+" s)："+remotePath+"/"+fileName+"-> "+localPath+"/"+fileName);
}

/*for (FTPFile ftpfile : fileList) {
String ftpFileName=ftpfile.getName();
if (ftpFileName.equals(fileName)) {
File localFilePath = new File(localPath + File.separator
+ ftpFileName);
output = new BufferedOutputStream(new FileOutputStream(
localFilePath));
success = ftp.retrieveFile(ftpFileName, output);
if(!success){
System.err.println("文件下載失敗:"+remotePath+" "+fileName);
}
}else{
System.err.println("ftpFileName.equals(fileName) 不匹配 "+ftpFileName+" "+fileName);
}
}*/
/*if (!success) {
throw new Exception("文件下載失敗!");
}*/
} catch (Exception e) {
throw e;
} finally {
if (output != null) {
output.close();
}
}
return success;
}


/**
* 從FTP服務器獲取文件流
* 
* @param remoteFilePath
* @return
* @throws Exception
*/
public InputStream downloadFile(String remoteFilePath) throws Exception {


return ftp.retrieveFileStream(remoteFilePath);
}


/**
* 獲取FTP服務器上指定路徑下的文件列表
* 
* @param filePath
* @return
*/
/*
public List<FTPFile> getFtpServerFileList(String remotePath)
throws Exception {


FTPListParseEngine engine = ftp.initiateListParsing(remotePath);
List<FTPFile> ftpfiles = Arrays.asList(engine.getNext(25));


return ftpfiles;
}*/


/**
* 獲取FTP服務器上[指定路徑]下的文件列表
* 
* @param path
* @return
* @throws Exception
*/
public List<FTPFile> getFileList(String remotePath) throws Exception {
if(remotePath!=null && !remotePath.endsWith("/")){
remotePath+="/";
}
List<FTPFile> ftpfiles = Arrays.asList(ftp.listFiles(remotePath,new FTPFileFilter() {
@Override
public boolean accept(FTPFile f) {
/*if(remotePath2!=null && remotePath2.equals(f.getName()) && f.getType()==FTPFile.DIRECTORY_TYPE){
return false;
}*/
if(".".equals(f.getName()) || "..".equals(f.getName())){
return false;
}
return true;
}
}));


return ftpfiles;
}


/**
* 獲取FTP服務器[當前工作路徑]下的文件列表
* 
* @param path
* @return
* @throws Exception
*/
public List<FTPFile> getFileList() throws Exception {


List<FTPFile> ftpfiles = Arrays.asList(ftp.listFiles(null,new FTPFileFilter() {
@Override
public boolean accept(FTPFile f) {
if(!".".equals(f.getName()) && !"..".equals(f.getName())){
return true;
}
return false;
}
}));

return ftpfiles;
}


/**
* 改變FTP服務器工作路徑 
* 
* @param remoteFoldPath
*/
public Boolean changeDirectory(String remoteFoldPath) throws Exception {


return ftp.changeWorkingDirectory(remoteFoldPath);
}


/**
* 刪除文件
* 
* @param remoteFilePath
* @return
* @throws Exception
*/
public Boolean deleteFtpServerFile(String remoteFilePath) throws Exception {


return ftp.deleteFile(remoteFilePath);
}


/**
* 創建目錄
* 
* @param remoteFoldPath
* @return
*/
public boolean createFold(String remoteFoldPath) throws Exception {


boolean flag = ftp.makeDirectory(remoteFoldPath);
if (!flag) {
throw new Exception("創建目錄失敗");
}
return false;
}


/**
* 刪除目錄
* @param remoteFoldPath
* @return
* @throws Exception
*/
public boolean deleteFold(String remoteFoldPath) throws Exception {

return ftp.removeDirectory(remoteFoldPath) ;
}


/**
* 刪除目錄以及文件
* 
* @param remoteFoldPath
* @return
*/
public boolean deleteFoldAndsubFiles(String remoteFoldPath)
throws Exception {


boolean success = false;
List<FTPFile> list = this.getFileList(remoteFoldPath);
if (list == null || list.size() == 0) {
return deleteFold(remoteFoldPath);
}
for (FTPFile ftpFile : list) {

String name = ftpFile.getName();
if (ftpFile.isDirectory()) {
success = deleteFoldAndsubFiles(remoteFoldPath + "/" + name);
if (!success)
break;
} else {
success = deleteFtpServerFile(remoteFoldPath + "/" + name);
if (!success)
break;
}
}
if (!success)
return false;
success = deleteFold(remoteFoldPath);
return success;
}


/**
* 檢查本地路徑是否存在
* 
* @param filePath
* @return
* @throws Exception
*/
public boolean checkFileExist(String filePath) throws Exception {
boolean flag = false;
File file = new File(filePath);
if (!file.exists()) {
throw new Exception("本地路徑不存在,請檢查!");
} else {
flag = true;
}
return flag;
}

/**
* 創建XML文件
* @return
*/
/*public Element getCurrentElement(){
document = DocumentHelper.createDocument();
return document.addElement("root");
}*/

/**
* 生成目錄XML文件
*/
/*public void createDirectoryXML(String remotePath,Element fatherElement) throws Exception{


List<FTPFile> list = this.getFileList();
for(FTPFile ftpfile:list){
Element currentElement = fatherElement; //當前的目錄節點
String newRemotePath = remotePath+ftpfile.getName();
if(ftpfile.isDirectory()){
Element dirElement = fatherElement.addElement("dir") ;
dirElement.addAttribute("name",ftpfile.getName());
currentElement = dirElement;
this.changeDirectory(newRemotePath); //從根目錄開始
createDirectoryXML(newRemotePath,dirElement);
}else{
Element fileElement = fatherElement.addElement("file");//文件節點
fileElement.setText(ftpfile.getName()) ;
}
}
}*/

/**
* 保存xml
*/
/*public void saveXML(){
XMLWriter output = new XMLWriter();
        //輸出格式化
        OutputFormat format = OutputFormat.createPrettyPrint();
        try {
            output = new XMLWriter(new FileWriter("src/com/shine/Ftp/config/dir.xml"), format);
            output.write(this.document);
            output.close();
        } catch (IOException e) {
            e.printStackTrace();
        }
}*/

/**
* 關閉FTP連接
* 
* @param ftp
* @throws Exception
*/
public void closeFTPClient(FTPClient ftp) throws Exception {


try {
if (ftp.isConnected())
ftp.logout();
ftp.disconnect();
} catch (Exception e) {
throw new Exception("關閉FTP服務出錯!");
}
}


/**
* 關閉FTP連接
* 
* @throws Exception
*/
public void closeFTPClient() throws Exception {


this.closeFTPClient(this.ftp);
}


/**
* Get Attribute Method
* 
*/
public FTPClient getFtp() {
return ftp;
}


public String getServer() {
return server;
}


public String getUname() {
return uname;
}


public String getPassword() {
return password;
}


public int getPort() {
return port;
}


/**
* Set Attribute Method
* 
*/
public void setFtp(FTPClient ftp) {
this.ftp = ftp;
}


public void setServer(String server) {
this.server = server;
}


public void setUname(String uname) {
this.uname = uname;
}


public void setPassword(String password) {
this.password = password;
}


public void setPort(int port) {
this.port = port;
}

public int synFtpFolder(String remotePath,String localPath) throws Exception{
if(remotePath==null){
remotePath="/";
}else if(!remotePath.startsWith("/")){
remotePath="/"+remotePath;
}

List<FTPFile> lst=getFileList(remotePath);
int fileCount=0;
System.out.println("同步文件夾：" +remotePath+" "+lst.size());
for(int i=0;i<lst.size();i++){
FTPFile f=lst.get(i);
if(f.getType()==FTPFile.DIRECTORY_TYPE){
fileCount+=synFtpFolder((remotePath=="/"?"":remotePath)+"/"+f.getName(),localPath+"/"+f.getName());
}else if(f.getType()==FTPFile.FILE_TYPE){
System.out.println("同步文件:"+remotePath+"/"+f.getName()+"  ");
File dir=new File(localPath);
if(!dir.exists()){
dir.mkdirs();
}

downloadFile(remotePath, f.getName(), localPath);
fileCount++;
}else{
System.out.println("ftp文件 特殊類型"+f.getType());
}
}
return fileCount;
}
public List<FTPFile> getAllFiles(String remotePath) throws Exception{
Date begin=new Date();
if(remotePath==null){
remotePath="/";
}else if(!remotePath.startsWith("/")){
remotePath="/"+remotePath;
}
List<FTPFile> files=new ArrayList<>();
List<FTPFile> lst=getFileList(remotePath);
for(int i=0;i<lst.size();i++){
FTPFile f=lst.get(i);
if(f.getType()==FTPFile.DIRECTORY_TYPE){
files.addAll(getAllFiles((remotePath=="/"?"":remotePath)+"/"+f.getName()));
}else if(f.getType()==FTPFile.FILE_TYPE){
files.add(f);
}else{
System.out.println("ftp文件 特殊類型"+f.getType());
}
}
System.out.println("遍歷"+remotePath+" 耗時 "+(System.currentTimeMillis()-begin.getTime())/1000d+" s");
return files;
}
/**
* 主方法(測試)
* 
* 問題：上傳時命名的新文件名不能有中文，否則上傳失敗.
* 
* @param args
* @throws Exception 
*/
public static void main(String[] args) throws Exception {
/*try {
FtpHelper fu = new FtpHelper("192.168.2.18", 21, "administrator","sunshine");
fu.connectFTPServer();
Element fatherElement = fu.getCurrentElement();
fu.createDirectoryXML("/", fatherElement);
fu.saveXML();
} catch (Exception e) {
System.out.println("異常信息：" + e.getMessage());
}*/

FtpHelper fu = new FtpHelper("192.168.1.137", 88, "HoPacs","cnhis");
//FtpHelper fu = new FtpHelper("192.168.1.213", 88, "martin","martin");
fu.connectFTPServer();

//fu.do"ftp://HoPacs:[email protected]:88/RisImgDir/2016-06-21/US0000000001/US0000000001.jpg"

/*fu.changeDirectory("RisImgDir/2013-11-27/US0000000013");

List<FTPFile> lst=fu.getFileList();
System.out.println(lst.size());
for(int i=0;i<lst.size();i++){
FTPFile f=lst.get(i);

System.out.println("類型:"+f.getType()+"  "+f);
if(f.getType()==FTPFile.DIRECTORY_TYPE){

}else if(f.getType()==FTPFile.FILE_TYPE){
fu.downloadFile("/RisImgDir/2013-11-27/US0000000013", f.getName(), "D:/workspace/testFTP/ftp");
}else{
System.out.println("ftp文件 特殊類型"+f.getType());
}
}*/

//同步文件夾
/* 
int count=fu.synFtpFolder("/2015-08-18","D:/workspace/testFTP/ftp");
System.out.println("文件同步總數量"+count);*/

//遍歷根目錄
List<FTPFile> allFiles=fu.getAllFiles(null);
for(FTPFile f: allFiles){
System.out.println(f.getName()+" "+(f.getTimestamp()==null?null:f.getTimestamp().getTime().toLocaleString()));
}

//fu.downloadFile("/test","《技術服務部制度》修訂版V1.4.pdf","D:/workspace/testFTP/ftp/localftp") ;


//fu.downloadFile("/21877","《技術服務部制度》修訂版V1.4.pdf","D:/workspace/testFTP/ftp") ;

/*for(FTPFile f: fu.getFileList("/21877")){
System.out.println(f.getName());
}*/

/*fu.changeDirectory("/2012-07-11/US0000000009");
System.out.println(fu.getFileList("/").size());*/

/*fu.changeDirectory("/2012-07-11/US0000000009");
boolean b=fu.changeDirectory("/2012-07-11/US0000000009");
System.out.println("存在目錄? "+b);*/

fu.closeFTPClient();
}
}