首頁 > 軟體

Java實現紀錄檔檔案監聽並讀取相關資料的方法實踐

2022-05-24 14:00:18

專案需求

由於所在資料中臺專案組需要實現監聽資料夾或者紀錄檔檔案並讀取對應格式的髒資料的需求,以便在檔案、資料夾發生變化時進行相應的業務流程;所以在這裡記錄下相關業務的實現及技術選型。

Apache Commons-IO

首先需要新增對應依賴:

<dependency>
 <groupId>commons-io</groupId>
 <artifactId>commons-io</artifactId>
 <version>2.7</version>
</dependency>

版本可自行選擇,這裡需要注意的是 2.7 版本及以上需要 Java 8

官網截圖:

Apache Commos IO中的 org.apache.commons.io.monitor包提供了檔案系統監聽的功能。

核心知識

  • 一句話總結:通過觀察者模式以及事件監聽機制,以 FileAlterationObserver 為核心,再通過 FileAlterationListenerFileAlterationMonitor,就可以實現對檔案系統的事件監聽。
  • 整體流程:
  • 自定義檔案監聽類並繼承 FileAlterationListenerAdaptor 實現對檔案與目錄的建立,修改,刪除事件的處理
  • 自定義檔案監控類,通過指定目錄建立一個觀察者 FileAlterationObserver
  • 向此監視器新增檔案系統觀察器,並新增檔案監聽器
  • 通過 ApplicationRunner 或者 CommandLineRunner 呼叫並執行

程式碼實現

  • 檔案監聽類:
/**
 * 檔案監聽類
 * @author Greenarrow
 * @date 2022-05-12 14:43
 **/
public class FileListener extends FileAlterationListenerAdaptor {

    private static Logger logger = LoggerFactory.getLogger(FileListener.class);
    @Override
    public void onStart(FileAlterationObserver observer) {
        super.onStart(observer);
        logger.info("onStart");
    }

    @Override
    public void onDirectoryCreate(File directory) {
        logger.info("[新建]:" + directory.getAbsolutePath());
    }

    @Override
    public void onDirectoryChange(File directory) {
        logger.info("[修改]:" + directory.getAbsolutePath());
    }

    @Override
    public void onDirectoryDelete(File directory) {
        logger.info("[刪除]:" + directory.getAbsolutePath());
    }

    @Override
    public void onFileCreate(File file) {
        String compressedPath = file.getAbsolutePath();
        logger.info("[新建]:" + compressedPath);
        List<String> contentList = null;
        try {
            if (file.canRead()){
                // 將檔案按行讀取為字串集合
                contentList = FileUtils.readLines(new File(compressedPath), StandardCharsets.UTF_8);
                if (CollectionUtil.isNotEmpty(contentList)){
                    // 獲取對應格式的資料並輸出,這裡可自行新增業務處理
                    List<String> dirtyRecord  = contentList.stream().filter(s -> s.startsWith("{") && s.endsWith("}")).collect(Collectors.toList());
                    dirtyRecord.forEach(System.out::println);
                }
            }

        } catch (IOException e) {
            e.printStackTrace();
            logger.error("讀取檔案內容失敗",e);
        }
    }

    @Override
    public void onFileChange(File file) {
        String compressedPath = file.getAbsolutePath();
        logger.info("[修改]:" + compressedPath);
    }

    @Override
    public void onFileDelete(File file) {
        logger.info("[刪除]:" + file.getAbsolutePath());
    }

    @Override
    public void onStop(FileAlterationObserver observer) {
        super.onStop(observer);
        logger.info("onStop");
    }
}
  • 檔案監控類:
/**
 * 檔案監聽測試 demo
 * @author Greenarrow
 * @date 2022-05-12 14:45
 **/
public class FileMonitor {

    FileAlterationMonitor monitor = null;

    public FileMonitor(long interval) throws Exception {
        monitor = new FileAlterationMonitor(interval);
    }

    /**
     * 給檔案新增監聽
     * @param path
     * @param listener
     */
    public void monitor(String path, FileAlterationListener listener) {
        FileAlterationObserver observer = new FileAlterationObserver(new File(path));
        monitor.addObserver(observer);
        observer.addListener(listener);
    }

    public void stop() throws Exception {
        monitor.stop();
    }

    public void start() throws Exception {
        monitor.start();

    }
}
  • 自定義 Runner 並實現 CommandLineRunner :
/**
 * 專案啟動之後開啟檔案監聽功能
 * @author Greenarrow
 * @date 2022-05-12 10:02
 **/
@Component
// @Order(Integer.MIN_VALUE)
public class DirtyRecordRunner implements CommandLineRunner {

    private static Logger logger = LoggerFactory.getLogger(DirtyRecordRunner.class);

    @Value("${test}")
    private String path;

    @Override
    public void run(String... args) throws Exception {
        logger.info(this.getClass().getName()+"[開啟資料夾監聽功能]");
        FileMonitor fileMonitor = new FileMonitor(1000);
        fileMonitor.monitor(path,new FileListener());
        fileMonitor.start();
    }
}

總結

  • 檔案、資料夾監聽功能較簡單,實現方式可自行選擇

  • 需要注意的是,通過 Runner 的方式在專案啟動之後開啟相關監聽功能,此方式存在缺陷,只能呼叫一次,出現異常就會停止,除非專案重啟,這裡需要通過相關補償機制來實現

到此這篇關於Java實現紀錄檔檔案監聽並讀取相關資料的方法實踐的文章就介紹到這了,更多相關Java 紀錄檔檔案監聽讀取內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com!


IT145.com E-mail:sddin#qq.com