C#个人珍藏基础类库分享 — 3、目录、文件帮助类FileHelper

已于 2022-12-21 20:34:02 修改
阅读量1.3k 收藏 5
点赞数 3
分类专栏： C# 分享 文章标签： c# 学习 服务器
于 2022-12-20 19:48:15 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/MarcoPro/article/details/128389487
版权

        做.NET后台开发的同学，对文件处理一定不陌生，这里把我混迹C#圈子十余载珍藏的基础类库分享出来，希望能够给刚踏入开发门槛的朋友一些帮助。

        后续我会逐步分享基础库的其余部分，先列个大纲：

C#个人珍藏基础类库分享 — 1、通用缓存帮助类CacheHelper
C#个人珍藏基础类库分享 — 2、Memcached缓存帮助类MemcachedHelper
C#个人珍藏基础类库分享 — 3、目录、文件帮助类FileHelper
C#个人珍藏基础类库分享 — 4、字节数组帮助类BytesObjectHelper
C#个人珍藏基础类库分享 — 5、日志帮助类LogHelper
C#个人珍藏基础类库分享 — 6、数据库处理帮助类SqlHelper
C#个人珍藏基础类库分享 — 7、Xml处理帮助类XmlHelper
C#个人珍藏基础类库分享 — 8、通用工具帮助类ToolHelper

直接进入主题，文件处理类主要包括以下方法：

1、获得指定（文件或目录）相对路径的物理路径

2、确保目录存在，如果目录不存在，则创建目录（包括上级目录）

3、确保文件存在，如果文件目录不存在，则创建目录（包括上级目录）

4、将默认编码类型（Unicode）的字符串，追加至指定文件

5、将指定编码类型的字符串，追加至指定文件

6、将默认编码类型（Unicode）的字符串，写入指定文件

7、将指定编码类型的字符串，写入指定文件

8、依据默认编码类型（Unicode），获取指定文件、指定范围的字符

9、依据指定的编码类型，获取指定文件、指定范围的字符

10、基于默认编码类型（Unicode），将字节数组追加至指定的二进制文件

11、基于所提供编码类型，将字节数组追加至指定的二进制文件

12、基于默认编码类型（Unicode），将字节数组写入指定的二进制文件

13、基于所提供编码类型，将字节数组写入指定的二进制文件

14、依据默认编码类型（Unicode），获取指定文件、指定范围的二进制数据

15、依据指定的编码类型，获取指定文件、指定范围的二进制数据

源码如下：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Web;
using System.IO;
using Microsoft.Win32.SafeHandles;

namespace BaseUtilities
{
    /// <summary>
    /// 目录、文件与文件内容相关，常用的处理方法集合。
    /// </summary>
    public class FileHelper
    {
        #region Path & Directory & File

        /// <summary>
        /// 获得指定（文件或目录）相对路径的物理路径。
        /// <para>支持 Web 程序、Windows 服务程序、控制台等程序。</para>
        /// </summary>
        /// <param name="path">相对路径</param>
        /// <returns>返回指定相对路径的物理路径（异常时返回值为 Null）。</returns>
        public static string GetMapPath(string path)
        {
            try
            {
                if (HttpContext.Current != null)
                    return HttpContext.Current.Server.MapPath(path);
                else
                    return Path.Combine(AppDomain.CurrentDomain.BaseDirectory, path);
            }
            catch (Exception ex)
            {
                LogHelper.Error("Sxmobi.FileHelper", null, ex);
                return null;
            }
        }

        /// <summary>
        /// 确保目录存在。
        /// <para>如果目录不存在，则创建目录（包括上级目录）。</para>
        /// </summary>
        /// <param name="path">目录路径（不含文件名）</param>
        /// <returns>返回一个 Boolean 值，如果目录不存在且创建目录出现异常时，返回值为 False。</returns>
        public static bool EnsureDir(string path)
        {
            try
            {
                if (Directory.Exists(path))
                    return true;
                if (EnsureDir(Directory.GetParent(path).ToString()))
                {
                    Directory.CreateDirectory(path);
                    return true;
                }
                return false;
            }
            catch (Exception ex)
            {
                LogHelper.Error("Sxmobi.FileHelper", null, ex);
                return false;
            }
        }

