本文使用.net 2.0(c#)来实现一般的ftp功能
介绍
微软的.net framework 2.0相对于1.x来说增加了对ftp的支持。以前为了符合我的需求,我不等不使用第三方类库来实现ftp功能,但是为了可靠,还是使用.net framework的类比较好。我的这段代码没有做成可重复使用的类库的形式,但它却是比较容易理解的并能满足你的需求。它可以实现上传,下载,删除等任意功能。在这篇文章的后面将给大家出示.net 2.0下实现ftp的简单代码,使用的语言是c#。或许是因为这是.net新增的类,又或许是第三方类库已经能很好的实现你的需求,.net 2.0的这部分类库并没有得到足够的关注。
背景
作为我的工作的一部分,我已经使用了ftp模块,但是我只能在.net 1.1中去使用它,所以我不能深入的研究.net 2.0下ftp的实现。但是我相信,.ne 2.0下对ftp的支持是非常好的。
代码
不要忘记引入命名空间
using system.net;
using system.io;
下面的几个步骤包括了使用ftpwebrequest类实现ftp功能的一般过程
1、创建一个ftpwebrequest对象,指向ftp服务器的uri
2、设置ftp的执行方法(上传,下载等)
3、给ftpwebrequest对象设置属性(是否支持ssl,是否使用二进制传输等)
4、设置登录验证(用户名,密码)
5、执行请求
6、接收相应流(如果需要的话)
7、如果没有打开的流,则关闭ftp请求
开发任何ftp应用程序都需要一个相关的ftp服务器及它的配置信息。ftpwebrequest暴露了一些属性来设置这些信息。
接下来的代码示例了上传功能
首先设置一个uri地址,包括路径和文件名。这个uri被使用在ftpwebrequest实例中。
然后根据ftp请求设置ftpwebrequest对象的属性
其中一些重要的属性如下:
·credentials - 指定登录ftp服务器的用户名和密码。
·keepalive - 指定连接是应该关闭还是在请求完成之后关闭,默认为true
·usebinary - 指定文件传输的类型。有两种文件传输模式,一种是binary,另一种是ascii。两种方法在传输时,字节的第8位是不同的。ascii使用第8位作为错误控制,而binary的8位都是有意义的。所以当你使用ascii传输时要小心一些。简单的说,如果能用记事本读和写的文件用ascii传输就是安全的,而其他的则必须使用binary模式。当然使用binary模式发送ascii文件也是非常好的。
·usepassive - 指定使用主动模式还是被动模式。早先所有客户端都使用主动模式,而且工作的很好,而现在因为客户端防火墙的存在,将会关闭一些端口,这样主动模式将会失败。在这种情况下就要使用被动模式,但是一些端口也可能被服务器的防火墙封掉。不过因为ftp服务器需要它的ftp服务连接到一定数量的客户端,所以他们总是支持被动模式的。这就是我们为什么要使用被动模式的原意,为了确保数据可以正确的传输,使用被动模式要明显优于主动模式。(译者注:主动(port)模式建立数据传输通道是由服务器端发起的,服务器使用20端口连接客户端的某一个大于1024的端口;在被动(pasv)模式中,数据传输的通道的建立是由ftp客户端发起的,他使用一个大于1024的端口连接服务器的1024以上的某一个端口)
·contentlength - 设置这个属性对于ftp服务器是有用的,但是客户端不使用它,因为ftpwebrequest忽略这个属性,所以在这种情况下,该属性是无效的。但是如果我们设置了这个属性,ftp服务器将会提前预知文件的大小(在upload时会有这种情况)
·method - 指定当前请求是什么命令(upload,download,filelist等)。这个值定义在结构体webrequestmethods.ftp中。
private void upload(string filename)
{
fileinfo fileinf = new fileinfo(filename);
string uri = "ftp://" + ftpserverip + "/" + fileinf.name;
ftpwebrequest reqftp;
// 根据uri创建ftpwebrequest对象
reqftp = (ftpwebrequest)ftpwebrequest.create(new uri("ftp://" + ftpserverip + "/" + fileinf.name));
// ftp用户名和密码
reqftp.credentials = new networkcredential(ftpuserid, ftppassword);
// 默认为true,连接不会被关闭
// 在一个命令之后被执行
reqftp.keepalive = false;
// 指定执行什么命令
reqftp.method = webrequestmethods.ftp.uploadfile;
// 指定数据传输类型
reqftp.usebinary = true;
// 上传文件时通知服务器文件的大小
reqftp.contentlength = fileinf.length;
// 缓冲大小设置为2kb
int bufflength = 2048;
byte[] buff = new byte[bufflength];
int contentlen;
// 打开一个文件流 (system.io.filestream) 去读上传的文件
filestream fs = fileinf.openread();
try
{
// 把上传的文件写入流
stream strm = reqftp.getrequeststream();
// 每次读文件流的2kb
contentlen = fs.read(buff, 0, bufflength);
// 流内容没有结束
while (contentlen != 0)
{
// 把内容从file stream 写入 upload stream
strm.write(buff, 0, contentlen);
contentlen = fs.read(buff, 0, bufflength);
}
// 关闭两个流
strm.close();
fs.close();
}
catch (exception ex)
{
messagebox.show(ex.message, "upload error");
}
}
以上代码简单的示例了ftp的上传功能。创建一个指向某ftp服务器的ftpwebrequest对象,然后设置其不同的属性credentials,keepalive,method,usebinary,contentlength。
打开本地机器上的文件,把其内容写入ftp请求流。缓冲的大小为2kb,无论上传大文件还是小文件,这都是一个合适的大小。
private void download(string filepath, string filename)
{
ftpwebrequest reqftp;
try
{
filestream outputstream = new filestream(filepath + "//" + filename, filemode.create);
reqftp = (ftpwebrequest)ftpwebrequest.create(new uri("ftp://" + ftpserverip + "/" + filename));
reqftp.method = webrequestmethods.ftp.downloadfile;
reqftp.usebinary = true;
reqftp.credentials = new networkcredential(ftpuserid, ftppassword);
ftpwebresponse response = (ftpwebresponse)reqftp.getresponse();
stream ftpstream = response.getresponsestream();
long cl = response.contentlength;
int buffersize = 2048;
int readcount;
byte[] buffer = new byte[buffersize];
readcount = ftpstream.read(buffer, 0, buffersize);
while (readcount > 0)
{
outputstream.write(buffer, 0, readcount);
readcount = ftpstream.read(buffer, 0, buffersize);
}
ftpstream.close();
outputstream.close();
response.close();
}
catch (exception ex)
{
messagebox.show(ex.message);
}
}
上面的代码实现了从ftp服务器上下载文件的功能。这不同于之前所提到的上传功能,下载需要一个响应流,它包含着下载文件的内容。这个下载的文件是在ftpwebrequest对象中的uri指定的。在得到所请求的文件后,通过ftpwebrequest对象的getresponse()方法下载文件。它将把文件作为一个流下载到你的客户端的机器上。
注意:我们可以设置文件在我们本地机器上的存放路径和名称。
public string[] getfilelist()
{
string[] downloadfiles;
stringbuilder result = new stringbuilder();
ftpwebrequest reqftp;
try
{
reqftp = (ftpwebrequest)ftpwebrequest.create(new uri("ftp://" + ftpserverip + "/"));
reqftp.usebinary = true;
reqftp.credentials = new networkcredential(ftpuserid, ftppassword);
reqftp.method = webrequestmethods.ftp.listdirectory;
webresponse response = reqftp.getresponse();
streamreader reader = new streamreader(response.getresponsestream());
string line = reader.readline();
while (line != null)
{
result.append(line);
result.append("/n");
line = reader.readline();
}
// to remove the trailing '/n'
result.remove(result.tostring().lastindexof('/n'), 1);
reader.close();
response.close();
return result.tostring().split('/n');
}
catch (exception ex)
{
system.windows.forms.messagebox.show(ex.message);
downloadfiles = null;
return downloadfiles;
}
}
上面的代码示例了如何从ftp服务器上获得文件列表。uri指向ftp服务器的地址。我们使用streamreader对象来存储一个流,文件名称列表通过“/r/n”分隔开,也就是说每一个文件名称都占一行。你可以使用streamreader对象的readtoend()方法来得到文件列表。上面的代码中我们用一个stringbuilder对象来保存文件名称,然后把结果通过分隔符分开后作为一个数组返回。我确定只是一个比较好的方法。
其他的实现如rename,delete,getfilesize,filelistdetails,makedir等与上面的几段代码类似,就不多说了。
注意:实现重命名的功能时,要把新的名字设置给ftpwebrequest对象的renameto属性。连接指定目录的时候,需要在ftpwebrequest对象所使用的uri中指明。
需要注意的地方
你在编码时需要注意以下几点:
·除非enablessl属性被设置成true,否作所有数据,包括你的用户名和密码都将明文发给服务器,任何监视网络的人都可以获取到你连接服务器的验证信息。如果你连接的ftp服务器提供了ssl,你就应当把enablessl属性设置为true。
·如果你没有访问ftp服务器的权限,将会抛出securityexception错误
·发送请求到ftp服务器需要调用getresponse方法。当请求的操作完成后,一个ftpwebresponse对象将返回。这个ftpwebresponse对象提供了操作的状态和已经从ftp服务器上下载的数据。ftpwebresponse对象的statuscode属性提供了ftp服务器返回的最后的状态代码。ftpwebresponse对象的statusdescription属性为这个状态代码的描述。
新闻热点
疑难解答
图片精选