[Java] NIO 기반 입출력 및 네트워킹 - NIO, 파일 & 디렉토리

NIO 기반 입출력 및 네트워킹은 여러 절로 구성되어 있습니다.

[Java] NIO 기반 입출력 및 네트워킹 - NIO, 파일 & 디렉토리

[Java] NIO 기반 입출력 및 네트워킹 - 버퍼(Buffer)

[Java] NIO 기반 입출력 및 네트워킹 - 파일 채널

[Java] NIO 기반 입출력 및 네트워킹 - 파일 비동기 채널

[Java] NIO 기반 입출력 및 네트워킹 - TCP 블로킹 채널

[Java] NIO 기반 입출력 및 네트워킹 - TCP 넌블로킹 채널

[Java] NIO 기반 입출력 및 네트워킹 - UDP 채널

---

1. NIO 소개

 자바 4부터 새로운 입출력(NIO: New Input/Output)이라는 뜻에서 java.nio 패키지가 포함되었는데, 자바 7로 버전업하면서 자바 IO와 자바 NIO 사이의 일관성 없는 클래스 설계를 바로 잡고, 비동기 채널 등의 네트워크 지원을 대폭 강화한 NIO.2 API가 추가되었습니다.

 NIO.2는 java.nio2 패키지로 제공되지 않고 기존 java.nio의 하위 패키지(java.nio.channels, java.nio.charset, java.nio.file)에 통합되어 있습니다. 

 아래는 NIO에서 제공하는 패키지에 대해 간략히 설명한 표입니다.

 

NIO 패키지	포함되어 있는 내용
java.nio	다양한 버퍼 클래스
java.nio.channels	파일 채널, TCP 채널, UDP 채널 등의 클래스
java.nio.channels.spi	java.nio.channels 패키지를 위한 서비스 제공자 클래스
java.nio.charset	문자셋, 인코더, 디코더 API
java.nio.charset.spi	java.nio.charset 패키지를 위한 서비스 제공자 클래스
java.nio.file	파일 및 파일 시스템에 접근하기 위한 클래스
java.nio.file.attribute	파일 및 파일 시스템의 속성에 접근하기 위한 클래스
java.nio.file.spi	java.nio.file 패키지를 위한 서비스 제공자 클래스

 1.1 IO와 NIO의 차이점

  IO와 NIO는 데이터를 입출력한다는 목적은 동일하지만, 방식에 있어서 크게 차이가 납니다.

 아래 표는 IO와 NIO의 차이점을 간단히 정리하였습니다.