        /// <summary>
        /// 确保文件存在。
        /// <para>如果文件目录不存在，则创建目录（包括上级目录）。</para>
        /// </summary>
        /// <param name="path">文件路径</param>
        /// <returns>返回一个 Boolean 值，如果目录或文件不存在且创建它们出现异常时，返回值为 False。</returns>
        public static bool EnsureFile(string path)
        {
            try
            {
                if (File.Exists(path))
                    return true;
                if (EnsureDir(Directory.GetParent(path).ToString()))
                {
                    File.Create(path).Close();
                    return true;
                }
                return false;
            }
            catch (Exception ex)
            {
                LogHelper.Error("Sxmobi.FileHelper", null, ex);
                return false;
            }
        }

        #endregion

        #region Text 相关

        /// <summary>
        /// 将默认编码类型（Unicode）的字符串，追加至指定文件。
        /// <para>系统推荐使用默认的 Unicode 编码类型格式来进行文字的读取与写入。</para>
        /// <para>方法将确保目录与文件存在</para>
        /// </summary>
        /// <param name="path">文件路径</param>
        /// <param name="text">需要写入的字符</param>
        /// <param name="isNewLine">指定是否将字符串写入新行</param>
        /// <returns>返回一个 Boolean 值，如果指定的目录、文件不存在且创建它们（或写入字符时）出现异常，返回值为 False。</returns>
        public static bool AddFileText(string path, string text, bool isNewLine)
        {
            return AddFileText(path, Encoding.Unicode, text, isNewLine);
        }

        /// <summary>
        /// 将指定编码类型的字符串，追加至指定文件。
        /// <para>方法将确保目录与文件存在。</para>
        /// <para>系统推荐使用默认的 Unicode 编码类型格式来进行文字的读取与写入。</para>
        /// </summary>
        /// <param name="path">文件路径</param>
        /// <param name="encodingType">编码类型</param>
        /// <param name="text">需要写入的字符</param>
        /// <param name="isNewLine">指定是否将字符串写入新行</param>
        /// <returns>返回一个 Boolean 值，如果指定的目录、文件不存在且创建它们（或写入字符时）出现异常，返回值为 False。</returns>
        public static bool AddFileText(string path, Encoding encodingType, string text, bool isNewLine)
        {
            if (!EnsureFile(path))
                return false;

            try
            {
                using (FileStream fs = new FileStream(path, FileMode.Append, FileAccess.Write, FileShare.ReadWrite))
                {
                    using (StreamWriter sw = new StreamWriter(fs, encodingType))
                    {
                        if (isNewLine)
                            sw.WriteLine(text);
                        else
                            sw.Write(text);
                    }
                }
                return true;
            }
            catch (Exception ex)
            {
                LogHelper.Error("Sxmobi.FileHelper", null, ex);
                return false;
            }
        }

        /// <summary>
        /// 将默认编码类型（Unicode）的字符串，写入指定文件。
        /// <para>方法将确保目录与文件存在。</para>
        /// <para>系统推荐使用默认的 Unicode 编码类型格式来进行文字的读取与写入。</para>
        /// </summary>
        /// <param name="path">文件路径</param>
        /// <param name="text">需要写入的字符</param>
        /// <returns>返回一个 Boolean 值，如果指定的目录、文件不存在且创建它们（或写入字符时）出现异常，返回值为 False。</returns>
        public static bool SetFileText(string path, string text)
        {
            return SetFileText(path, Encoding.Unicode, text);
        }

        /// <summary>
        /// 将指定编码类型的字符串，写入指定文件。
        /// <para>方法将确保目录与文件存在。</para>
        /// <para>系统推荐使用默认的 Unicode 编码类型格式来进行文字的读取与写入。</para>
        /// </summary>
        /// <param name="path">文件路径</param>
        /// <param name="encodingType">编码类型</param>
        /// <param name="text">需要写入的字符</param>
        /// <returns>返回一个 Boolean 值，如果指定的目录、文件不存在且创建它们（或写入字符时）出现异常，返回值为 False。</returns>
        public static bool SetFileText(string path, Encoding encodingType, string text)
        {
            if (!EnsureDir(Directory.GetParent(path).ToString()))
                return false;

            try
            {
                using (FileStream fs = new FileStream(path, FileMode.Create, FileAccess.Write, FileShare.ReadWrite))
                {
                    using (StreamWriter sw = new StreamWriter(fs, encodingType))
                    {
                        sw.Write(text);
                    }
                }
                return true;
            }
            catch (Exception ex)
            {
                LogHelper.Error("Sxmobi.FileHelper", null, ex);
                return false;
            }
        }

