内容


NIO.2 入门,第 2 部分

文件系统 API

探索可实现访问、查看文件与目录、以及获取文件与目录属性的新 API

Comments

系列内容:

此内容是该系列 # 部分中的第 # 部分: NIO.2 入门,第 2 部分

敬请期待该系列的后续内容。

此内容是该系列的一部分:NIO.2 入门,第 2 部分

敬请期待该系列的后续内容。

本文是介绍 Java 7 中的 More New I/O APIs for Java (NIO.2) 的两部分文章的第二部分。 正如在 第一部分 中探索的异通道 API 一样, NIO.2 的文件系统用以前 Java 版本处理 I/O 的相关方法,填补了一些重大的空白。 依照 NIO.2 Java 规范要求(JSR 203):

Java 平台早就需要一个文件系统接口而不是 java.io.File 类。 该类不会在平台中以一贯的方式来处理文件名,它不支持高效文件属性访问,不允许复杂应用程序利用可用的文件系统特定特性(比如,符号链接), 而且,其大多数方法在出错时仅返回失败,而不会提供异常信息。

补救措施是 Java 7 试用版中的三个新的文件系统包:

  • java.nio.file
  • java.nio.file.attribute
  • java.nio.file.spi

本文重点关注这些包中最有用的类:

  • java.nio.file.Filesjava.nio.file.FileVisitor 使得您可以在文件系统中漫步,在特定目录深度查询文件或者目录,并可对每个查询结果执行用户实现的回调方法。
  • java.nio.file.Pathjava.nio.file.WatchService 允许 “ 注册 ” 来监视特定目录。如果在目录中发生了文件创建、修改或者删除操作,监视目录的应用程序将收到通知。
  • java.nio.attribute.*AttributeView 允许查看此前对于 Java 用户隐藏的文件和目录属性。这些属性包括文件所有者及组权限,访问控制列表(ACL),以及扩展文件属性。

本文将提供如何使用这些类的相关例子。 这些例子都处于可运行状态(见 下载),您可在 Oracle 以及 IBM®(在本文写作期间,都还处于开发阶段;见 参见资料) 所提供的 Java 7 版中运行这些例子。

文件访问类

我们的第一个例子演示了新的 FileVisitor API。

设想一个场景,您想要递归地访问一个目录树,在该树中的每个文件及目录上停下来,并为每个查找到的条目调用您自己的回调方法。在以前的 Java 版本中,这可能是个很痛苦的过程,包括递归列出目录、检查其条目、并自己调用回调。在 Java 7 中,这些都在 FileVisitor 中有提供,使用起来非常简单。

第一步是实现您自己的 FileVisitor 类。这个类包含 file-visitor 引擎穿越文件系统时所调用的回调方法。FileVisitor 接口由 5 个方法组成,在此处以遍历其间被调用的典型顺序来列出(T 在此处代表 java.nio.file.Path 或者超类):

  • 在访问目录中的条目之前调用 FileVisitResult preVisitDirectory(T dir)。它返回一个 FileVisitResult 枚举值,来告诉文件访问程序 API 下一步做什么。
  • 当目录由于某些原因无法访问时,调用 FileVisitResult preVisitDirectoryFailed(T dir, IOException exception)。在第二个参数中指出了导致访问失败的异常。
  • 在当前目录中有文件被访问时,调用 FileVisitResult visitFile(T file, BasicFileAttributes attribs)。该文件的属性传递给第二个参数。(可在本文 文件属性 部分更深入了解文件属性。)
  • 当访问文件失败时,调用 FileVisitResult visitFileFailed(T file, IOException exception)。第二个参数指明导致访问失败的异常。
  • 完成对目录及其子目录的访问后,调用 FileVisitResult postVisitDirectory(T dir, IOException exception)。当目录访问成功时,异常参数为空,或者包含导致目录访问过早结束的异常。

为了节约开发人员的时间, NIO.2 提供了 FileVisitor 的实现接口:java.nio.file.SimpleFileVisitor。该类以基础方式获取:对于 *Failed() 方法,它只是重新引发该异常,并且对于其他方法,它会继续下去而根本不做任何事!它的作用在于,您可以使用匿名类来替代您所希望替代的方法;剩下的方法会按默认方式实现。

清单 1 展示如何创建一个 FileVisitor 实例的例子:

清单 1. FileVisitor 实现
FileVisitor<Path> myFileVisitor = new SimpleFileVisitor<Path>() { 

    @Override
    public FileVisitResult preVisitDirectory(Path dir) { 
       System.out.println("I'm about to visit the "+dir+" directory"); 
       return FileVisitResult.CONTINUE;
    }
  
    @Override 
    public FileVisitResult visitFile(Path file, BasicFileAttributes attribs) {

       System.out.println("I'm visiting file "+file+" which has size " +attribs.size());
       return FileVisitResult.CONTINUE;
    }

};

清单 1FileVisitor 的实现,应当为其访问的每个目录和文件打印消息,并给出从其 BasicFileAttributes 中获取的文件大小。

接下来,我们想创建开始我们文件访问的 Path。利用类 java.nio.Paths 完成这一操作:

Path headDir = Paths.get("headDir");

我们可以利用两个方法中的任何一个在 类上启动树遍历:

  • public static void walkFileTree(Path head, FileVisitor<? super Path> fileVisitor) 浏览头目录下的文件树,在这一过程中调用在 fileVisitor 中实现的回调方法。
  • public static void walkFileTree(Path head, Set<FileVisitOption> options, int depth, FileVisitor<? super Path> fileVisitor) 与前面的方法相似,但是它给出两个附加的参数来指定访问选项,以及遍历将访问文件树中的多少个目录。

我们将使用 walkFileTree() 方法的简单版本,来开始浏览文件数的流程:

Files.walkFileTree(headDir, myFileVisitor);

假设目录结构是这样的:

 headDir
  |--- myFile1
  |--- mySubDirectory1
  |     \myFile2
  \--- mySubDirectory2
        |--- myFile3
        \--- mySubdirectory3
              \---myFile4

清单 2 展示了这一例子的输出:

清单 2. FileVisitor 输出
I'm about to visit the headDir directory
I'm about to visit the headDir\mySubDirectory2 directory
I'm about to visit the headDir\mySubDirectory2\mySubDirectory3 directory
I'm visiting file headDir\mySubDirectory2\mySubDirectory3\myFile4 which has size 2
I'm visiting file headDir\mySubDirectory2\myFile3 which has size 2
I'm about to visit the headDir\mySubDirectory1 directory
I'm visiting file headDir\mySubDirectory1\myFile2 which has size 2
I'm visiting file headDir\myFile1 which has size 2

正如您所见到的,该文件是深度优先遍历,但不一定在任何目录内按字母顺序来进行。回调方法如期望那样被调用,我们可以看到,树中的所有文件都已列出,并且所有目录均已被访问。

仅利用 15 行内容,我们就创建了文件访问程序,来浏览任何您所给出的文件树,并检查包含在其中的文件。这个例子很基础,但是回调可按需地进行更加复杂的实现。

目录监视

第二个例子展示了新 WatchService API 及其相关类的精彩世界。

这一例子的场景很简单:您想要追踪特定目录(或多个目录)中是否有文件或者目录正被创建、修改、或者删除。您可能要利用这一信息来更新 GUI 显示中列示的文件,或者想检查对将要重新加载的配置文件的修改。在以前的 Java 版本中,必须实现一个代理,该代理运行在单独的线程中,来保持对目录所有内容的追踪,不断轮询文件系统来查看是否有相关的情况发生。在 Java 7 中,WatchService API 提供了查看目录的能力。这就免除了自己编写文件系统轮询程序的所有麻烦,并且,如果可能的话,它可基于本地系统 API 来获取更优的性能。

第一步是通过 java.nio.file.FileSystems 类创建 WatchService 实例。本文不涉及文件系统的细节,因此在大多数情况下,您 会希望得到默认的文件系统,然后调用其 newWatchService() 方法:

WatchService watchService = FileSystems.getDefault().newWatchService();

现在我们有了自己的监视服务实例,我们想要注册到一个路径来进行监视。因为我们想要以与文件访问程序示例完全不同的方式,来为监视的目录创建一个 Path 对象,所以,我们可以在此使用其 File 实例:

File watchDirFile = new File("watchDir");
Path watchDirPath = watchDirFile.toPath();