구분	IO	NIO
입출력 방식	스트림(stream) 방식	채널(channel) 방식
버퍼 방식	넌버퍼(non-buffer)	버퍼(buffer)
비동기 방식	지원 안 함	지원
블로킹 / 넌블로킹 방식	블로킹 방식만 지원	블로킹 / 넌 블로킹 모두 지원

  스트림 VS 채널

 IO는 스트림 기반입니다. 스트림은 입력 스트림과 출력 스트림으로 구분되어 있기 때문에 데이터를 읽기 위해서는 입력 스트림을 생성해야 하고, 데이터를 출력하기 위해서는 출력 스트림을 생성해야 합니다. 예를 들어 하나의 파일에서 데이터를 읽고 저장하는 작업을 모두 해야 한다면 FileInputStream 과 FileOutputStream을 별도로 생성해야 합니다.

 NIO는 채널 기반입니다. 채널은 스트림과 달리 양방향으로 입력과 출력이 가능합니다. 그렇기 때문에 입력과 출력을 위한 별도의 채널을 만들 필요가 없습니다. 예를 들어 하나의 파일에서 데이터를 읽고 저장하는 작업을 모두 해야 한다면 FileChannel 하나만 생성하면 됩니다.

  넌버퍼 VS 버퍼

 IO에서는 출력 스트림이 1바이트를 쓰면 입력 스트림이 1바이트를 읽습니다. 이런 시스템은 대체로 느립니다. 이것보다는 버퍼를 사용해서 복수 개의 바이트를 한꺼번에 입력받고 출력하는 것이 빠른 성능을 냅니다. 그래서 IO는 버퍼를 제공해 주는 보조 스트림인 BufferedInputStream, BufferedOutputStream을 연결해서 사용하기도 합니다.

 NIO는 기본적으로 버퍼를 사용해서 입출력을 하기 때문에 IO 보다는 성능이 좋습니다. 채널은 버퍼에 저장된 데이터를 출력하고, 입력된 데이터를 버퍼에 저장합니다.

 IO는 스트림에서 읽은 데이터를 즉시 처리합니다. 그렇기 때문에 스트림으로부터 입력된 전체 데이터를 별도로 저장하지 않으면, 입력된 데이터의 위치를 이동해 가면서 자유롭게 이용할 수 없습니다.

 NIO는 읽은 데이터를 무조건 버퍼에 저장하기 때문에 버퍼 내에서 데이터의 위치를 이동해 가면서 필요한 부분만 읽고 쓸 수 있습니다.

  블로킹 VS 넌블로킹

 IO는 블로킹(blocking)이 됩니다. 입력 스트림의 read() 메소드를 호출하면 데이터가 입력되기 전까지 스레드는 블로킹(대기 상태)됩니다. 마찬가지로 출력 스트림의 write() 메소드를 호출하면 데이터가 출력되기 전까지 스레드는 블로킹됩니다. IO 스레드가 블로킹되면 다른 일을 할 수 없고 블로킹을 빠져나오기 위해 인터럽트도 할 수 없습니다. 블로킹을 빠져나오는 유일한 방법은 스트림을 닫는 것입니다.

 NIO는 블로킹과 넌블로킹 특징을 모두 가지고 있습니다. IO 블로킹과의 차이점은 NIO 블로킹은 스레드를 인터럽트함으로써 빠져나올 수가 있다는 것입니다. 블로킹의 반대 개념인 넌블로킹인데, 입출력 작업 시 스레드가 블로킹되지 않는 것을 말합니다. NIO의 넌블로킹은 입출력 작업 준비가 완료된 채널만 선택해서 작업 스레드가 처리하기 때문에 작업 스레드가 블로킹되지 않습니다. 여기서 작업 준비가 완료되었다는 뜻은 지금 바로 읽고 쓸 수 있는 상태를 말합니다. NIO 넌블로킹의 핵심 객체는 멀티플렉서(multiplexor) 인 셀렉터(Selector)입니다. 셀렉터는 복수 개의 채널 중에서 준비 완료된 채널을 선택하는 방법을 제공해줍니다.

 1.2 IO와 NIO의 선택

  네트워크 프로그램을 개발할 때 IO와 NIO 선택 기준에 대해 생각해봅시다. NIO는 불특정 다수의 클라이언트 연결 또는 멀티 파일들을 넌 블로킹이나 비동기로 처리할 수 있기 때문에 과도한 스레드 생성을 피하고 스레드를 효과적으로 재사용한다는 점에서 큰 장점이 있습니다. 또한 운영체제의 버퍼(다이렉트 버퍼)를 이용한 입출력이 가능하기 때문에 입출력 성능이 향상됩니다.

  NIO는 연결 클라이언트 수가 많고, 하나의 입출력 처리 작업이 오래 걸리지 않는 경우에 사용하는 것이 좋습니다. 스레드에서 입출력 처리가 오래 걸린다면 대기하는 작업의 수가 늘어나기 때문에 제한된 스레드로 처리하는 것이 좋습니다. 스레드에서 입출력 처리가 오래 걸린다면 대기하는 작업의 수가 늘어나기 때문에 제한된 스레드로 처리하는 것이 오히려 불리할 수 있습니다. 대용량 데이터를 처리할 경우에는 IO가 더 유리한데, NIO는 버퍼의 할당 크기도 문제가 되고, 모든 입출력 작업에 버퍼를 무조건 사용해야 하므로 받은 즉시 처리하는 IO 보다는 좀 더 복잡합니다. 연결 클라이언트 수가 적고, 전송되는 데이터가 대용량이면서 순차적으로 처리될 필요성이 있는 경우에는 IO로 서버를 구현하는 것이 좋습니다.

2. 파일과 디렉토리

 IO는 파일의 속성 정보를 읽기 위해 File 클래스만 제공하지만, NIO는 좀 더 다양한 파일의 속성 정보를 제공해주는 클래스와 인터페이스를 java.nio.file, java.nio.file.attribute 패키지에서 제공하고 있습니다.

 

 2.1 경로 정의(Path)

  NIO에서 제일 먼저 살펴봐야 할 API는 java.nio.file.Path 인터페이스 입니다. Path는 IO의 java.io.File 클래스에 대응되는 NIO 인터페이스 입니다. 

  NIO의 API에서 파일의 경로를 지정하기 위해 Path를 사용하기 때문에 Path 사용 방법을 잘 익혀두어야 합니다. Path 구현 객체를 얻기 위해서는 java.nio.file.Paths 클래스의 정적 메소드인 get() 메소드를 호출하면 됩니다.

   Path path = Paths.get(String first, String ... more)

   Path path = Paths.get(URI uri)

  get() 메소드의 파라미터는 파일의 경로인데, 문자열로 지정할 수도 있고, URI 객체로 지정할 수도 있습니다. 

  문자열로 지정할 경우 전체 경로를 한꺼번에 지정해도 좋고, 상위 디렉토리와 하위 디렉토리를 나열해서 지정해도 좋습니다.

  다음은 "C:\Tmp\dir\TestFile.txt" 경로를 이용해서 Path 객체를 얻는 방법을 보여줍니다.

    Path path = Paths.get("C:\Tmp\dir\TestFile.txt");

    Path path = Paths.get("C:\Tmp\dir", "TestFile.txt");

    Path path = Paths.get("C:", "Tmp", "dir", "TestFile.txt");

  파일의 경로는 절대 경로와 상대 경로를 모두 사용할 수 있습니다. 

  만약 현재 디렉토리 위치가 "C:\Tmp" 일 경우 "C:\Tmp\dir\file.txt" 는 다음과 같이 지정이 가능합니다.

    Path path = Paths.get("dir/TestFile.txt");

    Path path = Paths.get("./dir/file.txt");

  현재 위치가 C:\Tmp\dir1 이라면 "C:\Tmp\dir2\File2.txt" 는 다음과 같이 지정이 가능합니다.

     Path path = Paths.get("../dir2/File2.txt");

  Path 인터페이스에는 다음과 같이 파일 경로에서 얻을 수 있는 여러가지 정보를 제공해주는 메소드가 있습니다.

  http://docs.oracle.com/javase/7/docs/api/java/nio/file/Path.html

  

  다음 예제는 상대 경로를 이용해 소스 파일에 대한 Path 객체를 얻고, 파일 명, 부모 디렉토리 명, 중첩 경로 수, 경로 상에 있는 모든 디렉토리를 출력합니다.

  * PathExample.java

package pathexam;
 
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Iterator;
 
public class PathExample {
    public static void main(String[] args) {
        Path path = Paths.get("/src/pathexam/PathExample.java");
        
        System.out.println("파일 명: " + path.getFileName());    // 파일명 리턴
        System.out.println("부모 디렉토리 명: " + path.getParent().getFileName()); // 부모 객체의 이름 리턴
        System.out.println("중첩 경로 수: " + path.getNameCount());
 
        System.out.println();
        for (int i = 0; i < path.getNameCount(); i++) {
            System.out.println(path.getName(i));
        }
 
        System.out.println();
        Iterator<Path> iterator = path.iterator();
        while (iterator.hasNext()) {
            Path tmp = iterator.next();
            System.out.println(tmp.getFileName());
        }
    }
 
}
 

 

 2.2 파일 시스템 정보(FileSystem)

  운영체제의 파일 시스템은 FileSystem 인터페이스를 통해서 접근할 수 있습니다. FileSystem 구현 객체는 FileSystems 의 정적 메소드인 getDefault()로 얻을 수 있습니다.

   FileSystem fileSystem = FileSystems.getDefault();

 

  FileSystem은 다음과 같은 메소드를 제공합니다.

 

