15.10.3 使用WatchService监控文件变化

在以前的Java版本中,如果程序需要监控文件的变化,则可以考虑启动一条后台线程,这条后线程每隔一段时间去“遍历”一次指定目录的文件,如果发现此次遍历结果与上次遍历结果不同,则认为文件发生了变化。但这种方式不仅十分烦琐,而且性能也不好。

Path类监听文件系统的方法

NIO.2的Path类提供了如下一个方法来监听文件系统的变化。

Path类的register方法	描述
default WatchKey register(WatchService watcher, WatchEvent.Kind<?>... events)	用watcher监听该path代表的目录下的文件变化。events参数指定要监听哪些类型的事件。
WatchKey register(WatchService watcher, WatchEvent.Kind<?>[] events, WatchEvent.Modifier... modifiers)	Registers the file located by this path with a watch service.

在这个方法中WatchService代表一个文件系统监听服务,它负责监听path代表的目录下的文件变化。

WatchService

一旦使用register方法完成注册之后,接下来就可调用WatchService的如下三个方法来获取被监听目录的文件变化事件

WatchService方法	描述
WatchKey poll()	获取下一个LatchKey,如果没有LatchKey发生就立即返回null
WatchKey poll(long timeout, TimeUnit unit)	尝试等待timeout时间去获取下一个LatchKey
WatchKey take()	获取下一个LatchKey,如果没有LatchKey发生就一直等待。

• 如果程序需要一直监控,则应该选择使用take()方法;
• 如果程序只需要监控指定时间,则可考虑使用poll()方法。

程序WatchService监控文件变化

下面程序示范了使用WatchService来监控D盘根路径下文件的变化

import java.nio.file.FileSystems;
import java.nio.file.Paths;
import java.nio.file.StandardWatchEventKinds;
import java.nio.file.WatchEvent;
import java.nio.file.WatchKey;
import java.nio.file.WatchService;

public class WatchServiceTest
{
    public static void main(String[] args)
        throws Exception
    {
        // 获取文件系统的WatchService对象
        WatchService watchService = FileSystems.getDefault()
            .newWatchService();
        // 为D:盘根路径注册监听
        Paths.get("D:/").register(watchService
            , StandardWatchEventKinds.ENTRY_CREATE
            , StandardWatchEventKinds.ENTRY_MODIFY
            , StandardWatchEventKinds.ENTRY_DELETE);
        while(true)
        {
            // 获取下一个文件改动事件
            WatchKey key = watchService.take();    //①
            for (WatchEvent<?> event : key.pollEvents())
            {
                System.out.println(event.context() +" 文件发生了 "
                    + event.kind()+ "事件！");
            }
            // 重设WatchKey
            boolean valid = key.reset();
            // 如果重设失败，退出监听
            if (!valid)
            {
                break;
            }
        }
    }
}

上面程序使用了一个死循环重复获取D盘根路径下文件的变化,程序在①号代码处试图获取下一个LatchKey,如果没有发生就等待。因此D盘根路径下每次文件的变化都会被该程序监听到。
运行该程序,然后在D:盘下新建一个文件,再删除该文件,将看到如下的输出。

新建文本文档.txt 文件发生了 ENTRY_CREATE事件！
新建文本文档.txt 文件发生了 ENTRY_DELETE事件！
test.txt 文件发生了 ENTRY_CREATE事件！
test.txt 文件发生了 ENTRY_DELETE事件！

通过使用WatchService可以非常优雅地监控指定目录下文件的变化,至于文件发生变化后,程序应该进行哪些处理,这就取决于程序的业务需要了