Path 类实现 java.nio.file.Watchable 接口,并且该接口定义我们将在这里例子中使用的 register() 方法。WatchKey register(WatchService watchService, WatchEvent.Kind<?>... events) 通过为所给特定事件所指定的 watchService 来注册这一方法所要调用的 Path。仅当在注册调用中指定了事件时,事件才会触发一个通知。

对于默认的 WatchService 实现,java.nio.file.StandardWatchEventKind 类定义三个 java.nio.file.StandardWatchEventKind 的静态实现,这些可用于 register() 调用:

  • StandardWatchEventKind.ENTRY_CREATE 指出在所注册的 Path 中创建了文件或者目录。当文件重命名或者移入这一目录时,还触发了 ENTRY_CREATE 事件。
  • StandardWatchEventKind.ENTRY_MODIFY 指出在所注册的 Path 中文件或者目录被修改。究竟是哪些事件组成了修改,在一定程度上是平台特定的,但是在这里只想说,其实对文件内容的修改总会触发一个修改事件。在一些平台中,变更文件的属性也会触发这一事件。
  • StandardWatchEventKind.ENTRY_DELETE 指出在所注册的 Path 中删除了文件或者目录。当对文件重命名或者将文件移出目录时,也会触发 ENTRY_DELETE 事件。

对于我们的例子,让我们监视 ENTRY_CREATEENTRY_MODIFY 事件,而不是 ENTRY_DELETE

WatchKey watchKey = watchDirPath.register(watchService, 
       StandardWatchEventKind.ENTRY_CREATE, StandardWatchEventKind.ENTRY_MODIFY);

Path 现在注册为被监视,并且 WatchService 将总会一直在后台安静地工作,专心地监视目录。利用前面所展示的相同 Path 创建和 register() 调用,同一个 WatchService 实例能够监视多个目录。

您可能已经发现 register() 方法调用返回了我们以前从未遇到过的类:WatchKey。该类代表注册到 WatchService。是否挂接到这个引用由您决定,因为触发事件后,WatchService 会返回相关的 WatchKey。然而,要注意不存在方法调用用来找出 WatchKey 注册到哪个 目录,因此如果正在监视多个目录,您可能想要追踪哪个 WatchKey 与哪个 Path 相关。当您 在处理特定 WatchKey 及其所注册的事件时,可以很简单地通过调用 cancel() 方法,来取消其在 WatchService 的注册。

现在已注册了 Path,我们可以用很方便的方式来检查 WatchService,看是否发生了任何我们感兴趣的事件。WatchService 提供三个方法来检查是否有任何令人激动的事发生。

  • 如果有相关事件出现,WatchKey poll() 会返回下一个 WatchKey,或者没有注册的事件发生,会返回 null
  • WatchKey poll(long timeout, TimeUnit unit) 需要超时和时间单元(java.util.concurrent.TimeUnit)。如果在特定时间范围内,有任何事件发生,这一方法存在,会返回相应的 WatchKey。如果在超时时间结束时,没有 WatchKeys 返回,这一方法将会返回 null
  • WatchKey take() 与前面的方法相似,不同之处是,它将无限期等待,直到可以返回 WatchKey

一旦这三个方法之一返回了 WatchKey,它将不会再被 poll() 或者 take() 调用返回,直到其 reset() 方法被调用。一旦 WatchService 返回了 WatchKey,就可以检查由于调用了 WatchKeypollEvents() 方法而触发的事件,其将返回一列 WatchEvent

为了便于说明,清单 3 中的简单示例仍然是来自我们前面注册的 WatchKey

清单 3. 使用 pollEvents()
// Create a file inside our watched directory
File tempFile = new File(watchDirFile, "tempFile");
tempFile.createNewFile();

// Now call take() and see if the event has been registered
WatchKey watchKey = watchService.take();
for (WatchEvent<?> event : watchKey.pollEvents()) {
   System.out.println(
   "An event was found after file creation of kind " + event.kind() 
   + ". The event occurred on file " + event.context() + ".");
}

当执行完成后,清单 3 中的代码打印为:

An event was found after file creation of kind ENTRY_CREATE. The event occurred 
 on file tempFile.
An event was found after file creation of kind ENTRY_MODIFY. The event occurred 
 on file tempFile.