리턴 타입	메소드(매개 변수)	설명
Iterable<FileStore>	getFileStores()	드라이버 정보를 가진 FileStore 객체들을 리턴
Iterable<Path>	getRootDirectories()	루트 디렉토리 정보를 가진 Path 객체들을 리턴
String	getSeparator()	디렉토리 구분자 리턴

  FileStore는 드라이버를 표현한 객체로 다음과 같은 메소드를 제공합니다.

리턴 타입	메소드(매개 변수)	설명
long	getTotalSpace()	드라이버 전체 공간 크기(단위: 바이트) 리턴
long	getUnallocatedSpace()	할당되지 않은 공간 크기(단위: 바이트) 리턴
long	getUsableSpace()	사용 가능한 공간 크기, getUnallocatedSpace()와 동일한 값
boolean	isReadOnly()	읽기 전용 여부
String	name()	드라이버 명 리턴
String	type()	파일 시스템 종류

 * FileSystemExample.java

 
package pathexam;
 
import java.nio.file.FileStore;
import java.nio.file.FileSystem;
import java.nio.file.FileSystems;
import java.nio.file.Path;
 
public class FileSystemExampleV {
    public static void main(String[] args) throws Exception {
        FileSystem fileSystem = FileSystems.getDefault();
 
        for (FileStore store : fileSystem.getFileStores()) {
            System.out.println("드라이버명: " + store.name());
            System.out.println("파일시스템: " + store.type());
            System.out.println("전체 공간: " + store.getTotalSpace() + " 바이트");
            System.out.println("사용 중인 공간: " + (store.getTotalSpace() - store.getUnallocatedSpace()) + " 바이트");
            System.out.println("사용 가능한 공간: " + (store.getTotalSpace() - store.getUsableSpace()) + " 바이트");
            System.out.println();
        }
 
        System.out.println("파일 구분자: " + fileSystem.getSeparator());
        System.out.println();
 
        for (Path path : fileSystem.getRootDirectories()) {
            System.out.println(path.toString());
        }
    }
}
 

 2.3 파일 속성 읽기 및 파일, 디렉토리 생성 / 삭제

  java.nio.file.Files 클래스는 파일과 디렉토리의 생성 및 삭제, 그리고 이들의 속성을 읽는 메소드를 제공하고 있습니다.

  여기서 속성이란 파일이나 디렉토리가 숨김인지, 디렉토리인지, 크리가 어떻게 되는지, 소유자가 누구인지에 대한 정보를 말합니다. 

  아래는 java.nio.file.Files 클래스가 제공하는 정적 메소드들에 대한 API Document 입니다.

  http://docs.oracle.com/javase/7/docs/api/java/nio/file/Files.html

  다음 예제는 파일의 속성을 읽고 출력합니다.

  * FileExample.java

 
package pathexam;
 
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
 
public class FileExample {
    public static void main(String[] args) throws Exception {
        
        Path path = Paths.get("src/pathexam/FileExample.java");
        
        System.out.println("디렉토리 여부: " + Files.isDirectory(path));
        System.out.println("파일 여부: " + Files.isRegularFile(path));
        System.out.println("마지막 수정 시간: " + Files.getLastModifiedTime(path));
        System.out.println("파일 크기: " + Files.size(path));
        System.out.println("소유자: " + Files.getOwner(path));
        System.out.println("숨김 파일 여부: " + Files.isHidden(path));
        System.out.println("읽기 가능 여부: " + Files.isReadable(path));
        System.out.println("쓰기 가능 여부: " + Files.isWritable(path));
        
    }
}
 

  

  다음 예제는 디렉토리와 파일을 생성하고, 디렉토리의 내용을 출력합니다.

  *DirectoryExample.java

 
package pathexam;
 
import java.nio.file.DirectoryStream;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
 