        /// <summary>
        /// 依据默认编码类型（Unicode），获取指定文件、指定范围的字符。
        /// <para>系统推荐使用默认的 Unicode 编码类型格式来进行文字的读取与写入。</para>
        /// </summary>
        /// <param name="path">文件路径</param>
        /// <param name="index">指定要获取内容的起始索引位置（例如文件内容：“类型 FileHelper 是...”，如果 index 设置为 3，则取得字符串“FileHelper 是...”）</param>
        /// <param name="count">指定要获取内容的长度，内容读取长度设置不宜过大，以避免内存溢出</param>
        /// <returns>返回 String 类型值，当文件不存在或其它异常时，返回值为 Null。</returns>
        public static string GetFileText(string path, int index, int count)
        {
            return GetFileText(path, Encoding.Unicode, index, count);
        }

        /// <summary>
        /// 依据指定的编码类型，获取指定文件、指定范围的字符。
        /// <para>系统推荐使用默认的 Unicode 编码类型格式来进行文字的读取与写入。</para>
        /// </summary>
        /// <param name="path">文件路径</param>
        /// <param name="encodingType">编码类型</param>
        /// <param name="index">指定要获取内容的起始索引位置（例如文件内容：“类型 FileHelper 是...”，如果 index 设置为 3，则取得字符串“FileHelper 是...”）</param>
        /// <param name="count">指定要获取内容的长度，内容读取长度设置不宜过大，以避免内存溢出</param>
        /// <returns>返回 String 类型值，当文件不存在或其它异常时，返回值为 Null。</returns>
        public static string GetFileText(string path, Encoding encodingType, int index, int count)
        {
            try
            {
                if (!File.Exists(path))
                    return null;

                int maxReads = 10000;
                char[] tempChars = new char[maxReads];
                char[] chars = new char[count];
                int loopCount = index / maxReads;
                int tempIndex = index % maxReads;
                using (FileStream fs = new FileStream(path, FileMode.Open, FileAccess.Read, FileShare.ReadWrite))
                {
                    using (StreamReader sr = new StreamReader(fs, encodingType))
                    {
                        // 如果起始索引超过 1W 个字符，则以 1W 个字符为单位，循环丢弃起始索引之前的所有字符，以避免内存开销过大。
                        while (loopCount-- > 0)
                            sr.ReadBlock(tempChars, 0, maxReads);
                        sr.ReadBlock(tempChars, 0, tempIndex);

                        sr.ReadBlock(chars, 0, count);
                    }
                }
                return new string(chars);
            }
            catch (Exception ex)
            {
                LogHelper.Error("Sxmobi.FileHelper", null, ex);
                return null;
            }
        }

        #endregion

        #region Binary 相关

        /// <summary>
        /// 基于默认编码类型（Unicode），将字节数组追加至指定的二进制文件
        /// </summary>
        /// <param name="path">二进制文件</param>
        /// <param name="bytes">字节数组</param>
        /// <returns>返回一个 Boolean 值，如果指定的目录、文件不存在且创建它们（或写入二进制数据时）出现异常，返回值为 False。</returns>
        public static bool AddFileBinary(string path, byte[] bytes)
        {
            return AddFileBinary(path, Encoding.Unicode, bytes);
        }

        /// <summary>
        /// 基于所提供编码类型，将字节数组追加至指定的二进制文件
        /// </summary>
        /// <param name="path">二进制文件</param>
        /// <param name="encodingType">编码类型</param>
        /// <param name="bytes">字节数组</param>
        /// <returns>返回一个 Boolean 值，如果指定的目录、文件不存在且创建它们（或写入二进制数据时）出现异常，返回值为 False。</returns>
        public static bool AddFileBinary(string path, Encoding encodingType, byte[] bytes)
        {
            if (!EnsureDir(Directory.GetParent(path).ToString()))
                return false;

            try
            {
                using (FileStream fs = new FileStream(path, FileMode.Append, FileAccess.Write, FileShare.ReadWrite))
                {
                    using (BinaryWriter bw = new BinaryWriter(fs, encodingType))
                    {
                        bw.Write(bytes);
                    }
                }
                return true;
            }
            catch (Exception ex)
            {
                LogHelper.Error("Sxmobi.FileHelper", null, ex);
                return false;
            }
        }

