Java實現檔案監控器FileMonitor的例項程式碼
阿新 • • 發佈:2020-01-07
應用場景:
程式碼可以實現檔案變化後的監聽,如檔案變化,自動重新載入檔案內容,實現配置檔案的熱部署。
程式碼:
package com.yx.demo.filemonitor; import java.io.File; import java.lang.ref.WeakReference; import java.util.ArrayList; import java.util.Collection; import java.util.HashMap; import java.util.Iterator; import java.util.List; import java.util.Timer; import java.util.TimerTask; /** * FileMonitor * 檔案監控器 * * @author yx * @date 2019/12/21 0:59 */ public class FileMonitor { /** * 每2秒更新的預設監控器 */ private static FileMonitor defaultFileMonitor = new FileMonitor(2 * 1000); private Timer timer_; private HashMap<File,FileEntry> files_; // File -> Long private List<FileEntry> fileEntrys = new java.util.concurrent.CopyOnWriteArrayList<FileEntry>(); private Collection<WeakReference<FileListener>> listeners_; // of WeakReference(FileListener) private long pollingInterval = 10000; public static FileMonitor getDefaultFileMonitor() { return defaultFileMonitor; } /** * Create a file monitor instance with specified polling interval. * * @param pollingInterval Polling interval in milli seconds. */ public FileMonitor(long pollingInterval) { this.pollingInterval = pollingInterval; files_ = new HashMap<File,FileEntry>(); listeners_ = new ArrayList<WeakReference<FileListener>>(); timer_ = new Timer("FileMonitor",true); timer_.schedule(new FileMonitorNotifier(),pollingInterval); } /** * Stop the file monitor polling. */ public void stop() { timer_.cancel(); timer_ = null; } public void start() { if (timer_ == null) { timer_ = new Timer(true); timer_.schedule(new FileMonitorNotifier(),pollingInterval); } } /** * Add file to listen for. File may be any java.io.File (including a * directory) and may well be a non-existing file in the case where the * creating of the file is to be trepped. * <p> * More than one file can be listened for. When the specified file is * created,modified or deleted,listeners are notified. * * @param file File to listen for. */ public void addFile(String id,File file) { if (!files_.containsKey(file)) { FileEntry entry = new FileEntry(id,file,file.exists() ? file.lastModified() : -1); files_.put(file,entry); } } /** * 新增監控檔案實體。 * * @param fileEntry */ public void addFileEntry(FileEntry fileEntry) { if (!fileEntrys.contains(fileEntry)) { fileEntrys.add(fileEntry); } } /** * 通過檔案實體的標識判斷監控檔案實體是否存在。 * * @param id * @return */ public boolean fileEntryExists(String id) { if (id == null) { return false; } for (int i = 0; i < fileEntrys.size(); i++) { if (id.equals(fileEntrys.get(i).getId())) { return true; } } return false; } /** * 通過檔案實體標識刪除一個監控檔案實體。 * * @param id */ public void removeFileEntry(String id) { if (id == null) { return; } for (int i = 0; i < fileEntrys.size(); i++) { if (id.equals(fileEntrys.get(i).getId())) { fileEntrys.remove(i); return; } } } /** * Remove specified file for listening. * * @param file File to remove. */ public void removeFile(File file) { files_.remove(file); } /** * Add listener to this file monitor. * * @param fileListener Listener to add. */ public void addListener(FileListener fileListener) { // Don't add if its already there for (Iterator<WeakReference<FileListener>> i = listeners_.iterator(); i.hasNext(); ) { WeakReference<FileListener> reference = i.next(); FileListener listener = (FileListener) reference.get(); if (listener == fileListener) { return; } } // Use WeakReference to avoid memory leak if this becomes the // sole reference to the object. listeners_.add(new WeakReference<FileListener>(fileListener)); } /** * Remove listener from this file monitor. * * @param fileListener Listener to remove. */ public void removeListener(FileListener fileListener) { for (Iterator<WeakReference<FileListener>> i = listeners_.iterator(); i.hasNext(); ) { WeakReference<FileListener> reference = (WeakReference<FileListener>) i.next(); FileListener listener = (FileListener) reference.get(); if (listener == fileListener) { i.remove(); break; } } } /** * This is the timer thread which is executed every n milliseconds according * to the setting of the file monitor. It investigates the file in question * and notify listeners if changed. */ private class FileMonitorNotifier extends TimerTask { @Override public void run() { try { for (Iterator<FileEntry> i = fileEntrys.iterator(); i.hasNext(); ) { try { FileEntry entry = i.next(); if (entry == null || !entry.check()) { i.remove(); } } catch (Throwable t) { t.printStackTrace(); System.out.println("執行檔案監控發生錯誤:" + t.getMessage()); } } // Loop over the registered files and see which have changed. // Use a copy of the list in case listener wants to alter the // list within its fileChanged method. Collection<File> files = new ArrayList<File>(files_.keySet()); for (Iterator<File> i = files.iterator(); i.hasNext(); ) { File file = i.next(); try { FileEntry fileEntry = files_.get(file); long lastModifiedTime = fileEntry.getLastModified(); long newModifiedTime = file.exists() ? file.lastModified() : -1; //logger.debug(file.getAbsolutePath()); //logger.debug(" {}=>{}",lastModifiedTime,newModifiedTime); // Chek if file has changed if (newModifiedTime != lastModifiedTime) { //logger.debug("file changed {})",file.getAbsolutePath()); fileEntry.setLastModified(newModifiedTime); // Register new modified time files_.put(file,fileEntry); if (fileEntry.getFileListener() != null) { fileEntry.getFileListener().fileChanged(fileEntry); } else { // Notify listeners for (Iterator<WeakReference<FileListener>> j = listeners_.iterator(); j.hasNext(); ) { WeakReference<FileListener> reference = (WeakReference<FileListener>) j.next(); FileListener listener = (FileListener) reference.get(); // Remove from list if the back-end object has been GC'd if (listener == null) { j.remove(); } else { listener.fileChanged(fileEntry); } } } } } catch (Throwable t) { if (file != null) { t.printStackTrace(); System.out.println( "file monitor execute error,file=" + file.getAbsolutePath() + t.getMessage()); } else { System.out.println( "file monitor execute error,file=null" + t.getMessage()); } } } } catch (Throwable t) { System.out.println("執行檔案監控發生錯誤" + t.getMessage()); } } } } package com.yx.demo.filemonitor; /** * FileListener * * @author yx * @date 2019/12/21 0:55 */ public interface FileListener { /** * * @param fileEntry */ public void fileChanged(FileEntry fileEntry); }
package com.yx.demo.filemonitor;
import java.io.File; import java.lang.ref.WeakReference; /** * FileEntry * 檔案Entry,如果FileEntry指定了FileListener,那麼當檔案發生變動時只觸發指定的FileListener * * @author yx * @date 2019/12/21 0:56 */ public class FileEntry { String id; File file; long lastModified; FileListener fileListener = null; Object userData; WeakReference<Object> reference = null; /** * 建構函式。 * * @param id * @param file */ public FileEntry(String id,File file) { this(id,file.exists() ? file.lastModified() : -1); } public FileEntry(Object reference,String id,file.exists() ? file.lastModified() : -1); reference = new WeakReference<Object>(reference); } /** * 建構函式。 * * @param id 標識 * @param file 要監控的檔案 * @param lastmodified 最後修改日期 */ public FileEntry(String id,File file,long lastmodified) { super(); this.id = id; this.file = file; this.lastModified = lastmodified; } public boolean check() { if (reference != null && reference.get() == null) { //監控物件已經不存在,請求FileMonitor刪除自己 return false; } long newModifiedTime = file.exists() ? file.lastModified() : -1; if (lastModified != newModifiedTime) { this.lastModified = newModifiedTime; FileListener ls = this.getFileListener(); if (ls == null) { return false; } else { try { ls.fileChanged(this); } catch (Exception e) { e.printStackTrace(); System.err.println("執行檔案監控事件監聽" + e.getMessage()); } return true; } } else { return true; } } public String getId() { return id; } public void setId(String id) { this.id = id; } public File getFile() { return file; } public void setFile(File file) { this.file = file; } public long getLastModified() { return lastModified; } public void setLastModified(long lastModified) { this.lastModified = lastModified; } public FileListener getFileListener() { return fileListener; } public void setFileListener(FileListener fileListener) { this.fileListener = fileListener; } public Object getUserData() { return userData; } public void setUserData(Object userData) { this.userData = userData; } }
使用demo:
// 檔案路徑 String fileName = "conf/database.xml"; // 檔案監控 FileListener fileListener = new FileListener() { @Override public void fileChanged(FileEntry fileEntry) { // TODO 檔案變化後的業務處理 } }; File file = new File(fileName); FileEntry fileEntry = new FileEntry("database",file); // 設定檔案監控 fileEntry.setFileListener(fileListener); FileMonitor.getDefaultFileMonitor().addFileEntry(fileEntry);
總結
以上所述是小編給大家介紹的Java實現檔案監控器FileMonitor的例項程式碼,希望對大家有所幫助,如果大家有任何疑問請給我留言,小編會及時回覆大家的。在此也非常感謝大家對我們網站的支援!
如果你覺得本文對你有幫助,歡迎轉載,煩請註明出處,謝謝!