381. Java IO API - 控制文件树遍历流程

文章目录

• [381. Java IO API - 控制文件树遍历流程](#381. Java IO API - 控制文件树遍历流程)
• • • [🧩 `FileVisitResult `枚举值详解](#🧩 FileVisitResult 枚举值详解)
    • [🎯 示例 1：跳过名为 `SCCS` 的目录](#🎯 示例 1：跳过名为 SCCS 的目录)
    • [🔍 示例 2：一旦找到目标文件立即退出](#🔍 示例 2：一旦找到目标文件立即退出)
    • [🚫 示例 3：跳过所有兄弟目录](#🚫 示例 3：跳过所有兄弟目录)
    • [🛠 小技巧：结合 walkFileTree 精准控制](#🛠 小技巧：结合 walkFileTree 精准控制)
  • [🧠 总结回顾](#🧠 总结回顾)

381. Java IO API - 控制文件树遍历流程

在使用 FileVisitor 遍历文件系统时，有时候我们并不希望遍历整个文件树。例如：

• ✅ 只查找特定文件或目录，找到后立即退出
• 🚫 跳过特定的子目录或文件夹分支
• 🌲 有选择地控制哪些兄弟目录继续遍历，哪些不再访问

Java 提供了 FileVisitResult 枚举来让我们控制这些流程。

---

🧩 FileVisitResult 枚举值详解

枚举常量	含义	应用场景
CONTINUE	继续遍历	默认行为，进入下一级目录或继续访问兄弟节点
TERMINATE	终止遍历	找到目标文件/目录后立即停止遍历
SKIP_SUBTREE	跳过当前目录及其子树	不进入当前目录，适合用来排除不必要的分支
SKIP_SIBLINGS	跳过当前目录的所有兄弟节点	当前目录访问结束后，不再访问同级的其他目录

---

🎯 示例 1：跳过名为 SCCS 的目录

我们可能不希望遍历一些临时目录或版本控制目录（如 SCCS、.git、node_modules 等），这时可以在 preVisitDirectory() 中使用 SKIP_SUBTREE：

@Override
public FileVisitResult preVisitDirectory(Path dir, BasicFileAttributes attrs) {
    if (dir.getFileName().toString().equals("SCCS")) {
        // 🚫 跳过该目录及其子目录
        return SKIP_SUBTREE;
    }
    return CONTINUE;
}

💡 补充说明：

• SKIP_SUBTREE 只跳过当前目录及其下的子内容，不影响同级目录的遍历
• 适合用于排除结构性目录（如缓存、构建输出）

---

🔍 示例 2：一旦找到目标文件立即退出

假设我们要查找某个文件名匹配的文件（如 "config.yml"），并在找到后立刻停止遍历整个文件树，可以使用 TERMINATE：

Path lookingFor = Paths.get("config.yml");

@Override
public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) {
    if (file.getFileName().equals(lookingFor)) {
        System.out.println("✅ Found target file: " + file);
        return TERMINATE;
    }
    return CONTINUE;
}

💡 补充说明：

• TERMINATE 会立刻中止遍历
• 所有后续的 visitFile、preVisitDirectory、postVisitDirectory 都不会再被调用

---

🚫 示例 3：跳过所有兄弟目录

有时候我们只想进入一个特定目录做操作后，不再访问同级目录：

@Override
public FileVisitResult preVisitDirectory(Path dir, BasicFileAttributes attrs) {
    if (dir.getFileName().toString().equals("target")) {
        // 👇 不进入该目录，也不访问其他同级目录
        return SKIP_SIBLINGS;
    }
    return CONTINUE;
}

或在目录处理完成后决定不再访问兄弟节点：

@Override
public FileVisitResult postVisitDirectory(Path dir, IOException exc) {
    // 完成对某个目录的处理后终止兄弟目录遍历
    return SKIP_SIBLINGS;
}

💡 补充说明：

• SKIP_SIBLINGS 是较少使用但非常强力的控制方式
• 使用时要确保对逻辑影响有清晰的认识（比如提前终止同级处理）

---

🛠 小技巧：结合 walkFileTree 精准控制

EnumSet<FileVisitOption> opts = EnumSet.noneOf(FileVisitOption.class); // 不跟随符号链接
Files.walkFileTree(startingPath, opts, Integer.MAX_VALUE, new MyCustomVisitor());

你可以结合访问深度限制、是否跟随链接以及返回值控制整个遍历策略，实现精准而高效的文件系统操作。

---

🧠 总结回顾

控制目标	应用方法	返回值
跳过特定目录	在 preVisitDirectory() 中判断	SKIP_SUBTREE
跳过当前目录及兄弟目录	在 preVisitDirectory() 或 postVisitDirectory() 返回	SKIP_SIBLINGS
完全中止遍历	在任意方法中	TERMINATE
默认继续	所有未触发控制逻辑时	CONTINUE