File静态类

1.File 类

File 类是一个静态类,提供了用于创建、复制、删除、移动和打开单一文件的静态方法,并协助创建 System.IO.FileStream 对象。

所有 File 方法都需要文件路径作为参数,这些方法直接操作文件,无需实例化对象。适用于简单的文件操作,特别是针对一次性操作的场景。

img

2. 方法

方法名 描述
AppendAllLines(String, IEnumerable) 向一个文件中追加行,然后关闭该文件。 如果指定文件不存在,此方法会创建一个文件,向其中写入指定的行,然后关闭该文件。
AppendAllLines(String, IEnumerable, Encoding) 使用指定的编码向一个文件中追加行,然后关闭该文件。 如果指定文件不存在,此方法会创建一个文件,向其中写入指定的行,然后关闭该文件。
AppendAllLinesAsync(String, IEnumerable, CancellationToken) 以异步形式向一个文件中追加行,然后关闭该文件。 如果指定文件不存在,此方法会创建一个文件,向其中写入指定的行,然后关闭该文件。
AppendAllLinesAsync(String, IEnumerable, Encoding, CancellationToken) 使用指定的编码以异步形式向一个文件中追加行,然后关闭该文件。 如果指定文件不存在,此方法会创建一个文件,向其中写入指定的行,然后关闭该文件。
AppendAllText(String, String) 打开一个文件,向其中追加指定的字符串,然后关闭该文件。 如果文件不存在,此方法将创建一个文件,将指定的字符串写入文件,然后关闭该文件。
AppendAllText(String, String, Encoding) 使用指定的编码将指定的字符串追加到文件中,如果文件还不存在则创建该文件。
AppendAllTextAsync(String, String, CancellationToken) 以异步方式打开文件或创建文件(如果文件尚不存在),将指定的字符串追加到该文件,然后关闭文件。
AppendAllTextAsync(String, String, Encoding, CancellationToken) 以异步方式打开文件或创建文件(如果文件尚不存在),使用指定的编码将指定的字符串追加到该文件,然后关闭文件。
AppendText(String) 创建一个 StreamWriter,它将 UTF-8 编码文本追加到现有文件或新文件(如果指定文件不存在)。
Copy(String, String) 将现有文件复制到新文件。 不允许覆盖同名的文件。
Copy(String, String, Boolean) 将现有文件复制到新文件。 允许覆盖同名的文件。
Create(String) 在指定路径中创建、截断和覆盖文件。
Create(String, Int32) 在指定路径中创建、截断和覆盖文件,并指定缓冲区大小。
Create(String, Int32, FileOptions) 创建或覆盖指定路径中的文件,指定缓冲区大小和一个描述如何创建或覆盖该文件的选项。
CreateSymbolicLink(String, String) 创建由 path 标识的文件符号链接,该 pathToTarget链接指向 。
CreateText(String) 创建或打开用于写入 UTF-8 编码文本的文件。 如果文件已存在,则替换其内容。
Decrypt(String) 使用 Encrypt(String) 方法解密由当前帐户加密的文件。
Delete(String) 删除指定的文件。
Encrypt(String) 将某个文件加密,使得只有加密该文件的帐户才能将其解密。
Exists(String) 确定指定的文件是否存在。
GetAttributes(SafeFileHandle) 获取与 fileHandle关联的文件或目录的指定 FileAttributes
GetAttributes(String) 获取在此路径上的文件的 FileAttributes
GetCreationTime(SafeFileHandle) 返回指定文件或目录的创建时间。
GetCreationTime(String) 返回指定文件或目录的创建日期和时间。
GetCreationTimeUtc(SafeFileHandle) 返回指定文件或目录的创建日期和时间(协调世界时 (UTC) )。
GetCreationTimeUtc(String) 返回指定文件或目录的创建日期和时间(协调世界时 (UTC) )。
GetLastAccessTime(SafeFileHandle) 返回指定文件或目录的上次访问日期和时间。
GetLastAccessTime(String) 返回上次访问指定文件或目录的日期和时间。
GetLastAccessTimeUtc(SafeFileHandle) 返回指定文件或目录的上次访问日期和时间(协调世界时 (UTC) )。
GetLastAccessTimeUtc(String) 返回上次访问指定文件或目录的日期和时间(协调世界时 (UTC) )。
GetLastWriteTime(SafeFileHandle) 返回指定文件或目录的上次写入日期和时间。
GetLastWriteTime(String) 返回上次写入指定文件或目录的日期和时间。
GetLastWriteTimeUtc(SafeFileHandle) 返回指定文件或目录的上次写入日期和时间(协调世界时 (UTC) )。
GetLastWriteTimeUtc(String) 返回上次写入指定文件或目录的日期和时间(协调世界时 (UTC) )。
GetUnixFileMode(SafeFileHandle) UnixFileMode获取指定文件句柄的 。
GetUnixFileMode(String) 获取在此路径上的文件的 UnixFileMode
Move(String, String) 将指定文件移到新位置,提供要指定新文件名的选项。
Move(String, String, Boolean) 将指定文件移动到新位置,提供用于指定新文件名和替换目标文件(如果已存在)的选项。
Open(String, FileMode) 通过不共享的读/写访问权限打开指定路径上的 FileStream
Open(String, FileMode, FileAccess) 通过指定的模式和不共享的访问权限打开指定路径上的 FileStream
Open(String, FileMode, FileAccess, FileShare) 打开指定路径上的 FileStream,具有带读、写或读/写访问的指定模式和指定的共享选项。
Open(String, FileStreamOptions) 使用指定的路径、创建模式、读/写和共享权限、其他 FileStream 对同一文件的访问权限、缓冲区大小、其他文件选项和分配大小初始化 类的新实例 FileStream
OpenHandle(String, FileMode, FileAccess, FileShare, FileOptions, Int64) 使用指定的路径、创建模式、读/写和共享权限、其他 SafeFileHandles 对同一文件、其他文件选项和分配大小的访问权限初始化 类的新实例 SafeFileHandle
OpenRead(String) 打开现有文件以进行读取。
OpenText(String) 打开现有 UTF-8 编码文本文件以进行读取。
OpenWrite(String) 打开一个现有文件或创建一个新文件以进行写入。
ReadAllBytes(String) 打开一个二进制文件,将文件的内容读入一个字节数组,然后关闭该文件。
ReadAllBytesAsync(String, CancellationToken) 以异步形式打开一个二进制文件,将文件的内容读入一个字节数组,然后关闭该文件。
ReadAllLines(String) 打开一个文本文件,读取文件的所有行,然后关闭该文件。
ReadAllLines(String, Encoding) 打开一个文件,使用指定的编码读取文件的所有行,然后关闭该文件。
ReadAllLinesAsync(String, CancellationToken) 以异步形式打开一个文本文件,读取文件的所有行,然后关闭该文件。
ReadAllLinesAsync(String, Encoding, CancellationToken) 以异步形式打开一个文本文件,使用指定的编码读取文件的所有行,然后关闭该文件。
ReadAllText(String) 打开一个文本文件,读取文件中的所有文本,然后关闭此文件。
ReadAllText(String, Encoding) 打开一个文件,使用指定的编码读取文件中的所有文本,然后关闭此文件。
ReadAllTextAsync(String, CancellationToken) 以异步形式打开一个文本文件,读取文件中的所有文本,然后关闭此文件。
ReadAllTextAsync(String, Encoding, CancellationToken) 以异步形式打开一个文本文件,使用指定的编码读取文件的所有文本,然后关闭该文件。
ReadLines(String) 读取文件的行。
ReadLines(String, Encoding) 读取具有指定编码的文件的行。
ReadLinesAsync(String, CancellationToken) 异步读取文件的行。
ReadLinesAsync(String, Encoding, CancellationToken) 异步读取具有指定编码的文件的行。
Replace(String, String, String) 使用其他文件的内容替换指定文件的内容,这一过程将删除原始文件,并创建被替换文件的备份。
Replace(String, String, String, Boolean) 用其他文件的内容替换指定文件的内容,这一过程将删除原始文件,并创建被替换文件的备份,还可以忽略合并错误。
ResolveLinkTarget(String, Boolean) 获取指定文件链接的目标。
SetAttributes(SafeFileHandle, FileAttributes) 设置与 fileHandle关联的文件或目录的指定 FileAttributes
SetAttributes(String, FileAttributes) 获取指定路径上的文件的指定 FileAttributes
SetCreationTime(SafeFileHandle, DateTime) 设置创建文件或目录的日期和时间。
SetCreationTime(String, DateTime) 设置创建该文件的日期和时间。
SetCreationTimeUtc(SafeFileHandle, DateTime) 设置创建文件或目录的日期和时间(协调世界时 (UTC) )。
SetCreationTimeUtc(String, DateTime) 设置创建文件的日期和时间(协调世界时 (UTC) )。
SetLastAccessTime(SafeFileHandle, DateTime) 设置上次访问指定文件或目录的日期和时间。
SetLastAccessTime(String, DateTime) 设置上次访问指定文件的日期和时间。
SetLastAccessTimeUtc(SafeFileHandle, DateTime) 设置上次访问指定文件或目录的日期和时间(协调世界时 (UTC) )。
SetLastAccessTimeUtc(String, DateTime) 设置上次访问指定文件的日期和时间(协调世界时 (UTC) )。
SetLastWriteTime(SafeFileHandle, DateTime) 设置上次写入指定文件或目录的日期和时间。
SetLastWriteTime(String, DateTime) 设置上次写入指定文件的日期和时间。
SetLastWriteTimeUtc(SafeFileHandle, DateTime) 设置上次写入指定文件或目录的日期和时间(协调世界时 (UTC) )。
SetLastWriteTimeUtc(String, DateTime) 设置指定文件上次写入到的日期和时间(协调世界时 (UTC) )。
SetUnixFileMode(SafeFileHandle, UnixFileMode) 设置指定 UnixFileMode 文件句柄的 。
SetUnixFileMode(String, UnixFileMode) 获取指定路径上的文件的指定 UnixFileMode
WriteAllBytes(String, Byte[ ]) 创建一个新文件,在其中写入指定的字节数组,然后关闭该文件。 如果目标文件已存在,则会将其截断并覆盖。
WriteAllBytesAsync(String, Byte[], CancellationToken) 以异步形式创建一个新文件,在其中写入指定的字节数组,然后关闭该文件。 如果目标文件已存在,则会将其截断并覆盖。
WriteAllLines(String, IEnumerable) 创建一个新文件,向其中写入一个字符串集合,然后关闭该文件。
WriteAllLines(String, IEnumerable, Encoding) 使用指定的编码创建一个新文件,向其中写入一个字符串集合,然后关闭该文件。
WriteAllLines(String, String[ ]) 创建一个新文件,在其中写入指定的字节数组,然后关闭该文件。
WriteAllLines(String, String[ ], Encoding) 创建一个新文件,使用指定编码在其中写入指定的字符串数组,然后关闭该文件。
WriteAllLinesAsync(String, IEnumerable, CancellationToken) 以异步形式创建一个新文件,在其中写入指定的行,然后关闭该文件。
WriteAllLinesAsync(String, IEnumerable, Encoding, CancellationToken) 以异步形式创建一个新文件,使用指定编码在其中写入指定的行,然后关闭该文件。
WriteAllText(String, String) 创建一个新文件,向其中写入指定的字符串,然后关闭文件。 如果目标文件已存在,则会将其截断并覆盖。
WriteAllText(String, String, Encoding) 创建一个新文件,使用指定编码向其中写入指定的字符串,然后关闭文件。 如果目标文件已存在,则会将其截断并覆盖。
WriteAllTextAsync(String, String, CancellationToken) 以异步形式创建一个新文件,在其中写入指定的字符串,然后关闭该文件。 如果目标文件已存在,则会将其截断并覆盖。
WriteAllTextAsync(String, String, Encoding, CancellationToken) 以异步形式创建一个新文件,使用指定编码在其中写入指定的字符串,然后关闭该文件。 如果目标文件已存在,则会将其截断并覆盖。

