XFE Git
XFE Studio Git
Git 首页 全局搜索
XFE 主站 文档 NuGet

XFEExtension

【DLL】XFE各类拓展是一个C#的DLL库,旨在优化C#代码中常用语句的使用,并提供更简洁的访问方式,同时提供Xunit测试框架,快速搭建服务器/客户端,免费ChatGPTAPI接口,免费通讯服务器,XFE下载器,新增格式等

公开
关注 0 Fork 0 Star 0
UTF-8
using System.Diagnostics;
using System.Runtime.Serialization.Formatters.Binary;
using System.Text;

namespace XFEExtension.NetCore.FileExtension;

/// <summary>
/// 文件的拓展
/// </summary>
public static class FileExtension
{
    /// <summary>
    /// 将字符串写入文件
    /// </summary>
    /// <param name="text"></param>
    /// <param name="fileName">目标文件路径及文件名</param>
    public static void WriteIn(this string text, string fileName)
    {
        FileInfo fileInfo = new(fileName);
        using var fileStream = fileInfo.Create();
        var stream = Encoding.UTF8.GetBytes(text);
        fileStream.Write(stream, 0, stream.Length);
        fileStream.Flush();
    }
    /// <summary>
    /// 将非法字符串写入文件
    /// </summary>
    /// <param name="objectToWrite"></param>
    /// <param name="fileName">文件名</param>
    [Obsolete("序列化方法在.NET 8.0中已经不再受支持")]
    public static void WriteInObj(this object objectToWrite, string fileName)
    {
        FileInfo fileInfo = new(fileName);
        using var fileStream = fileInfo.Create();
        BinaryFormatter binaryFormatter = new();
        binaryFormatter.Serialize(fileStream, objectToWrite);
        fileStream.Flush();
        fileStream.Close();
    }
    /// <summary>
    /// 读取文件中的字符串
    /// </summary>
    /// <param name="name"></param>
    /// <param name="content">读取的内容</param>
    /// <returns>被读取的文件是否存在</returns>
    public static bool ReadOut(this string name, out string? content)
    {
        FileInfo fileInfo = new(name);
        if (fileInfo.Exists)
        {
            using StreamReader streamReader = fileInfo.OpenText();
            content = streamReader.ReadToEnd();
            streamReader.Close();
            return true;
        }
        else
        {
            content = string.Empty;
            return false;
        }
    }
    /// <summary>
    /// 读取文件中的字符串
    /// </summary>
    /// <param name="fileName">目标文件路径及文件名</param>
    /// <returns>目标文件内容,如不存在则返回-1</returns>
    public static string? ReadOut(this string fileName)
    {
        FileInfo fileInfo = new(fileName);
        if (fileInfo.Exists)
        {
            using var streamReader = fileInfo.OpenText();
            var text = streamReader.ReadToEnd();
            streamReader.Close();
            return text;
        }
        else
        {
            return "-1";
        }
    }
    /// <summary>
    /// 读取文件中的字符串
    /// </summary>
    /// <param name="fileName"></param>
    /// <returns></returns>
    [Obsolete("序列化方法在.NET 8.0中已经不再受支持")]
    public static T? ReadOutObj<T>(this string fileName)
    {
        FileInfo fileInfo = new(fileName);
        if (fileInfo.Exists)
        {
            using var fileStream = fileInfo.OpenRead();
            BinaryFormatter bf = new();
            var result = (T)bf.Deserialize(fileStream);
            fileStream.Close();
            return result;
        }
        else
        {
            return default;
        }
    }
    /// <summary>
    /// 读取文件中的字符串
    /// </summary>
    /// <param name="fileName">目标文件路径及文件名</param>
    /// <param name="exist">目标文件是否存在</param>
    /// <returns>目标文件内容,如不存在则返回-1</returns>
    public static string? ReadOut(string fileName, out bool exist)
    {
        FileInfo fileInfo = new(fileName);
        exist = fileInfo.Exists;
        if (fileInfo.Exists)
        {
            using StreamReader streamReader = fileInfo.OpenText();
            var text = streamReader.ReadLine();
            streamReader.Close();
            return text;
        }
        else
        {
            return "-1";
        }
    }
    /// <summary>
    /// 读取文件中的字符串
    /// </summary>
    /// <param name="fileName"></param>
    /// <param name="exist">是否存在</param>
    /// <returns></returns>
    [Obsolete("序列化方法在.NET 8.0中已经不再受支持")]
    public static string? ReadOutObj(this string fileName, out bool exist)
    {
        FileInfo fileInfo = new(fileName);
        exist = fileInfo.Exists;
        if (fileInfo.Exists)
        {
            using var fileStream = fileInfo.OpenRead();
            BinaryFormatter binaryFormatter = new();
            var text = binaryFormatter.Deserialize(fileStream).ToString();
            fileStream.Close();
            return text;
        }
        else
        {
            return "-1";
        }
    }
    /// <summary>
    /// 序列化对象到文件
    /// </summary>
    /// <param name="obj"></param>
    /// <param name="fileName">文件路径</param>
    [Obsolete("序列化方法在.NET 8.0中已经不再受支持")]
    public static void SerializeToFile(this object obj, string fileName)
    {
        BinaryFormatter writeBinary = new();
        using var WriteStream = File.OpenWrite(fileName);
        writeBinary.Serialize(WriteStream, obj);
        WriteStream.Flush();
        WriteStream.Close();
    }
    /// <summary>
    /// 从文件反序列化对象
    /// </summary>
    /// <typeparam name="T">类型</typeparam>
    /// <param name="fileName"></param>
    /// <returns></returns>
    [Obsolete("序列化方法在.NET 8.0中已经不再受支持")]
    public static T DeserializeFromFile<T>(this string fileName)
    {
        BinaryFormatter readBinary = new();
        using var readStream = File.OpenRead(fileName);
        T obj = (T)readBinary.Deserialize(readStream);
        readStream.Close();
        return obj;
    }
    /// <summary>
    /// 输出文件大小
    /// </summary>
    /// <param name="bufferLength"></param>
    /// <returns></returns>
    public static string FileSize(this long bufferLength)
    {
        string[] sizes = ["B", "KB", "MB", "GB", "TB"];
        double len = bufferLength;
        int order = 0;
        while (len >= 1024 && order < sizes.Length - 1)
        {
            order++;
            len /= 1024;
        }
        return string.Format("{0:0.##} {1}", len, sizes[order]);
    }
    /// <summary>
    /// 获取占用某个文件的程序
    /// </summary>
    /// <param name="filePath">文件路径</param>
    /// <returns></returns>
    public static Process? GetOwningProcess(this string filePath)
    {
        try
        {
            // 获取所有正在运行的进程
            Process[] processes = Process.GetProcesses();

            foreach (Process process in processes)
            {
                try
                {
                    // 获取进程打开的文件句柄信息
                    foreach (ProcessModule module in process.Modules)
                    {
                        if (module.FileName.Equals(filePath, StringComparison.OrdinalIgnoreCase))
                        {
                            return process; // 返回占用文件的进程
                        }
                    }
                }
                catch (Exception)
                {
                    // 忽略无法访问的进程
                }
            }
        }
        catch { }
        return null; // 如果没有找到占用文件的进程,返回null
    }
    /// <summary>
    /// 获取文件的有效起始位置
    /// </summary>
    /// <param name="fileStream">文件流</param>
    /// <param name="startPosition">起始搜寻位置</param>
    /// <param name="endPosition">结束搜寻位置</param>
    /// <returns>一个长整型,介于起始位置和结束位置之间</returns>
    public static async Task<long> GetValidPosition(this FileStream fileStream, long startPosition, long endPosition)
    {
        long seekPosition = endPosition;
        fileStream.Seek(startPosition, SeekOrigin.Begin);
        byte[] buffer = new byte[endPosition - startPosition];
        await fileStream.ReadAsync(buffer.AsMemory(0, (int)(endPosition - startPosition)));
        for (int i = buffer.Length - 1; i >= 0; i--)
        {
            if (buffer[i] != 0)
                break;
            seekPosition--;
        }
        return seekPosition > startPosition ? seekPosition : startPosition;
    }
    /// <summary>
    /// 获取文件的有效起始位置
    /// </summary>
    /// <param name="fileStream">文件流</param>
    /// <param name="startPosition">起始搜寻位置</param>
    /// <returns>一个长整型,介于起始位置和结束位置之间</returns>
    public static async Task<long> GetValidPosition(this FileStream fileStream, long startPosition) => await GetValidPosition(fileStream, startPosition, fileStream.Length);
    /// <summary>
    /// 获取文件的有效起始位置
    /// </summary>
    /// <param name="fileStream">文件流</param>
    /// <returns>一个长整型,介于起始位置和结束位置之间</returns>
    public static async Task<long> GetValidPosition(this FileStream fileStream) => await GetValidPosition(fileStream, 0, fileStream.Length);
}