[java] 파일 이벤트 및 상태 변화 감지를 위한 Apache Commons IO 사용법

14 Nov 2023

java

파일의 이벤트와 상태 변화를 감지하는 프로그램을 작성할 때, Apache Commons IO 라이브러리는 매우 유용한 도구입니다. 이 라이브러리를 사용하면 파일이 생성되거나 수정되는 등의 이벤트를 신속하게 감지하고, 파일의 상태 변화를 쉽게 추적할 수 있습니다.

Apache Commons IO란?

Apache Commons IO는 자바의 표준 라이브러리인 java.io 패키지를 보완하고 확장하기 위해 만들어진 라이브러리입니다. 이 라이브러리를 사용하면 파일 및 디렉토리 작업에 필요한 다양한 유틸리티 기능을 사용할 수 있습니다.

Apache Commons IO 설치하기

Apache Commons IO 라이브러리를 사용하기 위해서는 먼저 해당 라이브러리를 프로젝트에 추가해야 합니다. Maven을 사용한다면, pom.xml 파일에 다음과 같은 의존성을 추가합니다:

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

Gradle을 사용한다면, build.gradle 파일에 다음과 같이 의존성을 추가합니다:

dependencies {
    implementation 'commons-io:commons-io:2.11.0'
}

파일 이벤트 감지하기

Apache Commons IO를 사용하여 파일의 생성, 수정, 삭제 등의 이벤트를 감지하기 위해서는 FileAlterationObserver 및 FileAlterationListener 인터페이스를 사용합니다.

아래는 파일의 생성 및 수정 이벤트를 감지하는 예제 코드입니다:

import org.apache.commons.io.monitor.FileAlterationListener;
import org.apache.commons.io.monitor.FileAlterationObserver;

public class FileEventListener implements FileAlterationListener {
    @Override
    public void onStart(FileAlterationObserver observer) {
        // 이벤트 감지가 시작될 때 실행되는 코드
    }

    @Override
    public void onDirectoryCreate(File directory) {
        // 디렉토리 생성 이벤트가 발생했을 때 실행되는 코드
    }
    
    @Override
    public void onFileCreate(File file) {
        // 파일 생성 이벤트가 발생했을 때 실행되는 코드
    }
    
    @Override
    public void onFileChange(File file) {
        // 파일 수정 이벤트가 발생했을 때 실행되는 코드
    }

    @Override
    public void onStop(FileAlterationObserver observer) {
        // 이벤트 감지가 종료될 때 실행되는 코드
    }
}

위의 예제 코드에서 FileEventListener 클래스는 FileAlterationListener 인터페이스를 구현하고, 파일 이벤트 발생에 따라 적절한 메서드를 오버라이드합니다. 이제 이 이벤트 리스너를 사용하여 파일 이벤트를 감지할 수 있습니다.

import org.apache.commons.io.monitor.FileAlterationMonitor;
import org.apache.commons.io.monitor.FileAlterationObserver;

public class FileEventWatcher {
    public static void main(String[] args) throws Exception {
        // 감지할 디렉토리를 설정합니다
        String directory = "/path/to/directory";

        // 파일 이벤트 감지 주기를 설정합니다
        long interval = 1000;

        // 파일 이벤트 리스너를 생성합니다
        FileAlterationListener listener = new FileEventListener();

        // 파일 이벤트 감지기를 생성하고 설정합니다
        FileAlterationObserver observer = new FileAlterationObserver(directory);
        observer.addListener(listener);

        // 파일 이벤트 감지 주기를 설정합니다
        FileAlterationMonitor monitor = new FileAlterationMonitor(interval);
        monitor.addObserver(observer);

        // 파일 이벤트 감지를 시작합니다
        monitor.start();
    }
}

위의 예제 코드에서는 FileAlterationObserver와 FileAlterationMonitor 클래스를 사용하여 디렉토리를 감시하고, 파일 이벤트를 주기적으로 감지합니다. 파일 이벤트가 발생할 때마다 FileEventListener의 메서드가 호출됩니다.

파일 상태 변화 감지하기

파일의 상태 변화를 감지하기 위해서는 FileAlterationObserver와 FileAlterationListenerWithHistory 인터페이스를 사용합니다. 이를 통해 파일의 변화 내역을 추적하고, 이전 상태와 비교할 수 있습니다.

아래는 파일의 상태 변화를 감지하여 이전 상태와 비교하는 예제 코드입니다:

import org.apache.commons.io.monitor.FileAlterationListenerAdaptor;
import org.apache.commons.io.monitor.FileAlterationObserver;

import java.io.File;

public class FileStatusListener extends FileAlterationListenerAdaptor {
    @Override
    public void onFileCreate(File file) {
        // 파일 생성 이벤트가 발생했을 때 실행되는 코드
        System.out.println("File created: " + file.getAbsolutePath());
    }

    @Override
    public void onFileChange(File file) {
        // 파일 수정 이벤트가 발생했을 때 실행되는 코드
        System.out.println("File modified: " + file.getAbsolutePath());

        // 파일의 이전 상태와 비교하여 변경된 내용을 확인할 수 있습니다.
        // 이전 상태는 file.getHistory()를 통해 가져올 수 있습니다.
        // 예: String previousContent = file.getHistory().get(0).getContent();
    }

    @Override
    public void onFileDelete(File file) {
        // 파일 삭제 이벤트가 발생했을 때 실행되는 코드
        System.out.println("File deleted: " + file.getAbsolutePath());
    }
}

위의 예제 코드에서 FileStatusListener는 FileAlterationListenerAdaptor 클래스를 상속받아 파일의 상태 변화 이벤트를 감지합니다. onFileChange 메서드 내에서는 이전 상태와 비교하여 변경된 내용을 확인할 수 있습니다.

import org.apache.commons.io.monitor.FileAlterationMonitor;
import org.apache.commons.io.monitor.FileAlterationObserver;

public class FileStatusWatcher {
    public static void main(String[] args) throws Exception {
        // 감지할 디렉토리를 설정합니다
        String directory = "/path/to/directory";

        // 파일 상태 변화 감지 주기를 설정합니다
        long interval = 1000;

        // 파일 상태 변화 리스너를 생성합니다
        FileAlterationListenerAdaptor listener = new FileStatusListener();

        // 파일 상태 변화 감지기를 생성하고 설정합니다
        FileAlterationObserver observer = new FileAlterationObserver(directory);
        observer.addListener(listener);

        // 파일 상태 변화 감지 주기를 설정합니다
        FileAlterationMonitor monitor = new FileAlterationMonitor(interval);
        monitor.addObserver(observer);

        // 파일 상태 변화 감지를 시작합니다
        monitor.start();
    }
}

위의 예제 코드에서는 FileAlterationObserver와 FileAlterationMonitor 클래스를 사용하여 디렉토리를 감시하고, 파일 상태 변화를 주기적으로 감지합니다. 파일 상태 변화가 발생할 때마다 FileStatusListener의 메서드가 호출됩니다.

결론

Apache Commons IO 라이브러리를 사용하면 파일의 이벤트와 상태 변화를 감지하는 프로그램을 쉽게 작성할 수 있습니다. 이 라이브러리의 다양한 기능을 활용하면 파일과 디렉토리 관련 작업을 보다 쉽고 효율적으로 처리할 수 있습니다.