基于 FileAlterationListener 實現文件變化監聽
作者：一安
由于FileAlterationMonitor是通過定時檢查文件狀態來判斷變化的，因此監聽間隔不宜設置得過小，否則會增加系統開銷；但也不能設置過大，以免無法及時響應文件變化。開發者需要根據實際需求合理調整監聽間隔。
前言
在軟件開發中，尤其是在處理文件相關的業務時，實時感知文件的變化顯得尤為重要。無論是日志文件的更新、配置文件的修改，還是數據文件的變動，及時捕捉這些變化能夠讓程序更加靈活、智能地響應。
FileAlterationListener 簡介
FileAlterationListener是 Apache Commons IO 庫中的一個接口，它用于監聽文件或目錄的變化事件。該接口定義了一系列方法，分別對應文件或目錄的創建、修改和刪除事件。通過實現這個接口，開發者可以自定義邏輯來處理這些事件，從而實現對文件系統變化的響應。
與FileAlterationListener緊密相關的還有FileAlterationObserver和FileAlterationMonitor類。
- FileAlterationObserver用于觀察指定的文件或目錄，它會記錄文件或目錄的狀態信息，并與之前的狀態進行比較，從而判斷是否發生了變化。
- FileAlterationMonitor則負責定時觸發FileAlterationObserver進行狀態檢查，并在檢測到變化時調用FileAlterationListener的相關方法。
核心方法
- onStart(FileAlterationObserver observer)：在監聽開始時調用，可用于初始化資源或執行一些準備工作。
- onDirectoryCreate(File directory)：當觀察的目錄中創建新的子目錄時觸發該方法，參數directory為新創建的目錄對象。
- onDirectoryChange(File directory)：當觀察的目錄內容發生變化（例如子文件或子目錄的增刪改）時調用，參數directory為發生變化的目錄對象。
- onDirectoryDelete(File directory)：當觀察的目錄被刪除時觸發，參數directory為被刪除的目錄對象。
- onFileCreate(File file)：當觀察的目錄中創建新文件時調用，參數file為新創建的文件對象。
- onFileChange(File file)：當觀察的文件內容被修改時觸發，參數file為發生變化的文件對象。
- onFileDelete(File file)：當觀察的文件被刪除時調用，參數file為被刪除的文件對象。
- onStop(FileAlterationObserver observer)：在監聽停止時調用，可用于釋放資源或執行清理操作。
實現案例
實現 FileAlterationListener 接口
import org.apache.commons.io.monitor.FileAlterationListener;
import org.apache.commons.io.monitor.FileAlterationObserver;
import java.io.File;
public class MyFileAlterationListener implements FileAlterationListener {
@Override
public void onStart(FileAlterationObserver observer) {
System.out.println("文件監聽開始");
}
@Override
public void onDirectoryCreate(File directory) {
System.out.println("目錄創建: " + directory.getAbsolutePath());
}
@Override
public void onDirectoryChange(File directory) {
System.out.println("目錄變化: " + directory.getAbsolutePath());
}
@Override
public void onDirectoryDelete(File directory) {
System.out.println("目錄刪除: " + directory.getAbsolutePath());
}
@Override
public void onFileCreate(File file) {
System.out.println("文件創建: " + file.getAbsolutePath());
}
@Override
public void onFileChange(File file) {
System.out.println("文件修改: " + file.getAbsolutePath());
}
@Override
public void onFileDelete(File file) {
System.out.println("文件刪除: " + file.getAbsolutePath());
}
@Override
public void onStop(FileAlterationObserver observer) {
System.out.println("文件監聽停止");
}
}配置并啟動監聽
import org.apache.commons.io.monitor.FileAlterationListener;
import org.apache.commons.io.monitor.FileAlterationMonitor;
import org.apache.commons.io.monitor.FileAlterationObserver;
import java.io.File;
public class FileChangeMonitor {
private static final long DEFAULT_INTERVAL = 5000; // 監聽間隔，單位為毫秒
public static void main(String[] args) {
// 要監聽的目錄
File directory = new File("D:\test\logs");
// 創建文件變化觀察者
FileAlterationObserver observer = new FileAlterationObserver(directory);
// 創建文件變化監聽器實例
FileAlterationListener listener = new MyFileAlterationListener();
observer.addListener(listener);
// 創建文件變化監視器，設置監聽間隔
FileAlterationMonitor monitor = new FileAlterationMonitor(DEFAULT_INTERVAL);
monitor.addObserver(observer);
try {
// 啟動監視器
monitor.start();
System.out.println("開始監聽文件變化...");
} catch (Exception e) {
e.printStackTrace();
}
}
}測試案例
開始監聽文件變化...
文件監聽開始
文件監聽停止
文件監聽開始
文件刪除: D:\test\logs\stdout-2023-06-30-0.txt
文件監聽停止
文件監聽開始
文件創建: D:\test\logs\新建文本文檔.txt
文件監聽停止
文件監聽開始
文件創建: D:\test\logs\stdout-2023-06-30-0.txt
文件刪除: D:\test\logs\新建文本文檔.txt
文件監聽停止
文件監聽開始
文件修改: D:\test\logs\stdout-2023-06-30-0.txt
文件監聽停止注意事項
- 性能問題：由于FileAlterationMonitor是通過定時檢查文件狀態來判斷變化的，因此監聽間隔不宜設置得過小，否則會增加系統開銷；但也不能設置過大，以免無法及時響應文件變化。開發者需要根據實際需求合理調整監聽間隔。
- 遞歸監聽：FileAlterationObserver默認只會監聽指定目錄下的直接子文件和子目錄，如果需要遞歸監聽子目錄下的所有文件和目錄變化，需要使用FileAlterationObserver的帶遞歸參數的構造函數，例如new FileAlterationObserver(directory, true)。
- 線程安全：在處理文件變化事件的方法中，如果涉及多線程操作或共享資源訪問，需要注意線程安全問題，避免出現數據不一致或競態條件。
責任編輯：武曉燕
來源：
一安未來
