使用WatchService监听文件变化

在Java 7发布的新的IO框架中,除了大家都熟知的 FileVisitor 接口外,还有个 WatchService 接口经常被人忽视掉。 这个类可以让你实时的监控操作系统中文件的变化,包括创建、更新和删除事件。

WatchService 用来观察被注册了的对象的变化和事件。它和 Watchable 两个接口的配合使用, WatchService类似于在观察者模式中的观察者,Watchable类似域观察者模式中的被观察者。

而Java 7中的 java.nio.file.Path 类就实现了Watchable接口,这样的话,和Path类一起可实现观察者模式。

基本使用

要使用WatchService,首先必须创建一个实例,使用 java.nio.file.FileSystems 类:

WatchServicewatchService = FileSystems.getDefault().newWatchService();

接下来,我们初始化一个被监控文件夹的Path类:

Pathpath = Paths.get("pathToDir");

然后,将这个Path注册到 WatchService 中去:

WatchKeywatchKey = path.register(  watchService, StandardWatchEventKinds...);

注意,注册方法第二个参数是一个可变长参数,也就是可以注册多个事件类型。

StandardWatchEventKinds 有如下四种类型:

ENTRY_CREATE 创建事件,可是新建一个文件或重命名文件

ENTRY_MODIFY 修改事件,文件内容被修改,有些系统上面文件属性被修改也会触发

ENTRY_DELETE 删除事件,文件被删除或被重命名

OVERFLOW 如果丢失或放弃事件时被触发,我们一般不会关注这个类型

WatchKey

WatchKey 类代表了这个监听服务的注册,可以用它来获取事件的各个属性。一般来讲我们会通过如下方法获取这个类实例:

WatchKeywatchKey = watchService.take();

这个方法会一直阻塞,知道某个事件到来。

有一点非常重要的需要记住,一旦 WatchKey 实例通过poll或take返回后,它再也不会捕获任何事件,触发你调用reset方法:

watchKey.reset();

这样的话就能将这个 WatchKey 又放回到watch service队列中去,可以重新等待新的事件了。

所以一般来讲这个服务代码形式会写成如下形式:

WatchKeykey;while((key = watchService.take()) != null) {for(WatchEventevent : key.pollEvents()) {//process}key.reset();}

解释一下运行过程,take()方法会一直阻塞直到返回一个WatchKey实例,然后进入循环内部, pollEvents()方法会返回当前Key上面所有事件列表,我们一个个去处理这些事件。

所有事件处理完成后,必须调用reset方法,让这个key重新进入监听队列。

一个完整例子

下面通过一个完整例子演示WatchService的用法,我们监听用户家目录的文件变动,打印相应的信息。

publicclassDirectoryWatcherExample{publicstaticvoidmain(String[] args){        WatchService watchService          = FileSystems.getDefault().newWatchService();        Path path = Paths.get(System.getProperty("user.home"));        path.register(          watchService,            StandardWatchEventKinds.ENTRY_CREATE,              StandardWatchEventKinds.ENTRY_DELETE,                StandardWatchEventKinds.ENTRY_MODIFY);        WatchKey key;while((key = watchService.take()) !=null) {for(WatchEventevent: key.pollEvents()) {                System.out.println("Event kind:"+event.kind()                    +". File affected: "+event.context() +".");            }            key.reset();        }    }}

测试一下,在用户目录新建一个文件,然后重命名为 www.txt ,看看输出结果:

Eventkind:ENTRY_CREATE.Fileaffected: 新建文本文档.txt.Eventkind:ENTRY_MODIFY.Fileaffected: 新建文本文档.txt.Eventkind:ENTRY_DELETE.Fileaffected: 新建文本文档.txt.Eventkind:ENTRY_CREATE.Fileaffected:www.txt.

上面两行是新建文件输出,可以看到产生两个事件。下面是重命名产生两个事件,一个是原文件的删除事件,一个是新文件的新建事件。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,163评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,301评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,089评论 0 352
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,093评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,110评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,079评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,005评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,840评论 0 273
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,278评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,497评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,667评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,394评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,980评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,628评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,796评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,649评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,548评论 2 352

推荐阅读更多精彩内容