[Java 21] (17) - I/O 2

표준 입출력과 File

 

표준 입출력 - System.in, System.out, System.err

 

표준 입출력은 콘솔(console, 도스창)을 통한 데이터 입력과 콘솔로의 데이터 출력을 의미합니다. 자바에서는 표준 입출력(standard I/O)을 위해 3가지 입출력 스트림, System.in, System.out, System.err을 제공하는데, 이 들은 자바 어플리케이션의 실행과 동시에 사용할 수 있게 자동적으로 생성되기 때문에 개발자가 별도로 스트림을 생성하는 코드를 작성하지 않고 사용이 가능합니다.

아래의 System클래스의 소스에서 알 수 있듯이 in, out, err은 System클래스에 선언된 클래스 변수(static변수)입니다. 선언 부분만을 봐서는 out, err, in의 타입은 InputStream과 PrintStream이지만 실제로는 버퍼를 이용하는 BufferedInputStream과 BufferedOutputStream의 인스턴스를 사용합니다.

public final class System {
    public static final InputStream in = null;
    public static final PrintStream out = null;
    public static final PrintStream err = null;
    ...
}

Intellij나 eclipse와 같은 에디터는 콘솔로의 출력을 중간에 가로채서 에디터에 뿌려주는 것입니다.

 

public static void main(String[] args) {
    try {
        int input = 0;

        while ((input = System.in.read()) != -1) {
            System.out.println("input: " + input + ", (char)input: " + (char)input);
        }

    } catch (IOException e) {
        e.printStackTrace();
    }
}

hello
input: 104, (char)input: h
input: 101, (char)input: e
input: 108, (char)input: l
input: 108, (char)input: l
input: 111, (char)input: o
input: 10, (char)input:

콘솔 입력은 버퍼를 갖고 있기 때문에 backspace키를 이용해서 편집이 가능하며 한 번에 버퍼의 크기만큼 입력이 가능합니다. 그래서 Enter 나 '^D'('^Z')를 누르기 전까지는 아직 데이터가 입력 중인 것으로 간주되어 커서가 입력을 계속 기다리는 상태(블로킹 상태)에 머무르게 됩니다.

 

위의 결과에서 알 수 있듯이 Enter키를 누르는 것은 특수문자 '\n' (윈도우는 '\r' 과 '\n')이 입력된 것으로 간주됩니다. '\r'은 캐리지리턴(carriage return), 즉 커서를 현재 라인의 첫 번째 컬럼으로 이동시키고, '\n'은 커서를 다음 줄로 이동시키는 줄바꿈(new line)을 합니다.

 

여기서 한 가지 문제는 Enter키도 사용자입력으로 간주되어 매 입력마다 '\n'이 붙기 때문에 이 들을 제거해주어야 하는 불편함이 있다는 것입니다. 이러한 불편함을 제거하려면 전에  살펴본 것과 같이 System.in에 BufferedReader를 이용해서 readLine()을 통해 라인 단위로 데이터를 입력받으면 됩니다.

 

텍스트 기반의 사용자인터페이스 시대에 탄생한 C언어는 콘솔이 데이터를 입력받는 주요 수단이었지만, 자바가 탄생한 그래픽 기반의 사용자인터페이스 시대는 콘솔을 통해서 데이터를 입력받는 경우가 드물기 때문에 Java에서 콘솔을 통한 입력에 대한 지원이 미약했습니다. 나중에 Scanner와 Console같은 클래스가 추가되면서 많이 보완되었습니다.

 

표준 입출력의 대상변경 - setIn(), setOut(), setErr()

 

초기에는 System.in, System.out, System.err의 입출력 대상이 콘솔화면이지만, setIn(), setOut(), setErr()를 사용하면 입출력을 콘솔 이외에 다른 입출력 대상으로 변경하는 것이 가능합니다.

메서드	설명
static void setIn(InputStream in)	System.in의 입력을 지정한 InputStream으로 변경
static void setOut(PrintStream out)	System.out의 출력을 지정한 PrintStream으로 변경
static void setErr(PrintStream err)	System.err의 출력을 지정한 PrintStream으로 변경

 

그러나 JDK 5부터 Scanner클래스가 제공되면서 System.in으로부터 데이터를 입력받아 작업하는 것이 편리해졌습니다.

 

다음은 System.out의 출력 소스를 test.txt파일로 변경한 예제입니다.

public static void main(String[] args) {
    PrintStream ps = null;
    FileOutputStream fos = null;
    try {
        fos = new FileOutputStream("src/test.txt");
        ps = new PrintStream(fos);
        System.setOut(ps);
    } catch (IOException e) {
        e.printStackTrace();
    }
    System.out.println("HELLO WORLD");
}

 

RandomAccessFile

 

자바에서는 기본적으로 입력과 출력이 각각 분리되어 별도로 작업을 하도록 설계되어 있는데, RandomAccessFile만은 하나의 클래스로 파일에 대한 입력과 출력을 모두 할 수 있게 되어 있습니다.

위 그림에서 알 수 있듯이, InputStream이나 OutputStream으로부터 상속받지 않고, DataInput인터페이스와 DataOutput인터페이스를 모두 구현했기 때문에 읽기와 쓰기가 모두 가능합니다. 그리고 DataInputStream과 DataOutputStream처럼 RandomAccessFile 또한 기본형 단위로 데이터를 읽고 쓸 수 있습니다.

 

그래도 역시 RandomAccessFile클래스의 가장 큰 장점은 파일의 어느 위치에나 읽기/쓰기가 가능하다는 것입니다. 다른 입출력 클래스들은 입출력 소스에 순차적으로 읽기/쓰기를 하기 때문에 읽기와 쓰기가 제한적인데 반해서 RandomAccessFile클래스는 파일에 읽고 쓰는 위치에 제한이 없습니다.

 

이것을 가능하게 하기 위해서 내부적으로 파일 포인터를 사용하는데, 입출력 시에 작업이 수행되는 곳이 바로 파일 포인터가 위치한 곳이 됩니다. 파일 포인터의 위치는 파일의 제일 첫 부분(0부터 시작)이며, 읽기 또는 쓰기를 수행할 때마다 작업이 수행된 다음 위치로 자동으로 이동하게 됩니다. 그래서 순차적으로 읽기나 쓰기를 원한다면, 파일 포인터를 수동으로 이동시키지 않아도 되지만, 파일의 임의의 위치에 있는 내용에 대해 작업하고자 한다면, 먼저 파일 포인터를 원하는 위치로 옮겨야 합니다.

 

현재 작업 중인 파일에서 파일 포인터의 위치를 알고 싶을 때는 getFilePointer()를 사용하면 되고, 파일 포인터의 위치를 옮기기 위해서는 seek(long pos)나 skipBytes(int n)를 사용하면 됩니다.

모든 입출력에 사용되는 클래스들은 입출력 시 다음 작업이 이루어질 위치를 저장하고 있는 포인터(변수)를 내부적으로 갖고 있습니다. 다만 내부에서만 접근할 수 있기 때문에 외부에서 포인터 위치를 마음대로 변경할 수 없다는 것이 RandomAccessFile과 다른 점입니다.

 

생성자	설명
RandomAccessFile(String name, String mode)	파일 경로를 문자열로 받아 객체 생성	"r" : 읽기 전용 (읽기만 가능) "rw" : 읽기 + 쓰기 "rws" : 읽기 + 쓰기 + 내용 즉시 동기화 "rwd" : 읽기 + 쓰기 + 메타데이터 동기화
RandomAccessFile(File file, String mode)	File 객체를 받아 객체 생성

 

메서드	설명
FileChannel getChannel()	파일의 파일 채널 반환
FileDescriptor getFD()	파일 디스크립터 반환
long getFilePointer()	현재 포인터 위치 반환
void seek(long pos)	원하는 위치로 포인터 이동
long length()	파일 전체 크기 반환
void setLength(long newLength)	파일 크기 변경
int skipBytes(int n)	지정된 수만큼의 byte를 건너뜀

 