public class DirectoryExample {
    public static void main(String[] args) throws Exception {
 
        Path path1 = Paths.get("C:/r_temp/sub_dir");
        Path path2 = Paths.get("C:/r_temp/java_text.txt");
 
        if (Files.notExists(path1)) {
            Files.createDirectories(path1);
        }
 
        if (Files.notExists(path2)) {
            Files.createFile(path2);
        }
 
        Path path3 = Paths.get("C:/r_temp");
        DirectoryStream<Path> directoryStream = Files.newDirectoryStream(path3);
 
        for (Path path : directoryStream) {
            if (Files.isDirectory(path)) {
                System.out.println("디렉토리: " + path.getFileName());
            } else {
                System.out.println("파일: " + path.getFileName() + " (크기: " + Files.size(path) + " )");
            }
        }
    }
}
 

 2.4 와치 서비스(WatchService)

  와치 서비스는 자바 7에서 처음 소개된 것으로 디렉토리 내부에서 파일 생성, 삭제, 수정 등의 내용 변화를 감시하는데 사용됩니다.

  흔하게 볼 수 있는 와치 서비스의 적용 예는 에디터에서 파일을 편집하고 있을 때, 에디터 바깥에서 파일 내용을 수정하게 되면 파일 내용이 변경됐으니 파일을 다시 불러올 것인지 묻는 대화상자를 띄우는 것입니다.

  와치 서비스는 일반적으로 파일 변경 통지 메커니즘으로 알려져 있습니다.

  WatchService 를 생성하려면 다음과 같이 FileSystem의 newWatchService() 메소드를 호출하면 됩니다.

   WatchService watchService = FileSystems.getDefault().newWatchService();

  WatchService를 생성했다면 감시가 필요한 디렉토리의 Path 객체에 register() 메소드로  WatchService를 등록하면 됩니다.

  이때 어떤 변화(생성, 수정, 삭제) 를 감시할 것인지를 StandardWatchEventKinds 상수로 지정할 수 있습니다.

  다음은 생성, 수정, 삭제를 감시하도록  WatchService를 등록합니다.

   path.register(watchService, StandardWatchEventKinds.ENTRY_CREATE, StandardWatchEventKinds.ENTRY_MODIFY, StandardWatchEventKinds.ENTRY_DELETE);

 

  디렉토리(path)에  WatchService를 등록하는 순간부터 디렉토리 내부에서 변경이 발생하면 와치 이벤트(WatchEvent)가 발생하고,  WatchService는 해당 이벤트 정보를 가진 와치키(WatchKey)를 생성하여 큐(Queue)에 넣어줍니다.

  프로그램은 무한루프를 돌면서  WatchService의 take() 메소드를 호출하여 WatchKey가 큐에 들어올 때까지 대기하고 있다가 WatchKey가 들어오면 WatchKey를 얻어 처리하면 됩니다.

while(true) {
    WatchKey watchKey = watchService.take();   
}

  WatchKey를 얻고나서 해야 할 일은 pollEvents() 메소드를 호출해서 WatchEvent 리스트를 얻어내는 것입니다. 한 개의 WatchEvent가 아니라 List<WatchList<?>>로 리턴하는 이유는 여러 개의 파일이 동시에 삭제, 수정, 생성될 수 있기 때문입니다.

  참고로 WatchEvent는 파일당 하나씩 발생합니다.

   List<WatchEvent<?>> list = watchKey.pollEvents();

>  프로그램은 WatchEvent 리스트에서 WatchEvent를 하나씩 꺼내어 이벤트의 종류와 Path 객체를 얻어낸 다음 적절히 처리하면 됩니다.

for(WatchEvent watchEvent : list) {
    Kind kind = watchEvent.kind();
    Path path = (Path) watchEvent.context();
    if (kind == StandardWatchEventKinds.ENTRY_CREATE) {
 
    } else if (kind == StandardWatchEventKinds.ENTRY_DELETE) {
 
    } else if (kind == StandardWatchEventKinds.ENTRY_MODIFY) {
 
    } else if (kind == StandardWatchEventKinds.OVERFLOW) {
 
    }
}
 

  OVERFLOW 이벤트는 운영체제에서 이벤트가 소실됐거나 버려진 경우에 발생하므로 별도의 처리 코드가 필요 없습니다. 

  따라서 CREATE, DELETE, MODIFY 이벤트만 처리하면 됩니다. 한 번 사용된 WatchKey는 reset() 메소드로 초기화해야 하는데, 새로운 WatchEvent가 발생하면 큐에 다시 들어가기 때문입니다. 

  초기화에 성공하면 reset() 메소드는 true를 리턴하지만, 감시하는 디렉토리가 삭제되었거나 유효하지 않을 경우에는 false를 리턴합니다.

  WatchKey가 더 이상 유효하지 않게 되면 무한 루프를 빠져나와 WatchService의 close() 메소드를 호출하고 종료하면 됩니다.

 
