小师妹学JavaIO之文件系统和WatchService

小师妹这次遇到了监控文件变化的问题，F 师兄给小师妹介绍了 JDK7 nio 中引入的 WatchService，没想到又顺道普及了一下文件系统的概念，万万没想到。

小师妹：F 师兄最近你有没有感觉到呼吸有点困难，后领有点凉飕飕的，说话有点不顺畅的那种？

没有啊小师妹，你是不是秋衣穿反了？

小师妹：不是的 F 师兄，我讲的是心里的感觉，那种莫须有的压力，还有一丝悸动缠绕在心。

别绕弯子了小师妹，是不是又遇到问题了。

更多精彩内容且看：

区块链从入门到放弃系列教程 - 涵盖密码学, 超级账本, 以太坊,Libra, 比特币等持续更新
Spring Boot 2.X 系列教程: 七天从无到有掌握 Spring Boot- 持续更新
Spring 5.X 系列教程: 满足你对 Spring5 的一切想象 - 持续更新
java 程序员从小工到专家成神之路（2020 版）- 持续更新中, 附详细文章教程

更多内容请访问 www.flydean.com

小师妹：还是 F 师兄懂我，这不上次的 Properties 文件用得非常上手，每次修改 Properties 文件都要重启 java 应用程序，真的是很痛苦。有没有什么其他的办法呢？

办法当然有，最基础的办法就是开一个线程定时去监控属性文件的最后修改时间，如果修改了就重新加载，这样不就行了。

小师妹：写线程啊，这么麻烦，有没有什么更简单的办法呢？

就知道你要这样问，还好我准备的比较充分，今天给你介绍一个 JDK7 在 nio 中引入的类 WatchService。

WatchService 是 JDK7 在 nio 中引入的接口：

监控的服务叫做 WatchService，被监控的对象叫做 Watchable：

WatchKey register(WatchService watcher,
                      WatchEvent.Kind<?>[] events,
                      WatchEvent.Modifier... modifiers)
        throws IOException;
WatchKey register(WatchService watcher, WatchEvent.Kind<?>... events)
        throws IOException;

Watchable 通过 register 将该对象的 WatchEvent 注册到 WatchService 上。从此只要有 WatchEvent 发生在 Watchable 对象上，就会通知 WatchService。

WatchEvent 有四种类型：

ENTRY_CREATE 目标被创建
ENTRY_DELETE 目标被删除
ENTRY_MODIFY 目标被修改
OVERFLOW 一个特殊的 Event，表示 Event 被放弃或者丢失

现在来看 WatchService 的 4 个方法：

close 关闭 watchService
poll 获取下一个 watchKey，如果没有则返回 null
带时间参数的 poll 在等待的一定时间内获取下一个 watchKey
take 获取下一个 watchKey，如果没有则一直等待

小师妹：F 师兄，那怎么才能构建一个 WatchService 呢？

上次文章中说的文件系统，小师妹还记得吧，FileSystem 中就有一个获取 WatchService 的方法：

public abstract WatchService newWatchService() throws IOException;

我们看下 FileSystem 的结构图：

在我的 mac 系统上，FileSystem 可以分为三大类，UnixFileSystem，JrtFileSystem 和 ZipFileSystem。我猜在 windows 上面应该还有对应的 windows 相关的文件系统。小师妹你要是有兴趣可以去看一下。

小师妹：UnixFileSystem 用来处理 Unix 下面的文件，ZipFileSystem 用来处理 zip 文件。那 JrtFileSystem 是用来做什么的？

哎呀，这就又要扯远了，为什么每次问问题都要扯到天边 ….

从前当 JDK 还是 9 的时候，做了一个非常大的改动叫做模块化 JPMS（Java Platform Module System），这个 Jrt 就是为了给模块化系统用的，我们来举个例子：

public void useJRTFileSystem(){
        String resource = "java/lang/Object.class";
        URL url = ClassLoader.getSystemResource(resource);
        log.info("{}",url);
    }

上面一段代码我们获取到了 Object 这个 class 的 url，我们看下如果是在 JDK8 中，输出是什么：

jar:file:/Library/Java/JavaVirtualMachines/jdk1.8.0_171.jdk/Contents/Home/jre/lib/rt.jar!/java/lang/Object.class

输出结果是 jar:file 表示这个 Object class 是放在 jar 文件中的，后面是 jar 文件的路径。

如果是在 JDK9 之后：

jrt:/java.base/java/lang/Object.class

结果是 jrt 开头的，java.base 是模块的名字，后面是 Object 的路径。看起来是不是比传统的 jar 路径更加简洁明了。

有了文件系统，我们就可以在获取系统默认的文件系统的同时，获取到相应的 WatchService：

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

小师妹：F 师兄，WatchSerice 是咋实现的呀？这么神奇，为我们省了这么多工作。

其实 JDK 提供了这么多类的目的就是为了不让我们重复造轮子，之前跟你讲监控文件的最简单办法就是开一个独立的线程来监控文件变化吗？其实 …..WatchService 就是这样做的！

PollingWatchService() {
        // TBD: Make the number of threads configurable
        scheduledExecutor = Executors
            .newSingleThreadScheduledExecutor(new ThreadFactory() {
                 @Override
                 public Thread newThread(Runnable r) {Thread t = new Thread(null, r, "FileSystemWatcher", 0, false);
                     t.setDaemon(true);
                     return t;
                 }});
    }

上面的方法就是生成 WatchService 的方法，小师妹看到没有，它的本质就是开启了一个 daemon 的线程，用来接收监控任务。

下面看下怎么把一个文件注册到 WatchService 上面：

private void startWatcher(String dirPath, String file) throws IOException {WatchService watchService = FileSystems.getDefault().newWatchService();
        Path path = Paths.get(dirPath);
        path.register(watchService, ENTRY_MODIFY);

        Runtime.getRuntime().addShutdownHook(new Thread(() -> {
            try {watchService.close();
            } catch (IOException e) {log.error(e.getMessage());
            }
        }));

        WatchKey key = null;
        while (true) {
            try {key = watchService.take();
                for (WatchEvent<?> event : key.pollEvents()) {if (event.context().toString().equals(fileName)) {loadConfig(dirPath + file);
                    }
                }
                boolean reset = key.reset();
                if (!reset) {log.info("该文件无法重置");
                    break;
                }
            } catch (Exception e) {log.error(e.getMessage());
            }
        }
    }

上面的关键方法就是 path.register，其中 Path 是一个 Watchable 对象。

然后使用 watchService.take 来获取生成的 WatchEvent，最后根据 WatchEvent 来处理文件。

道生一，一生二，二生三，三生万物。一个简简单单的功能其实背后隐藏着 … 道德经，哦，不对，背后隐藏着道的哲学。

本文的例子 https://github.com/ddean2009/learn-java-io-nio

本文作者：flydean 程序那些事

本文链接：http://www.flydean.com/java-io-file-watchservice/

本文来源：flydean 的博客

欢迎关注我的公众号: 程序那些事，更多精彩等着您！

小师妹学JavaIO之文件系统和WatchService

简介

监控的痛点

WatchService 和文件系统

WatchSerice 的使用和实现本质

总结