Files

作者: JiinYuu | 来源:发表于2019-01-04 12:47 被阅读0次

Java NIO的Filesjava.nio.file.Files)类提供一些操作文件系统的文件的方法。本篇教程会包含这些方法的大部分通用用法。Files类有很多方法,如果本教程里面没有你想要的,你也可以查看其JavaDoc。Files类可能有你想要的方法。

java.nio.file.Files类是和java.nio.file.Path一起使用的,所以在你使用Files之前,你需要先理解Path这个类。

Files.exists()

Files.exists()方法用来检查给定的Path是否存在于文件系统中。

创建一个在文件系统中并不存在的Path是可能的。比如,你计划创建一个新的目录,你需要先创建对应的Path实例,然后创建目录。

由于Path实例可能指向在文件系统存在或不存在的路径,你可以使用Files.exists()方法来确定这一点(当你需要确定的时候)。

下面是一个Files.exists()的例子:

Path path = Paths.get("data/logging.properties");
boolean pathExists = Files.exists(path, new Linkoption[] { LinkOption.NOFOLLOW_LINKS });

本例首先创建了一个指向我们想检查其是否存在的路径的Path实例。然后,例子调用了Files.exists()方法,并将这个Path实例作为其第一个参数。

注意Files.exists()方法的第二个参数。这个参数是一个影响Files.exists()如何确定路径是否存在的选项数组。上面的例子中,这个数组包含了LinkOption.NOFOLLOW_LINKS,意味着Files.exists()方法不应跟随文件系统的符号引用来确定路径是否存在。

Files.createDirectory()

Files.createDirectory()方法通过一个Path实例来创建一个新的目录。这有个例子:

Path path = Paths.get("data/suddir");
try {
    Path newDir = Files.createDirectory(path);
} catch (FileAlreadyExistsException e) {
    // 目录已经存在
} catch (IOException e) {
    // 发生了其他错误
    e.printStackTrace();
}

第一行创建了代表要创建的目录的Path实例。在try-catch块里用这个Path实例作为参数调用了Files.createDirectory()方法。如果创建成功,会返回一个指向新创建的路径的Path实例。

如果这个目录已经存在了,会抛出一个java.nio.file.FileAlreadyExistsException。如果发生其他错误,则会抛出IOException。比如,如果父目录不存在,就会抛出一个IOException。父目录就是你想在那个目录里创建新的目录。所以,它被称为新目录的父目录。

Files.copy()

Files.copy()方法将文件从一个路径拷贝到另一个路径。这有个例子:

Path sourcePath = Paths.get("data/logging.properties");
Path destinationPath = Paths.get("data/logging-copy.properties");
try {
    Files.copy(sourcePath, destinationPath);
} catch (FileAlreadyExistsException e) {
    // 目标文件已经存在
} catch (IOException e) {
    // 发生了其他错误
    e.printStackTrace();
}

本例首先创建了一个源和一个目标Path实例。然后用这两个Path实例作为参数,调用了Files.copy()方法。这将导致源路径引用的文件被复制到目标路径引用的文件。

如果目标文件已经存在,会抛出一个java.nio.file.FileAlreadyExistsException。如果发生其他错误,则会抛出IOException。比如,要拷贝文件的目录不存在,就会抛出IOException

Overwriting Existing Files

强制Files.copy()方法覆盖已存在文件是可行的。下面是个例子:

Path sourcePath = Paths.get("data/logging.properties");
Path destinationPath = Paths.get("data/logging-copy.properties");
try {
    Files.copy(sourcePath, destinationPath, StandardCopyOption.REPLACE_EXISTING);
} catch (FileAlreadyExistsException e) {
    // 目标文件已经存在
} catch (IOException e) {
    // 发生了其他错误
    e.printStackTrace();
}

注意Files.copy()的第三个参数。这个参数命令copy()方法在目标文件已经存在的情况将其覆盖。

Files.move()

Java NIO的Files类还包含将文件从一个路径移动到另一个路径的函数。移动文件和文件重命名是一样的,只不过移动文件除了可以将文件移动到不同的目录,同时还可以修改其名称。是的,通过java.io.File类的renameTo()方法也可以做到这点,但现在你在java.nio.file.Files类中也拥有了移动文件的功能。

下面是个例子:

Path sourcePath = Paths.get("data/logging-copy.properties");
Path destinationPath = Paths.get("data/logging-moved.properties");
try {
    Files.move(sourcePath, destinationPath, StandardCopyOption.REPLACE_EXISTING);
} catch (IOException e) {
    // 移动文件失败
    e.printStackTrace();
}

首先,创建源路径和目标路径实例。原路径指向要移动的文件,目标路径指向该文件要移动到的目的地。然后调用Files.move()方法,这会导致文件的移动。

注意传给Files.move()方法的第三个参数。这个参数告诉Files.move()去覆盖目标路径上任何已存在文件。这个参数事实上是可选的。

如果文件移动失败,Files.move()方法会抛出一个IOException。比如,目标路径上已经存在了一个文件,但你又没有设置StandardCopyOption.REPLACE_EXISTING选项,或者你要移动的文件并不存在等。

Files.delete()

Files.delete()方法可以删除一个文件或目录。下面是个例子:

Path path = Paths.get("data/subdir/logging-moved.properties");
try {
    Files.delete(path);
} catch (IOException e) {
    // 删除失败
    e.printStackTrace();
}

首先,创建指向要删除的文件的Path实例。然后调用Files.delete()方法。如果Files.delete()方法由于某种原因(比如文件或目录不存在)未能删除文件,就会抛出一个IOException

Files.walkFileTree()

Files.walkFileTree()方法具有递归遍历目录树的功能。walkFileTree()方法接收一个Path实例和一个FileVisitor实例作为参数。Path实例指向你想要遍历的目录。FileVisitor会在遍历时被调用。

在解释如何遍历之前,先看看FileVisitor接口:

public interface FileVisitor {

    public FileVisitResult preVisitDirectory(Path dir, BasicFileAttributes attrs) throws IOException;

    public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException;

    public FileVisitResult visitFileFailed(Path file, IOException exc) throws IOException;

    public FileVisitResult postVisitDirectory(Path dir, IOException exc) throws IOException {

}

你必须自己实现FileVisitor接口,并将你的实现的实例传给walkFileTree()方法作为参数。你的FileVisitor实现类中的每个方法都会在遍历目录的不同时刻被调用。如果你不想实现所有的方法,你可以继承SimpleFileVisitor类,其中包含了对FileVisitor接口的所有方法的默认实现。

下面是关于walkFileTree()方法的一个例子:

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实现里的每个方法会在遍历期间的不同时刻被调用:

preVisitDirectory()会在访问任何目录之前被调用。postVisitDirectory()方法会在一个目录访问结束后被调用。

visitFile()方法会在访问每个文件的时候被调用。访问目录的时候并不会调用它 - 只有访问文件时才会。visitFileFailed()方法会在访问文件失败的时候被调用。比如,你没有权限访问这个文件,或者其他什么错误。

这四个方法都会返回一个FileVisitResult枚举类型的实例。FileVisitResult枚举包含以下四个选项:

  • CONTINUE
  • TERMINATE
  • SIKP_SIBLINGS
  • SIKP_SUBTREE

通过返回其中之一来告诉文件遍历器下一步应该怎么做。

CONTINUE意味着文件遍历应该像往常一样继续。

TERMINATE意味着文件遍历应该立即停止。

SIKP_SIBLINGS意味着文件遍历应该继续,但不要再遍历当前文件或目录的兄弟文件或目录了。

SIKP_SUBTREE意味着文件遍历应该继续,但不要再遍历当前目录下的任何文件或子目录了。该值只有作为preVisitDirectory()方法的返回值才有作用。如果其他方法返回该值,会被当作CONTINUE处理。

Searching For Files

下面是一个继承至SimpleFileVisitor的例子,目的是查找名为README.txt的文件:

Path rootPath = Paths.get("data");
String fileToFind = File.separator + "README.txt";

try {
    Files.walkFileTree(rootPath, new SimpleFileVisitor<Path>() {
    
        @Override
        public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException {
            String fileString = file.toAbsolutePath().toString();
            // System.out.println("pathString = " + fileString);

            if (fileString.endsWith(fileToFind)) {
                System.out.println("file found at path: " + file.toAbsolutePath());
                return FileVisitResult.TERMINATE;
            }
            return FileVisitResult.CONTINUE;
         }
    });
} catch(IOException e) {
    e.printStackTrace();
}

Deleting Directories Recursively

Files.walkFileTree()同样可以用来删除目录及其中的文件和子目录。Files.delete()方法只能删除空的目录。通过遍历所有目录并删除每个目录中的所有文件(在visitFile()中),然后删除目录本身(在postVisitDirectory()中),你可以目录及其中的所有文件和子目录。这有个递归删除目录的例子:

Path rootPath = Paths.get("data/to-delete");

try {
    Files.walkFileTree(rootPath, new SimpleFileVisitor<Path>() {
        @Override
        public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException {
            System.out.println("delete file: " + file.toString());
            Files.delete(file);
            return FileVisitResult.CONTINUE;
        }

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

Additional Methods in the Files Class

java.nio.file.Files还有很多其他有用的函数,比如创建符号链接、确定文件大小、设置文件权限等。关于这些方法的更多细节信息,请查看java.nio.file.Files类的JavaDoc。

发现貌似有人在看这个系列文章了,有必要说明下,这个Java NIO系列来源于jenkov.com,本文只是翻译,希望大家千万不要误会,本文不是原创。原文地址:Java NIO

相关文章

网友评论

      本文标题:Files

      本文链接:https://www.haomeiwen.com/subject/zzczlqtx.html