@[toc] 0. 前言 本章節是IO篇的第二集,我們在上一篇中介紹了C 中IO的基本概念和一些基本方法,接下來我們介紹一下操作文件的方法。在編程的世界中,操作文件是一個很重要的技能。 1. 文件、目錄和路徑 在開始操作之前,先大概講解一下基本概念。在電腦系統中,文件是以硬碟為載體存儲在電腦上的 ...
@目錄
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篇完成後,我會演示一下如何做一個簡單的文件查找工具。
簡單介紹一下這個工具的內容:它會遍歷系統里所有文件的路徑信息,然後記錄到一個緩存文件中,用戶輸入一個要查詢的文件名時,我們可以通過讀取緩存文件確認文件所在目錄。
更多內容煩請關註我的博客