学步园

利用org.apache.commons.net.ftp包实现一个简单的ftp客户端实用类。主要实现一下功能

1.支持上传下载。支持断点续传

2.支持进度汇报

3.支持对于中文目录及中文文件创建的支持。

具体请看代码，上面有详细的注释。简化版本请参见http://zhouzaibao.javaeye.com/blog/342766

枚举类UploadStatus代码

1. public enum UploadStatus {<br /> 2. Create_Directory_Fail, //远程服务器相应目录创建失败<br /> 3. Create_Directory_Success, //远程服务器闯将目录成功<br /> 4. Upload_New_File_Success, //上传新文件成功<br /> 5. Upload_New_File_Failed, //上传新文件失败<br /> 6. File_Exits, //文件已经存在<br /> 7. Remote_Bigger_Local, //远程文件大于本地文件<br /> 8. Upload_From_Break_Success, //断点续传成功<br /> 9. Upload_From_Break_Failed, //断点续传失败<br /> 10. Delete_Remote_Faild; //删除远程文件失败<br /> 11. }

枚举类DownloadStatus代码

1. public enum DownloadStatus {<br /> 2. Remote_File_Noexist, //远程文件不存在<br /> 3. Local_Bigger_Remote, //本地文件大于远程文件<br /> 4. Download_From_Break_Success, //断点下载文件成功<br /> 5. Download_From_Break_Failed, //断点下载文件失败<br /> 6. Download_New_Success, //全新下载文件成功<br /> 7. Download_New_Failed; //全新下载文件失败<br /> 8. }

核心FTP代码

核心FTP代码</p> <p>import java.io.File;<br /> import java.io.FileOutputStream;<br /> import java.io.IOException;<br /> import java.io.InputStream;<br /> import java.io.OutputStream;<br /> import java.io.PrintWriter;<br /> import java.io.RandomAccessFile;</p> <p>import open.mis.data.DownloadStatus;<br /> import open.mis.data.UploadStatus;</p> <p>import org.apache.commons.net.PrintCommandListener;<br /> import org.apache.commons.net.ftp.FTP;<br /> import org.apache.commons.net.ftp.FTPClient;<br /> import org.apache.commons.net.ftp.FTPFile;<br /> import org.apache.commons.net.ftp.FTPReply;</p> <p>/**<br /> * 支持断点续传的FTP实用类<br /> * @author BenZhou<br /> * @version 0.1 实现基本断点上传下载<br /> * @version 0.2 实现上传下载进度汇报<br /> * @version 0.3 实现中文目录创建及中文文件创建，添加对于中文的支持<br /> */<br /> public class ContinueFTP {<br /> public FTPClient ftpClient = new FTPClient();</p> <p>public ContinueFTP(){<br /> //设置将过程中使用到的命令输出到控制台<br /> this.ftpClient.addProtocolCommandListener(new PrintCommandListener(new PrintWriter(System.out)));<br /> }</p> <p>/**<br /> * 连接到FTP服务器<br /> * @param hostname 主机名<br /> * @param port 端口<br /> * @param username 用户名<br /> * @param password 密码<br /> * @return 是否连接成功<br /> * @throws IOException<br /> */<br /> public boolean connect(String hostname,int port,String username,String password) throws IOException{<br /> ftpClient.connect(hostname, port);<br /> ftpClient.setControlEncoding("GBK");<br /> if(FTPReply.isPositiveCompletion(ftpClient.getReplyCode())){<br /> if(ftpClient.login(username, password)){<br /> return true;<br /> }<br /> }<br /> disconnect();<br /> return false;<br /> }</p> <p>/**<br /> * 从FTP服务器上下载文件,支持断点续传，上传百分比汇报<br /> * @param remote 远程文件路径<br /> * @param local 本地文件路径<br /> * @return 上传的状态<br /> * @throws IOException<br /> */<br /> public DownloadStatus download(String remote,String local) throws IOException{<br /> //设置被动模式<br /> ftpClient.enterLocalPassiveMode();<br /> //设置以二进制方式传输<br /> ftpClient.setFileType(FTP.BINARY_FILE_TYPE);<br /> DownloadStatus result;</p> <p> //检查远程文件是否存在<br /> FTPFile[] files = ftpClient.listFiles(new String(remote.getBytes("GBK"),"iso-8859-1"));<br /> if(files.length != 1){<br /> System.out.println("远程文件不存在");<br /> return DownloadStatus.Remote_File_Noexist;<br /> }</p> <p> long lRemoteSize = files[0].getSize();<br /> File f = new File(local);<br /> //本地存在文件，进行断点下载<br /> if(f.exists()){<br /> long localSize = f.length();<br /> //判断本地文件大小是否大于远程文件大小<br /> if(localSize >= lRemoteSize){<br /> System.out.println("本地文件大于远程文件，下载中止");<br /> return DownloadStatus.Local_Bigger_Remote;<br /> }</p> <p> //进行断点续传，并记录状态<br /> FileOutputStream out = new FileOutputStream(f,true);<br /> ftpClient.setRestartOffset(localSize);<br /> InputStream in = ftpClient.retrieveFileStream(new String(remote.getBytes("GBK"),"iso-8859-1"));<br /> byte[] bytes = new byte[1024];<br /> long step = lRemoteSize /100;<br /> long process=localSize /step;<br /> int c;<br /> while((c = in.read(bytes))!= -1){<br /> out.write(bytes,0,c);<br /> localSize+=c;<br /> long nowProcess = localSize /step;<br /> if(nowProcess > process){<br /> process = nowProcess;<br /> if(process % 10 == 0)<br /> System.out.println("下载进度："+process);<br /> //TODO 更新文件下载进度,值存放在process变量中<br /> }<br /> }<br /> in.close();<br /> out.close();<br /> boolean isDo = ftpClient.completePendingCommand();<br /> if(isDo){<br /> result = DownloadStatus.Download_From_Break_Success;<br /> }else {<br /> result = DownloadStatus.Download_From_Break_Failed;<br /> }<br /> }else {<br /> OutputStream out = new FileOutputStream(f);<br /> InputStream in= ftpClient.retrieveFileStream(new String(remote.getBytes("GBK"),"iso-8859-1"));<br /> byte[] bytes = new byte[1024];<br /> long step = lRemoteSize /100;<br /> long process=0;<br /> long localSize = 0L;<br /> int c;<br /> while((c = in.read(bytes))!= -1){<br /> out.write(bytes, 0, c);<br /> localSize+=c;<br /> long nowProcess = localSize /step;<br /> if(nowProcess > process){<br /> process = nowProcess;<br /> if(process % 10 == 0)<br /> System.out.println("下载进度："+process);<br /> //TODO 更新文件下载进度,值存放在process变量中<br /> }<br /> }<br /> in.close();<br /> out.close();<br /> boolean upNewStatus = ftpClient.completePendingCommand();<br /> if(upNewStatus){<br /> result = DownloadStatus.Download_New_Success;<br /> }else {<br /> result = DownloadStatus.Download_New_Failed;<br /> }<br /> }<br /> return result;<br /> }</p> <p>/**<br /> * 上传文件到FTP服务器，支持断点续传<br /> * @param local 本地文件名称，绝对路径<br /> * @param remote 远程文件路径，使用/home/directory1/subdirectory/file.ext 按照Linux上的路径指定方式，支持多级目录嵌套，支持递归创建不存在的目录结构<br /> * @return 上传结果<br /> * @throws IOException<br /> */<br /> public UploadStatus upload(String local,String remote) throws IOException{<br /> //设置PassiveMode传输<br /> ftpClient.enterLocalPassiveMode();<br /> //设置以二进制流的方式传输<br /> ftpClient.setFileType(FTP.BINARY_FILE_TYPE);<br /> ftpClient.setControlEncoding("GBK");<br /> UploadStatus result;<br /> //对远程目录的处理<br /> String remoteFileName = remote;<br /> if(remote.contains("/")){<br /> remoteFileName = remote.substring(remote.lastIndexOf("/")+1);<br /> //创建服务器远程目录结构，创建失败直接返回<br /> if(CreateDirecroty(remote, ftpClient)==UploadStatus.Create_Directory_Fail){<br /> return UploadStatus.Create_Directory_Fail;<br /> }<br /> }</p> <p> //检查远程是否存在文件<br /> FTPFile[] files = ftpClient.listFiles(new String(remoteFileName.getBytes("GBK"),"iso-8859-1"));<br /> if(files.length == 1){<br /> long remoteSize = files[0].getSize();<br /> File f = new File(local);<br /> long localSize = f.length();<br /> if(remoteSize==localSize){<br /> return UploadStatus.File_Exits;<br /> }else if(remoteSize > localSize){<br /> return UploadStatus.Remote_Bigger_Local;<br /> }</p> <p> //尝试移动文件内读取指针,实现断点续传<br /> result = uploadFile(remoteFileName, f, ftpClient, remoteSize);</p> <p> //如果断点续传没有成功，则删除服务器上文件，重新上传<br /> if(result == UploadStatus.Upload_From_Break_Failed){<br /> if(!ftpClient.deleteFile(remoteFileName)){<br /> return UploadStatus.Delete_Remote_Faild;<br /> }<br /> result = uploadFile(remoteFileName, f, ftpClient, 0);<br /> }<br /> }else {<br /> result = uploadFile(remoteFileName, new File(local), ftpClient, 0);<br /> }<br /> return result;<br /> }<br /> /**<br /> * 断开与远程服务器的连接<br /> * @throws IOException<br /> */<br /> public void disconnect() throws IOException{<br /> if(ftpClient.isConnected()){<br /> ftpClient.disconnect();<br /> }<br /> }</p> <p>/**<br /> * 递归创建远程服务器目录<br /> * @param remote 远程服务器文件绝对路径<br /> * @param ftpClient FTPClient对象<br /> * @return 目录创建是否成功<br /> * @throws IOException<br /> */<br /> public UploadStatus CreateDirecroty(String remote,FTPClient ftpClient) throws IOException{<br /> UploadStatus status = UploadStatus.Create_Directory_Success;<br /> String directory = remote.substring(0,remote.lastIndexOf("/")+1);<br /> if(!directory.equalsIgnoreCase("/")&&!ftpClient.changeWorkingDirectory(new String(directory.getBytes("GBK"),"iso-8859-1"))){<br /> //如果远程目录不存在，则递归创建远程服务器目录<br /> int start=0;<br /> int end = 0;<br /> if(directory.startsWith("/")){<br /> start = 1;<br /> }else{<br /> start = 0;<br /> }<br /> end = directory.indexOf("/",start);<br /> while(true){<br /> String subDirectory = new String(remote.substring(start,end).getBytes("GBK"),"iso-8859-1");<br /> if(!ftpClient.changeWorkingDirectory(subDirectory)){<br /> if(ftpClient.makeDirectory(subDirectory)){<br /> ftpClient.changeWorkingDirectory(subDirectory);<br /> }else {<br /> System.out.println("创建目录失败");<br /> return UploadStatus.Create_Directory_Fail;<br /> }<br /> }</p> <p> start = end + 1;<br /> end = directory.indexOf("/",start);</p> <p> //检查所有目录是否创建完毕<br /> if(end <= start){<br /> break;<br /> }<br /> }<br /> }<br /> return status;<br /> }</p> <p>/**<br /> * 上传文件到服务器,新上传和断点续传<br /> * @param remoteFile 远程文件名，在上传之前已经将服务器工作目录做了改变<br /> * @param localFile 本地文件File句柄，绝对路径<br /> * @param processStep 需要显示的处理进度步进值<br /> * @param ftpClient FTPClient引用<br /> * @return<br /> * @throws IOException<br /> */<br /> public UploadStatus uploadFile(String remoteFile,File localFile,FTPClient ftpClient,long remoteSize) throws IOException{<br /> UploadStatus status;<br /> //显示进度的上传<br /> long step = localFile.length() / 100;<br /> long process = 0;<br /> long localreadbytes = 0L;<br /> RandomAccessFile raf = new RandomAccessFile(localFile,"r");<br /> OutputStream out = ftpClient.appendFileStream(new String(remoteFile.getBytes("GBK"),"iso-8859-1"));<br /> //断点续传<br /> if(remoteSize>0){<br /> ftpClient.setRestartOffset(remoteSize);<br /> process = remoteSize /step;<br /> raf.seek(remoteSize);<br /> localreadbytes = remoteSize;<br /> }<br /> byte[] bytes = new byte[1024];<br /> int c;<br /> while((c = raf.read(bytes))!= -1){<br /> out.write(bytes,0,c);<br /> localreadbytes+=c;<br /> if(localreadbytes / step != process){<br /> process = localreadbytes / step;<br /> System.out.println("上传进度:" + process);<br /> //TODO 汇报上传状态<br /> }<br /> }<br /> out.flush();<br /> raf.close();<br /> out.close();<br /> boolean result =ftpClient.completePendingCommand();<br /> if(remoteSize > 0){<br /> status = result?UploadStatus.Upload_From_Break_Success:UploadStatus.Upload_From_Break_Failed;<br /> }else {<br /> status = result?UploadStatus.Upload_New_File_Success:UploadStatus.Upload_New_File_Failed;<br /> }<br /> return status;<br /> }</p> <p>public static void main(String[] args) {<br /> ContinueFTP myFtp = new ContinueFTP();<br /> try {<br /> myFtp.connect("192.168.21.181", 21, "nid", "123");<br /> // myFtp.ftpClient.makeDirectory(new String("电视剧".getBytes("GBK"),"iso-8859-1"));<br /> // myFtp.ftpClient.changeWorkingDirectory(new String("电视剧".getBytes("GBK"),"iso-8859-1"));<br /> // myFtp.ftpClient.makeDirectory(new String("走西口".getBytes("GBK"),"iso-8859-1"));<br /> // System.out.println(myFtp.upload("E://yw.flv", "/yw.flv",5));<br /> // System.out.println(myFtp.upload("E://走西口24.mp4","/央视走西口/新浪网/走西口24.mp4"));<br /> System.out.println(myFtp.download("/央视走西口/新浪网/走西口24.mp4", "E://走西口242.mp4"));<br /> myFtp.disconnect();<br /> } catch (IOException e) {<br /> System.out.println("连接FTP出错："+e.getMessage());<br /> }<br /> }<br /> }<br />