本篇继续前两篇内容,跟大家介绍一下 Path 类以及 FileSystemInfo 这个类的主要方法和属性。
上文提到,在《C# 基础知识系列 -IO 篇》之文件相关的内容完结之后,会带领大家开发一个小工具 - 快速检索文件所在目录。
1.3. Path
Path 的中文名称有路径的意思,所以 Path 类就是路径类,C# 把 Path 设置为工具类,路径的实例被区分为文件和目录了。以下是它的定义:
public static class Path
路径是描述文件和目录的位置的字符串,路径并不一定指向硬盘上,换句话说就是路径不一定是物理路径也有可能是虚拟路径或者网络路径。在不同的操作系统和平台上,路径有着不同的表现,所以 Path 类是对不同平台行为的统一抽象。具体的路径表示需要参照具体的系统表示形式。
那么我们先来看看 Path 为我们提供了哪些内容,让我们一睹为快:
1.3.1 字段
public static readonly char AltDirectorySeparatorChar;
public static readonly char DirectorySeparatorChar;
这两个是特定系统下的目录分隔符,其中 AltDirectorySeparatorChar 表示正斜线(/),DirectorySeparatorChar 表示反斜线()。为什么说是特定系统下的目录分隔符呢,因为 Windows 环境对两种分隔符都支持,但是 Unix 和类 Unix 系统只支持 / 作为目录分隔符。所以如果系统需要跨平台支持,则最好使用 AltDirectorySeparatorChar 作为目录分隔符来使用。
public static readonly char PathSeparator;
这个字段返回在环境变量中分隔路径字符串的平台特定的分隔符。Windows 中返回一个分号(;), 其他平台可能会有不一样的表现。
public static readonly char VolumeSeparatorChar;
这个表示卷分隔符,是个很有意思的特定。对于 Linux 系统来说并没有类似于 Windows 一样的卷,所以该字段会返回一个 /,而 Windows 中例如:
D:Temp 这个目录则会返回冒号(:)。
1.3.2 方法
介绍完了字段,我们来看看 Path 给我们提供了哪些方法吧。
先从最常用的说起吧:
public static string Combine (params string[] paths);
public static string Combine (string path1, string path2);
public static string Combine (string path1, string path2, string path3);
public static string Combine (string path1, string path2, string path3, string path4);
这一组方法用来拼接路径,除第一个参数外,每个参数都应当是相对于之前参数拼接结果路径的相对路径。如果后续出现了绝对路径,那之前计算出的路径信息则会全部抛弃,重新计算。
以下是一个示例:
string[] paths = {@"d:\archives", "2001", "media", "images"};
string fullPath = Path.Combine(paths);
Console.WriteLine(fullPath);
paths = new string[] {@"d:\archives\", @"2001\", "media", "images"};
fullPath = Path.Combine(paths);
Console.WriteLine(fullPath);
paths = new string[] {"d:/archives/", "2001/", "media", "images"};
fullPath = Path.Combine(paths);
Console.WriteLine(fullPath);
// Windows 系统下的执行结果
// d:\archives\2001\media\images
// d:\archives\2001\media\images
// d:/archives/2001/media\images
//
// 类 Unix 系统的执行结果
// d:\archives/2001/media/images
// d:\archives\/2001\/media/images
// d:/archives/2001/media/images
继续下一个方法:
public static string GetFullPath (string path, string basePath);
public static string GetFullPath (string path);
获取相对路径的绝对路径,其中 path 是相对路径,basePath 是绝对路径。如果指定 basePath,则从 basePath 根据 path 计算全路径。
public static string GetRelativePath (string relativeTo, string path);
返回从一个路径到另一个路径的相对路径,其中 relativeTo 是源路径,path 为目标路径。其中 relativeTo 始终是目录,或者被认为是目录。
public static string GetDirectoryName (string path);
返回路径 path 里的目录信息,例如:”C:DirectorySubDirectorytest.txt”,返回 ”C:DirectorySubDirectory”,如果 path 是目录,则返回其上级目录的路径字符串。
public static string Join (string path1, string path2, string path3, string path4);
public static string Join (string path1, string path2, string path3);
public static string Join (params string[] paths);
与 Combine 方法差不多,不过 Join 方法是把所以参数均按照相对目录来拼接。
说完了目录的一些操作,我们看看 Path 对文件路径提供了哪些支持:
public static string GetFileName (string path);
获取路径里的文件名,例如说:“C:mydirmyfile.ext”,返回结果就是“myfile.ext”,也就是说这个方法会返回携带后缀名的文件名。因为文件名本身就包含后缀名。
public static string GetFileNameWithoutExtension (string path);
返回不带后缀名的文件名,与 GetFileName 类似,但是不好含文件格式后缀。
public static bool HasExtension (string path);
确定是否包含后缀名,也称格式名或者扩展名。
public static string GetExtension (string path);
返回所代表的文件的后缀名。
public static string ChangeExtension (string path, string extension);
修改文件的后缀名。
这些是 Path 的常用方法,大家有个印象就好。
1.3 FileSystemInfo
文件系统信息,这是 FileInfo 和 DirectoryInfo 的两个类的基类,它定义了文件系统中文件和目录共有的一些属性和方法。接下来让我们简单看一看。
先来看一下类的声明:
public abstract class FileSystemInfo : MarshalByRefObject, System.Runtime.Serialization.ISerializable
一个 abstract 类,这个标记意味着这个类是一个抽象类,抽象类不能直接实例化,所以我们可能不会自己去直接实例化一个 FileSystemInfo 了。
所以我们先略过 FileSystemInfo 的构造函数,直接看属性和方法。
public System.IO.FileAttributes Attributes {get; set;}
获取或者设置当前文件或目录的特性,这个特性是一个枚举,而且是一个位标记的枚举类型。
名称 | 值 | 含义 |
---|---|---|
Archive | 32 | 此文件标记为包含在增量备份操作中。每当修改文件时,Windows 会设置该属性,并且在增量备份期间处理文件时,备份软件应进行清理该属性。 |
Compressed | 2048 | 此文件是压缩文件。 |
Device | 64 | 留待将来使用。 |
Directory | 16 | 此文件是一个目录。Directory 在 Windows、Linux 和 macOS 上受支持。 |
Encrypted | 16384 | 此文件或目录已加密。对于文件来说,表示文件中的所有数据都是加密的。对于目录来说,表示新创建的文件和目录在默认情况下是加密的。 |
Hidden | 2 | 文件是隐藏的,因此没有包括在普通的目录列表中。Hidden 在 Windows、Linux 和 macOS 上受支持。 |
IntegrityStream | 32768 | 文件或目录包括完整性支持数据。在此值适用于文件时,文件中的所有数据流具有完整性支持。此值将应用于一个目录时,所有新文件和子目录在该目录中和默认情况下应包括完整性支持。 |
Normal | 128 | 该文件是没有特殊属性的标准文件。仅当其单独使用时,此特性才有效。Normal 在 Windows、Linux 和 macOS 上受支持。 |
NoScrubData | 131072 | 文件或目录从完整性扫描数据中排除。此值将应用于一个目录时,所有新文件和子目录在该目录中和默认情况下应不包括数据完整性。 |
NotContentIndexed | 8192 | 将不会通过操作系统的内容索引服务来索引此文件。 |
Offline | 4096 | 此文件处于脱机状态,文件数据不能立即供使用。 |
ReadOnly | 1 | 文件为只读文件。ReadOnly 在 Windows、Linux 和 macOS 上受支持。在 Linux 和 macOS 上,更改 ReadOnly 标记是权限操作。 |
ReparsePoint | 1024 | 文件包含一个重新分析点,它是一个与文件或目录关联的用户定义的数据块。ReparsePoint 在 Windows、Linux 和 macOS 上受支持。 |
SparseFile | 512 | 此文件是稀疏文件。稀疏文件一般是数据通常为零的大文件。 |
System | 4 | 此文件是系统文件。即,该文件是操作系统的一部分或者由操作系统以独占方式使用。 |
Temporary | 256 | 文件是临时文件。临时文件包含当执行应用程序时需要的,但当应用程序完成后不需要的数据。文件系统尝试将所有数据保存在内存中,而不是将数据刷新回大容量存储,以便可以快速访问。当临时文件不再需要时,应用程序应立即删除它。 |
通过以下方式进行判断:
FileSystemInfo fsi;
bool isXXX = (fsi.Attributes & FileAttributes.XXX) == FileAttributes.XXX;
public DateTime CreationTime {get; set;}
public DateTime CreationTimeUtc {get; set;}
返回文件 / 目录的创建时间,其中 UTC 指协调世界时。
public string Extension {get;}
获取文件的文件后缀名(扩展名),带点号(.)。
public virtual string FullName {get;}
public abstract string Name {get;}
都是返回文件或目录的名称,不过 FullName 返回的是全路径名称,Name 只返回了文件名。
public DateTime LastAccessTime {get; set;}
public DateTime LastAccessTimeUtc {get; set;}
获取或设置文件最后一次访问的时间,该属性的返回值并不是严格意义上的最后一次访问时间,因为部分系统不会及时更新。
public DateTime LastWriteTime {get; set;}
public DateTime LastWriteTimeUtc {get; set;}
最后一次修改时间,可以自己设置或修改,类似与 LastAccessTime,可能不是正确的值。
2. 总结
到目前为止,常用的文件 API 已经介绍完毕。接下来将为大家演示各种流的使用,以及各种流的操作场景。
更多内容烦请关注我的博客《高先生小屋》