다음은 RandomAccessFile의 사용 예제입니다.

public static void main(String[] args) {
    try {
        RandomAccessFile raf = new RandomAccessFile("test.txt", "rw");

        raf.writeInt(100);
        raf.writeDouble(3.14);

        raf.seek(0);
        System.out.println(raf.readInt());
        System.out.println(raf.readDouble());

        raf.close();
    } catch (IOException e) {
        e.printStackTrace();
    }
}

 

한 가지 주의해야할 점은 'rw(읽기쓰기)'모드로 작업을 할 땐 write작업이 끝나고 read()작업을 하기 전에 seek(long pos)를 이용해서 파일 포인터의 위치를 다시 처음으로 이동시켜야 합니다. 그렇지 않으면 EOFException이 발생하게 됩니다.

 

File

 

파일은 기본적이면서 가장 많이 사용되는 입출력 대상이기 때문에 중요합니다. 자바에서는 File클래스를 통해서 파일과 디렉터리를 다룰 수 있도록 하고 있습니다. 그래서 File인스턴스는 파일 일 수도 있고 디렉터리일 수도 있습니다.

 

다음은 File의 생성자와 주요 메서드들 입니다.

생성자	설명
File(String pathname)	경로 문자열로 File 객체 생성
File(String parent, String child)	부모 경로 + 자식 경로
File(File parent, String child)	부모 File 객체 + 자식 경로
File(URI uri)	URI로부터 File 생성

부모 경로는 현재 파일을 포함하고 있는 상위 폴더의 경로이고, 자식 경로는 부모 경로 아래에 위치한 파일 이름을 의미합니다.

 

File 정보 조회 메서드	설명
String getName()	파일 이름 반환
String getPath()	경로 문자열 반환
String getAbsolutePath()	절대 경로 반환
File getAbsoluteFile()	절대 경로 File 객체
String getParent()	부모 경로 문자열
File getParentFile()	부모 File 객체
String getCanonicalPath()	정규 경로 반환
File getCanonicalFile()	정규 경로 File 객체
boolean exists()	존재 여부
boolean isFile()	일반 파일인가
boolean isDirectory()	디렉토리인가
boolean isHidden()	숨김 여부
long length()	파일 크기(byte)
long lastModified()	마지막 수정 시간(ms)

 

파일/디렉터리 생성 메서드	설명
boolean createNewFile()	새 파일 생성
static File createTempFile(String prefix, String suffix)	시스템 임시 폴더에 임시 파일 생성
static File createTempFile(String prefix, String suffix, File directory)	지정한 디렉토리에 생성
boolean mkdir()	디렉토리 하나 생성
boolean mkdirs()	중간 경로 포함 디렉토리 생성
boolean delete()	파일/폴더 삭제
void deleteOnExit()	JVM 종료 시 삭제
boolean renameTo(File dest)	지정된 파일(dest)로 이름 변경

 

파일 목록 조회 메서드	설명
String[] list()	파일 이름 배열
String[] list(FilenameFilter filter)	필터 조건 적용
File[] listFiles()	File 객체 배열
File[] listFiles(FileFilter filter)	필터 적용 File 배열

 

static 필드	타입	설명
public static final char separatorChar	char	이름 구분자 ('/' , '\\')
public static final String separator	String	이름 구분자 ("/" , "\\")
public static final char pathSeparatorChar	char	경로 구분자 (';' , ':')
public static final String pathSeparator	String	경로 구분자 (";" , ":")

 

위 표에서 알 수 있듯이 파일의 경로(path)와 디렉터리나 파일의 이름을 구분하는 데 사용되는 구분자가 OS마다 다를 수 있기 때문에, OS독립적으로 프로그램을 작성하기 위해서는 반드시 위의 멤버 변수들을 이용해야 합니다.

 

