【.Net实用方法总结】 整理并总结System.IO中File类及其方法介绍

简介: 本文主要介绍System.IO命名空间的File 类,介绍其常用的方法和示例说明。
🐋作者简介:博主是一位.Net开发者,同时也是RPA和低代码平台的践行者。
🦀专栏简介:博主针对.Net开发和C站问答过程中遇到的问题进行总结,形成本专栏,希望可以帮助到您解决问题。
🐶座右铭:总有一天你所坚持的会反过来拥抱你。

11.jpg

🌈写在前面:

本文主要介绍System.IO命名空间的File 类,介绍其常用的方法和示例说明。


👉本文关键字:System.IO、File类、文件信息、方法示例、C#

1️⃣ System.IO命名空间

.NET中的IO操作命名空间,包含允许读写文件数据流的类型以及提供基本文件和目录支持的类型。

我们在.NET中的IO操作,经常需要调用一下几个类。

  • FileStream类

​ 文件流类,负责大文件的拷贝,读写。

  • Path类

​ Path类中方法,基本都是对字符串(文件名)的操作,与实际文件没多大关系。

  • File类

    File类可以进行一些对小文件拷贝、剪切操作,还能读一些文档文件。

  • Dirctory类

    目录操作,创建文件、删除目录,获取目录下文件名等等。

2️⃣ File类

♈ 定义

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

public static class File

♉ 自定义各种方法的行为的枚举

枚举 描述
FileAccess 指定对文件的读取和写入访问权限。
FileShare 指定已在使用的文件所允许的访问级别。
FileMode 指定是保留还是覆盖现有文件的内容,以及创建现有文件的请求是否会引发异常。
FileAccess 定义文件的读取、写入或读/写访问权限的常量
[System.Flags]
public enum FileAccess
Read 1 对文件的读访问。 可从文件中读取数据。 与 Write 组合以进行读写访问。
ReadWrite 3 对文件的读写访问权限。 可从文件读取数据和将数据写入文件。
Write 2 文件的写访问。 可将数据写入文件。 与 Read 组合以进行读写访问。
FileShare 包含用于控制其他FileStream对象对同一文件可以具有的访问类型的常数
[System.Flags]
public enum FileShare
Delete 4 允许随后删除文件。
Inheritable 16 使文件句柄可由子进程继承。 Win32 不直接支持此功能。
None 0 谢绝共享当前文件。 文件关闭前,打开该文件的任何请求(由此进程或另一进程发出的请求)都将失败。
Read 1 允许随后打开文件读取。 如果未指定此标志,则文件关闭前,任何打开该文件以进行读取的请求(由此进程或另一进程发出的请求)都将失败。 但是,即使指定了此标志,仍可能需要附加权限才能够访问该文件。
ReadWrite 3 允许随后打开文件读取或写入。 如果未指定此标志,则文件关闭前,任何打开该文件以进行读取或写入的请求(由此进程或另一进程发出)都将失败。 但是,即使指定了此标志,仍可能需要附加权限才能够访问该文件。
Write 2 允许随后打开文件写入。 如果未指定此标志,则文件关闭前,任何打开该文件以进行写入的请求(由此进程或另一进过程发出的请求)都将失败。 但是,即使指定了此标志,仍可能需要附加权限才能够访问该文件。
FileMode 指定操作系统打开文件的方式
public enum FileMode
Append 6 若存在文件,则打开该文件并查找到文件尾,或者创建一个新文件。 这需要 Append 权限。 FileMode.Append 只能与 FileAccess.Write 一起使用。 试图查找文件尾之前的位置时会引发 IOException 异常,并且任何试图读取的操作都会失败并引发 NotSupportedException 异常。
Create 2 指定操作系统应创建新文件。 如果此文件已存在,则会将其覆盖。 这需要 Write 权限。 FileMode.Create 等效于这样的请求:如果文件不存在,则使用 CreateNew;否则使用 Truncate。 如果该文件已存在但为隐藏文件,则将引发 UnauthorizedAccessException异常。
CreateNew 1 指定操作系统应创建新文件。 这需要 Write 权限。 如果文件已存在,则将引发 IOException异常。
Open 3 指定操作系统应打开现有文件。 打开文件的能力取决于 FileAccess 枚举所指定的值。 如果文件不存在,引发一个 FileNotFoundException 异常。
OpenOrCreate 4 指定操作系统应打开文件(如果文件存在);否则,应创建新文件。 如果用 FileAccess.Read 打开文件,则需要 Read权限。 如果文件访问为 FileAccess.Write,则需要 Write权限。 如果用 FileAccess.ReadWrite 打开文件,则同时需要 ReadWrite权限。
Truncate 5 指定操作系统应打开现有文件。 该文件被打开时,将被截断为零字节大小。 这需要 Write 权限。 尝试从使用 FileMode.Truncate 打开的文件中进行读取将导致 ArgumentException 异常。

♉ 常用方法

Copy(String, String, Boolean) 将现有文件复制到新文件。 允许覆盖同名的文件。
public static void Copy (string sourceFileName, string destFileName, bool overwrite);

参数

sourceFileName

string

要复制的文件。

destFileName

string

目标文件的名称。 它不能是一个目录或现有文件。

overwrite

bool

如果可以覆盖目标文件,则为 true;否则为 false

示例

以下示例将文件复制到 C:\archives\2008 备份文件夹。 它使用 方法的两个 Copy 重载,如下所示:

  • 它首先使用 File.Copy(String, String)) 方法重载来复制文本 (.txt) 文件。 代码演示此重载不允许覆盖已复制的文件。
  • 然后,它 File.Copy(String, String, Boolean)) 使用 方法重载将图片 (.jpg 文件) 。 该代码演示此重载允许覆盖已复制的文件。
string sourceDir = @"c:\current";
string backupDir = @"c:\archives\2008";

try
{
    string[] picList = Directory.GetFiles(sourceDir, "*.jpg");
    string[] txtList = Directory.GetFiles(sourceDir, "*.txt");

    // Copy picture files.
    foreach (string f in picList)
    {
        // Remove path from the file name.
        string fName = f.Substring(sourceDir.Length + 1);

        // Use the Path.Combine method to safely append the file name to the path.
        // Will overwrite if the destination file already exists.
        File.Copy(Path.Combine(sourceDir, fName), Path.Combine(backupDir, fName), true);
    }

    // Copy text files.
    foreach (string f in txtList)
    {

        // Remove path from the file name.
        string fName = f.Substring(sourceDir.Length + 1);

        try
        {
            // Will not overwrite if the destination file already exists.
            File.Copy(Path.Combine(sourceDir, fName), Path.Combine(backupDir, fName));
        }

        // Catch exception if the file was already copied.
        catch (IOException copyError)
        {
            Console.WriteLine(copyError.Message);
        }
    }

    // Delete source files that were copied.
    foreach (string f in txtList)
    {
        File.Delete(f);
    }
    foreach (string f in picList)
    {
        File.Delete(f);
    }
}

catch (DirectoryNotFoundException dirNotFound)
{
    Console.WriteLine(dirNotFound.Message);
}
Create(String) 在指定路径中创建或覆盖文件
public static System.IO.FileStream Create (string path);

参数

path

string

要创建的文件的路径及名称。

返回

FileStream

一个 FileStream,它提供对 path 中指定的文件的读/写访问。

示例

