Windows编程系列:遍历文件(C++和C#实现)

Windows编程系列：遍历文件(C++和C#实现)

本文经原作者授权以原创方式二次分享，欢迎转载、分享。

Windows编程系列：遍历文件(C++和C#实现)

作者：zhaotianff - 赵嘉

原文链接^[1]：https://www.cnblogs.com/zhaotianff/p/17944974

以前在学校的时候做过一个类似Bridge的图片浏览器，当时就对系统的文件树进行了显示。后面就没有涉及这一块的开发了。

最近想做一个文件夹大小统计的功能，在使用C#对文件进行遍历时，发现许多文件夹都会报System.UnauthorizedAccessException的错误。

最开始我是想通过判断文件夹的访问权限来避开这些未授权的文件夹。

我尝试了下面的C#代码

string path = @"xxx";
string NtAccountName = System.Security.Principal.WindowsIdentity.GetCurrent().Name;

DirectoryInfo di = new DirectoryInfo(path);
DirectorySecurity acl = di.GetAccessControl(AccessControlSections.All);
AuthorizationRuleCollection rules = acl.GetAccessRules(true, true, typeof(NTAccount));

foreach (AuthorizationRule rule in rules)
{
if (rule.IdentityReference.Value.Equals(NtAccountName, StringComparison.CurrentCultureIgnoreCase))
 {
var filesystemAccessRule = (FileSystemAccessRule)rule;

if ((filesystemAccessRule.FileSystemRights & FileSystemRights.Read) > 0 && filesystemAccessRule.AccessControlType != AccessControlType.Deny)
 {
//success
 }
else
 {
//failed
 }
 }
}

但是在文件夹里DACL中，并不包含了当前用户对应的权限，所以会判断不准确。

后面我又查看了.NET的源码，发现里面会对权限进行判断，判断失败就会引发异常。

internal static void CheckPermissions(string displayPath, string fullPath, bool checkHost, FileSecurityStateAccess access = FileSecurityStateAccess.Read)
 {
// You need read access to the directory to be returned back and write access to all the directories
// that you need to create. If we fail any security checks we will not create any directories at all.
// We attempt to create directories only after all the security checks have passed. This is avoid doing
// a demand at every level.

#if FEATURE_CORECLR
if (checkHost)
 {
 FileSecurityState state = new FileSecurityState(
 access,
 path: displayPath,
 canonicalizedPath: GetDemandDir(fullPath, thisDirOnly: true));
 state.EnsureState(); // do the check on the AppDomainManager to make sure this is allowed
 }
#else
// In full trust we want to avoid allocating another string via GetDemandDir()
if (CodeAccessSecurityEngine.QuickCheckForAllDemands())
 FileIOPermission.EmulateFileIOPermissionChecks(fullPath);
else
 FileIOPermission.QuickDemand(
 (FileIOPermissionAccess)access,
 GetDemandDir(fullPath, thisDirOnly: true),
 checkForDuplicates: false,
 needFullPath: false);
#endif
 }

最后直接使用try...catch...跳过，但运行不够理想。

回想起以前使用WinAPI去遍历文件，试了下，真的可以，也不会报错。

使用WinAPI实现

使用WinAPI去遍历文件主要涉及以下几个函数，FindFirstFile、FindNextFile和FindClose等。

FindFirstFile：搜索与特定名称匹配的文件或子目录 函数声明如下

HANDLE FindFirstFileW(
 [in] LPCWSTR lpFileName,
 [out] LPWIN32_FIND_DATAA lpFindFileData
 );

参数：lpFileName

指定目录、路径，以及文件名。文件名可以包括通配符，例如星号(*）或问号(?)。此参数不应为，无效的字符串（例如，空字符串或缺少终止空字符的字符串)。尾部以反斜杠(\)结尾。如果字符串以通配符、句点(.)或目录名称结尾，那么用户必须对路径上的根目录和所有子目录具有访问权限。

参数：lpFindFileData

指向WIN32_FIND_DATA结构的指针，用于接收搜索到的文件或目录的信息。

WIN32_FIND_DATA结构定义如下：

typedef struct _WIN32_FIND_DATAW {
 DWORD dwFileAttributes; //文件属性
 FILETIME ftCreationTime; //指定创建文件或目录的时间
 FILETIME ftLastAccessTime; //上次运行时间（文件）或创建时间（目录）
 FILETIME ftLastWriteTime; //上次写入、截断或覆盖时间
 DWORD nFileSizeHigh; //文件大小的高位 DWORD 值（以字节为单位）
 DWORD nFileSizeLow; //文件大小的低位 DWORD 值（以字节为单位）
 DWORD dwReserved0; //保留
 DWORD dwReserved1; //保留
 _Field_z_ WCHAR cFileName[ MAX_PATH ]; //文件的名称
 _Field_z_ WCHAR cAlternateFileName[ 14 ]; //文件的可选名称
} WIN32_FIND_DATAW, *PWIN32_FIND_DATAW, *LPWIN32_FIND_DATAW;

返回值:HANDLE

如果函数成功，则返回值是在后续调用FindNextFile或FindClose中使用的搜索句柄，lpFindFileData参数包含搜索到的第一个文件或目录的信息。如果函数失败或无法从lpFileName参数的搜索字符串中找到文件，则返回值为INVALID_HANDLE_VALUE，并且lpFindFileData的内容是不确定的。

FindNextFile函数：继续搜索文件 函数声明如下

 BOOL FindNextFileA(
 [in] HANDLE hFindFile,
 [out] LPWIN32_FIND_DATAA lpFindFileData
 );

参数：hFindFile

指向由前一次调用FindFirstFile或 FindFirstFileEx函数返回的搜索句柄。

参数：lpFindData

指向WIN32_FIND_DATA结构的指针，该结构接收搜索到的文件或子目录的信息。

返回值：BOOL

如果函数成功，则返回TRUE，lpFindFileData参数包含搜索到的下一个文件或目录的信息。如果函数失败，则返回FALSE，并且lpFindFileData的内容是不确定的。

FindClose函数：关闭由FindFirstFile函数打开的文件搜索句柄 函数声明如下：

 BOOL FindClose(
 [in, out] HANDLE hFindFile
 );

参数：hFindFile

文件搜索句柄

返回值：BOOL

如果函数成功，则返回TRUE。如果函数失败，则返回FALSE。

文件遍历的实现原理

1、构建搜索字符串，如我要遍历C:\盘下的文件，构建搜索字符串为C:\\*.*（*是通配符，代表所有文件）

2、调用FindFirstFile函数，按照指定的搜索路径和类型进行搜索，搜索结果保存在由WIN32_FIND_DATA 结构体指针指向的内存中。结构体WIN32_FIND_DATA包含文件的名称、创建日期、属性、大小等信息。

3、根据WIN32_FIND_DATA结构体中的成员dwFileAttributes来判断搜索到文件属性，若值为FILE_ATTRIBUTE_DIRECTORY，则表示该文件为目录，再次构建搜索字符串，进行递归搜索，否则为为文件，保存成员cFileName值以备后续使用或直接输出。

4、对目录进行递归搜索时，需要对当前目录“.”和上一层目录“..”进行过滤，如果对这两个目录递归遍历，则会陷入无限搜索中，而且还会造成缓冲区溢出。

5、调用FindNextFile函数搜索下一个文件，根据返回值判断是否搜索到文件，若没有，则说明文件遍历结束，然后退出;若搜索到文件，则继续循环上面的操作，获取文件名，判断文件属性等。

6、搜索完毕后，调用FindClose函数文件关闭搜索句柄，并释放缓冲区资源。

看起来挺复杂的，总结起来就是，构建搜索字符串进行文件搜索，是文件就输出，并继续搜索下一个文件，是目录，再次构建搜索字符串进行上述过程。

C++实现代码如下：

VOID SearchFile(LPCTSTR pszDirectory)
{
// 搜索指定类型文件
 DWORD dwBufferSize = 2048;
 TCHAR* pszFileName = ;
 TCHAR* pTempSrc = ;
 WIN32_FIND_DATA findData{};
 BOOL bRet = FALSE;

// 申请动态内存
 pszFileName = new TCHAR[dwBufferSize];
 pTempSrc = new TCHAR[dwBufferSize];

// 构造搜索文件类型字符串, *.*表示搜索所有文件类型
 wsprintf(pszFileName, L"%s\\*.*", pszDirectory);

// 搜索第一个文件
 HANDLE hFile = FindFirstFile(pszFileName, &findData);
if (INVALID_HANDLE_VALUE != hFile)
 {
do
 {
// 要过滤掉 当前目录"." 和 上一层目录"..", 否则会不断进入死循环遍历
if ('.' == findData.cFileName[0])
 {
continue;
 }
// 拼接文件路径
 wsprintf(pTempSrc, L"%s\\%s", pszDirectory, findData.cFileName);
// 判断是否是目录还是文件
if (findData.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)
 {
// 目录, 则继续往下递归遍历文件
 SearchFile(pTempSrc);
 }
else
 {
// 文件
 wprintf_s(L"%s\n", pTempSrc);
 }

// 搜索下一个文件
 } while (FindNextFile(hFile, &findData));
 }

// 关闭文件句柄
 FindClose(hFile);
// 释放内存
delete[]pTempSrc;
 pTempSrc = ;
delete[]pszFileName;
 pszFileName = ;
}

这里我直接遍历 C盘下的文件

 int main()
{
 SearchFile("C:\\");
 }

运行效果如下：

C#实现代码：

C#中调用跟C++中一致，做好相应数据类型的映射即可

首先需要声明P/Invoke签名

[DllImport("Kernel32.dll",CharSet = CharSet.Unicode)]
public static extern IntPtr FindFirstFile(string lpFileName, out WIN32_FIND_DATA lpFindFileData);

[DllImport("Kernel32.dll",CharSet= CharSet.Unicode)]
public static extern bool FindNextFile(IntPtr hFindFile, out WIN32_FIND_DATA lpFindFileData);

[DllImport("Kernel32.dll")]
public static extern bool FindClose(IntPtr hFindFile);

定义数据类型

public static readonly IntPtr INVALID_HANDLE_VALUE = (IntPtr)(-1);
public static readonly uint FILE_ATTRIBUTE_DIRECTORY = 0x00000010;

public struct FILETIME
{
public uint dwLowDateTime;
public uint dwHighDateTime;
}

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct WIN32_FIND_DATA
{
public System.IO.FileAttributes dwFileAttributes;

public FILETIME ftCreationTime;

public FILETIME ftLastAccessTime;

public FILETIME ftLastWriteTime;

public uint nFileSizeHigh;

public uint nFileSizeLow;

public uint dwReserved0;

public uint dwReserved1;

 [MarshalAs(UnmanagedType.ByValTStr, SizeConst = 260)]
public string cFileName;

 [MarshalAs(UnmanagedType.ByValTStr, SizeConst = 14)]
public string cAlternateFileName;
}

觉得麻烦的，可以直接引用 Nuget包，我习惯了手写，所以就自己撸了

NuGet\Install-Package Vanara.PInvoke.Kernel32 -Version 4.0.0-beta

调用代码如下：

public static void EnumerateSubDirectory(string dir)
 {
 // 搜索指定类型文件
 string pszFileName;
 string pTempSrc;
 WIN32_FIND_DATA FileData = new WIN32_FIND_DATA();

 // 构造搜索文件类型字符串, *.*表示搜索所有文件类型
 pszFileName = $"{dir}\\*.*";

 // 搜索第一个文件
 IntPtr hFile = FindFirstFile(pszFileName, out FileData);
if (INVALID_HANDLE_VALUE != hFile)
 {
do
 {
 // 要过滤掉 当前目录"." 和 上一层目录"..", 否则会不断进入死循环遍历
if ('.' == FileData.cFileName[0])
 {
continue;
 }
 // 拼接文件路径
 pTempSrc = $"{dir}\\{FileData.cFileName}";
 // 判断是否是目录还是文件
if (FileData.dwFileAttributes == System.IO.FileAttributes.Directory)
 {
 // 目录, 则继续往下递归遍历文件
 EnumerateSubDirectory(pTempSrc);
 }
else
 {
 // 文件
 Console.WriteLine(pTempSrc);
 }

 // 搜索下一个文件
 } while (FindNextFile(hFile, out FileData));
 }

 // 关闭文件句柄
 FindClose(hFile);
 }

使用api去遍历 ，没有权限的目录也是访问不了的，但是不会报错，也不会影响文件遍历的过程

源码下载^[2]

参考资料：

参考01^[3]

[参考02](https://learn.microsoft.com/zh-cn/previous-versions/visualstudio/visual-studio-2012/bb513869(v=vs.110 "参考02") "参考01"))

参考资料