我可以使用WatchService(而不是整个目录)查看单个文件更改吗?

时间:2013-04-27 10:57:32

标签: java watchservice

当我尝试注册文件而不是目录java.nio.file.NotDirectoryException时。我可以监听单个文件更改,而不是整个目录吗?

7 个答案:

答案 0 :(得分:82)

只需在目录中过滤所需文件的事件:

final Path path = FileSystems.getDefault().getPath(System.getProperty("user.home"), "Desktop");
System.out.println(path);
try (final WatchService watchService = FileSystems.getDefault().newWatchService()) {
    final WatchKey watchKey = path.register(watchService, StandardWatchEventKinds.ENTRY_MODIFY);
    while (true) {
        final WatchKey wk = watchService.take();
        for (WatchEvent<?> event : wk.pollEvents()) {
            //we only register "ENTRY_MODIFY" so the context is always a Path.
            final Path changed = (Path) event.context();
            System.out.println(changed);
            if (changed.endsWith("myFile.txt")) {
                System.out.println("My file has changed");
            }
        }
        // reset the key
        boolean valid = wk.reset();
        if (!valid) {
            System.out.println("Key has been unregisterede");
        }
    }
}

在这里,我们检查更改的文件是否为“myFile.txt”,如果是,则执行任何操作。

答案 1 :(得分:19)

不能注册文件,手表服务不会这样做。但注册目录实际上监视对子目录(文件和子目录)的更改,而不是对目录本身的更改。

如果要查看文件,请使用监视服务注册包含目录。 Path.register() documentation说:

  

WatchKey java.nio.file.Path.register(WatchService观察者,Kind []事件,修饰符......   修饰符)抛出IOException

     

使用监视服务注册此路径所在的文件。

     

在此版本中,此路径将查找存在的目录。 目录已注册 与监视服务,以便可以监视目录中的条目

然后,您需要通过检查事件的上下文值来处理条目上的事件,并检测与您感兴趣的文件相关的事件。上下文值表示条目的名称(实际上是条目相对于其父级路径的路径,这正是子名称)。你有一个example here

答案 2 :(得分:16)

其他答案是正确的,您必须查看特定文件的目录和过滤器。但是,您可能希望在后台运行一个线程。接受的答案可以无限期地阻止watchService.take();,并且不会关闭WatchService。适合单独线程的解决方案可能如下所示:

public class FileWatcher extends Thread {
    private final File file;
    private AtomicBoolean stop = new AtomicBoolean(false);

    public FileWatcher(File file) {
        this.file = file;
    }

    public boolean isStopped() { return stop.get(); }
    public void stopThread() { stop.set(true); }

    public void doOnChange() {
        // Do whatever action you want here
    }

    @Override
    public void run() {
        try (WatchService watcher = FileSystems.getDefault().newWatchService()) {
            Path path = file.toPath().getParent();
            path.register(watcher, StandardWatchEventKinds.ENTRY_MODIFY);
            while (!isStopped()) {
                WatchKey key;
                try { key = watcher.poll(25, TimeUnit.MILLISECONDS); }
                catch (InterruptedException e) { return; }
                if (key == null) { Thread.yield(); continue; }

                for (WatchEvent<?> event : key.pollEvents()) {
                    WatchEvent.Kind<?> kind = event.kind();

                    @SuppressWarnings("unchecked")
                    WatchEvent<Path> ev = (WatchEvent<Path>) event;
                    Path filename = ev.context();

                    if (kind == StandardWatchEventKinds.OVERFLOW) {
                        Thread.yield();
                        continue;
                    } else if (kind == java.nio.file.StandardWatchEventKinds.ENTRY_MODIFY
                            && filename.toString().equals(file.getName())) {
                        doOnChange();
                    }
                    boolean valid = key.reset();
                    if (!valid) { break; }
                }
                Thread.yield();
            }
        } catch (Throwable e) {
            // Log or rethrow the error
        }
    }
}

我尝试使用已接受的答案和this article。您应该能够将此线程与new FileWatcher(new File("/home/me/myfile")).start()一起使用,并通过在线程上调用stopThread()来停止它。

答案 3 :(得分:10)

Apache使用doOnChange方法提供FileWatchDog类。

private class SomeWatchFile extends FileWatchdog {

    protected SomeWatchFile(String filename) {
        super(filename);
    }

    @Override
    protected void doOnChange() {
        fileChanged= true;
    }

}

无论你想要什么,你都可以开始这个帖子:

SomeWatchFile someWatchFile = new SomeWatchFile (path);
someWatchFile.start();

FileWatchDog类轮询文件的lastModified()时间戳。来自Java NIO的本地WatchService效率更高,因为通知是即时的。

答案 4 :(得分:6)

您不能直接观看单个文件,但可以过滤掉您不需要的内容。

这是我的FileWatcher类实现:

import java.io.File;
import java.nio.file.*;
import java.nio.file.WatchEvent.Kind;

import static java.nio.file.StandardWatchEventKinds.*;

public abstract class FileWatcher
{
    private Path folderPath;
    private String watchFile;

    public FileWatcher(String watchFile)
    {
        Path filePath = Paths.get(watchFile);

        boolean isRegularFile = Files.isRegularFile(filePath);

        if (!isRegularFile)
        {
            // Do not allow this to be a folder since we want to watch files
            throw new IllegalArgumentException(watchFile + " is not a regular file");
        }

        // This is always a folder
        folderPath = filePath.getParent();

        // Keep this relative to the watched folder
        this.watchFile = watchFile.replace(folderPath.toString() + File.separator, "");
    }

    public void watchFile() throws Exception
    {
        // We obtain the file system of the Path
        FileSystem fileSystem = folderPath.getFileSystem();

        // We create the new WatchService using the try-with-resources block
        try (WatchService service = fileSystem.newWatchService())
        {
            // We watch for modification events
            folderPath.register(service, ENTRY_MODIFY);

            // Start the infinite polling loop
            while (true)
            {
                // Wait for the next event
                WatchKey watchKey = service.take();

                for (WatchEvent<?> watchEvent : watchKey.pollEvents())
                {
                    // Get the type of the event
                    Kind<?> kind = watchEvent.kind();

                    if (kind == ENTRY_MODIFY)
                    {
                        Path watchEventPath = (Path) watchEvent.context();

                        // Call this if the right file is involved
                        if (watchEventPath.toString().equals(watchFile))
                        {
                            onModified();
                        }
                    }
                }

                if (!watchKey.reset())
                {
                    // Exit if no longer valid
                    break;
                }
            }
        }
    }

    public abstract void onModified();
}

要使用此功能,您只需扩展并实现onModified()方法,如下所示:

import java.io.File;

public class MyFileWatcher extends FileWatcher
{
    public MyFileWatcher(String watchFile)
    {
        super(watchFile);
    }

    @Override
    public void onModified()
    {
        System.out.println("Modified!");
    }
}

最后,开始观看文件:

String watchFile = System.getProperty("user.home") + File.separator + "Desktop" + File.separator + "Test.txt";
FileWatcher fileWatcher = new MyFileWatcher(watchFile);
fileWatcher.watchFile();

答案 5 :(得分:5)

我创建了一个围绕Java 1.7&{39}的包装器,它允许注册一个目录和任意数量的 glob 模式。该类将负责过滤并仅发出您感兴趣的事件。

WatchService

完整代码位于此repo

答案 6 :(得分:3)

不确定其他人,但我对使用基本WatchService API观看单个文件进行更改所需的代码量感到呻吟。它必须更简单!

以下是使用第三方库的几种替代方法: