C# 基礎知識系列- 14 IO篇 檔案的操作

@

目錄

• 0. 前言
• 1. 檔案、目錄和路徑
  • 1.1 File和FileInfo
    • 1.1.1 File工具類
    • 1.1.2 FileInfo 物件類
  • 1.2 Directory和DirectoryInfo
    • 1.2.1 Directory
    • 1.2.2 DirectoryInfo

0. 前言

本章節是IO篇的第二集，我們在上一篇中介紹了C#中IO的基本概念和一些基本方法，接下來我們介紹一下操作檔案的方法。在程式設計的世界中，操作檔案是一個很重要的技能。

1. 檔案、目錄和路徑

在開始操作之前，先大概講解一下基本概念。在計算機系統中，檔案是以硬碟為載體儲存在計算機上的資訊集合。檔案通常會有一個字尾名，表示檔案格式（當然，通常的另一個含義就是可能沒有）。我們最常見到的圖片檔案，字尾有jpg/png/gif這些常見的；文字檔案為txt等。

目錄，不嚴謹的來講可以用資料夾代替。不過嚴格來說，目錄指的是檔案所在的資料夾以及資料夾的位置這些資訊的集合。

路徑是指檔案或資料夾所在的位置的字串表示，有相對路徑和絕對路徑，有物理路徑和網路路徑等一系列這些劃分。

• 相對路徑指的是，相對程式所在目錄目標檔案所在的目錄路徑
• 絕對路徑指的是從系統或者網站的目錄起點開始檔案所在的位置，也就是說無論程式在哪都能通過絕對路徑訪問到對應檔案
• 物理路徑是指檔案在磁碟的路徑，劃分依據與之前的兩種並不一致，所以不是並列關係
• 網路路徑是指網路或檔案是在網路服務上部署的，通過URI訪問的路徑資訊

好了，基本概念介紹到這裡，讓我們來看看如何實現C#操作檔案吧。

1.1 File和FileInfo

C# 提供了兩個訪問檔案的入口，File和FileInfo這兩個類。有人可能要迷惑了，為啥要提供兩個呢，這兩個又有啥子不一樣的呢？別急，讓我們來一起看一看吧。

我們先來觀察一下兩個類的宣告方式有什麼不一樣的：

public static class File;
public sealed class FileInfo : System.IO.FileSystemInfo;

我們忽略突然冒出來的FileSystemInfo，只需要明白它是FileInfo的基類即可。

通過兩個類的宣告方式，可以看出File是一個工具類，而FileInfo則是檔案物件。所以，File更多的用在快速操作檔案並不需要長時間多次使用同一個檔案的場景，而FileInfo則適合同一個檔案的多次使用。

1.1.1 File工具類

我們先來看下File支援哪些操作：

a.檔案讀取

public static byte[] ReadAllBytes (string path);
public static string[] ReadAllLines (string path);
public static string[] ReadAllLines (string path, System.Text.Encoding encoding);
public static string ReadAllText (string path);
public static string ReadAllText (string path, System.Text.Encoding encoding);
public static System.Collections.Generic.IEnumerable<string> ReadLines (string path);

先從名稱上分析方法應該是什麼，應該具有哪些功能？

• ReadAllBytes以二進位制的形式一次性把檔案全部讀出來
• ReadAllLines開啟文字檔案，將檔案內容一行一行的全部讀出來並返回
• ReadAllText開啟檔案，並將檔案所有內容一次性讀出來
• ReadLines 這是一個新的方法，根據返回值和方法名稱，可以判斷它應該與ReadAllLines有著類似的行為

ReadLInes和ReadAllLines的區別：

• ReadAllLines返回的是字串陣列，所以該方法會一次性將檔案內容全部讀出
• ReadLines返回的是一個可列舉物件，根據之前在Linq系列和集合系列的知識，我們能判斷出，這個方法不會立即返回資料

所以我們很輕易的就能得出，ReadAllLines不會過久的持有檔案物件，但是不適合操作大檔案；ReadLines對於大檔案的操作更擅長一些，但是可能會更久的持有檔案

b.寫入檔案

public static void AppendAllLines (string path, System.Collections.Generic.IEnumerable<string> contents);
public static void AppendAllLines (string path, System.Collections.Generic.IEnumerable<string> contents, System.Text.Encoding encoding);
public static void AppendAllText (string path, string contents);
public static void AppendAllText (string path, string contents, System.Text.Encoding encoding);
public static void WriteAllBytes (string path, byte[] bytes);
public static void WriteAllLines (string path, string[] contents, System.Text.Encoding encoding);
public static void WriteAllText (string path, string contents);
public static void WriteAllText (string path, string contents, System.Text.Encoding encoding);

來，我們簡單看一下這幾個方法具體作用：

• AppendAllLines：追加行到檔案末尾
• AppendAllText ：將字串內容追加到檔案末尾
• WriteBytes：將位元組陣列寫到檔案裡，如果檔案有內容就覆蓋原有內容
• WriteAllLines：按行寫入檔案中，如果檔案有內容則覆蓋原有內容
• WriteAllText：將內容寫入檔案，如果檔案有內容則覆蓋原有內容

在使用File寫入檔案的時候，如果檔案不存在則會自動建立檔案。

c. 複製檔案

File類提供了簡單易用的複製檔案功能，只需要指定原始檔和新檔案即可：

public static void Copy (string sourceFileName, string destFileName);
public static void Copy (string sourceFileName, string destFileName, bool overwrite);

這兩個方法對的作用就是將 sourceFileName複製為destFileName。第一個方法不允許複製為已存在的檔案，也就是說如果destFileName已存在則報錯。第二個方法則通過overwrite指定是否覆蓋。

d.移動檔案

與複製檔案相同的使用方式，File提供了移動檔案的方法：

public static void Move (string sourceFileName, string destFileName);
public static void Move (string sourceFileName, string destFileName, bool overwrite);

注意事項與複製檔案一致。

e.刪除檔案

public static void Delete (string path);

1.1.2 FileInfo 物件類

FileInfo提供了檔案的建立、複製、刪除、移動和開啟等屬性和例項方法。我們先來看看，如果建立一個FileInfo：

public FileInfo (string fileName);

通過指定檔案路徑，來換取一個FileInfo物件，如果fileName指定的是目錄則會提示錯誤。

好，現在我們已經可以獲取一個FileInfo物件例項了，那麼一起來看看FileInfo支援哪些內容吧：

a. 先來看看檔案的基本屬性

public override bool Exists { get; }

檔案是否存在，等效於File.Existss(string path)。

public string DirectoryName { get; }

獲取檔案所在目錄的完整路徑（絕對路徑）。

public System.IO.DirectoryInfo Directory { get; }

獲取檔案所在目錄的目錄型別例項。

public long Length { get; }

獲取檔案的大小，單位是位元組。

public override string Name { get; }

獲取檔名，包括檔案的副檔名。

b. 檔案的操作

對於FileInfo例項來說，對於檔案的操作大多都是基於流來完成的（這部分請留意下一篇內容），這裡先看一下它的例項方法：

public System.IO.StreamWriter AppendText ();//建立一個流介面卡，在介面卡裡追加文字到檔案中
public System.IO.FileInfo CopyTo (string destFileName);//將現有檔案複製到新檔案，並返回新檔案的例項，不支援覆蓋
public System.IO.FileInfo CopyTo (string destFileName, bool overwrite);//根據orverwrite確定是否覆蓋
public System.IO.FileStream Create ();//建立當前物件代表的檔案，並返回一個檔案流
public System.IO.StreamWriter CreateText ();//與AppendText類似，但會覆蓋檔案原有內容
public override void Delete ();//刪除檔案
public void MoveTo (string destFileName);// 將檔案移動到新檔案，不支援覆蓋已存在檔案
public void MoveTo (string destFileName, bool overwrite);// 根據overwrite確定是否覆蓋
public System.IO.FileStream Open (System.IO.FileMode mode);// 根據模式開啟檔案
public System.IO.FileStream Open (System.IO.FileMode mode, System.IO.FileAccess access);//指定許可權和模式，開啟檔案
public System.IO.FileStream OpenRead ();//開啟一個只能讀取的檔案流
public System.IO.StreamReader OpenText ();//開啟一個讀流介面卡
public System.IO.FileStream OpenWrite ();// 開啟一個只能寫的流

最新版C#的API，取消了通過FileInfo獲取檔案的格式名的屬性以及其他的很多屬性，只保留了文中提到的幾個屬性。