以下示例在指定的路径中创建文件,将一些信息写入该文件,然后从该文件中读取。

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

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

        try
        {
            // Create the file, or overwrite if the file exists.
            using (FileStream fs = File.Create(path))
            {
                byte[] info = new UTF8Encoding(true).GetBytes("This is some text in the file.");
                // Add some information to the file.
                fs.Write(info, 0, info.Length);
            }

            // Open the stream and read it back.
            using (StreamReader sr = File.OpenText(path))
            {
                string s = "";
                while ((s = sr.ReadLine()) != null)
                {
                    Console.WriteLine(s);
                }
            }
        }

        catch (Exception ex)
        {
            Console.WriteLine(ex.ToString());
        }
    }
}
Create(String, Int32, FileOptions) 创建或覆盖指定路径中的文件,指定缓冲区大小和一个描述如何创建或覆盖该文件的选项
public static System.IO.FileStream Create (string path, int bufferSize, System.IO.FileOptions options);

参数

path

string

要创建的文件的路径及名称。

bufferSize

int

用于读取和写入到文件的已放入缓冲区的字节数。

options

FileOptions

FileOptions 值之一,它描述如何创建或覆盖该文件。

返回

FileStream

具有指定缓冲区大小的新文件。

示例

以下示例演示如何在创建文件流时使用异步值。

using System;
using System.Text;
using System.Threading.Tasks;
using System.IO;

namespace ConsoleApplication
{
    class Program
    {
        static void Main(string[] args)
        {
            WriteToFile();
        }

        static async void WriteToFile()
        {
            byte[] bytesToWrite = Encoding.Unicode.GetBytes("example text to write");
            using (FileStream createdFile = File.Create("c:/Temp/testfile.txt", 4096, FileOptions.Asynchronous))
            {
                await createdFile.WriteAsync(bytesToWrite, 0, bytesToWrite.Length);
            }
        }
    }
}
Delete(String) 删除指定的文件
public static void Delete (string path);

参数

path

string

要删除的文件的名称。 不支持通配符。

示例

以下示例将文件组复制到 C:\archives\2008 备份文件夹,然后从源文件夹中将其删除。

string sourceDir = @"c:\current";
string backupDir = @"c:\archives\2008";

try
{
    string[] picList = Directory.GetFiles(sourceDir, "*.jpg");
    string[] txtList = Directory.GetFiles(sourceDir, "*.txt");

    // Copy picture files.
    foreach (string f in picList)
    {
        // Remove path from the file name.
        string fName = f.Substring(sourceDir.Length + 1);

        // Use the Path.Combine method to safely append the file name to the path.
        // Will overwrite if the destination file already exists.
        File.Copy(Path.Combine(sourceDir, fName), Path.Combine(backupDir, fName), true);
    }

    // Copy text files.
    foreach (string f in txtList)
    {

        // Remove path from the file name.
        string fName = f.Substring(sourceDir.Length + 1);

        try
        {
            // Will not overwrite if the destination file already exists.
            File.Copy(Path.Combine(sourceDir, fName), Path.Combine(backupDir, fName));
        }

        // Catch exception if the file was already copied.
        catch (IOException copyError)
        {
            Console.WriteLine(copyError.Message);
        }
    }

    // Delete source files that were copied.
    foreach (string f in txtList)
    {
        File.Delete(f);
    }
    foreach (string f in picList)
    {
        File.Delete(f);
    }
}

catch (DirectoryNotFoundException dirNotFound)
{
    Console.WriteLine(dirNotFound.Message);
}
Exists(String) 确定指定的文件是否存在
public static bool Exists (string? path);

参数

path

string

文件或目录的路径。

返回

bool

如果 path 指向现有目录,则为 true;如果该目录不存在或者在尝试确定指定目录是否存在时出错,则为 false

示例

下面的示例确定文件是否存在。

string curFile = @"c:\temp\test.txt";
Console.WriteLine(File.Exists(curFile) ? "File exists." : "File does not exist.");
GetCreationTime(String) 返回指定文件或目录的创建日期和时间
public static DateTime GetCreationTime (string path);

参数

path

string

目录的路径。

返回

DateTime

一个设置为指定目录的创建日期和时间的结构。 该值用本地时间表示。

