JDK文件的陷阱：监听文件变更需小心

2024-01-10 00:13:22

监听文件变更时潜伏的陷阱：JDK 1.7 中的隐秘 Bug

在日常开发中，我们经常需要监听文件变更，以便在文件内容更新时做出相应响应。然而，在使用 JDK 1.7 或更低版本时，开发者可能会遭遇一个令人头疼的 Bug，导致文件变更监听功能失效。

Bug 的成因与影响

当使用 JDK 1.7 监听文件变更时，如果采用以下代码：

Path path = Paths.get("/path/to/file");
WatchService watchService = FileSystems.getDefault().newWatchService();
path.register(watchService, Kind.ENTRY_MODIFY);

while (true) {
    WatchKey key = watchService.take();
    for (WatchEvent<?> event : key.pollEvents()) {
        if (event.kind() == Kind.ENTRY_MODIFY) {
            // 文件修改后需要执行的逻辑
        }
    }
}

你可能会发现：

文件内容明明发生了变化，但监听器却无法检测到。
即使文件内容确实发生了变化，WatchKey#pollEvents() 方法也可能返回一个空列表，无法获取变更事件。

解决方案

解决这个 Bug 的办法有两种：

升级 JDK 版本： 使用 JDK 1.8 或更高版本，因为此 Bug 已在这些版本中修复。
使用变通方法： 在监听文件变更之前，调用 FileSystems.getDefault().newWatchService().close() 方法；或者在监听循环中，使用 WatchKey#reset() 方法重置 WatchKey。

修改后的代码如下：

// 使用变通方法
Path path = Paths.get("/path/to/file");
WatchService watchService = FileSystems.getDefault().newWatchService();
path.register(watchService, Kind.ENTRY_MODIFY);

while (true) {
    WatchKey key = watchService.take();
    for (WatchEvent<?> event : key.pollEvents()) {
        if (event.kind() == Kind.ENTRY_MODIFY) {
            // 文件修改后需要执行的逻辑
        }
    }
    key.reset();
}