Java 7:WatchService

在Java 7的所有新功能中,更有趣的是WatchService,它增加了监视目录更改的功能。 WatchService直接映射到本机文件事件通知机制(如果有)。

如果本机事件通知机制不可用,则默认实现将使用轮询。 结果,响应性,事件的顺序和可用细节是特定于实现的。 (注意:有一篇有关使用Guava EventBus处理WatchService事件的文章

观看目录

Path接口实现了将WatchService对象和WatchEvent.Kind类型的varargs作为参数的register方法。 有4个事件需要注意:

  1. ENTRY_CREATE
  2. ENTRY_DELETE
  3. ENTRY_MODIFY
  4. 溢出

前三种是不言自明的,而OVERFLOW则表示事件可能丢失或丢弃。 通过调用FileSystem.newWatchService()创建WatchService。 观看目录是通过在WatchService中注册Path对象来完成的:

import static java.nio.file.StandardWatchEventKinds.*;
Path path = Paths.get("/home");
WatchService watchService = FileSystems.getDefault().newWatchService();
WatchKey watchKey = path.register(watchService,ENTRY_CREATE,ENTRY_DELETE,ENTRY_MODIFY);

从示例中可以看到,register方法返回一个WatchKey对象。 WatchKey是表示在WatchService中注册路径的令牌。

WatchKey

作为注册过程的结果,WatchKey处于“就绪”状态,并被视为有效。 WatchKey保持有效,直到发生以下情况之一:

  1. WatchKey.cancel()被调用。
  2. 正在监视的目录不再可用。
  3. WatchService对象已关闭。

检查变更

当检测到更改时,WatchKey状态将设置为“已信号发送”,并将其放入队列中进行处理。 使WatchKeys脱离队列涉及调用WatchService.poll()或WatchService.take()。 这是一个基本示例:

private boolean notDone = true;
while(notDone){
    try{
         WatchKey watchKey = watchService.poll(60,TimeUnit.SECONDS);
         List<WatchEvent.Kind<?>> events = watchKey.pollEvents();
         for(WatchEvent event : events){
            ...process the events
         }
         if(!watchKey.reset()){
            ...handle situation no longer valid
         }
     }catch(InterruptedException e){
            Thread.currentThread().interrupt();
     }

在第5行上,我们调用pollEvents方法来检索此WatchKey对象的所有事件。 在第9行,您会注意到对reset方法的调用。 reset方法将WatchKey状态重新设置为“就绪”,并返回一个布尔值,指示WatchKey是否仍然有效。 如果有任何未决事件,则WatchKey将立即重新排队,否则它将保持就绪状态,直到检测到新事件。 在已取消或处于就绪状态的WatchKey上调用reset无效。 如果WatchKey在排队时被取消,它将在队列中扩大直到被取回。 如果目录已删除或不再可用,取消也会自动发生。

处理事件

现在我们已经检测到一个事件,我们如何确定:

  1. 事件发生在哪个目录? (假设注册了多个目录)
  2. 实际事件是什么? (假设收听多个事件)
  3. 事件的目标是什么,即创建,删除或更新了哪个Path对象?

跳到上一个示例的第6行,我们将从WatchKey和WatchEvent中解析所需的信息:

//WatchKey watchable returns the calling Path object of Path.register
 Path watchedPath = (Path) watchKey.watchable();
 //returns the event type
 StandardWatchEventKinds eventKind = event.kind();
 //returns the context of the event
 Path target = (Path)event.context();

在第6行,我们看到了WatchEvent.context方法被调用。 如果事件是创建,删除或更新,并且该事件相对于监视目录,则context方法将返回Path对象。 重要的是要知道,当收到事件时,不能保证执行该操作的程序已经完成,因此可能需要一定程度的协调。

结论

WatchService是Java 7中新的java.nio.file包的一个非常有趣的功能。也就是说,WatchService需要牢记两件事:

  1. WatchService不会为监视目录的子目录拾取事件。
  2. 我们仍然需要轮询WatchService的事件,而不是接收异步通知。

为了解决上述问题,有一篇后续文章,使用Guava EventBus处理WatchService事件 。 感谢您的宝贵时间,在下一篇文章中见。


资源资源

  1. java.nio.file软件包,其中包含此处讨论的WatchService,WatchKey和WatchEvent对象。
  2. 演示WatchService的单元测试

参考: Java 7的新增功能: JCG合作伙伴提供的 WatchService   比尔·贝杰克(Bill Bejeck)在“ 编码随机思想”博客上。


翻译自: https://www.javacodegeeks.com/2012/02/java-7-watchservice.html

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
### 回答1: 下面是 Java 代码示例,它使用 `WatchService` 监听文件夹: ``` import java.io.IOException; import java.nio.file.*; public class FileWatcher { public static void main(String[] args) { try { WatchService watcher = FileSystems.getDefault().newWatchService(); Path dir = Paths.get("/path/to/watch"); dir.register(watcher, StandardWatchEventKinds.ENTRY_CREATE, StandardWatchEventKinds.ENTRY_DELETE, StandardWatchEventKinds.ENTRY_MODIFY); System.out.println("Watch Service registered for dir: " + dir.getFileName()); while (true) { WatchKey key; try { key = watcher.take(); } catch (InterruptedException ex) { return; } for (WatchEvent<?> event : key.pollEvents()) { WatchEvent.Kind<?> kind = event.kind(); @SuppressWarnings("unchecked") WatchEvent<Path> ev = (WatchEvent<Path>) event; Path fileName = ev.context(); System.out.println(kind.name() + ": " + fileName); if (kind == StandardWatchEventKinds.ENTRY_MODIFY && fileName.toString().equals("DirectoryToWatch.java")) { System.out.println("My source file has changed!!!"); } } boolean valid = key.reset(); if (!valid) { break; } } } catch (IOException ex) { System.err.println(ex); } } } ``` 该代码创建了一个 `WatchService` 实例,并将目录 `/path/to/watch` 注册为监听的目录。它将监听文件夹内的文件创建、删除和修改事件。 这是一个死循环,监听服务会在目录上等待任何事件。如果事件发生,该代码将打印事件类型(例如 `ENTRY_CREATE`)和事件上下文(即文件名)。如果事件是文件修改事件,且文件名为 `DirectoryToWatch.java`,它将打印一条信息。 请注意,该代码仅提 ### 回答2: Java提供了WatchService类来监听文件夹中的文件变化。下面是一个使用WatchService监听文件夹的示例代码: ```java import java.nio.file.*; import java.nio.file.WatchEvent.Kind; import java.nio.file.attribute.BasicFileAttributes; public class WatchServiceDemo { public static void main(String[] args) throws Exception { // 创建WatchService对象 WatchService watchService = FileSystems.getDefault().newWatchService(); // 需要监听的文件夹路径 Path dir = Paths.get("/path/to/directory"); // 注册监听事件,这里我们监听文件的创建、修改和删除事件 dir.register(watchService, StandardWatchEventKinds.ENTRY_CREATE, StandardWatchEventKinds.ENTRY_MODIFY, StandardWatchEventKinds.ENTRY_DELETE); // 启动一个线程来处理文件变化事件 Thread thread = new Thread(() -> { try { while (true) { // 获取下一个文件变化事件 WatchKey key = watchService.take(); // 遍历文件变化事件 for (WatchEvent<?> event : key.pollEvents()) { // 获取事件类型 Kind<?> kind = event.kind(); // 获取事件发生的文件路径 Path file = (Path) event.context(); // 打印事件类型和文件路径 System.out.println(kind + ": " + file); } // 重置WatchKey,否则下一次将无法接收到文件变化事件 key.reset(); } } catch (Exception e) { e.printStackTrace(); } }); // 启动文件监听线程 thread.start(); // 等待线程结束 thread.join(); } } ``` 上述代码中,我们首先创建了一个WatchService对象。然后,通过调用register方法将需要监听的文件夹路径和要监听的事件类型注册到WatchService中。在我们的例子中,我们监听了文件的创建、修改和删除事件。 接下来,我们创建一个新的线程来处理文件变化事件。在这个线程中,我们通过调用take方法获取下一个文件变化事件的WatchKey对象。然后通过遍历WatchKey的pollEvents方法获取每个事件的类型和文件路径,并输出到控制台。最后,我们重置WatchKey,以便下一次接收文件变化事件。 最后,我们启动文件监听线程,并等待线程结束。 这样,就完成了使用WatchService类来监听文件夹的代码。当文件夹中的文件发生变化时,代码将会输出对应的事件类型和文件路径。 ### 回答3: 使用JavaWatchService类可以方便地在文件夹中进行文件和目录的监视。下面是一个简单的Java代码示例,演示如何使用WatchService来监听文件夹: ```java import java.io.IOException; import java.nio.file.*; public class FolderWatcher { public static void main(String[] args) { try { // 创建WatchService对象 WatchService watchService = FileSystems.getDefault().newWatchService(); // 注册要监听的文件夹 Path folderPath = Paths.get("/path/to/folder"); folderPath.register(watchService, StandardWatchEventKinds.ENTRY_CREATE, StandardWatchEventKinds.ENTRY_DELETE, StandardWatchEventKinds.ENTRY_MODIFY); System.out.println("开始监听文件夹:" + folderPath); // 监听文件夹中的事件 WatchKey key; while ((key = watchService.take()) != null) { for (WatchEvent<?> event : key.pollEvents()) { WatchEvent.Kind<?> kind = event.kind(); if (kind == StandardWatchEventKinds.OVERFLOW) { continue; } // 获取发生的事件和文件路径 WatchEvent<Path> watchEvent = (WatchEvent<Path>) event; Path fileName = watchEvent.context(); // 打印事件类型和文件路径 System.out.println(kind.name() + ": " + folderPath.resolve(fileName)); } // 重置WatchKey对象,以便继续监听 boolean valid = key.reset(); if (!valid) { break; } } } catch (IOException | InterruptedException e) { e.printStackTrace(); } } } ``` 在上面的代码中,首先创建了一个WatchService对象,然后指定要监听的文件夹,并将其注册到WatchService中。接着,使用while循环来监听文件夹中的事件。在循环中,使用take()方法从WatchService获取WatchKey对象,并通过pollEvents()方法获取WatchEvent对象列表。在列表中,可以获取到事件的类型和文件路径。最后,使用reset()方法重置WatchKey对象,以便继续监听。 需要注意的是,上述代码中需要替换"/path/to/folder"为实际要监听的文件夹路径。另外,监听到的文件和目录变化将会以事件的形式进行处理,可以根据需要进行相应的逻辑操作。 希望以上的回答对您有所帮助!
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值