使用Commons-net包实现ftp服务器的访问

项目需要实现从某银行的ftp服务器上定时下载数据文件的模块.于是使用apache的commons-net包实现ftp服务器的链接

中间使用了commons的io和Oro包.Io包封装了一些使用的方法,eg:安全的关闭各种流.根据文件的长度得到文件的方便识别的大小(k,m.g).还有一些其它使用的方法,读者可以下载后自行研究..

commons-net包封装了一些常见的网络包:ftp,smtp,pop3等..本文使用了ftp包的功能. 代码如下:

java 代码

import java.io.IOException;
import java.io.OutputStream;

import org.apache.commons.io.FileUtils;
import org.apache.commons.io.IOUtils;
import org.apache.commons.net.ftp.FTPClient;
import org.apache.commons.net.ftp.FTPFile;

/**
 * 使用commons的net包进行ftp链接.
 * 相关包：commons-net-1.4.1.jar ; commons-io-1.2.jar;jakarta-oro-2.0.8.jar测试通过.可以列出ftp上的文件
 * 通过把ftp服务器上的文件流连接到outSteam及可以把文件下载到本机的目录..限制如果目录为中文则需要处理.最好使用英文文件名
 * @author xzgf
 * email:
 *
 * @create 2007-2-11
 *
 */
public class ListFtpFile {

    private FTPClient ftpClient = new FTPClient();

    private OutputStream outSteam = null;

    /**
     * ftp服务器地址
     */
    private String hostName = "127.0.0.1";

    /**
     * 登录名
     */
    private String userName = "1";

    /**
     * 登录密码
     */
    private String password = "1";

    /**
     * 需要访问的远程目录
     */
    private String remoteDir = "/ClientTest";

    /**
     * 登录方法
     *
     */
    private void login() {
        try {
            //链接到ftp服务器
            ftpClient.connect(hostName);
            System.out.println("连接到ftp服务器：" + hostName + " 成功..开始登录");
            //登录.用户名 密码
            ftpClient.login(userName, password);
            System.out.println("登录成功.");

            FTPFile[] remoteFiles = ftpClient.listFiles(remoteDir);
            System.out.println("目录" + remoteDir + "下的文件:");
            if(remoteFiles != null) {
                for(int i=0;i
                    String name = remoteFiles[i].getName();
                    long length = remoteFiles[i].getSize();
                    String readableLength = FileUtils.byteCountToDisplaySize(length);
                    System.out.println(name + ":\t\t" + readableLength);
                }
            }

        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            //使用IO包关闭流
            IOUtils.closeQuietly(outSteam);
            try {
                ftpClient.disconnect();
            } catch (IOException ioe) {
                ioe.printStackTrace();
            }
        }
    }

    public static void main(String[] args) {
        ListFtpFile listFtpfiles = new ListFtpFile();
        listFtpfiles.login();
    }
}

寥寥几行实现了ftp服务器某个目录下的所有文件.当然本例中没有处理中文的问题,所以如果ftp上存在中文目录,则会出现乱码.

通过获得ftp的流,可以将文件下载到本地.配合正则表达式,可以实现从服务器上下载匹配规则的文件....

欢迎交流..

分享到：

为何无法发表文章啊? | Spring 是否可以使用Applet作为客户端？

• 2007-02-12 10:15
• 浏览 11923
• 评论(10)
• 论坛回复 / 浏览 (10 / 25010)
• 查看更多

评论

10 楼 cuclh27 2007-04-11  

有没有用apache的commons-net开发的ftp上传或者下载进度的代码啊，谢谢拉！！

9 楼 cuclh27 2007-04-09  

有没有处理中文文件夹或者中文文件名的dd

8 楼 fujohnwang 2007-02-13  

package org.darrenstudio.wrapper.ftp;

import java.io.IOException;

import org.apache.commons.net.ftp.FTPClient;
import org.apache.commons.net.ftp.FTPClientConfig;
import org.apache.commons.net.ftp.FTPReply;


/**
 * A Wrapper Class to Commons Net's FTPClient to ease the ftp transfer process
 * so Jakarta Commons Net needed.
 * @author Darren.Wang
 * @since 1.0 (2005-06-13)
 */
public class FtpTemplate {
	
	private FTPClientConfig ftpClientConfig;// optional 
	//
	private String server;// required
	private String username; // required
	private String password; // required
	//
	public FtpTemplate(String server,String user,String pwd)
	{
		this.server   = server;
		this.username = user;
		this.password = pwd;
	}
	
	public void transfer(FtpTransferCallback callback) throws IOException
	{
		FTPClient ftp = new FTPClient();
		try {
			if(this.getFtpClientConfig() != null)
				ftp.configure(this.getFtpClientConfig());
			ftp.connect(server);
			// check whether the connection to server is confirmed
			int reply = ftp.getReplyCode();
			if(!FTPReply.isPositiveCompletion(reply)) 
			{
		        ftp.disconnect();
		        throw new IOException("failed to connect to the FTP Server:"+server);
			}
			// login
			ftp.login(this.getUsername(),this.getPassword());
			
			// do your ftp operations in call back method
			callback.doTransfer(ftp);
			
			// logout
			ftp.logout();
			
		}
		finally
		{
			if(ftp.isConnected())
			{
				ftp.disconnect();
			}
		}
	}
	
	
	// Setters and getters
	public FTPClientConfig getFtpClientConfig() {
		return ftpClientConfig;
	}
	public void setFtpClientConfig(FTPClientConfig ftpClientConfig) {
		this.ftpClientConfig = ftpClientConfig;
	}
	public String getPassword() {
		return password;
	}
	public void setPassword(String password) {
		this.password = password;
	}
	public String getServer() {
		return server;
	}
	public void setServer(String server) {
		this.server = server;
	}
	public String getUsername() {
		return username;
	}
	public void setUsername(String username) {
		this.username = username;
	}
}