示例

下面的示例演示了 GetCreationTime

using System;
using System.IO;

class Test
{
    public static void Main()
    {
        try
        {
            // Get the creation time of a well-known directory.
            DateTime dt = Directory.GetCreationTime(Environment.CurrentDirectory);

            // Give feedback to the user.
            if (DateTime.Now.Subtract(dt).TotalDays > 364)
            {
                Console.WriteLine("This directory is over a year old.");
            }
            else if (DateTime.Now.Subtract(dt).TotalDays > 30)
            {
                Console.WriteLine("This directory is over a month old.");
            }
            else if (DateTime.Now.Subtract(dt).TotalDays <= 1)
            {
                Console.WriteLine("This directory is less than a day old.");
            }
            else
            {
                Console.WriteLine("This directory was created on {0}", dt);
            }
        }
        catch (Exception e)
        {
            Console.WriteLine("The process failed: {0}", e.ToString());
        }
    }
}
Move(String, String) 将指定文件移到新位置,提供要指定新文件名的选项
public static void Move (string sourceFileName, string destFileName);

参数

sourceFileName

string

要移动的文件的名称。 可以包括相对或绝对路径。

destFileName

string

文件的新路径和名称。

示例

下面的示例将移动一个文件。

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))
            {
                // This statement ensures that the file is created,
                // but the handle is not kept.
                using (FileStream fs = File.Create(path)) {}
            }

            // Ensure that the target does not exist.
            if (File.Exists(path2))    
            File.Delete(path2);

            // Move the file.
            File.Move(path, path2);
            Console.WriteLine("{0} was moved to {1}.", path, path2);

            // See if the original exists now.
            if (File.Exists(path))
            {
                Console.WriteLine("The 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());
        }
    }
}
Open(String, FileMode) 通过不共享的读/写访问权限打开指定路径上的 FileStream
public static System.IO.FileStream Open (string path, System.IO.FileMode mode);

参数

path

string

要打开的文件。

mode

FileMode

FileMode 值,用于指定在文件不存在时是否创建该文件,并确定是保留还是覆盖现有文件的内容。

返回

FileStream

以读/写访问与不共享权限打开的指定模式和路径上的 FileStream

示例

下面的代码示例创建一个临时文件并向其中写入一些文本。 然后,该示例使用 T:System.IO.FileMode.Open 打开该文件;也就是说,如果该文件不存在,则不会创建它。

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

class Test
{
    public static void Main()
    {
        // Create a temporary file, and put some data into it.
        string path = Path.GetTempFileName();
        using (FileStream fs = File.Open(path, FileMode.Open, FileAccess.Write, FileShare.None))
        {
            Byte[] info = new UTF8Encoding(true).GetBytes("This is some text in the file.");
            // Add some information to the file.
            fs.Write(info, 0, info.Length);
        }

        // Open the stream and read it back.
        using (FileStream fs = File.Open(path, FileMode.Open))
        {
            byte[] b = new byte[1024];
            UTF8Encoding temp = new UTF8Encoding(true);

            while (fs.Read(b,0,b.Length) > 0)
            {
                Console.WriteLine(temp.GetString(b));
            }
        }
    }
}
Replace(String, String, String) 使用其他文件的内容替换指定文件的内容,这一过程将删除原始文件,并创建被替换文件的备份
public static void Replace (string sourceFileName, string destinationFileName, string? destinationBackupFileName);

参数

sourceFileName

string

替换由 destinationFileName 指定的文件的文件名。

destFileName

string

被替换文件的名称。

destinationBackupFileName

string

备份文件的名称。

示例

下面的代码示例使用 Replace 方法将文件替换为其他文件,并创建被替换文件的备份。

using System;
using System.IO;