while(true) {
    WatchKey watchKey = watchService.take();
    List<WatchEvent<?>> list = watchkey.polllEvents();
 
    for (WatchEvent watchEvent : list) {
    ...
    }
 
    boolean valid = watchKey.reset();
    if (!valid) { break; }
}
 
watchService.close();
 
 

  다음 예제는 c:\r_temp 디렉토리를 감시 디렉토리로 설정했습니다. 실행 후, C:\r_temp\dir 디렉토리와 C:\r_temp\file.txt 파일을 생성하고, file.txt 파일 내용을 수정한 다음 저장하였습니다. 그리고 dir, file.txt를 동시에 삭제했습니다. 이 모든 행위들이 TextArea에 기록되는 것을 볼 수 있는 예제입니다.

 * WatchServiceExample.java

 
package pathexam;
 
import java.nio.file.FileSystems;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.nio.file.StandardWatchEventKinds;
import java.nio.file.WatchEvent;
import java.nio.file.WatchEvent.Kind;
import java.nio.file.WatchKey;
import java.nio.file.WatchService;
import java.util.List;
 
import javafx.application.Application;
import javafx.application.Platform;
import javafx.scene.Scene;
import javafx.scene.control.TextArea;
import javafx.scene.layout.BorderPane;
import javafx.stage.Stage;
 
public class WatchServiceExample extends Application {
 
    class WatchServiceThread extends Thread {
 
        @Override
        public void run() {
            try {
                WatchService watchService = FileSystems.getDefault().newWatchService();
                Path directory = Paths.get("C:/r_temp");
                directory.register(watchService, StandardWatchEventKinds.ENTRY_CREATE,
                        StandardWatchEventKinds.ENTRY_DELETE, StandardWatchEventKinds.ENTRY_MODIFY);
 
                while (true) {
                    WatchKey watchKey = watchService.take();
                    List<WatchEvent<?>> list = watchKey.pollEvents();
 
                    for (WatchEvent<?> watchEvent : list) {
                        Kind<?> kind = watchEvent.kind();
                        Path path = (Path) watchEvent.context();
 
                        if (kind == StandardWatchEventKinds.ENTRY_CREATE) {
                            Platform.runLater(() -> textArea.appendText("파일 생성됨 -> " + path.getFileName() + "\n"));
                        } else if (kind == StandardWatchEventKinds.ENTRY_DELETE) {
                            Platform.runLater(() -> textArea.appendText("파일 삭제됨 -> " + path.getFileName() + "\n"));
                        } else if (kind == StandardWatchEventKinds.ENTRY_MODIFY) {
                            Platform.runLater(() -> textArea.appendText("파일 수정됨 -> " + path.getFileName() + "\n"));
                        } else if (kind == StandardWatchEventKinds.OVERFLOW) {
 
                        }
                    }
 
                    boolean valid = watchKey.reset();
 
                    if (!valid) {
                        break;
                    }
                }
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
 
    }
 
    TextArea textArea;
 
    @Override
    public void start(Stage arg0) throws Exception {
        BorderPane root = new BorderPane();
        root.setPrefSize(500, 300);
 
        textArea = new TextArea();
        textArea.setEditable(false);
        root.setCenter(textArea);
 
        Scene scene = new Scene(root);
        arg0.setScene(scene);
        arg0.setTitle("WatchServiceExample");
        arg0.show();
 
        WatchServiceThread wst = new WatchServiceThread();
        wst.start();
    }
 
    public static void main(String[] args) {
        launch(args);
    }
 
}
 

다음 포스트에서는 버퍼에 관한 포스팅을 작성하도록 하겠습니다.

* 이 포스트은 서적 '이것이 자바다' 를 참고하여 작성한 포스트입니다.