1.2 Directory和DirectoryInfo

與之前的類似，Directory也是個工具類，DirectoryInfo則代表目錄例項。

1.2.1 Directory

先來個簡單的：

a. 建立目錄：

public static System.IO.DirectoryInfo CreateDirectory (string path);

如果目錄已存在，則跳過建立，直接返回指定路徑的DirectoryInfo例項

b.是否存在：

public static bool Exists (string path);

返回是否存在這個目錄。

c.返回目錄下的所有檔案

public static string[] GetFiles (string path);

d. 返回目錄下的所有子目錄：

public static string[] GetDirectories (string path);
public static string[] GetDirectories (string path, string searchPattern);
public static string[] GetDirectories (string path, string searchPattern, System.IO.EnumerationOptions enumerationOptions);
public static string[] GetDirectories (string path, string searchPattern, System.IO.SearchOption searchOption);

除了上文提到的 GetDirectories 方法可以直接返回目錄下所有子目錄以外，還有一組方法也可以列舉出當前目錄下的子目錄：

public static System.Collections.Generic.IEnumerable<string> EnumerateDirectories (string path);

列舉 path 目錄下的所有子目錄。

public static System.Collections.Generic.IEnumerable<string> EnumerateDirectories (string path, string searchPattern);

searchPattern，搜尋名稱字串，可以包含有效文字路徑和萬用字元（* 和 ?）的組合，但不支援正規表示式。

public static System.Collections.Generic.IEnumerable<string> EnumerateDirectories (string path, string searchPattern, System.IO.EnumerationOptions enumerationOptions);
public static System.Collections.Generic.IEnumerable<string> EnumerateDirectories (string path, string searchPattern, System.IO.SearchOption searchOption);

這兩個方法放在一起講，這兩個是對上一個方法的增強和補充。其中 EnumerationOptions 是類，可以配置查詢的條件；SearchOption 是個列舉，選擇只查詢當前目錄的子目錄名稱還是繼續深入查詢子孫目錄。

e.檢視目錄下的所有檔案-補充

與子目錄查詢相同，Directory也支援這麼幾組查詢方法：

public static string[] GetFiles (string path);
public static string[] GetFiles (string path, string searchPattern);
public static string[] GetFiles (string path, string searchPattern, System.IO.EnumerationOptions enumerationOptions);
public static string[] GetFiles (string path, string searchPattern, System.IO.SearchOption searchOption);

從引數上看，可以看出來這是返回子目錄下的檔案列表。其中使用 searchPattern查詢名稱，enumerationOptions 作為查詢條件，searchOption 作為查詢的深度。

同樣，查詢檔案也可以使用列舉方法：

public static System.Collections.Generic.IEnumerable<string> EnumerateFiles (string path);
public static System.Collections.Generic.IEnumerable<string> EnumerateFiles (string path, string searchPattern);
public static System.Collections.Generic.IEnumerable<string> EnumerateFiles (string path, string searchPattern, System.IO.EnumerationOptions enumerationOptions);
public static System.Collections.Generic.IEnumerable<string> EnumerateFiles (string path, string searchPattern, System.IO.SearchOption searchOption);

f.獲取當前目錄

public static string GetCurrentDirectory ();

在程式中呼叫這個方法可以獲取程式執行時的目錄，如果是在除錯階段，目錄是指程式的主方法所在目錄；如果在釋出之後，也就是執行階段，該目錄指程式所在目錄。

g.獲取上級目錄

public static System.IO.DirectoryInfo GetParent (string path);

獲取傳入目錄的上級目錄資訊。

h.目錄移動

public static void Move (string sourceDirName, string destDirName);

sourceDirName 移動到 destDirName，其中destDirName所代表的目錄不能純在。這個方法有個很有意思的特點，它也支援移動檔案。也就是說，如果sourceDirNanme指向的是一個檔案，那麼destDirName也必須是一個檔案型別的路徑字串。

i.刪除目錄

public static void Delete (string path);//刪除 path所代表的目錄，如果目錄非空則提示無法刪除
public static void Delete (string path, bool recursive);// recursive指示是否同時刪除子目錄和檔案

以上是Directory類的一些常用方法，當然還有更多的內容留待小夥伴一起發掘。傳送門==>https://docs.microsoft.com/zh-cn/dotnet/api/system.io.directory?view=netcore-3.1

