[翻譯].net 2.0(c#)下簡單的FTP應用程式 zhuan

原文地址：http://www.c-sharpcorner.com/UploadFile/neo_matrix/SimpleFTP01172007082222AM/SimpleFTP.aspx
[原文源碼下載]

 

.net 2.0(c#)下簡單的FTP應用程式

原文發布日期：2007.01.18
作者：Neo Matrix
翻譯：webabcd

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