Java实时监控目录下文件、文件夹的创建、修改、删除操作之JDK7+ WatchService

517人浏览 / 0人评论

Java7对NIO进行了大的改进,新增了许多功能:

  • 对文件系统的访问提供了全面的支持
  • 提供了基于异步Channel的IO

这些新增的IO功能简称为 NIO.2,依然在java.nio包下。

早期的Java只提供了File类来操作文件、文件夹本身,功能有限,性能也不高。

NIO.2为解决这种缺陷,提供了Path接口,并提供了Paths、Files2个工具类,这2个工具类包含的方法都是静态方法,Files类提供了大量的静态方法来操作文件、文件夹。

Path接口、Paths工具类使用示例:

//获取指定路径的Path对象
Path path=Paths.get("D:/untitled/test/");   
//也可以这样写:   Path path=Paths.get("D","untitled","test");    参数个数可变

//返回文件/文件夹名,test
System.out.println(path.getFileName());
//返回父目录的路径,D:\untitled
System.out.println(path.getParent());
//判断该路径的最后一级是否是指定的文件/文件夹,true。和String的endsWith有点不同。当参数是最后一级的文件/文件夹名时,才返回true。
System.out.println(path.endsWith("test"));    
//以上方法的操作对象是Path对象中的路径,就是说路径不必是真实存在的

//返回根路径(盘符),D:\
System.out.println(path.getRoot());
//返会绝对路径
System.out.println(path.toAbsolutePath());   
//以上获取的路径要是真实存在的

以前,如果要监控文件、目录的变化(新建、修改、删除),一般是启动一条后台线程,这条线程每隔一段时间去遍历指定目录的文件,如果此次遍历的结果与上次遍历的结果不同,就认为文件发生了变化。这种方式很繁琐,性能也低。

NIO.2的Path接口提供了一个方法来监听文件变化:

register(WatchService watcher, 要监听的事件类型1,要监听的事件类型2,.......)       //注册一个监听服务

比如“xx安全卫士提醒您:xx程序将创建xx文件,是否允许?”、“xx程序试图修改xx文件,是否允许?”,就可使用此方法实现。

使用示例:

public class Test {
    public static void main(String[] args) throws IOException, InterruptedException {

        //创建一个文件系统的监听服务
        WatchService watchService= FileSystems.getDefault().newWatchService();

        Path path=Paths.get("D:/untitled/test");
        
        //为该文件夹注册监听,监听新建、修改、删除事件。只能为文件夹(目录)注册监听,不能为单个文件注册监听
        path.register(watchService,StandardWatchEventKinds.ENTRY_CREATE,StandardWatchEventKinds.ENTRY_MODIFY,StandardWatchEventKinds.ENTRY_DELETE);

        //编写事件处理
        while (true){  //一直监听
            //拉取一个WatchKey。当触发监听的事件时,就会产生一个WatchKey,此WatchKey封装了事件信息。
            WatchKey watchKey=watchService.take();

            //使用循环是因为这一个WatchKey中可能有多个文件变化了,比如Ctrl+A全选,然后删除,只触发了一个WatchKey,但有多个文件变化了
            for (WatchEvent event:watchKey.pollEvents()){   
                System.out.println(event.context()+"发生了"+event.kind()+"事件!");
                /*
                watchKey.pollEvents()  获取此次WatchKey中所有变化了的文件的信息,以List(列表)形式返回,一个WatchEvent就是一个元素,封装了一个变化了的文件的信息
                event.context()  获取文件名
                event.kind()  获取发生的事件类型

                因为只能为文件夹注册监听,如果要监听某些指定的文件,可以在增强的for循环中,先根据event.context()判断是否是指定的文件,是才处理。
                 */
            }

            //虽然是while()循环,但WatchKey和ByteBuffer一样,使用完要重置状态,才能继续用。
            watchKey.reset();    //如果不重置,WatchKey使用一次过后就不能再使用,即只能监听到一次文件变化。
        }


        /*
        测试:在D:/untitled/test目录下
        1、新建1.txt文件      1.txt.txt发生了ENTRY_CREATE事件!
        2、打开1.txt,输入"hello world!",并保存      1.txt.txt发生了ENTRY_MODIFY事件!
        3、删除“hello world!",并保存      1.txt.txt发生了ENTRY_MODIFY事件!
        4、新建2.txt文件    2.txt发生了ENTRY_CREATE事件!

        说明:编辑文件内容时,不算修改,保存时才算修改。

        5、新建文件夹“图片”
            新建文件夹发生了ENTRY_CREATE事件!
            新建文件夹发生了ENTRY_DELETE事件!
            图片发生了ENTRY_CREATE事件!
        OS执行过程:新建了一个名为“新建文件夹”的文件夹,再把此文件夹重命名为指定的名称。
        重命名时,”新建文件夹“消失了,算作删除,”图片“出现了,算作新建。

        6、在图片目录下,随便新建一个文件或者文件夹
            图片发生了ENTRY_MODIFY事件!
         说明监控的只是子文件、子文件夹,不会递归监控。

        7、全选,删除test下所有文件、子文件夹
            图片发生了ENTRY_DELETE事件!
            1.txt.txt发生了ENTRY_DELETE事件!
            2.txt发生了ENTRY_DELETE事件!
         */

    }
}