3.常用方法

1. bool Exists (string? path)检查文件是否存在。

string path = @"c:\temp\MyTest.txt";
if (File.Exists(path))
{
    // 文件存在
}

2. string ReadAllText (string path)打开一个文本文件,读取文件中的所有文本,然后关闭此文件。

using System;
using System.IO;
using System.Text;

class Test
{
    public static void Main()
    {
        string path = @"c:\temp\MyTest.txt";
        //Open the file to read from 
        string readText = File.ReadAllText(path);
        Console.WriteLine(readText);
    }
}

3. void WriteAllText (string path, string? contents)创建一个新文件,向其中写入指定的字符串,然后关闭文件。 如果目标文件已存在,则会将其截断并覆盖。

using System;
using System.IO;
using System.Text;

class Test
{
    public static void Main()
    {
        string path = @"c:\temp\MyTest.txt";

        if (!File.Exists(path))
        {
            // Create a file to write to.
            string createText = "Hello and Welcome" + Environment.NewLine;
            File.WriteAllText(path, createText);
        }
        
        //Open the file to read from 
        string readText = File.ReadAllText(path);
        Console.WriteLine(readText);

    }
}

4. void AppendAllText (string path, string? contents)打开一个文件,将指定的字符串追加到该文件末尾,然后关闭该文件。如果文件不存在,此方法将创建一个文件,将指定的字符串写入该文件,然后关闭该文件。

