java.nio.file.WatchService?實(shí)時(shí)監(jiān)控文件變化的示例代碼

更新時(shí)間：2022年05月30日 10:33:31 作者：志波同學(xué)

在?Java?語(yǔ)言中，從?JDK7?開(kāi)始，新增了java.nio.file.WatchService類(lèi)，用來(lái)實(shí)時(shí)監(jiān)控文件的變化，這篇文章主要介紹了java.nio.file.WatchService?實(shí)時(shí)監(jiān)控文件變化,需要的朋友可以參考下

在平時(shí)的開(kāi)發(fā)過(guò)程中，會(huì)有很多場(chǎng)景需要實(shí)時(shí)監(jiān)聽(tīng)文件的變化，如下：
1、通過(guò)實(shí)時(shí)監(jiān)控 mysql 的 binlog 日志實(shí)現(xiàn)數(shù)據(jù)同步
2、修改配置文件后，希望系統(tǒng)可以實(shí)時(shí)感知
3、應(yīng)用系統(tǒng)將日志寫(xiě)入文件中，日志監(jiān)控系統(tǒng)可以實(shí)時(shí)抓取日志，分析日志內(nèi)容并進(jìn)行報(bào)警
4、類(lèi)似 ide 工具，可以實(shí)時(shí)感知管理的工程下的文件變更

在 Java 語(yǔ)言中，從 JDK7 開(kāi)始，新增了java.nio.file.WatchService類(lèi)，用來(lái)實(shí)時(shí)監(jiān)控文件的變化。

1.示例代碼

FileWatchedService 類(lèi)：

package org.learn.file;

import java.io.IOException;
import java.nio.file.FileSystems;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.nio.file.StandardWatchEventKinds;
import java.nio.file.WatchEvent;
import java.nio.file.WatchKey;
import java.nio.file.WatchService;
import java.util.List;

/**
 * 實(shí)時(shí)監(jiān)控文件的變化
 *
 * @author zhibo
 * @date 2019-07-30 20:37
 */
public class FileWatchedService {
    private WatchService watchService;

    private FileWatchedListener listener;

    /**
     *
     * @param path 要監(jiān)聽(tīng)的目錄，注意該 Path 只能是目錄，否則會(huì)報(bào)錯(cuò) java.nio.file.NotDirectoryException: /Users/zhibo/logs/a.log
     * @param listener 自定義的 listener，用來(lái)處理監(jiān)聽(tīng)到的創(chuàng)建、修改、刪除事件
     * @throws IOException
     */
    public FileWatchedService(Path path, FileWatchedListener listener) throws IOException {
        watchService = FileSystems.getDefault().newWatchService();
        path.register(watchService,
                /// 監(jiān)聽(tīng)文件創(chuàng)建事件
                StandardWatchEventKinds.ENTRY_CREATE,
                /// 監(jiān)聽(tīng)文件刪除事件
                StandardWatchEventKinds.ENTRY_DELETE,
                /// 監(jiān)聽(tīng)文件修改事件
                StandardWatchEventKinds.ENTRY_MODIFY);
//
//            path.register(watchService,
//                    new WatchEvent.Kind[]{
//                            StandardWatchEventKinds.ENTRY_MODIFY,
//                            StandardWatchEventKinds.ENTRY_CREATE,
//                            StandardWatchEventKinds.ENTRY_DELETE
//                    },
//                    SensitivityWatchEventModifier.HIGH);

        this.listener = listener;
    }

    private void watch() throws InterruptedException {
        while (true) {
            WatchKey watchKey = watchService.take();
            List<WatchEvent<?>> watchEventList = watchKey.pollEvents();
            for (WatchEvent<?> watchEvent : watchEventList) {
                WatchEvent.Kind kind = watchEvent.kind();

                WatchEvent<Path> curEvent = (WatchEvent<Path>) watchEvent;
                if (kind == StandardWatchEventKinds.OVERFLOW) {
                    listener.onOverflowed(curEvent);
                    continue;
                } else if (kind == StandardWatchEventKinds.ENTRY_CREATE) {
                    listener.onCreated(curEvent);
                    continue;
                } else if (kind == StandardWatchEventKinds.ENTRY_MODIFY) {
                    listener.onModified(curEvent);
                    continue;
                } else if (kind == StandardWatchEventKinds.ENTRY_DELETE) {
                    listener.onDeleted(curEvent);
                    continue;
                }
            }

            /**
             * WatchKey 有兩個(gè)狀態(tài)：
             * {@link sun.nio.fs.AbstractWatchKey.State.READY ready} 就緒狀態(tài)：表示可以監(jiān)聽(tīng)事件
             * {@link sun.nio.fs.AbstractWatchKey.State.SIGNALLED signalled} 有信息狀態(tài)：表示已經(jīng)監(jiān)聽(tīng)到事件，不可以接續(xù)監(jiān)聽(tīng)事件
             * 每次處理完事件后，必須調(diào)用 reset 方法重置 watchKey 的狀態(tài)為 ready，否則 watchKey 無(wú)法繼續(xù)監(jiān)聽(tīng)事件
             */
            if (!watchKey.reset()) {
                break;
            }

        }
    }

