【Java NIO 简例】Files

原文：《Java NIO Files》

Java NIO 的 Files 类（java.nio.file.Files）提供了多个方法用于操纵文件系统中的文件。此教程包含这些方法中最常用的几个。Files类包含了许多方法，如果你需要的方法未包含在此教程中，可以去查看JavaDoc。

java.nio.file.Files 类与 java.nio.file.Path 类协同工作，所以在使用 Files 类前，你需要了解 Path 类。

 

Files.exists()

此方法用于检查给定的 Path 实例对应的路径是否存在。

我们可以创建一个对应路径不存在的Path实例。如，假设你要创建一个新目录，你可以先创建一个相应的 Path实例，然后再创建该目录。

例：

Path path = Paths.get("C:\\test\\file1.txt");
boolean pathExists = Files.exists(path);

 

Files.createDirectory()

该方法用于创建一个目录。例：

Path path = Paths.get("C:\\test\\dir1")
try {
  Path newDir = Files.createDirectory(path);
} catch (Exception e) {
  ...
}

注意：该方法只会创建目标路径的最后一层目录。如果路径中有部分“父目录”不存在，会抛异常。所以 Files.createDirectories() 方法可能更常用。

 

Files.copy()

该方法用于拷贝文件。例：

Path srcPath = Paths.get("C:\\test\\file1.txt");
Path dstPath = Paths.get("C:\\new\\newFile1.txt");

try {
  Files.copy(srcPath, dstPath);
} catch (Exception e) {
  ...
}

如果目标路径文件已存在，将抛出 FileAlreadyExistsException。
可以指定参数以强制覆盖已有文件。例：

Files.copy(srcPath, dstPath, StandardCopyOption.REPLACE_EXISTING);

 

Files.move()

该方法用于将文件移动到另一个路径。
在文件系统中，“移动（move）”文件 几乎等同于 “重命名（rename）”文件。
虽然通常“重命名”只表示更改文件的名称，而“移动”则可以将文件移到另一个目录中。
另，java.io.File类的实例方法 renameTo() 与此方法效果相同，既能重命名，又能移到其它目录。

例：

Path srcPath = Paths.get("C:\\test\\file1.txt");
Path dstPath = Paths.get("C:\\new\\newFile1.txt");

try {
  Files.move(srcPath, dstPath);
} catch (Exception e) {
  ...
}

 

与 copy() 方法一样，如果目标路径方法已存在，会抛出 FileAlreadyExistsException. 可以指定参数以强制覆盖原文件：

Files.move(srcPath, dstPath, StandardCopyOption.REPLACE_EXISTING);

 

Files.delete()

该方法用于删除目标路径（文件或目录）。例：

Path path = Paths.get("C:\\test\file1.txt");
try {
  Files.delete(path);
} catch (Exception e) {
  ...
}

 

Files.walkFileTree()

该方法用于递归地遍历一个目录树。

通常，我们可以，指定一个 Path实例作为遍历的起始位置，指定一个 FileVisitor实例用于操作遍历到了文件与目录。
如果Path路径指向一个文件，则只会访问这个文件，然后退出。因为文件没有子目录。

FileVisitor 的实现与具体业务相关，需要调用者自己实现。

public interface FileVisitor<T> {
  FileVisitResult preVisitDirectory(T dir, BasicFileAttributes attrs) throws IOException;
  FileVisitResult visitFile(T file, BasicFileAttributes attrs) throws IOException;
  FileVisitResult visitFileFailed(T file, IOException exc) throws IOException;
  FileVisitResult postVisitDirectory(T dir, IOException exc) throws IOException;
}

FileVisitor 中各方法的调用时机正如方法名称所表示。

如果你不想实现所有4个方法，可以继承自 SimpleFileVisitor 类，并 override 需要自定义的方法。

FileVisitResult 枚举类包含4个枚举项：

• CONTINUE：继续正常遍历
• TERMINATE：终止遍历
• SKIP_SIBLINGS：跳过当前目录的子目录，并继续遍历
• SKIP_SUBTREE：跳过当前目录。该枚举项只有作为 preVisitDirectory() 方法的返回值时才有效（或者说有意义）。因为其它方法被调用时都已经在遍历当前目录的内容了，当然不可能跳过。

例：

Files.walkFileTree(path, new FileVisitor() {
  @Override
  public FileVisitResult preVisitDirectory(Path dir, BasicFileAttributes attrs) throws IOException {
    System.out.println("pre visit dir: " + dir);
    return FileVisitResult.CONTINUE;
  }

  @Override
  public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException {
    System.out.println("visit file: " + file);
    return FileVisitResult.CONTINUE;
  }

  @Override
  public FileVisitResult visitFileFailed(Path file, IOException exc) throws IOException {
    System.out.println("visit file failed: " + file);
    return FileVisitResult.CONTINUE;
  }

  @Override
  public FileVisitResult postVisitDirectory(Path dir, IOException exc) throws IOException {
    System.out.println("post visit directory: " + dir);
    return FileVisitResult.CONTINUE;
  }
});

 

示例：搜索文件

此示例中，FileVisitor 继承自 SimpleFileVisitor，用于查找名称为 README.txt 的文件：

Path rootPath = Paths.get("C:\\test");
String fileToFind = File.separator + "README.txt";
try {
  Files.walkFileTree(rootPath, new SimpleFileVisitor() {
    @Override
    public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException {
      String fileString = file.toAbsolutePath().toString();

      if (fileString.endsWith(fileToFind)) {
        System.out.println("file found at path: " + fileString);
        return FileVisitResult.TERMINATE;
      }

      return FileVisitResult.CONTINUE;
    }
  });
} catch (IOException e) {
  ...
}

 

示例：递归地删除目录

Files.delete() 方法可用于删除一个空的目录。如果目录不为空（有文件或子目录），Files.delete() 将抛出异常 DirectoryNotEmptyException。

Files.walkFileTree()方法可以递归的方式删除这类非空目录。例：

Path rootPath = Paths.get("C:\\test");
try {
  Files.walkFileTree(rootPath, new SimpleFileVisitor() {
    @Override
    public FileVisitResult visitFile(Path file, BasicFileAttributes atrrs) throws IOException {
      System.out.println("delete file: " + file);
      File.delete(file);
      return FileVisitResult.CONTINUE;
    }

    @Override
    public FileVisitResult postVisitDirectory(Path dir, IOException exc) throws IOException {
      Files.delete(dir);
      System.out.println("delete dir: " + dir);
      return FileVisitResult.CONTINUE;
    }
  });
} catch(IOException e) {
  ...
}