using System;
using System.IO;
using System.Text;

class Test
{
    public static void Main()
    {
        string path = @"c:\temp\MyTest.txt";

        string appendText = "This is extra text" + Environment.NewLine;
        File.AppendAllText(path, appendText);

        // Open the file to read from.
        string readText = File.ReadAllText(path);
        Console.WriteLine(readText);
    }
}

5. void Delete (string path)删除指定的文件。

using System;
using System.IO;

class Program
{
    static void Main()
    {
        string directoryPath = @"C:\example";
        string searchPattern = "*.txt";

        try
        {
            string[] files = Directory.GetFiles(directoryPath, searchPattern);

            if (files.Length > 0)
            {
                foreach (string file in files)
                {
                    File.Delete(file);
                    Console.WriteLine($"文件 {file} 删除成功!");
                }
            }
            else
            {
                Console.WriteLine("没有找到匹配的文件。");
            }
        }
        catch (DirectoryNotFoundException)
        {
            Console.WriteLine("指定的目录不存在。");
        }
        catch (IOException e)
        {
            Console.WriteLine("发生IO异常: " + e.Message);
        }
        catch (UnauthorizedAccessException e)
        {
            Console.WriteLine("无权访问文件: " + e.Message);
        }
        catch (Exception e)
        {
            Console.WriteLine("发生异常: " + e.Message);
        }
    }
}