namespace FileSystemExample
{
    class FileExample
    {
        public static void Main()
        {
            try
            {
                string OriginalFile = "test.xml";
                string FileToReplace = "test2.xml";
                string BackUpOfFileToReplace = "test2.xml.bac";

                Console.WriteLine("Move the contents of " + OriginalFile + " into " + FileToReplace + ", delete " + OriginalFile +
                                   ", and create a backup of " + FileToReplace + ".");

                // Replace the file.
                ReplaceFile(OriginalFile, FileToReplace, BackUpOfFileToReplace);

                Console.WriteLine("Done");
            }
            catch (Exception e)
            {
                Console.WriteLine(e);
            }

            Console.ReadLine();
        }

        // Move a file into another file, delete the original, and create a backup of the replaced file.
        public static void ReplaceFile(string FileToMoveAndDelete, string FileToReplace, string BackupOfFileToReplace)
        {
            File.Replace(FileToMoveAndDelete, FileToReplace, BackupOfFileToReplace, false);
        }
    }
}

♊ 注解

使用 File 类执行典型操作,例如一次复制、移动、重命名、创建、打开、删除和追加到单个文件。 你还可以使用 File 类来获取和设置文件特性或 DateTime 与文件的创建、访问和写入相关的信息。 如果要对多个文件执行操作,请参阅 Directory.GetFilesDirectoryInfo.GetFiles

由于所有 File 方法都是静态的,因此 File FileInfo 如果你只想执行一个操作,则使用方法(而不是相应的实例方法)可能更有效。 所有 File 方法都需要正在处理的文件的路径。

类的静态方法对 File 所有方法执行安全检查。 如果要多次重用某个对象,请考虑改用的相应实例方法 FileInfo ,因为安全检查并不总是必需的。

默认情况下,将向所有用户授予对新文件的完全读/写访问权限。

♋ 更多方法

更多方法请查阅官方文档 File 类

⭐写在结尾:

文章中出现的任何错误请大家批评指出,一定及时修改。

希望写在这里的小伙伴能给个三连支持

相关文章
|
2月前
|
存储 编解码 缓存
|
5月前
|
IDE API 开发工具
拦截|篡改|伪造.NET类库中不限于public的类和方法
本文除了回顾拦截.NET类库中的方法,实现方法参数的篡改、方法返回结果的伪造,再着重介绍.NET类库中非public类及方法如何拦截。
拦截|篡改|伪造.NET类库中不限于public的类和方法
|
1月前
|
分布式计算 Java 大数据
IO流【Java对象的序列化和反序列化、File类在IO中的作用、装饰器模式构建IO流体系、Apache commons-io工具包的使用】(四)-全面详解(学习总结---从入门到深化)
IO流【Java对象的序列化和反序列化、File类在IO中的作用、装饰器模式构建IO流体系、Apache commons-io工具包的使用】(四)-全面详解(学习总结---从入门到深化)
44 0
|
26天前
|
运维 Java Unix
File类和IO流
File类和IO流
35 0
|
6月前
|
索引
文件IO之 File 类和 InputStream, OutputStream 的用法(三)
文件IO之 File 类和 InputStream, OutputStream 的用法
57 0
|
6月前
|
存储 Java
文件IO之 File 类和 InputStream, OutputStream 的用法(一)
文件IO之 File 类和 InputStream, OutputStream 的用法
52 0
|
2月前
|
Java
【文件IO】 File类的用法和 InputStream OutputStream 的用法
【文件IO】 File类的用法和 InputStream OutputStream 的用法
|
4月前
|
存储 Java 索引
"Java中的File类、IO基础、IO分类以及字节流的重要性"
"Java中的File类、IO基础、IO分类以及字节流的重要性"
31 0
|
5月前
|
Java Unix Windows
Java 流(Stream)、文件(File)和IO
Java 流(Stream)、文件(File)和IO
|
6月前
|
Java
文件IO之 File 类和 InputStream, OutputStream 的用法(二)
文件IO之 File 类和 InputStream, OutputStream 的用法
50 0