本文使用.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屬性為這個狀態代碼的描述。