    public static void main(String[] args) {
        try {
            Path path = Paths.get("/Users/zhibo/logs/");
            FileWatchedService fileWatchedService = new FileWatchedService(path, new FileWatchedAdapter());
            fileWatchedService.watch();
        } catch (IOException e) {
            e.printStackTrace();
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }
}

FileWatchedListener 類(lèi)：

package org.learn.file;

import java.nio.file.Path;
import java.nio.file.WatchEvent;

public interface FileWatchedListener {
    void onCreated(WatchEvent<Path> watchEvent);

    void onDeleted(WatchEvent<Path> watchEvent);

    void onModified(WatchEvent<Path> watchEvent);

    void onOverflowed(WatchEvent<Path> watchEvent);
}

FileWatchedAdapter 類(lèi)：

package org.learn.file;

import java.nio.file.Path;
import java.nio.file.WatchEvent;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.Calendar;

/**
 * 文件監(jiān)聽(tīng)適配器
 *
 * @author zhibo
 * @date 2019-07-31 11:07
 */
public class FileWatchedAdapter implements FileWatchedListener {

    @Override
    public void onCreated(WatchEvent<Path> watchEvent) {
        Path fileName = watchEvent.context();
        System.out.println(String.format("文件【%s】被創(chuàng)建，時(shí)間：%s", fileName, now()));
    }

    @Override
    public void onDeleted(WatchEvent<Path> watchEvent) {
        Path fileName = watchEvent.context();
        System.out.println(String.format("文件【%s】被刪除，時(shí)間：%s", fileName, now()));
    }

    @Override
    public void onModified(WatchEvent<Path> watchEvent) {
        Path fileName = watchEvent.context();
        System.out.println(String.format("文件【%s】被修改，時(shí)間：%s", fileName, now()));
    }

    @Override
    public void onOverflowed(WatchEvent<Path> watchEvent) {
        Path fileName = watchEvent.context();
        System.out.println(String.format("文件【%s】被丟棄，時(shí)間：%s", fileName, now()));
    }

    private String now(){
        DateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss SSS");
        return dateFormat.format(Calendar.getInstance().getTime());
    }
}

執(zhí)行以上代碼，啟動(dòng)監(jiān)控任務(wù)，然后我在/Users/zhibo/logs/目錄中創(chuàng)建、修改、刪除文件，命令如下：

在這里插入圖片描述

應(yīng)用程序感知到文件變化，打印日志如下：

在這里插入圖片描述

2.其實(shí)并沒(méi)有實(shí)時(shí)

大家可以看到，監(jiān)控任務(wù)基本上是以 10 秒為單位進(jìn)行日志打印的，也就是說(shuō)修改一個(gè)文件，WatchService 10秒之后才能感知到文件的變化，沒(méi)有想象中的那么實(shí)時(shí)。根據(jù)以上的經(jīng)驗(yàn)，推測(cè)可能是 WatchService 做了定時(shí)的操作，時(shí)間間隔為 10 秒。通過(guò)翻閱源代碼發(fā)現(xiàn)，在 PollingWatchService 中確實(shí)存在一個(gè)固定時(shí)間間隔的調(diào)度器，如下圖：

在這里插入圖片描述

該調(diào)度器的時(shí)間間隔有 SensitivityWatchEventModifier 進(jìn)行控制，該類(lèi)提供了 3 個(gè)級(jí)別的時(shí)間間隔，分別為2秒、10秒、30秒，默認(rèn)值為 10秒。SensitivityWatchEventModifier 源碼如下：

package com.sun.nio.file;

import java.nio.file.WatchEvent.Modifier;

public enum SensitivityWatchEventModifier implements Modifier {
    HIGH(2),
    MEDIUM(10),
    LOW(30);

    private final int sensitivity;

    public int sensitivityValueInSeconds() {
        return this.sensitivity;
    }

    private SensitivityWatchEventModifier(int var3) {
        this.sensitivity = var3;
    }
}

通過(guò)改變時(shí)間間隔來(lái)進(jìn)行驗(yàn)證，將

        path.register(watchService,
                /// 監(jiān)聽(tīng)文件創(chuàng)建事件
                StandardWatchEventKinds.ENTRY_CREATE,
                /// 監(jiān)聽(tīng)文件刪除事件
                StandardWatchEventKinds.ENTRY_DELETE,
                /// 監(jiān)聽(tīng)文件修改事件
                StandardWatchEventKinds.ENTRY_MODIFY);

修改為：

    path.register(watchService,
                    new WatchEvent.Kind[]{
                            StandardWatchEventKinds.ENTRY_MODIFY,
                            StandardWatchEventKinds.ENTRY_CREATE,
                            StandardWatchEventKinds.ENTRY_DELETE
                    },
                    SensitivityWatchEventModifier.HIGH);

查看日志，發(fā)現(xiàn)正如我們的推斷，WatchService 正以每 2 秒的時(shí)間間隔感知文件變化。
在 stackoverflow 中也有人提出了該問(wèn)題，問(wèn)題：Is Java 7 WatchService Slow for Anyone Else，我的 mac 系統(tǒng)中確實(shí)存在該問(wèn)題，由于手頭沒(méi)有 windows、linux 系統(tǒng)，因此無(wú)法進(jìn)行這兩個(gè)系統(tǒng)的驗(yàn)證。

到此這篇關(guān)于java.nio.file.WatchService 實(shí)時(shí)監(jiān)控文件變化的文章就介紹到這了,更多相關(guān)java.nio.file.WatchService 監(jiān)控文件變化內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: