在開發框架中使用FTP輔助類上傳或者下載文件，方便管理附件內容

在有些系統應用里面，我們需要對應用服務器、數據庫服務器、文件服務器進行分開，文件路徑等信息存儲在數據庫服務器里面，但文件內容則存儲在文件服務器里面，通過使用FTP進行文件的上傳下載，從而實現更加高效的IO輸出，也分擔了服務器的壓力。本篇隨筆介紹使用公用類庫里面的FTPHelper輔助類，實現文件的上傳下載等基礎操作。

1、FTPHelper輔助類的接口說明

首先我們為了方便輔助類的使用，使用了構造函數進行對象的參數初始化，如下所示。

我們整個FTPHelper輔助類，是使用FTP命令和FTP服務器進行交換，因此需要如果要獲取文件或目錄信息，那么就需要對這些信息進行轉換為合適格式的內容，這里我們定義一個結構體用來承載這些信息。

這樣我們可以順利把FTP服務器的字符串返回（DOS格式或者Unix格式字符串）它們轉換為對應的結構體，方便使用了。

 

整個輔助函數，提供了一些基礎的函數來操作FTP文件或者目錄，如下所示

        /// <summary>
        /// 僅獲取文件列表
        /// </summary>
        /// <returns>獲取的文件列表</returns>
        public List<FileStruct> ListFiles()
        
        /// <summary>
        /// 僅獲取目錄列表
        /// </summary>
        /// <returns>獲取到的目錄列表</returns>
        public List<FileStruct> ListDirectories()    

以及

        /// <summary>
        /// 關閉FTP服務器的所有連接
        /// </summary>
        public void Disconnect()

        /// <summary>
        /// 連接到FTP服務器
        /// </summary>
        /// <param name="server">FTP服務器的IP或者主機名</param>
        /// <param name="port">FTP服務器端口</param>
        /// <param name="user">登錄用戶名</param>
        /// <param name="pass">登錄密碼</param>
        public void Connect(string server, int port, string user, string pass)        
        
        /// <summary>
        /// 獲取FTP的當前工作目錄
        /// </summary>
        public string GetWorkingDirectory()        
        
        /// <summary>
        /// 在FTP服務器上改變目錄
        /// </summary>
        public void ChangeDir(string path)        
        
        /// <summary>
        /// 在FTP服務器上創建新的目錄
        /// </summary>
        public void MakeDir(string dir)        
        
        /// <summary>
        /// 在FTP服務器上移除目錄
        /// </summary>
        public void RemoveDir(string dir)    
        
        /// <summary>
        /// 在FTP上移除一個文件
        /// </summary>
        public void RemoveFile(string filename)        
        
        /// <summary>
        /// 在FTP服務器上重命名一個文件
        /// </summary>
        /// <param name="oldfilename">舊文件名</param>
        /// <param name="newfilename">新文件名</param>
        public void RenameFile(string oldfilename, string newfilename)

        /// <summary>
        /// 打開一個存在的文件（支持續傳）上傳
        /// </summary>
        /// <param name="filename">本地上傳的文件（包含文件路徑）</param>
        /// <param name="remote_filename">存儲在FTP上的文件名稱</param>
        /// <param name="resume">如果存在，指定是否續傳</param>
        public void OpenUpload(string filename, string remote_filename, bool resume)

        /// <summary>
        /// 打開下載一個文件
        /// </summary>
        /// <param name="remote_filename">FTP上的遠端文件名</param>
        /// <param name="local_filename">另存為的文件名稱(包含文件路徑)</param>
        /// <param name="resume">如果存在，指定是否續傳</param>
        public void OpenDownload(string remote_filename, string local_filename, bool resume)    
        
        /// <summary>
        /// 上傳文件，循環操作直到文件全部上傳完畢
        /// </summary>
        /// <returns>發送的字節數組大小</returns>
        public long DoUpload()
        
        /// <summary>
        /// 下載文件，循環操作直到文件全部下載完畢
        /// </summary>
        /// <returns>收到的字節數組大小</returns>
        public long DoDownload()
        

2、FTPHelper輔助類的使用

基於上述的接口，我們編寫了一個使用Demo，主要用來介紹這個輔助類的各種接口使用。

獲取到的測試結果輸出如下所示

雖然我們在附件管理里面采用了更為通用的《附件管理模塊》，統一上傳文件到服務器上進行管理，並提供下載管理等內容，連接如下：

《Winform開發框架之附件管理應用》。其他公用類庫的使用說明，具體可以參考文章《公用類庫使用幫助》

不過我們開發的時候，為了方便，也可以使用 FTPHelper輔助類進行簡單的文件上傳下載操作。