拉取一个WatchKey有3种方法:

  • WatchKey  take()   //阻塞式拉取,如果未拉取到,会一直等待,直到拉取到一个WatchKey。一般我们用这个。
  • WatchKey   poll()   //非阻塞式拉取,试图拉取一个WatchKey,拉取到了就返回拉取的WatchKey对象,没有WatchKey发生就立即返回null。
  • WatchKey   poll(long  timeout, TimeUnit  unit)    //非阻塞式拉取,如果没拉取到,会再等待timeout毫秒,还没拉取到才返回null。

但是在使用jdk7提供的API时,会出现些许问题。

  • 当文件修改时,会被调用两次,即输出两个相同的修改。
  • 不能对其子文件夹进行监控,只能提示目录被修改。
  • 无法对文件类型进行过滤。

比如我从网上下载1张图片到目录下就触发了以下一系列事件:

336a5e78-4a76-4452-989b-5ff14e39b001.tmp发生了ENTRY_CREATE事件!
336a5e78-4a76-4452-989b-5ff14e39b001.tmp发生了ENTRY_MODIFY事件!
336a5e78-4a76-4452-989b-5ff14e39b001.tmp发生了ENTRY_DELETE事件!
0ba09eec30275a878e78872421091c08.jpeg.crdownload发生了ENTRY_CREATE事件!
0ba09eec30275a878e78872421091c08.jpeg.crdownload发生了ENTRY_MODIFY事件!
0ba09eec30275a878e78872421091c08.jpeg.crdownload发生了ENTRY_MODIFY事件!
0ba09eec30275a878e78872421091c08.jpeg.crdownload发生了ENTRY_MODIFY事件!
0ba09eec30275a878e78872421091c08.jpeg.crdownload发生了ENTRY_DELETE事件!
0ba09eec30275a878e78872421091c08.jpeg发生了ENTRY_CREATE事件!
0ba09eec30275a878e78872421091c08.jpeg发生了ENTRY_MODIFY事件!
0ba09eec30275a878e78872421091c08.jpeg发生了ENTRY_MODIFY事件!
0ba09eec30275a878e78872421091c08.jpeg发生了ENTRY_MODIFY事件!

如果我想监听文件下载完成事件然后做其它一些操作就很难处理,毕竟触发了多次ENTRY_MODIFY事件,程序不好判断到底哪一次ENTRY_MODIFY事件意味着文件已经下载完成。

推荐另外一种通过commons-io来实现的方式:Java实时监控目录下文件、文件夹的创建、修改、删除操作之commons-io

 

全部评论