【愚公系列】2022年03月 C#帮助类-FTP的花样操作

简介: 【愚公系列】2022年03月 C#帮助类-FTP的花样操作

前言

文件传输协议(File Transfer Protocol,FTP)是用于在网络上进行文件传输的一套标准协议,它工作在 OSI 模型的第七层, TCP 模型的第四层, 即应用层, 使用 TCP 传输而不是 UDP, 客户在和服务器建立连接前要经过一个“三次握手”的过程, 保证客户与服务器之间的连接是可靠的, 而且是面向连接, 为数据传输提供可靠保证。


FTP允许用户以文件操作的方式(如文件的增、删、改、查、传送等)与另一主机相互通信。然而, 用户并不真正登录到自己想要存取的计算机上面而成为完全用户, 可用FTP程序访问远程资源, 实现用户往返传输文件、目录管理以及访问电子邮件等等, 即使双方计算机可能配有不同的操作系统和文件存储方式。


一、FTP的花样操作

1.配置文件

public class FTPConfig
{
    /// <summary>
    /// 
    /// </summary>
    public FTPConfig()
    {
        IsUpload = false;
        FtpServerIP = "127.0.0.1";
        FtpRemotePath = "";
        FtpUserID = "ftpTest";
        FtpPassword = "a123456.";
    }
    /// <summary>
    /// 是否上传
    /// </summary>
    public bool IsUpload { get; set; }
    /// <summary>
    /// FTP的IP地址
    /// </summary>
    public string FtpServerIP { get; set; }
    /// <summary>
    /// 上传FTP目录
    /// </summary>
    public string FtpRemotePath { get; set; }
    /// <summary>
    /// 用户名
    /// </summary>
    public string FtpUserID { get; set; }
    /// <summary>
    /// 密码
    /// </summary>
    public string FtpPassword { get; set; }
}

2.FTP的操作封装类

public class FTPHelp
{
    private string ftpURI;
    private FTPConfig ftpConfig { get; set; }
    /// <summary>
    ///  连接FTP
    /// </summary>
    /// <param name="ftpConfig"></param>
    public FTPHelp(FTPConfig ftpConfig)
    {
        this.ftpConfig = ftpConfig;
        if (string.IsNullOrEmpty(this.ftpConfig.FtpRemotePath))
        {
            ftpURI = "ftp://" + this.ftpConfig.FtpServerIP + "/";
        }
        else
        {
            ftpURI = "ftp://" + this.ftpConfig.FtpServerIP + "/" + this.ftpConfig.FtpRemotePath + "/";
        }
    }
    /// <summary>
    /// 上传
    /// </summary>
    /// <param name="filename"></param>
    public void Upload(string filename)
    {
        if (ftpConfig.IsUpload)
        {
            FileInfo fileInfo = new FileInfo(filename);
            string uri = ftpURI + fileInfo.Name;
            FtpWebRequest reqFTP;
            reqFTP = (FtpWebRequest)FtpWebRequest.Create(new Uri(uri));
            reqFTP.Credentials = new NetworkCredential(ftpConfig.FtpUserID, ftpConfig.FtpPassword);
            reqFTP.KeepAlive = false;
            reqFTP.Method = WebRequestMethods.Ftp.UploadFile;
            reqFTP.UseBinary = true;
            reqFTP.ContentLength = fileInfo.Length;
            int buffLength = 2048;
            byte[] buff = new byte[buffLength];
            int contentLen;
            using (FileStream fs = fileInfo.OpenRead())
            {
                using (Stream strm = reqFTP.GetRequestStream())
                {
                    try
                    {
                        contentLen = fs.Read(buff, 0, buffLength);
                        while (contentLen != 0)
                        {
                            strm.Write(buff, 0, contentLen);
                            contentLen = fs.Read(buff, 0, buffLength);
                        }
                        strm.Close();
                        fs.Close();
                    }
                    catch (Exception ex)
                    {
                        string errorMessage = "Upload Error --> " + ex.Message;
                        //logger.Error(errorMessage);
                        throw;
                    }
                }
            }
        }
        else
        {
            //logger.Debug("[UploadData] uploadConfig.IsUpload is false,abort to loaddata");
        }
    }
    /// <summary>
    /// 下载
    /// </summary>
    /// <param name="filePath"></param>
    /// <param name="fileName"></param>
    public void Download(string filePath, string fileName)
    {
        FtpWebRequest reqFTP;
        try
        {
            FileStream outputStream = new FileStream(filePath + "\\" + fileName, FileMode.Create);
            reqFTP = (FtpWebRequest)FtpWebRequest.Create(new Uri(ftpURI + fileName));
            reqFTP.Method = WebRequestMethods.Ftp.DownloadFile;
            reqFTP.UseBinary = true;
            reqFTP.Credentials = new NetworkCredential(ftpConfig.FtpUserID, ftpConfig.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)
        {
            string errorMessage = "Download Error --> " + ex.Message;
            //logger.Error(errorMessage);
            throw;
        }
    }
    /// <summary>
    /// 删除文件
    /// </summary>
    /// <param name="fileName"></param>
    public void Delete(string fileName)
    {
        try
        {
            string uri = ftpURI + fileName;
            FtpWebRequest reqFTP;
            reqFTP = (FtpWebRequest)FtpWebRequest.Create(new Uri(uri));
            reqFTP.Credentials = new NetworkCredential(ftpConfig.FtpUserID, ftpConfig.FtpPassword);
            reqFTP.KeepAlive = false;
            reqFTP.Method = WebRequestMethods.Ftp.DeleteFile;
            string result = String.Empty;
            FtpWebResponse response = (FtpWebResponse)reqFTP.GetResponse();
            long size = response.ContentLength;
            Stream datastream = response.GetResponseStream();
            StreamReader sr = new StreamReader(datastream);
            result = sr.ReadToEnd();
            sr.Close();
            datastream.Close();
            response.Close();
        }
        catch (Exception ex)
        {
            string errorMessage = "Delete Error --> " + ex.Message + "  文件名:" + fileName;
            //logger.Error(errorMessage);
            throw;
        }
    }
    /// <summary>
    /// 删除文件夹
    /// </summary>
    /// <param name="folderName"></param>
    public void RemoveDirectory(string folderName)
    {
        try
        {
            string uri = ftpURI + folderName;
            FtpWebRequest reqFTP;
            reqFTP = (FtpWebRequest)FtpWebRequest.Create(new Uri(uri));
            reqFTP.Credentials = new NetworkCredential(ftpConfig.FtpUserID, ftpConfig.FtpPassword);
            reqFTP.KeepAlive = false;
            reqFTP.Method = WebRequestMethods.Ftp.RemoveDirectory;
            string result = String.Empty;
            FtpWebResponse response = (FtpWebResponse)reqFTP.GetResponse();
            long size = response.ContentLength;
            Stream datastream = response.GetResponseStream();
            StreamReader sr = new StreamReader(datastream);
            result = sr.ReadToEnd();
            sr.Close();
            datastream.Close();
            response.Close();
        }
        catch (Exception ex)
        {
            string errorMessage = "Delete Error --> " + ex.Message + "  文件名:" + folderName;
            //logger.Error(errorMessage);
            throw;
        }
    }
    /// <summary>
    /// 获取当前目录下明细(包含文件和文件夹)
    /// </summary>
    /// <returns></returns>
    public string[] GetFilesDetailList()
    {
        string[] downloadFiles;
        try
        {
            StringBuilder result = new StringBuilder();
            FtpWebRequest ftp;
            ftp = (FtpWebRequest)FtpWebRequest.Create(new Uri(ftpURI));
            ftp.Credentials = new NetworkCredential(ftpConfig.FtpUserID, ftpConfig.FtpPassword);
            ftp.Method = WebRequestMethods.Ftp.ListDirectoryDetails;
            WebResponse response = ftp.GetResponse();
            StreamReader reader = new StreamReader(response.GetResponseStream(), Encoding.Default);
            string line = reader.ReadLine();
            while (line != null)
            {
                result.Append(line);
                result.Append("\n");
                line = reader.ReadLine();
            }
            result.Remove(result.ToString().LastIndexOf("\n"), 1);
            reader.Close();
            response.Close();
            return result.ToString().Split('\n');
        }
        catch (Exception ex)
        {
            downloadFiles = null;
            //logger.Error(ex);
            return downloadFiles;
        }
    }
    /// <summary>
    /// 获取当前目录下文件列表(仅文件)
    /// </summary>
    /// <returns></returns>
    public string[] GetFileList(string mask)
    {
        string[] downloadFiles;
        StringBuilder result = new StringBuilder();
        FtpWebRequest reqFTP;
        try
        {
            reqFTP = (FtpWebRequest)FtpWebRequest.Create(new Uri(ftpURI));
            reqFTP.UseBinary = true;
            reqFTP.Credentials = new NetworkCredential(ftpConfig.FtpUserID, ftpConfig.FtpPassword);
            reqFTP.Method = WebRequestMethods.Ftp.ListDirectory;
            WebResponse response = reqFTP.GetResponse();
            StreamReader reader = new StreamReader(response.GetResponseStream(), Encoding.Default);
            string line = reader.ReadLine();
            while (line != null)
            {
                if (mask.Trim() != string.Empty && mask.Trim() != "*.*")
                {
                    string mask_ = mask.Substring(0, mask.IndexOf("*"));
                    if (line.Substring(0, mask_.Length) == mask_)
                    {
                        result.Append(line);
                        result.Append("\n");
                    }
                }
                else
                {
                    result.Append(line);
                    result.Append("\n");
                }
                line = reader.ReadLine();
            }
            result.Remove(result.ToString().LastIndexOf('\n'), 1);
            reader.Close();
            response.Close();
            return result.ToString().Split('\n');
        }
        catch (Exception ex)
        {
            downloadFiles = null;
            if (ex.Message.Trim() != "远程服务器返回错误: (550) 文件不可用(例如,未找到文件,无法访问文件)。")
            {
                string errorMessage = "GetFileList Error --> " + ex.Message.ToString();
                //logger.Error(errorMessage);
            }
            return downloadFiles;
        }
    }
    /// <summary>
    /// 获取当前目录下所有的文件夹列表(仅文件夹)
    /// </summary>
    /// <returns></returns>
    public string[] GetDirectoryList()
    {
        string[] drectory = GetFilesDetailList();
        string m = string.Empty;
        foreach (string str in drectory)
        {
            int dirPos = str.IndexOf("<DIR>");
            if (dirPos > 0)
            {
                /*判断 Windows 风格*/
                m += str.Substring(dirPos + 5).Trim() + "\n";
            }
            else if (str.Trim().Substring(0, 1).ToUpper() == "D")
            {
                /*判断 Unix 风格*/
                string dir = str.Substring(49).Trim();
                if (dir != "." && dir != "..")
                {
                    m += dir + "\n";
                }
            }
        }
        char[] n = new char[] { '\n' };
        return m.Split(n);
    }
    /// <summary>
    /// 判断当前目录下指定的子目录是否存在
    /// </summary>
    /// <param name="RemoteDirectoryName">指定的目录名</param>
    public bool DirectoryExist(string RemoteDirectoryName)
    {
        string[] dirList = GetDirectoryList();
        foreach (string str in dirList)
        {
            if (str.Trim() == RemoteDirectoryName.Trim())
            {
                return true;
            }
        }
        return false;
    }
    /// <summary>
    /// 判断当前目录下指定的文件是否存在
    /// </summary>
    /// <param name="RemoteFileName">远程文件名</param>
    public bool FileExist(string RemoteFileName)
    {
        string[] fileList = GetFileList("*.*");
        foreach (string str in fileList)
        {
            if (str.Trim() == RemoteFileName.Trim())
            {
                return true;
            }
        }
        return false;
    }
    /// <summary>
    /// 创建文件夹
    /// </summary>
    /// <param name="dirName"></param>
    public void MakeDir()
    {
        if (!string.IsNullOrEmpty(ftpConfig.FtpRemotePath))
        {
            FtpWebRequest reqFTP;
            try
            {
                // dirName = name of the directory to create.
                reqFTP = (FtpWebRequest)FtpWebRequest.Create(new Uri(ftpURI));
                reqFTP.Method = WebRequestMethods.Ftp.MakeDirectory;
                reqFTP.UseBinary = true;
                reqFTP.Credentials = new NetworkCredential(ftpConfig.FtpUserID, ftpConfig.FtpPassword);
                FtpWebResponse response = (FtpWebResponse)reqFTP.GetResponse();
                Stream ftpStream = response.GetResponseStream();
                ftpStream.Close();
                response.Close();
            }
            catch (Exception ex)
            {
                string errorMesasge = "MakeDir Error --> " + ex.Message;
                //logger.Error(errorMesasge);
                throw;
            }
        }
    }
    /// <summary>
    /// 获取指定文件大小
    /// </summary>
    /// <param name="filename"></param>
    /// <returns></returns>
    public long GetFileSize(string filename)
    {
        FtpWebRequest reqFTP;
        long fileSize = 0;
        try
        {
            reqFTP = (FtpWebRequest)FtpWebRequest.Create(new Uri(ftpURI + filename));
            reqFTP.Method = WebRequestMethods.Ftp.GetFileSize;
            reqFTP.UseBinary = true;
            reqFTP.Credentials = new NetworkCredential(ftpConfig.FtpUserID, ftpConfig.FtpPassword);
            FtpWebResponse response = (FtpWebResponse)reqFTP.GetResponse();
            Stream ftpStream = response.GetResponseStream();
            fileSize = response.ContentLength;
            ftpStream.Close();
            response.Close();
        }
        catch (Exception ex)
        {
            string errorMesasge = "GetFileSize Error --> " + ex.Message;
            //logger.Error(errorMesasge);
            throw;
        }
        return fileSize;
    }
    /// <summary>
    /// 改名
    /// </summary>
    /// <param name="currentFilename"></param>
    /// <param name="newFilename"></param>
    public void ReName(string currentFilename, string newFilename)
    {
        FtpWebRequest reqFTP;
        try
        {
            reqFTP = (FtpWebRequest)FtpWebRequest.Create(new Uri(ftpURI + currentFilename));
            reqFTP.Method = WebRequestMethods.Ftp.Rename;
            reqFTP.RenameTo = newFilename;
            reqFTP.UseBinary = true;
            reqFTP.Credentials = new NetworkCredential(ftpConfig.FtpUserID, ftpConfig.FtpPassword);
            FtpWebResponse response = (FtpWebResponse)reqFTP.GetResponse();
            Stream ftpStream = response.GetResponseStream();
            ftpStream.Close();
            response.Close();
        }
        catch (Exception ex)
        {
            string errorMesasge = "ReName Error --> " + ex.Message;
            //logger.Error(errorMesasge);
            throw;
        }
    }
    /// <summary>
    /// 移动文件
    /// </summary>
    /// <param name="currentFilename"></param>
    /// <param name="newDirectory"></param>
    public void MovieFile(string currentFilename, string newDirectory)
    {
        ReName(currentFilename, newDirectory);
    }
    /// <summary>
    /// 切换当前目录
    /// </summary>
    /// <param name="DirectoryName"></param>
    /// <param name="IsRoot">true 绝对路径   false 相对路径</param>
    public void GotoDirectory(string DirectoryName, bool IsRoot)
    {
        if (IsRoot)
        {
            ftpConfig.FtpRemotePath = DirectoryName;
        }
        else
        {
            ftpConfig.FtpRemotePath += DirectoryName + "/";
        }
        ftpURI = "ftp://" + ftpConfig.FtpServerIP + "/" + ftpConfig.FtpRemotePath + "/";
    }
    /// <summary>
    /// 删除订单目录
    /// </summary>
    /// <param name="ftpConfig"></param>
    /// <param name="folderToDelete"></param>
    public static void DeleteOrderDirectory(FTPConfig ftpConfig, string folderToDelete)
    {
        try
        {
            if (!string.IsNullOrEmpty(ftpConfig.FtpServerIP) &&
                !string.IsNullOrEmpty(folderToDelete) &&
                !string.IsNullOrEmpty(ftpConfig.FtpUserID) &&
                !string.IsNullOrEmpty(ftpConfig.FtpPassword))
            {
                FTPTestViewModel fw = new FTPTestViewModel(ftpConfig);
                //进入订单目录
                fw.GotoDirectory(folderToDelete, true);
                //获取规格目录
                string[] folders = fw.GetDirectoryList();
                foreach (string folder in folders)
                {
                    if (!string.IsNullOrEmpty(folder) || folder != "")
                    {
                        //进入订单目录
                        string subFolder = folderToDelete + "/" + folder;
                        fw.GotoDirectory(subFolder, true);
                        //获取文件列表
                        string[] files = fw.GetFileList("*.*");
                        if (files != null)
                        {
                            //删除文件
                            foreach (string file in files)
                            {
                                fw.Delete(file);
                            }
                        }
                        //删除冲印规格文件夹
                        fw.GotoDirectory(folderToDelete, true);
                        fw.RemoveDirectory(folder);
                    }
                }
                //删除订单文件夹
                string parentFolder = folderToDelete.Remove(folderToDelete.LastIndexOf('/'));
                string orderFolder = folderToDelete.Substring(folderToDelete.LastIndexOf('/') + 1);
                fw.GotoDirectory(parentFolder, true);
                fw.RemoveDirectory(orderFolder);
            }
            else
            {
                throw new Exception("FTP 及路径不能为空!");
            }
        }
        catch (Exception ex)
        {
            throw new Exception("删除订单时发生错误,错误信息为:" + ex.Message);
        }
    }
}

3.使用

public void Upload()
{
    ftpConfig.IsUpload = true;
    Upload(@"D:\temp.png");
    MessageBox.Show("上传完成!!!");
}
public void Download()
{
    Download(@"D:\", "temp.png");
    MessageBox.Show("下载完成!!!");
}
public void Delete()
{
    Delete("temp.png");
    MessageBox.Show("删除完成!!!");
}
相关文章
|
5月前
|
C#
C#学习相关系列之数据类型类的三大特性(二)
C#学习相关系列之数据类型类的三大特性(二)
|
1月前
|
存储 C# 索引
C# 一分钟浅谈:数组与集合类的基本操作
【9月更文挑战第1天】本文详细介绍了C#中数组和集合类的基本操作,包括创建、访问、遍历及常见问题的解决方法。数组适用于固定长度的数据存储,而集合类如`List<T>`则提供了动态扩展的能力。文章通过示例代码展示了如何处理索引越界、数组长度不可变及集合容量不足等问题,并提供了解决方案。掌握这些基础知识可使程序更加高效和清晰。
62 2
|
1月前
|
C# 数据安全/隐私保护
C# 一分钟浅谈:类与对象的概念理解
【9月更文挑战第2天】本文从零开始详细介绍了C#中的类与对象概念。类作为一种自定义数据类型,定义了对象的属性和方法;对象则是类的实例,拥有独立的状态。通过具体代码示例,如定义 `Person` 类及其实例化过程,帮助读者更好地理解和应用这两个核心概念。此外,还总结了常见的问题及解决方法,为编写高质量的面向对象程序奠定基础。
17 2
|
2月前
|
C#
C#中的类和继承
C#中的类和继承
37 6
|
2月前
|
Java C# 索引
C# 面向对象编程(一)——类
C# 面向对象编程(一)——类
29 0
|
2月前
|
开发框架 .NET 编译器
C# 中的记录(record)类型和类(class)类型对比总结
C# 中的记录(record)类型和类(class)类型对比总结
|
4月前
|
开发框架 .NET 编译器
程序与技术分享:C#基础知识梳理系列三:C#类成员:常量、字段、属性
程序与技术分享:C#基础知识梳理系列三:C#类成员:常量、字段、属性
30 2
|
4月前
|
C#
C# 版本的 计时器类 精确到微秒 秒后保留一位小数 支持年月日时分秒带单位的输出
这篇2010年的文章是从别处搬运过来的,主要包含一个C#类`TimeCount`,该类有多个方法用于处理时间相关的计算。例如,`GetMaxYearCount`计算以毫秒为单位的最大年数,`GetCurrentTimeByMiliSec`将当前时间转换为毫秒,还有`SecondsToYYMMDDhhmmss`将秒数转换为年月日时分秒的字符串。此外,类中还包括一些辅助方法,如处理小数点后保留一位数字的`RemainOneFigureAfterDot`。
|
4月前
|
存储 安全 C#
C# 类的深入指南
C# 类的深入指南
|
5月前
|
C#
C#的类和对象的概念学习案例刨析
【5月更文挑战第17天】C#是一种面向对象的语言,以类和对象为核心。类作为对象的模板,定义了属性(如Name, Age)和行为(如Greet)。对象是类的实例,可设置属性值。封装通过访问修饰符隐藏实现细节,如Customer类的私有name字段通过Name属性访问。继承允许新类(如Employee)从现有类(Person)继承并扩展。多态让不同对象(如Circle, Square)共享相同接口(Shape),实现抽象方法Area,提供灵活的代码设计。
63 1