使用Apache 的commons-net 包实现FTP上传下载小结

短命女 2022-06-13 03:44 725阅读 0赞

原项目里用JDk6的sun[.][]net.ftp.FtpClient实现FTP的上传下载，这个类在jdk的帮助文档中没有具体的说明，也就是并没有对外公开。并且这个类是在jdk的 rt.jar中实现的，jdk1.7下其构造函数FtpClient()被定义为private类型，所以无法new了。 在jdk1.7，已经换成了 FtpClient.create(ip)方法

现在公司要升级jdk版本到1.7，需要把原来的ftp功能重写，索性使用Apache 的commons-net 来实现这个功能，这样就跟jdk的版本没关系了

以下是对原来项目的FTP工具类进行更换后的代码

import java.io.File;
    import java.io.FileInputStream;
    import java.io.FileOutputStream;
    import java.io.IOException;
    import java.io.OutputStream;
    import java.util.ArrayList;
    import java.util.List;
    import java.util.StringTokenizer;
    
    import org.apache.commons.logging.Log;
    import org.apache.commons.logging.LogFactory;
    import org.apache.commons.net.ftp.*;
    import org.apache.mina.core.RuntimeIoException;
    
    /**
     * FTP上传工具类
     * 
     */
    public class FtpUtil {
    	protected final Log log = LogFactory.getLog(getClass());
    	private String ip = "";
    	private String username = "";
    	private String password = "";
    	private int port = -1;
    	private String path = "";
    	private FTPClient ftpClient = null;
    	//private OutputStream os = null;
    	//private FileInputStream is = null;
    
    	public FtpUtil(String serverIP, String username, String password) {
    		this.ip = serverIP;
    		this.username = username;
    		this.password = password;
    	}
    
    	public FtpUtil(String serverIP, int port, String username, String password) {
    		this.ip = serverIP;
    		this.username = username;
    		this.password = password;
    		this.port = port;
    	}
    
    	/**
    	 * 连接ftp服务器
    	 * 
    	 * @throws IOException
    	 */
    	public boolean connectServer() {
    		ftpClient = new FTPClient();
    	// 使用commons-net 包里面的ftp时，建立目录的时候会有中文乱码，主要是ftp的文件名编码是iso-8859-1的，所以在根据文件名获取输出流的时候需要对文件名转编码格式：
        // ftpClient.storeFileStream(new String(fullPath.getBytes("utf-8"), "iso-8859-1")),或者在和ftp建立连接之前，直接设置ftp的编码:
            ftpClient.setControlEncoding("UTF-8");
    		ftpClient.setControlEncoding("UTF-8");
    		try {
    			if (this.port != -1) {
    				ftpClient.connect(this.ip, this.port);
    			} else {
    				ftpClient.connect(this.ip);
    			}
    			ftpClient.login(this.username, this.password);
    			if (this.path.length() != 0) {
    				ftpClient.changeWorkingDirectory (this.path);// path是ftp服务下主目录的子目录
    	
    			}
    			ftpClient.setFileType(FTPClient.BINARY_FILE_TYPE);;// 用2进制上传、下载
    			return true;
    		} catch (Exception e) {
    			log.error("FtpUtil.connectServer()===>>>", e);
    			e.printStackTrace();
    			return false;
    		}
    	}
    
    	/**
    	 * 断开与ftp服务器连接
    	 * 
    	 * @throws IOException
    	 */
    	public boolean closeServer() {
    		try {
    			if (ftpClient != null) {
    				ftpClient.disconnect();
    			}
    			return true;
    		} catch (Exception e) {
    			log.error("FtpUtil.closeServer()===>>>\n", e);
    			e.printStackTrace();
    			return false;
    		}
    	}
    
    	/**
    	 * 检查文件夹在当前目录下是否存在
    	 * 
    	 * @param dir
    	 * @return
    	 */
    	private boolean isDirExist(String dir) {
    		String pwd = "";
    		try {
    			pwd = ftpClient.printWorkingDirectory();
    			if(!ftpClient.changeWorkingDirectory(dir)){return false;};
    			ftpClient.changeWorkingDirectory(pwd);
    		} catch (Exception e) {
    			log.error("dir is not exist===>>>" + dir + "\n", e);
    			return false;
    		}
    		return true;
    	}
    
    	/**
    	 * 在当前目录下创建文件夹
    	 * 
    	 * @param dir
    	 * @return
    	 * @throws Exception
    	 */
    	 public boolean makeDirectory(String dir) {
    	        boolean flag = true;
    	        try {
    	            flag = ftpClient.makeDirectory(dir);
    	            if (flag) {
    	                log.info("创建文件夹" + dir + " 成功！");
    
    	            } else {
    	            	log.info("创建文件夹" + dir + " 失败！");
    	            }
    	        } catch (Exception e) {
    	            e.printStackTrace();
    	            return false;
    	        }
    	        return flag;
    	    }
    
    
    	/**
    	 * ftp上传 如果服务器段已存在名为filename的文件夹，该文件夹中与要上传的文件夹中同名的文件将被替换
    	 * 
    	 * @param filename
    	 *            要上传的文件（或文件夹）名
    	 * @return
    	 * @throws Exception
    	 */
    	public boolean upload(String filename) {
    		String newname = "";
    		if (filename.indexOf(File.separator) > -1) {
    			newname = filename
    					.substring(filename.lastIndexOf(File.separator) + 1);
    		} else {
    			newname = filename;
    		}
    		return upload(filename, newname);
    	}
    
    	/**
    	 * ftp上传 如果服务器段已存在名为newName的文件夹，该文件夹中与要上传的文件夹中同名的文件将被替换
    	 * 
    	 * @param fileName
    	 *            要上传的文件（或文件夹）名
    	 * @param newName
    	 *            服务器段要生成的文件（或文件夹）名
    	 * @return
    	 */
    	public boolean upload(String fileName, String newName) {
    		try {
    		//	String savefilename = new String(fileName.getBytes("ISO-8859-1"),
    		//			"GBK");
    			File file_in = new File(fileName);// 打开本地待长传的文件
    			if (!file_in.exists()) {
    				throw new Exception("此文件或文件夹[" + file_in.getName() + "]有误或不存在!");
    			}
    			if (file_in.isDirectory()) {
    				upload(file_in.getPath(), newName, ftpClient.printWorkingDirectory());
    			} else {
    				uploadFile(file_in.getPath(), newName);
    			}
    
    			log.info("file >>>" + fileName + " >>>upload SUCCESS!");
    			return true;
    		} catch (Exception e) {
    			log.error(
    					"FtpUtil.upload(String fileName, String newName)===>>>\n",
    					e);
    			e.printStackTrace();
    			return false;
    		} 
    	}
    
    	/**
    	 * 真正用于上传的方法
    	 * 
    	 * @param fileName
    	 * @param newName
    	 * @param path
    	 * @throws Exception
    	 */
    	private void upload(String fileName, String newName, String path)
    			throws Exception {
    		//String savefilename = new String(fileName.getBytes("ISO-8859-1"), "GBK");
    		File file_in = new File(fileName);// 打开本地待长传的文件
    		if (!file_in.exists()) {
    			throw new Exception("此文件或文件夹[" + file_in.getName() + "]有误或不存在!");
    		}
    		if (file_in.isDirectory()) {
    			if (!isDirExist(newName)) {
    				makeDirectory(newName);
    			}
    			ftpClient.changeWorkingDirectory(newName);
    			File sourceFile[] = file_in.listFiles();
    			for (int i = 0; i < sourceFile.length; i++) {
    				if (!sourceFile[i].exists()) {
    					continue;
    				}
    				if (sourceFile[i].isDirectory()) {
    					this.upload(sourceFile[i].getPath(), sourceFile[i]
    							.getName(), path + "/" + newName);
    				} else {
    					this.uploadFile(sourceFile[i].getPath(), sourceFile[i]
    							.getName());
    				}
    			}
    		} else {
    			uploadFile(fileName, newName);
    		}
    		ftpClient.changeWorkingDirectory(path);
    	}
    
    	/**
    	 * upload 上传文件
    	 * 
    	 * @param filename
    	 *            要上传的文件名
    	 * @param newname
    	 *            上传后的新文件名
    	 * @return -1 文件不存在 >=0 成功上传，返回文件的大小
    	 * @throws Exception
    	 */
    	public long uploadFile(String filename, String newname) throws Exception {
    		long result = 0;
    		FileInputStream input=null;
    		OutputStream out=null;
    		try {
    			java.io.File file_in = new java.io.File(filename);
    			if (!file_in.exists())
    				return -1;
    			 out = ftpClient.storeFileStream(newname);
    			 input = new FileInputStream(file_in);
    			 byte[] bytes = new byte[1024];
    				int c;
    				while ((c = input.read(bytes)) != -1) {
    					out.write(bytes, 0, c);
    				}						
    		} catch (Exception e) {
    			log.error("FtpUtil.uploadFile()===>>>\n", e);
    			e.printStackTrace();
    		} finally {
    			if (input != null) {
    				input.close();
    			}
    			if (out != null) {
    				out.close();
    			}
    			ftpClient.completePendingCommand();  //这个代码不执行的话第二次上传文件时，上面out会为null，上传空文件
    		}
    		return result;
    	}
    
    	/**
    	 * 从ftp下载文件到本地
    	 * 
    	 * @param filename
    	 *            服务器上的文件名 
    	 * @param newfilename
    	 *            本地生成的文件名
    	 * @return
    	 * @throws Exception
    	 */
    	public long downloadFile(String filename, String newfilename) {
    		long result = 0;
    		
    		FileOutputStream os = null;
    		try {
    			java.io.File outfile = new java.io.File(newfilename);
    			os = new FileOutputStream(outfile);
    			ftpClient.retrieveFile(filename, os);  
    		} catch (Exception e) {
    			log.error("FtpUtil.downloadFile()===>>>\n", e);
    			e.printStackTrace();
    		} finally {
    			try {
    				
    				if (os != null) {
    					os.close();
    				}
    			} catch (IOException e) {
    				log.error("FtpUtil.downloadFile()===>>>\n", e);
    				e.printStackTrace();
    			}
    		}
    		return result;
    	}
    
    	/**
    	 * 取得相对于当前连接目录的某个目录下所有文件列表
    	 * 
    	 * @param path
    	 * @return
    	 */
    	public List getFileList(String path) {
    		List list = new ArrayList();
    		try{
    			ftpClient.changeWorkingDirectory (path);	
    		FTPFile[] fs = ftpClient.listFiles();  
    		for (FTPFile ff : fs) { 
    				list.add(ff.getName());
    		}
    		} catch (Exception e) {
    			log.error("FtpUtil.getFileList()===>>>\n", e);
    			e.printStackTrace();
    		}
    		return list;
    	}
    
    	/**
    	 * 删除FTP上一个文件 silly
    	 * 
    	 * @param fileName
    	 *            文件名
    	 */
    	public boolean removeFile(String fileName) {
    		boolean flag=false;
    		if (ftpClient != null) {
    			try {
    				flag=ftpClient.deleteFile(fileName);
    				log.info("removeFile::" + fileName + "->" + flag);
    			} catch (IOException e) {				
    				log.info("删除"+fileName+"文件异常"+e);
    			}			
    		}
    		return flag;
    	}
    
    	/**
    	 * 删除FTP上一个目录 silly
    	 * 
    	 * @param dirName
    	 *            目录名
    	 */
    	public boolean removeDir(String dirName) {
    		boolean flag=false;
    		if (ftpClient != null) {
    			try {
    				flag=ftpClient.removeDirectory(dirName);
    				log.info("removeFile::" + dirName + "->" + flag);
    			} catch (IOException e) {				
    				log.info("删除"+dirName+"文件夹异常"+e);
    			}			
    		}
    		return flag;
    			
    	}
    
    	public static void main(String[] args) {
    		FtpUtil ftp = new FtpUtil("192.168.146.134", "chenweihuan", "xxh123");
    		ftp.connectServer();
    		
    		
    		try {
    			
    		//	boolean result=ftp.upload("E:\\pass");
    		//	ftp.downloadFile("lsjdas.txt", "E:/lsjdas.txt");
    		//	System.out.print(result);
    		} catch (Exception e) {
    			e.printStackTrace();
    		}finally{
    			
    			ftp.closeServer();
    			
    		}
    		
    	}
    
    
    	public FTPClient getFtpClient() {
    		return ftpClient;
    	}
    }

[.]: http://lib.csdn.net/base/dotnet