        /// <summary>
        /// 基于默认编码类型（Unicode），将字节数组写入指定的二进制文件
        /// </summary>
        /// <param name="path">二进制文件</param>
        /// <param name="bytes">字节数组</param>
        /// <returns>返回一个 Boolean 值，如果指定的目录、文件不存在且创建它们（或写入二进制数据时）出现异常，返回值为 False。</returns>
        public static bool SetFileBinary(string path, byte[] bytes)
        {
            return SetFileBinary(path, Encoding.Unicode, bytes);
        }

        /// <summary>
        /// 基于所提供编码类型，将字节数组写入指定的二进制文件
        /// </summary>
        /// <param name="path">二进制文件</param>
        /// <param name="encodingType">编码类型</param>
        /// <param name="bytes">字节数组</param>
        /// <returns>返回一个 Boolean 值，如果指定的目录、文件不存在且创建它们（或写入二进制数据时）出现异常，返回值为 False。</returns>
        public static bool SetFileBinary(string path, Encoding encodingType, byte[] bytes)
        {
            if (!EnsureDir(Directory.GetParent(path).ToString()))
                return false;

            try
            {
                using (FileStream fs = new FileStream(path, FileMode.Create, FileAccess.Write, FileShare.ReadWrite))
                {
                    using (BinaryWriter bw = new BinaryWriter(fs, encodingType))
                    {
                        bw.Write(bytes);
                    }
                }
                return true;
            }
            catch (Exception ex)
            {
                LogHelper.Error("Sxmobi.FileHelper", null, ex);
                return false;
            }
        }

        /// <summary>
        /// 依据默认编码类型（Unicode），获取指定文件、指定范围的二进制数据。
        /// </summary>
        /// <param name="path">文件路径</param>
        /// <param name="index">指定要获取数据的起始索引位置</param>
        /// <param name="count">指定要获取数据的长度，内容读取长度设置不宜过大，以避免内存溢出</param>
        /// <returns>返回 byte[] 类型值，当文件不存在或其它异常时，返回值为 Null。</returns>
        public static byte[] GetFileBinary(string path, int index, int count)
        {
            return GetFileBinary(path, Encoding.Unicode, index, count);
        }

        /// <summary>
        /// 依据指定的编码类型，获取指定文件、指定范围的二进制数据。
        /// </summary>
        /// <param name="path">文件路径</param>
        /// <param name="encodingType">编码类型</param>
        /// <param name="index">指定要获取数据的起始索引位置</param>
        /// <param name="count">指定要获取数据的长度，内容读取长度设置不宜过大，以避免内存溢出</param>
        /// <returns>返回 byte[] 类型值，当文件不存在或其它异常时，返回值为 Null。</returns>
        public static byte[] GetFileBinary(string path, Encoding encodingType, int index, int count)
        {
            try
            {
                if (!File.Exists(path))
                    return null;

                int maxReads = 1024000;
                byte[] bytes = new byte[count];
                int loopCount = index / maxReads;
                int tempIndex = index % maxReads;
                using (FileStream fs = new FileStream(path, FileMode.Open, FileAccess.Read, FileShare.ReadWrite))
                {
                    using (BinaryReader br = new BinaryReader(fs, encodingType))
                    {
                        // 如果起始索引超过1M（1000K），则以1M为单位，循环丢弃起始索引之前的所有字节，以避免内存开销过大。
                        while (loopCount-- > 0)
                            br.ReadBytes(maxReads);
                        br.ReadBytes(tempIndex);

                        bytes = br.ReadBytes(count);
                    }
                }
                return bytes;
            }
            catch (Exception ex)
            {
                LogHelper.Error("Sxmobi.FileHelper", null, ex);
                return null;
            }
        }

        #endregion
    }
}