7 楼 eonhy 2007-02-13  

这个办法不错

以前做过一个通过定时器访问SAMBA目录读取数据文件的实现

6 楼 neptune 2007-02-13  

package org.uranus.tools.net.ftp;

import java.io.InputStream;
import java.util.Properties;

import org.apache.commons.net.ftp.FTPClient;
import org.apache.commons.net.ftp.FTPClientConfig;
import org.apache.commons.net.ftp.FTPReply;
import org.uranus.util.StringUtils;

/**
* 基于apache组织的commonNet开源组件实现ftp客户端<br>
* 本程序运行依赖于一个config成员变量属性,其是一个属性(Properties)对象<br>
* 系统要求这个config对象,必需有如下属性key:<br>
* server(ftp服务器ip地址或域名)<br>
* username(登录用户名)<br>
* password(登录密码)<br>
* 如下属性key是可选的:<br>
* systemKey(ftp服务器的操作系统key,如window)<br>
* serverLanguageCode(ftp服务器使用的语言,如zh)<br>
* <br>
* 本程序是线程安全,在每一个上传时都将创建ftp连接,上传结束后再关闭ftp连接<br>
*
* 例子:<br>
* InputStream localIn = new FileInputStream("c:\\计算机.txt");<br>
*
* java.util.Properties config = new Properties();<br>
* config.setProperty("server", "192.168.5.120");<br>
* config.setProperty("username", "upload");<br>
* config.setProperty("password", "upload");<br>
*
* FtpClientCommonNetImpl client = new FtpClientCommonNetImpl();<br>
* client.setConfig(config);<br>
* client.upload(localIn, "/aaa/计算机.txt", true);<br>
*
*
* @author zhangdb
*
*/
public class FtpClientCommonNetImpl implements IFtpClient {
// ftp配置
private Properties config;

/**
* 连接到ftp服务器
*
* @param server
* @param userName
* @param password
* @return
* @throws FtpException
*/
protected FTPClient connectFtpServer(String server, String userName,
String password) throws FtpException {
// 创建ftp客户端对象
FTPClient ftp = new FTPClient();
try {
ftp.configure(this.getFTPClientConfig());
// 连接ftp服务器
ftp.connect(server);
// 登录
ftp.login(userName, password);

// 返回值
int reply = ftp.getReplyCode();
if ((!FTPReply.isPositiveCompletion(reply))) {
ftp.disconnect();
throw new FtpException("登录ftp服务器失败,请检查server[" + server
+ "]、username[" + userName + "]、password[" + password
+ "]是否正确!");
}

return ftp;
} catch (Exception ex) {
throw new FtpException(ex);
}
}

/**
* 关闭连接
*
* @param ftp
*/
protected void disconnectFtpServer(FTPClient ftp) {
try {
ftp.logout();
ftp.disconnect();
} catch (Exception ex) {
throw new FtpException(ex);
}
}

/**
* 上传
*/
public void upload(InputStream localIn, String remoteFilePath)
throws FtpException {
String server = this.config.getProperty("server");
String userName = this.config.getProperty("username");
String password = this.config.getProperty("password");
FTPClient ftp = this.connectFtpServer(server, userName, password);

try {
boolean result = ftp.storeFile(this
.enCodingRemoteFilePath(remoteFilePath), localIn);
if (!result) {
throw new FtpException("文件上传失败!");
}
} catch (Exception ex) {
throw new FtpException(ex);
} finally {
this.disconnectFtpServer(ftp);
}
}

/**
* 上传结束以后关闭输入流
*
* @param localIn
* @param remoteFilePath
* @param afterUploadCloseInputStream
* @throws FtpException
*/
public void upload(InputStream localIn, String remoteFilePath,
boolean afterUploadCloseInputStream) throws FtpException {
try {
// 上传
this.upload(localIn, remoteFilePath);
} finally {
if (afterUploadCloseInputStream) {
if (localIn != null) {
try {
localIn.close();
} catch (Exception ex) {
throw new FtpException(ex);
}
}
}
}
}

/**
* 得到配置
*
* @return
*/
protected FTPClientConfig getFTPClientConfig() {
// 创建配置对象
FTPClientConfig conf = new FTPClientConfig(this.config.getProperty(
"systemKey", FTPClientConfig.SYST_NT));
conf.setServerLanguageCode(this.config.getProperty(
"serverLanguageCode", "zh"));
return conf;
}

/**
* 远程文件路径编码(上传到ftp上的文件路径)
*
* @param remoteFilePath
* @return
*/
protected String enCodingRemoteFilePath(String remoteFilePath) {
return StringUtils.gbkToIso8859EnCoding(remoteFilePath);
}

public Properties getConfig() {
return config;
}

public void setConfig(Properties config) {
this.config = config;
}

}

5 楼 inprise_lyj 2007-02-13  

不错，收着。

4 楼 jamesby 2007-02-12  

有没有上传功能,如果有,那文件共享又多了一种思路,通过FTP服务器实现文件共享,简单方便!

3 楼 jvincent 2007-02-12  

连上服务器只是第一步,还需要定义一个job来定时执行.所以不能像楼上说的那样.

2 楼 caocao 2007-02-12  

不错，apache的那些commons包很灵。
楼主有否考虑写ant的build.xml，让ant来搞定？

1 楼 zack 2007-02-12  

不错不错，好东西。有空要仔细看一看的。