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

已于 2022-12-21 20:34:02 修改
阅读量1.2k 收藏 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
关注
  • 3
    点赞
  • 踩
  • 5
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
WORD 格式 编程 属性
luckisok的专栏
10-17 1596
word文档工程变量的     //合并单元格   table.Cell(2, 2).Merge(table.Cell(2, 3));//单元格分离    object Rownum = 2;    object Columnnum = 2;    table.Cell(2, 2).Split(ref Rownum, ref Columnnum);//单元格对齐方式     WApp.Se
C#常用的帮助类库.zip
08-21
C#帮助类，方便开发系统重用，包括ASP.NET类库，C#读取AD域里用户名或组，Common类库，DotNet基础类大全，SqlHelper基类，字符串加密
C#常用类库合集 100 完整版
05-17
VS2010打开的整个类库工程，直接生成dll就可使用。C#常用类库合集，小编整理的，里面都是源码，有excel导入导出的，Json类库，条码类库，全都是精品，绝对是你想要的，大家快来下载。类库会在编译之后生成一个dll文件，然后其他的项目可以引用这个dll。这个大家都是知道的。
C#最常用的100多个类库集合分享
01-09
C#最常用的100多个类库集合分享 包含文件、网络、http、多线程、控件、office、IO、JSON、压缩文件、文本字符串、正则表达式、HTML、邮件、系统、数据库、加密解密等操作类等
C#类库文件制作帮助文档
a290783133的博客
02-13 613
Sandcastle是通过提取dll文件及其xml注释文件来生成完整的帮助文档，同时还支持多种生成格式(Helpe1x:chm, Helper2x:Hxs, Website,HelperView)，结合新发布的Sandcastle Help File Builder可视化工具，整个生成过程十分简单，而且SHFB工具看起来很强大，不仅能够直接配置生成文档的各个属性，而且还支持很灵活的扩展设置，为我们提供完美的.NET类库文档成为一个可能。如果是C#的工程，需要把工程的属性-->生成-->Xml文档文件选中。
C#帮助工具类整理--FileHelper、XmlHelper、ToolHelper
Zhaof_Notes
04-03 1260
C#帮助工具类整理
【文件操作类】史上最完整的文件和目录操作类
weixin_30894389的博客
05-05 145
【文件操作类】史上最完整的文件和目录操作类 using System; using System.Text; using System.IO; namespace HelloCsharp.Utilities { /// &l...
C#操作文件帮助类FileHelper
仰望星空的代码
02-10 5716
删除文件、打开文件、创建文件、移动文件、复制文件以及删除、打开、创建、移动、复制文件夹等等操作集成在这个FileHelper中。using System; using System.Collections.Generic; using System.IO; using System.Linq; using System.Windows.Forms; namespace DocDecrypt.Co...
FileHelper（文件工具类）
suenpeng
08-02 5100
package com.yours.platfrom.util;import java.io.BufferedInputStream; import java.io.BufferedOutputStream; import java.io.File; import java.io.FileInputStream; import java.io.FileNotFoundException;
C#实用FileHelper分享
m0_62389241的博客
08-27 407
【代码】C#实用FileHelper分享。
C#最常用的100+个类库集合（源码分享，自由使用）
12-17
版本要求最低VS2010及以上都可以完美打开，分词辅助类，汉字转拼音，加密，日历，时间操作类，随机类，条形码，序列号，验证码，音频视频转换类，各种运算集合，正则表达式，字符，文件读写，Ini文件，图片，画图，邮件，各种Chart图，Excel/word/PDF等文件类型导出，等等100+类库，收集好几年了，分享给大家，希望能帮助到初学者！
C#读写文件帮助类.doc
05-19
C#读写文件帮助类.doc 应有尽有的类 关于文件的
C#文件上传下载类库项目DownLoadHelper.zip
04-24
C#文件下载帮助类 输出硬盘文件，提供下载 支持大文件、续传、速度限制、资源占用小 普通下载 分块下载 上传文件
收集的C#基类比较全（Common类库SqlHelper基类DotNet基础类大全）.zip
04-26
收集的C#基类比较全（Common类库SqlHelper基类DotNet基础类大全）： 包含有： ASP.NET类库 C#读取AD域里用户名或组 Common类库 DotNet基础类大全 SqlHelper基类 字符串加密
C#封装的Utilities基础类库文件
04-01
C#封装的Utilities基础类库，内含Aliyun.OSS，Excel，HtmlAgilityPack，ICSharpCode.SharpZipLib，Ionic.Zip，log4net，Newtonsoft.Json，NPOI，NPOI.OpenXml4Net，OpenCvSharp，OpenCvSharp.Extensions，Quartz，...
c#操作ini文件的类库
最新发布
05-19
c#操作ini文件的类库，实现了读取节点，节点赋值，读取节点的所有键值，删除节点、删除键、删除ini文件，创建ini文件等功能。可以直接开箱即用。ini文件结构： 节(section) 节用方括号括起来，单独占一行，例如： ...
C# 文件读写FileHelper类
tone1128的博客
04-19 1482
public static class FileHelper { /**************************************** * 函数名称：GetPostfixStr * 功能说明：取得文件后缀名 * 参 数：filename:文件名称 * 调用示列： ...
【Android】android_文件操作类FileHelper（超完整）
Taily老段的专栏
11-10 4609
http://fushui125.blog.163.com/blog/static/88169212012913104344734/ import java.io.File; import java.io.FileInputStream; import java.io.FileOutputStream; import java.io.IOException; import java.io.
文件帮助类（FileHelper）（c#）
qq_34884421的博客
03-06 1300
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...
3D网格数据。inp格式文件转换为unv格式 c# 类库
06-08
以下是一个基本的C#类库示例，用于将inp格式文件转换为unv格式： ``` using System.IO; using System.Collections.Generic; using FileHelpers; public class InpToUnvConverter { public static string Convert...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

打赏作者

MarcoPro

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

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

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

打赏作者

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

抵扣说明：

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

余额充值