「C/C++」C++17 之 std::filesystem::recursive_directory_iterator 目录及子目录迭代器

✨博客主页
何曾参静谧的博客
📌文章专栏
「C/C++」C/C++程序设计
📚全部专栏
「VS」Visual Studio	「C/C++」C/C++程序设计	「UG/NX」BlockUI集合
「Win」Windows程序设计	「DSA」数据结构与算法	「UG/NX」NX二次开发
「QT」QT5程序设计	「File」数据文件格式	「PK」Parasolid函数说明

std::filesystem::recursive_directory_iterator 类详解

1. 引用头文件

要使用 std::filesystem::recursive_directory_iterator 类，首先需要包含 <filesystem> 头文件。这个类是 C++17 引入的 std::filesystem 库的一部分，用于递归地遍历目录中的文件和子目录。

#include <filesystem>

注意：确保你的编译器支持 C++17 或更高版本，并且已经正确设置了编译选项以启用 C++17 标准。

2. 注意事项

• 命名空间：使用 std::filesystem 命名空间，或者通过 using namespace std::filesystem; 来简化代码。
• 异常处理：如果提供的路径不存在或无法访问，recursive_directory_iterator 的构造函数可能会抛出异常，如 std::filesystem::filesystem_error。
• 递归深度：虽然标准库没有直接限制递归深度，但过深的目录结构可能会导致栈溢出。因此，在处理深层目录时要特别小心。
• 跳过权限不足的目录：如果某个目录或文件的权限不足，recursive_directory_iterator 会跳过它，而不会抛出异常。可以通过检查 std::error_code 来识别这种情况。
• 不可变性：recursive_directory_iterator 提供对目录内容的只读访问，不能用于修改目录结构或文件内容。

3. 函数构造与对象初始化

3.1 构造函数

recursive_directory_iterator 类有多个构造函数，但最常用的是接受一个 std::filesystem::path 对象或字符串路径的构造函数。还可以指定一个选项对象来修改迭代器的行为，如跳过符号链接或报告错误代码。

namespace fs = std::filesystem;// 构造一个指向当前目录的递归迭代器
fs::recursive_directory_iterator it1(fs::current_path());// 构造一个指向指定路径的递归迭代器
fs::recursive_directory_iterator it2("/path/to/directory");// 构造一个带有选项的递归迭代器，例如跳过符号链接
fs::directory_options opts = fs::directory_options::skip_permission_denied;
fs::recursive_directory_iterator it3("/path/to/directory", opts);// 默认构造函数，表示迭代结束的状态
fs::recursive_directory_iterator end;

3.2 对象初始化

对象可以通过赋值操作符进行初始化，但需要注意赋值后的迭代器状态。

fs::recursive_directory_iterator it4;
it4 = it1; // 现在 it4 指向与 it1 相同的位置

4. 使用方法

4.1 递归遍历目录

recursive_directory_iterator 可以与范围 for 循环一起使用，方便地递归遍历目录中的文件和子目录。

fs::path dirPath = "/path/to/directory";
for (const auto& entry : fs::recursive_directory_iterator(dirPath)) {std::cout << "Path: " << entry.path() << std::endl;if (entry.is_regular_file()) {std::cout << "  (Regular File)" << std::endl;} else if (entry.is_directory()) {std::cout << "  (Directory)" << std::endl;}// 可以添加更多条件来检查其他类型的文件，如符号链接、块设备等
}

4.2 检查迭代结束

可以使用默认构造的 recursive_directory_iterator 对象作为结束标志，或者使用 == 运算符进行比较。

fs::recursive_directory_iterator it5(dirPath);
while (it5 != end) {std::cout << "Path: " << it5->path() << std::endl;++it5;
}

或者更简洁地，使用范围 for 循环的隐式结束条件（如上所示）。

4.3 处理错误代码

如果需要处理权限不足或其他错误，可以传递一个 std::error_code& 参数给迭代器的构造函数或 status() 方法。

std::error_code ec;
for (const auto& entry : fs::recursive_directory_iterator(dirPath, ec)) {if (ec) {std::cerr << "Error accessing: " << entry.path() << " - " << ec.message() << std::endl;ec.clear(); // 清除错误代码以继续迭代} else {std::cout << "Path: " << entry.path() << std::endl;}
}

5. 总结与应用场景

std::filesystem::recursive_directory_iterator 类是 C++17 文件系统库中的一个强大工具，它允许程序员以简单而高效的方式递归地遍历目录中的文件和子目录。通过构造函数和选项对象，可以灵活地控制迭代器的行为，如跳过符号链接或报告错误代码。

应用场景：

• 深度搜索：在指定目录及其所有子目录中搜索特定文件或文件类型。
• 统计与报告：生成目录结构的统计报告，如文件数量、文件大小、目录深度等。
• 权限检查：遍历目录并检查每个文件或目录的权限。
• 文件同步：在备份、恢复或文件同步过程中，递归地遍历目录以选择或排除特定的文件或子目录。
• 代码分析：在构建系统或代码分析工具中，递归地遍历源代码目录以处理或分析文件。

通过掌握 std::filesystem::recursive_directory_iterator 类的使用方法，程序员可以更加灵活地处理复杂的文件系统任务，提高代码的可读性和可维护性。

---