절대 경로(absolute path)는 파일 시스템의 루트(root)로부터 시작하는 파일의 전체 경로를 의미합니다. OS에 따라 다르지만, 하나의 파일에 대해 둘 이상의 절대 경로가 존재할 수 있습니다. 현재 디렉터리를 의미하는 '.' 와 같은 기호나 링크를 포함하고 있는 경우가 이에 해당합니다. 그러나 정규 경로(canonical path)는 기호나 링크등을 포함하지 않는 유일한 경로를 의미합니다.

 

시스템 속성 중에서 user.dir의 값을 확인하면 현재 프로그램이 실행 중인 디렉터리를 알 수 있습니다. 그리고 우리가 OS의 시스템 변수로 설정하는 classpath외에 sun.boot.class.path라는 시스템 속성에 기본적인 classpath가 있어서 기본적인 경로들은 이미 설정되어 있습니다. 그래서 처음에 JDK설치 후 classpath를 따로 지정해주지 않아도 되는 것입니다.

JDK 9부터 모듈이 도입되면서 sun.boot.class.path는 더이상 사용하지 않습니다.

 

한 가지 알아두어야 하는 것은 File인스턴스를 생성했다고 해서 파일이나 디렉터리가 생성되는 것은 아니라는 것입니다. 파일명이나 디렉터리명으로 지정된 문자열이 유효하지 않더라도 컴파일 에러나 예외를 발생시키지 않습니다. 새로운 파일을 생성하기 위해서는 File인스턴스를 생성한 다음, 출력 스트림을 생성하거나 createNewFile()을 호출해야 합니다.

 

FilenameFiler를 구현해서 `String[] list(FilenameFiter filter)`와 함께 사용하면 특정 조건에 맞는 파일의 목록을 얻을 수도 있습니다.

@FunctionalInterface
public interface FilenameFilter {
    boolean accept(File dir, String name);
}

 

그리고 createTempFile() 메서드를 사용하면 중복되지 않는 임시 파일을 간단하게 생성할 수 있습니다. 임시파일이 생성되는 곳은 지정할 수도 있지만, 지정하지 않으면 시스템 속성인 'java.io.tmpdir'에 지정된 디렉터리가 됩니다.

System.getProperty("java.io.tmpdir")로 임시 디렉터리의 위치를 확인할 수 있습니다.

 

 

직렬화(serialization)

 

직렬화(serialization)란 객체를 데이터 스트림으로 만드는 것을 뜻합니다. 다시 얘기하면 객체에 저장된 데이터를 스트림에 쓰기(write)위해 연속적인(serial) 데이터로 변환하는 것을 말합니다. 반대로 스트림으로부터 데이터를 읽어서 객체를 만드는 것을 역직렬화(deserialization)라고 합니다.

 

객체는 클래스에 정의된 인스턴스 변수의 집합입니다. 객체에는 클래스 변수나 메서드가 포함되지 않습니다. 객체는 오직 인스턴스 변수들로만 구성되어 있습니다. 객체를 생성하면 논리적으로 인스턴스 변수와 메서드가 함께 존재하지만, 객체의 실제 구현에는, 즉 물리적으로는 메서드가 포함되지 않습니다. 인스턴스 변수는 인스턴스마다 다른 값을 가질 수 있어야하기 때문에 별도의 메모리 공간이 필요하지만 메서드는 변하는 것이 아니라서 메모리를 낭비해 가면서 인스턴스마다 같은 내용의 코드(메서드)를 포함시킬 이유가 없기 때문입니다.

그래서 객체를 저장한다는 것은 바로 객체의 모든 인스턴스 변수의 값을 저장한다는 것과 같은 의미입니다. 어떤 객체를 저장하고자 한다면, 현재 객체의 모든 인스턴스 변수의 값을 저장하기만 하면 됩니다. 그리고 저장했던 객체를 다시 생성하려면, 객체를 생성한 후에 저장했던 값을 읽어서 생성한 객체의 인스턴스 변수에 저장하면 되는 것입니다.

 

클래스에 정의된 인스턴스 변수가 단순히 기본형일 때는 인스턴스 변수의 값을 저장하는 일이 간단하지만, 인스턴스 변수의 타입이 참조형일 때는 그리 간단하지 않습니다. 예를 들어 인스턴스 변수의 타입이 배열이라면 배열에 저장된 값들도 모두 저장되어야 할 것입니다. 그러나 우리는 객체를 어떻게 직렬화해야 하는지 전혀 고민할 필요가 없습니다. 다만 객체를 직렬화/역직렬화할 수 있는 ObjectInputStream과 ObjectOutputStream을 사용하는 방법만 알면 됩니다.

 

ObjectInputStream과 ObjectOutputStream

 

직렬화(스트림에 객체를 출력)에는 ObjectOutputStream을 사용하고 역직렬화(스트림으로부터 객체를 입력)에는 ObjectInputStream을 사용합니다. 

 

ObjectInputStream과 ObjectOutputStream은 각각 InputStream과 OutputStream을 직접 상속받지만 기반 스트림을 필요로 하는 보조 스트림입니다. 그래서 객체를 생성할 때 입출력(직렬화/역직렬화)할 스트림을 지정해주어야 합니다.

만일 파일에 객체를 저장(직렬화)하고 싶다면 다음과 같이 하면 됩니다.

FileOutputStream fos = new FileOutputStream("src/object.ser");
ObjectOutputStream out = new ObjectOutputStream(fos);

out.writeObject(new UserInfo());

위 코드는 'object.ser'이라는 파일에 UserInfo객체를 직렬화하여 저장합니다. 출력할 스트림(FileOutputStream)을 생성해서 이를 기반 스트림으로 하는 ObjectOutputStream을 생성합니다. ObjectOutputStream의 writeObject()를 사용해서 객체를 출력하면, 객체가 파일에 직렬화되어 저장됩니다.

 

역직렬화 방법 역시 간단합니다. 직렬화할 때와는 달리 입력 스트림을 사용하고 readObject()를 사용하여 저장된 데이터를 읽기만 하면 객체로 역직렬화됩니다. 다만 readObject()의 반환타입이 Object이기 때문에 객체 원래 타입으로 형변환을 해주어야 합니다.

FileInputStream fis = new FileInputStream("src/object.ser");
ObjectInputStream in = new ObjectInputStream(fis);

UserInfo info = (UserInfo)in.readObject();

 

 

직렬화 가능한 클래스 만들기 - Serializable, transient

 

직렬화가 가능한 클래스를 만드는 방법은 간단합니다. 직렬화하고자 하는 클래스가 java.io.Serializable인터페이스를 구현하도록 하면 됩니다. Serializable인터페이스는 아무런 내용도 없는 빈 인터페이스이지만, 직렬화를 고려해서 작성한 클래스인지 판단하는 기준됩니다.

public interface Serializable { }

 

만약 Serializable을 구현한 클래스를 상속받는다면, Serializable을 구현하지 않아도 직렬화가 가능합니다. 이 경우 조상 클래스에 정의된 인스턴스 변수들도 함께 직렬화됩니다.

 

한 가지 주의해야할 점은 모든 클래스의 최고 조상인 Object는 Serializable을 구현하지 않았기 때문에 직렬화할 수 없습니다. 그러나 Object타입 변수로 선언된 다른 클래스는 직렬화가 가능합니다.

public class UserInfo implements Serializable {
    ...
    Object obj = new Obejct();	// NotSerializableException
}


public class UserInfo implements Serializable {
    ...
    Object obj = new String("abc");	// 가능
}

직렬화 가능 여부는 인스턴스 변수 타입이 아니라 실제로 연결된 객체의 종류에 의해서 결정됩니다.

 

직렬화하고자 하는 객체의 클래스에 직렬화가 안되는 객체에 대한 참조를 포함하고 있다면, 제어자 transient를 붙여서 직렬화 대상에서 제외되록 할 수 있습니다. 또는 password와 같이 보안상 직렬화되면 안되는 값에 대해서 transient를 사용할 수 있습니다. 그리고 역직렬화시 transient가 붙은 인스턴스 변수의 값은 그 타입의 기본값으로 설정됩니다.

public class UserInfo implements java.io.Serializable {
    String name;
    transient String password;
    int age;
    transient Object obj = new Object();
    ...
}

 

커스텀 직렬화 / 역직렬화

ObjectInputStream과 ObjectOutputStream에는 readObject()와 writeObject()이외에도 여러 가지 타입의 값을 입출력할 수 있는 메서드를 제공합니다. 이 메서드들은 주로 직렬화와 역직렬화를 직접 구현할 때 사용되며, 그 중 defaultReadObject()와 defaultWriteObject()는 자동 직렬화를 수행합니다.

 

커스텀 직렬화를 하는 방법은 Serializable을 구현한 클래스에서 다음 두 메서드를 정의하면 됩니다.

private void writeObejct(ObjectOutputStream out)
private void readObject(ObjectInputStream in)

이때 메서드의 접근 제한자를 private으로 정의하는 것은 자바 직렬화 프로토콜의 규칙입니다.

 

다음과 같이 커스텀 직렬화를 정의할 수 있습니다.

class UserInfo implements Serializable {
    private String name;
    private transient String password;

    public UserInfo(String name, String password) {
        this.name = name;
        this.password = password;
    }

    private void writeObject(ObjectOutputStream out) throws IOException {
        out.defaultWriteObject();
        out.writeUTF(encrypt(password));
    }

    private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException {
        in.defaultReadObject();    
        this.password = decrypt(in.readUTF());
    }
}

패스워드를 직렬화 할 때 암호화를 하고 역직렬화 할 때 복호화를 하는 예제입니다.

 

직렬화 가능한 클래스의 버전 관리

 

직렬화된 객체를 역직렬화할 때는 직렬화 했을 때와 같은 클래스를 사용해야 합니다. 그러나 클래스의 이름이 같더라도 클래스의 내용이 변경된 경우 역직렬화는 실패하여 다음과 같은 예외가 발생합니다.

위 예외의 내용은 직렬화 할 때와 역직렬화 할 때의 클래스의 버전이 같아야 하는데 다르다는 것입니다. 객체가 직렬화될 때 클래스에 정의된 멤버들의 정보를 이용해서 serialVersionUID라는 클래스의 버전을 자동 생성해서 직렬화 내용에 포함됩니다. 그래서 역직렬화할 때 클래스의 버전을 비교함으로써 직렬화할 때의 클래스의 버전과 일치하는지 확인할 수 있는 것입니다.

 

그러나 static변수나 상수 또는 transient가 붙인 인스턴스 변수가 추가되는 경우에는 직렬화에 영향을 미치지 않기 때문에 클래스 버전을 다르게 인식하도록 할 필요는 없습니다. 네트워크로 객체를 직렬화하여 전송하는 경우, 보내는 쪽과 받는 쪽이 모두 같은 버전의 클래스를 가지고 있어야 하는데 클래스가 조금만 변경되어도 해당 클래스를 재배포하는 것은 프로그램을 관리하기 어렵게 만듭니다.

 

이럴 때는 클래스의 버전을 수동으로 관리해주면 됩니다.

class MyData implements java.io.Serializable {
    static final long serialVersionUID = 3518731767529258119L;
    int value;
}

이렇게 클래스 내에 serialVersionUID를 정의해주면, 클래스의 내용이 바뀌어도 클래스의 버전이 자동 생성된 값으로 변경되지 않습니다.

 

serialVersionUID의 값은 정수값이면 어떠한 값으로도 지정할 수 있지만 서로 다른 클래스간에 같은 값을 갖지 않도록 `serialver.exe` 를 사용해서 생성된 값을 사용하는 것이 보통입니다. 다만 serialver가 작동하기 위해서는 해당 클래스가 컴파일되어 .class 파일이 존재해야 합니다.

serialver은 JDK 기본적으로 포함되어 있습니다.