MarcoPro
关注
专栏目录
FileHelper
03-07
FileHelper上传和下载文件类。包括大小，扩展名均有疯涨
C#文件帮助类FoderHelper
weixin_34313182的博客
04-17 88
using System; using System.Data; using System.Configuration; using System.Linq; using System.Web; using System.IO; using System.Collections; using System.Collections.Generic; using System.Se...
C# 类（一）——类库、命名空间、类、对象
最新发布
sc_1313的博客
08-25 2655
类：“类”是一种构造，通过使用该构造，您可以将其他类型的变量、方法和事件组合在一起，从而创建自己的自定义类型。类就像一个蓝图， 指定该类型可以进行哪些操作。 对象：对象是基于类的具体实体，有时称为类的实例。从本质上说，对象是按照此蓝图分配和配置的内存块。
C#操作文件帮助类FileHelper
仰望星空的代码
02-10 5858
删除文件、打开文件、创建文件、移动文件、复制文件以及删除、打开、创建、移动、复制文件夹等等操作集成在这个FileHelper中。using System; using System.Collections.Generic; using System.IO; using System.Linq; using System.Windows.Forms; namespace DocDecrypt.Co...
C#文件操作类
小李专栏
02-04 1685
using System; using System.Data; using System.Configuration; using System.Linq; using System.Web; using System.IO; using System.Collections; using System.Collections.Generic; using System.Security.Acc
文件帮助类（FileHelper）（c#）
qq_34884421的博客
03-06 1366
public static class FileHelper { //得到目录下所有的文件 public static void GetAllFiles(List files, string dir) { string[] fls = Directory.GetFiles(dir); foreach (string fl in fls) { files.Add(fl); } string[] su...
C#常用的帮助类库.zip
08-21
"C#常用的帮助类库.zip"是一个集合了多种实用工具类的压缩包，它包含了一些关键领域的类库，如ASP.NET、AD域操作、通用类库、基础类以及数据库操作。下面将对这些知识点进行详细解释： 1. ASP.NET类库：ASP.NET是...
NET（C#）通用类库源码.rar_C# 通用类_c#通用类库源码_hungrysm6_net C#源码网站_通用类库
07-14
通用的原生类库源码资料，如INIFile,MailSend,MessageBox,Pagevlidate,TimeParser..
基于C#的串口助手类库SerialPortHelper
03-22
串口助手类库项目，目前基于 .NET Framework 3.5 编译，若需要 .NET Framework 4+ 可以直接自行修改框架编译。 SerialPortHelperTest 串口助手类库测试项目，主要用于演示SerialPortHelper类库的各项功能与测试任务...
C# USB设备控制类库 dll文件
05-07
C# USB IIC设备控制类库 dll文件 想要通过C#控制USB IIC通讯设备的可以下载使用 C# USB IIC设备控制类库 dll文件 想要通过C#控制USB IIC通讯设备的可以下载使用 C# USB IIC设备控制类库 dll文件 想要通过C#控制USB ...
C#上位机开发必备帮助类库2.0
05-16
一个用C#开发上位机的帮助类库，能减少重复开发某个模块的工作量。提高工作效率。同时帮助初学者提高自己的业务水平。 1.该资源是我上一个版本的2.0版本。其中增加了很多自定义通讯协议和数据同步的协议。 2.并且...
C#读写文件帮助类.doc
05-19
C#读写文件帮助类.doc 应有尽有的类 关于文件的
C#基本类库大全
12-21
方便开发人员快速掌握C#通用类，提高开发效率，减少编码量。
C#基类库大全（最全面的）
08-19
C#基类库大全（最全面的）
C#基础类库大全
01-04
C#基础类库大全
C#帮助工具类整理--FileHelper、XmlHelper、ToolHelper
Zhaof_Notes
04-03 1626
C#帮助工具类整理
C# 文件帮助类(FileHelper)
星火燎猿
11-30 1308
但是低版本里面最好的方式还是通过遍历当前工作目录下面dll的方式来快速获取我们想要的文件，当然这样肯定有人会说这样会有性能问题，我们也可以第一次运行的时候将读到的文件写一个配置文件后面就直接读配置文件来优化性能问题。在研究程序反射的时候我们往往需要获取当前运行程序所引用的dll文件，按照传统的方式我们可以维护一个这样的列表，但是这样维护成本实在是太高，而且不利于团队合作开发，在高版本的.net 4.6.2之后官方出了专门的dll帮我们做这个事情。
C#文件上传下载类库DownLoadHelper功能详解
资源摘要信息:"C#文件上传下载类库项目DownLoadHelper.zip是一个用于文件传输的C#类库项目，它提供了文件下载和上传的功能。该类库能够支持大文件处理，实现文件的续传以及速度限制，同时资源占用较小。主要功能包括...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

MarcoPro

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值