6. void Copy (string sourceFileName, string destFileName)将现有文件复制到新文件。 不允许覆盖同名的文件。

using System;
using System.IO;

class Program
{
    static void Main()
    {
        string sourceFile = @"C:\source.txt";
        string destFile = @"C:\destination.txt";

        try
        {
            // 将源文件复制到目标文件
            File.Copy(sourceFile, destFile);

            Console.WriteLine("文件复制成功!");
        }
        catch (IOException e)
        {
            Console.WriteLine($"发生IO异常: {e.Message}");
        }
        catch (UnauthorizedAccessException e)
        {
            Console.WriteLine($"无权访问文件: {e.Message}");
        }
        catch (Exception e)
        {
            Console.WriteLine($"发生异常: {e.Message}");
        }
    }
}

7. void Move (string sourceFileName, string destFileName)将指定文件移到新位置,提供要指定新文件名的选项。

using System;
using System.IO;

class Test
{
    public static void Main()
    {
        string path = @"c:\temp\MyTest.txt";
        string path2 = @"c:\temp2\MyTest.txt";
        try
        {
            if (!File.Exists(path))
            {
                // 此语句确保文件被创建,但不保留句柄。
                using (FileStream fs = File.Create(path)) {}
            }

            // 确保目标文件不存在。
            if (File.Exists(path2))	
            File.Delete(path2);

            // 移动文件。
            File.Move(path, path2);
            Console.WriteLine("{0} was moved to {1}。", path, path2);

            // 检查原文件是否仍存在。
            if (File.Exists(path))
            {
                Console.WriteLine("he original file still exists, which is unexpected.");
            }
            else
            {
                Console.WriteLine("The original file no longer exists, which is expected.");
            }			
        }
        catch (Exception e)
        {
            Console.WriteLine("The process failed: {0}", e.ToString());
        }
    }
}

8. DateTime GetCreationTime (string path)返回指定文件或目录的创建日期和时间

using System;
using System.IO;

class Program
{
    static void Main()
    {
        string filePath = @"C:\temp\example.txt";

        try
        {
            // 检查文件是否存在
            if (File.Exists(filePath))
            {
                // 获取文件的创建时间
                DateTime creationTime = File.GetCreationTime(filePath);

                Console.WriteLine($"文件 {filePath} 的创建时间是:{creationTime}");
            }
            else
            {
                Console.WriteLine($"文件 {filePath} 不存在");
            }
        }
        catch (Exception e)
        {
            Console.WriteLine($"发生异常: {e.Message}");
        }
    }
}

9. DateTime GetLastWriteTime (string path)返回上次写入指定文件或目录的日期和时间

using System;
using System.IO;

class Test
{
    public static void Main()
    {
        try
        {
            string path = @"c:\Temp\MyTest.txt";
            if (!File.Exists(path))
            {
                File.Create(path);
            }
            else
            {
                // 执行会影响写入时间的操作。
                File.SetLastWriteTime(path, new DateTime(1985, 4, 3));
            }

            // 获取一个已知目录的最后写入时间。
            DateTime dt = File.GetLastWriteTime(path);
            Console.WriteLine("该文件的最后写入时间为 {0}。", dt);
            
            // 更新最后写入时间。
            File.SetLastWriteTime(path, DateTime.Now);
            dt = File.GetLastWriteTime(path);
            Console.WriteLine("该文件的最后写入时间为 {0}。", dt);
        }
        catch (Exception e)
        {
            Console.WriteLine("进程失败: {0}", e.ToString());
        }
    }
}
posted @ 2024-04-20 15:32  好大的鱼  阅读(40)  评论(0)    收藏  举报