正如您所见到的,我们得到了期望的、新创建的 tempFileENTRY_CREATE 事件,但我们还得到了其他事件。在一些操作系统中,文件的创建或删除也会产生修改事件,那么不管是什么 OS ,我们只会得到 ENTRY_CREATE 事件。

示例代码 下载 中包含扩展的示例代码(展示了在这部分的例子中,为注册的 WatchKey 进行的文件修改与删除)。

文件属性

第三个并且是最后一个例子涉及了利用 java.nio.file.attribute 包中的类获取并设置文件属性的新的 API。

新的 API 能够提供对各种文件属性的访问。在以前的 Java 版本中,仅能得到基本的文件属性集(大小、修改时间、文件是否隐藏、以及它是文件还是目录)。为了获取或者修改更多的文件属性,必须利用运行所在平台特定的本地代码来实现,这很困难。很幸运的是,Java 7 能够允许您通过很简单的方式,利用 java.nio.file.attribute 类来读取,如果可能,修改扩展的属性集,完全去掉了这些操作的平台特定属性。

在新的 API 中有七个属性视图,其中一些特定于操作系统。这些 “ 视图 ” 类允许您获取并设置任何关联的属性,并且其中每个都具有对应的包含真实属性信息的属性类。让我们依次来看一下。

AclFileAttributeViewAclEntry

AclFileAttributeView 允许您为特定文件设置 ACL 及文件所有者属性。其 getAcl() 方法返回一个 List of AclEntry 对象,每个对应文件的一个权限集。其 setAcl(List<AclEntry>) 方法允许您修改该访问列表。这些属性视图仅可用于 Microsoft® Windows® 系统。

BasicFileAttributeViewBasicFileAttributes

这一视图类允许您获取一系列 —— 平常的 —— 基本文件属性,构建于以前的 Java 版本之上。其 readAttributes() 方法返回一个 BasicFileAttributes 实例,该实例包含最后修改时间、最后访问时间、创建时间、大小、以及文件属性等细节(常规文件、目录、符号链接、或者其他)。这一属性视图在所有平台上均可用。

我们来看一下这一视图的相关例子。为获取特定文件的文件属性视图,我们通常从为我们所感兴趣的文件创建 Path 对象开始:

 File attribFile = new File("attribFile");
 Path attribPath = attribFile.toPath();

为获取想要的文件属性视图,我们在 Path 上使用 getFileAttributeView(Class viewClass) 方法。为获取 BasicFileAttributeView for attribPath,我们简单地调用:

BasicFileAttributeView basicView 
    = attribPath.getFileAttributeView(BasicFileAttributeView.class);

正如前面所描述的,为从 BasicFileAttributeView 获取 BasicFileAttributes,我们只要调用其 readAttributes() 方法:

BasicFileAttributes basicAttribs = basicView.readAttributes();

那么这样就可以了,现在已经得到了您所想要的任何基本文件属性。对于 BasicFileAttributes,只有创建、最后修改、以及最后访问时间可被修改(因为改变文件大小或者类型没有意义)。为改变这些,我们可以使用 java.nio.file.attribute.FileTime 类来创建新的时间,然后在 BasicFileAttributeView 上调用 setTimes() 方法。例如,我们可以不断地更新文件的最后修改时间。

FileTime newModTime 
    = FileTime.fromMillis(basicAttribs.lastModifiedTime().toMillis() + 60000);
 basicView.setTimes(newModTime, null, null);

这两个 null 指出,我们不想改变这一文件的最后访问时间或者创建时间。如果以前面相同的方式再次检查基本属性,您会发现最后修改时间已被修改,但是创建时间和最后访问时间还保持原样。

DosFileAttributeViewDosFileAttributes

这一视图类允许您获取指定给 DOS 的属性。(您可能会猜想,这一视图仅用于 Windows 系统。)其 readAttributes() 方法返回一个 DosFileAttributes 实例,该实例包含有问题的文件是否为只读、隐藏、系统文件、以及存档文件等细节信息。这一视图还包含针对每个属性的 set*(boolean) 方法。

FileOwnerAttributeViewUserPrincipal

