前言
有時候你可能有個疑問,IDE總是可以檢測到外部文件是否發生了變化,比如你在某個類里面加了一些代碼,這時候的IDE就會彈出一個框說你做了更改。再或者是某個文件夾下的文件發生了改變,比如新建了一個或者是刪除了一個等等。這時候我們的IDE依然可以檢測到。這個功能到底是如何實現的呢?這篇文章主要是研究NIO的其中一個類,叫做WatchService。
也有一些其他的方式可以輕松地實現監控文件夾的功能,比如說JAVA輪詢的方式,或者是common-io的方式,我會慢慢比較。
OK,我們直接來看一下簡單例子如何實現,再去分析如何實現的?
一、代碼實現
1、簡單案例
這個代碼很簡單,只需要四步:
public static void main(String[] args) throws Exception {
//第一步:取得WatchService
WatchService watchService = FileSystems.getDefault().newWatchService();
//第二步:確定要監控的路徑
Path path = Paths.get("G:\");
//第三步:為本路徑綁定WatchService,并確定監控的事件
path.register(
watchService,
StandardWatchEventKinds.ENTRY_CREATE,
StandardWatchEventKinds.ENTRY_DELETE,
StandardWatchEventKinds.ENTRY_MODIFY);
WatchKey key;
//第四步:當有事件時,開始觸發
while ((key = watchService.take()) != null) {
for (WatchEvent<?> event : key.pollEvents()) {
System.out.println("事件" + event.kind() + "發生了,文件是:" + event.context());
}
key.reset();
}
}
這里我們監控G盤,然后我們在G盤新建文件,然后刪除修改,就會在后臺打印相關信息。
現在就可以監控了,很簡單。
2、代碼分析
第一步和第二步,新建一個取得WatchService和取得要監控的路徑,這個很容易理解。
第三步綁定,這里只需要注意兩件重要的事情:首先,path將watchService作為第一個參數,然后是StandardWatchEventKinds的變量參數。一共有四種。
- StandardWatchEventKinds.ENTRY_CREATE—當有新文件時觸發。可能是創建了一個新文件。
- StandardWatchEventKinds.ENTRY_MODIFY—當文件被修改時觸發。所有的文件編輯都會觸發這個事件。在一些平臺上,甚至改變文件屬性也會觸發它。
- StandardWatchEventKinds.ENTRY_DELETE—當文件被刪除、移動或重命名時觸發。
- StandardWatchEventKinds.OVERFLOW—觸發表示丟失或丟棄的事件。
第四步不斷監控,當watchService里面不為空時,開始獲取相應的事件,并poll彈出。最后還有一個reset 表示回退到相應的句柄,繼續處理下一次事件。
3、源碼分析
由于watchService是一個接口,所以分析起來也比較簡單。里面一共包含了三個方法
//方法1:關閉watchService
@Override
void close() throws IOException;
//方法2:彈出事件
WatchKey poll();
//方法3:帶有參數的彈出
WatchKey poll(long timeout, TimeUnit unit)
throws InterruptedException;
//方法4:獲取事件。
WatchKey take() throws InterruptedException;
由于方法比較簡單,所以我們可以直接看方法上的注釋就可以了。
結論
WatchService接口是在java7的版本中引入的。主要是處理NIO的文件相關問題。但是WatchService其實是有很多缺點的。
- WatchService是采用掃描式的,效率低。
- WatchService代碼寫起來費勁。雖然上面看起來很簡潔了,但是實際開發時麻煩。
- WatchService不能監聽到多級目錄,事先父文件夾需要存在。
鑒于以上原因,在簡單的實現時,可以使用,但是還有一個更強大的工具commons-io,使用更簡單也更加的高效。