1.2.2 DirectoryInfo

之前的篇幅我們介紹了Directory的工具類所支援的方法，接下來我們看一下 DirectoryInfo有哪些屬性和方法吧。

public DirectoryInfo (string path);

初始化的方式很簡單，直接傳遞一個目錄的路徑字串，就可以獲取一個目錄資訊類了。

接下來看看，DirectoryInfo支援的屬性：

public override bool Exists { get; }// 目錄是否存在
public override string Name { get; }// 目錄名稱，不是路徑
public System.IO.DirectoryInfo Parent { get; }//如果有上級目錄，則返回上級目錄，如果沒有則返回 null
public System.IO.DirectoryInfo Root { get; }//獲取目錄的根目錄

我們路過了DirectoryInfo的屬性，看到了它一部分特點，那麼我們該怎麼使用呢?

public void Create ();

建立目錄資訊所代表的目錄，如果目錄已存在，則不會有任何變化 。如果這個目錄的父目錄也不存在，則自動建立父目錄

public System.IO.DirectoryInfo CreateSubdirectory (string path);

建立 pathi指定的子目錄。

public override void Delete ();

如果當前目錄是空目錄，呼叫可直接刪除，如果非空則會提示錯誤。

public void Delete (bool recursive);

根據引數 recursive指定是否刪除當前目錄的子目錄。

public System.IO.DirectoryInfo[] GetDirectories ();
public System.IO.DirectoryInfo[] GetDirectories (string searchPattern);
public System.IO.DirectoryInfo[] GetDirectories (string searchPattern, System.IO.EnumerationOptions enumerationOptions);
public System.IO.DirectoryInfo[] GetDirectories (string searchPattern, System.IO.SearchOption searchOption);

獲取子目錄的陣列，引數與 Directory 的同名方法一致。

public System.Collections.Generic.IEnumerable<System.IO.DirectoryInfo> EnumerateDirectories ();
public System.Collections.Generic.IEnumerable<System.IO.DirectoryInfo> EnumerateDirectories (string searchPattern);
public System.Collections.Generic.IEnumerable<System.IO.DirectoryInfo> EnumerateDirectories (string searchPattern, System.IO.EnumerationOptions enumerationOptions);
public System.Collections.Generic.IEnumerable<System.IO.DirectoryInfo> EnumerateDirectories (string searchPattern, System.IO.SearchOption searchOption);

返回一個子目錄資訊的可列舉集合。

public System.IO.FileInfo[] GetFiles ();
public System.IO.FileInfo[] GetFiles (string searchPattern);
public System.IO.FileInfo[] GetFiles (string searchPattern, System.IO.EnumerationOptions enumerationOptions);
public System.IO.FileInfo[] GetFiles (string searchPattern, System.IO.SearchOption searchOption);

嗯，依舊類似的寫法，獲取檔案資訊的陣列

public System.Collections.Generic.IEnumerable<System.IO.FileInfo> EnumerateFiles ();
public System.Collections.Generic.IEnumerable<System.IO.FileInfo> EnumerateFiles (string searchPattern);
public System.Collections.Generic.IEnumerable<System.IO.FileInfo> EnumerateFiles (string searchPattern, System.IO.EnumerationOptions enumerationOptions);
public System.Collections.Generic.IEnumerable<System.IO.FileInfo> EnumerateFiles (string searchPattern, System.IO.SearchOption searchOption);

返回檔案的可列舉集合。

public void MoveTo (string destDirName);

把當前目錄移動到對應的目錄。

依舊未完待續，下一篇將為大家介紹一下 Path類和FileInfo與DirectoryInfo的父類 FileSystemInfo 這兩個類的API，然後演示一下如何使用流來讀寫檔案。在檔案和目錄這塊內容裡，我故意忽略了許可權的介紹，這部分我將會放在進階篇中介紹。

API的介紹總是這麼枯燥乏味，不過請期待一下，在IO篇完成後，我會演示一下如何做一個簡單的檔案查詢工具。

簡單介紹一下這個工具的內容：它會遍歷系統裡所有檔案的路徑資訊，然後記錄到一個快取檔案中，使用者輸入一個要查詢的檔名時，我們可以通過讀取快取檔案確認檔案所在目錄。

更多內容煩請關注我的部落格