这一视图类允许您获取并设置特定文件的所有者。其 getOwner()方法返回一个 UserPrincipal(还处于 java.nio.file.attribute 包中),其又具有 getName() 方法,来返回包含所有者名字的 String。该视图还提供 setOwner(UserPrincipal) 方法用于变更文件所有者。该视图在所有平台上都可用。

FileStoreSpaceAttributeViewFileStoreSpaceAttributes

这一用很吸引人的方式命名的类,允许您获取有关特定文件存储的信息。其 readAttributes() 方法返回一个包含文件存储的整个空间、未分配空间、以及已使用空间细节的 FileStoreSpaceAttributes 实例。这一视图在所有平台上都可用。

PosixFileAttributeViewPosixFileAttributes

这一视图类,仅在 UNIX® 系统上可用,允许您获取并设置指定给 POSIX(Portable Operating System Interface)的属性。其 readAttributes() 方法返回一个包含有关这一文件的所有者、组所有者、以及这一文件许可(这些细节通常用 UNIX chmod 命令设置)的 PosixFileAttributes 实例。这一视图还提供 setOwner(UserPrincipal)setGroup(GroupPrincipal)、以及 setPermissions(Set<PosixFilePermission>) 来修改这些属性。

UserDefinedFileAttributeViewString

这一视图类,仅可用于 Windows,允许您获取并设置文件的扩展属性。 这些属性跟其他的不同,它们只是名称值对,并可按需对其进行设置。 如果想向文件增加一些隐藏的元数据,而不必修改文件内容,这就很有用了。 这一属性提供 list() 方法,来为相关的文件返回 List of String 扩展属性的名字。

有了其名字后,就要获取特定属性的内容,这一视图具有一个 size(String name) 方法来返回属性值的大小,以及一个 read(String name, ByteBuffer dest) 方法来将属性值读取到 ByteBuffer 中。这一视图还提供 write(String name, ByteBuffer source) 方法来创建或者修改属性,以及一个 delete(String name) 方法来完全移除现有的属性。

这可能是最有趣的新属性视图,因为它允许您利用任意 String 名字和 ByteBuffer 值向文件增加属性。这很对 —— 其值是个 ByteBuffer,因此您可以在这里存储任何二进制数据。

首先,我们将会获取属性视图:

UserDefinedFileAttributeView userView 
    = attribPath.getFileAttributeView(UserDefinedFileAttributeView.class);

为获取用户为这一文件定义的属性名,我们在视图上调用 list() 方法:

List<String> attribList = userView.list();

一旦我们拥有了想得到相关值的特定属性名,就为该值分配一个大小合适的 ByteBuffer,然后调用视图的 read(String, ByteBuffer) 方法:

ByteBuffer attribValue = ByteBuffer.allocate(userView.size(attribName));
userView.read(attribName, attribValue);

attribValue 现在包含了为那一特定属性所存储的任何数据。 想设置自己的属性,只需创建 ByteBuffer 并按需填入数据,然后在视图上调用 write(String, ByteBuffer) 方法:

userView.write(attribName, attribValue);

写入属性,或者创建该属性,或者利用相同的名字覆盖已有的属性。

这样,我们结束第三个而且是最后一个例子。演示这四个属性视图(BasicFileAttributeViewFileOwnerAttributeViewFileStoreSpaceAttributeView、以及 UserDefinedAttributeView)的完整示例代码包含在 下载 的示例代码中。

结束语

除了本文所提到的以外,还有很多其他的 NIO.2 文件 API。Java 7 具有创建、检查、并修改符号链接的新功能。还有新的类,来允许访问文件系统的低级信息,并支持提供者(称为 FileSystemFileStore)访问任何想要访问的文件系统。

总之,NIO.2 为 Java 开发人员提供了一系列简单、兼容、并且功能强大的 API,来与文件系统交互。其目的是抽取处理文件和目录时所涉及的复杂的、平台特定的细节,并能较好地为程序员提供更强大的功能和更多的灵活性。


下载资源


相关主题


评论

添加或订阅评论,请先登录注册

static.content.url=http://www.ibm.com/developerworks/js/artrating/
SITE_ID=10
Zone=Java technology
ArticleID=593995
ArticleTitle=NIO.2 入门,第 2 部分: 文件系统 API
publish-date=12062010