Java DirectoryWalker 类详解

Java 中的 DirectoryWalker 类（通常指 Apache Commons IO 库中的实现）是一个用于递归遍历目录结构的工具类。它允许开发者通过继承并重写方法来自定义文件处理逻辑，同时支持文件过滤和异常处理。以下是对该类的详细解析：

1. 类概述

所属包 : org.apache.commons.io.directorywalker
作用: 递归遍历目录，处理文件和子目录，支持过滤、自定义操作和异常处理。
特点:
- 提供模板方法模式，通过重写方法自定义行为。
- 支持文件过滤器（IOFileFilter）。
- 可处理遍历过程中的异常（如访问权限问题）。

2. 核心方法

继承 DirectoryWalker 后，需重写以下方法：

handleFile(File file, int depth, List results) : 处理单个文件。
handleDirectory(File directory, int depth, List results) : 处理目录（进入时）。
handleDirectoryEnd(File directory, int depth, List results) : 处理目录（退出时）。
handleCancelled(File startDirectory, List results, CancelException cancel) : 当遍历被取消时调用。

3. 使用步骤

继承 DirectoryWalker 类。
重写处理方法 （如 handleFile）。
设置过滤器（可选）。
调用 walk() 方法启动遍历。

4. 示例代码

以下示例统计目录中 .txt 文件的数量：

java 复制代码

import org.apache.commons.io.DirectoryWalker;
import org.apache.commons.io.filefilter.IOFileFilter;
import org.apache.commons.io.filefilter.SuffixFileFilter;

import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;

public class TxtFileCounter extends DirectoryWalker<File> {

    // 定义过滤器：仅接受.txt文件和所有目录
    public TxtFileCounter() {
        super(new SuffixFileFilter(".txt"), DirectoryFileFilter.DIRECTORY, -1);
    }

    @Override
    protected void handleFile(File file, int depth, Collection<File> results) {
        results.add(file); // 收集符合条件的文件
    }

    public int countTxtFiles(File startDir) throws IOException {
        List<File> foundFiles = new ArrayList<>();
        walk(startDir, foundFiles);
        return foundFiles.size();
    }

    public static void main(String[] args) throws IOException {
        TxtFileCounter counter = new TxtFileCounter();
        int count = counter.countTxtFiles(new File("/path/to/directory"));
        System.out.println("Found " + count + " .txt files.");
    }
}

5. 过滤器配置

构造方法参数:

java 复制代码

   super(IOFileFilter fileFilter, IOFileFilter dirFilter, int depthLimit);

markdown 复制代码

-   `fileFilter`: 过滤文件的规则（如后缀名）。
-   `dirFilter`: 过滤目录的规则（通常允许所有目录）。
-   `depthLimit`: 遍历深度限制（-1 表示无限制）。

6. 注意事项

性能: 处理大量文件时需优化逻辑，避免内存溢出。
异常处理 : 重写 handleCancelled 处理中断，检查 IOException。
符号链接: 默认不处理符号链接，需额外逻辑避免循环。

依赖管理: 需添加 Apache Commons IO 依赖：

xml 复制代码

<!-- Maven -->
<dependency>
  <groupId>commons-io</groupId>
  <artifactId>commons-io</artifactId>
  <version>2.11.0</version>
</dependency>

7. 替代方案

Java NIO Files.walkFileTree:
- 更现代的实现，无需第三方库。
- 通过 SimpleFileVisitor 实现类似功能。
自定义递归遍历: 灵活性高，但需手动处理异常和过滤。

8. 适用场景

需要复杂过滤逻辑的目录遍历。
项目已使用 Apache Commons IO 库。
快速实现递归文件处理（如批量重命名、备份）。

通过 DirectoryWalker，开发者可以高效地处理目录遍历任务，同时保持代码的简洁性和可维护性。对于新项目，建议评估是否优先使用 Java NIO 的 Files.walkFileTree，但对于依赖 Commons IO 的项目，DirectoryWalker 仍是一个强大的工具。