JAVA의 객체 직렬화(Serialization)와 JSON 직렬화

JAVA의 객체 직렬화(Serialization)와 JSON 직렬화

📝 다루는 내용

• 직렬화와 역직렬화의 개념
• ObjectInputStream과 ObjectOutputStream
• Serializable
• transient
• 직렬화/역직렬화의 구현
• serialVersionUID
• Jackson을 이용한 JSON 직렬화

 

직렬화, 역직렬화란?

직렬화
- 객체에 저장된 데이터를 I/O 스트림에 쓰기(출력) 위해 연속적인(serial) 데이터로 변환하는 것

역직렬화
- I/O 스트림에서 데이터를 읽어서(입력) 객체를 만드는 것

자바에서 직렬화와 역직렬화는 객체를 파일로 저장하거나 네트워크를 통해 전송하기 위해 제공되는 기능이다.
객체는 '인스턴스 변수의 집합'이므로 객체를 저장/전송하는 것은 객체의 인스턴스 변수의 값을 저장/전송하는 것과 동일하다.

궁극적으로 객체의 직렬화는 서드파티에서 객체를 사용하기 위한 것이다.

객체 직렬화는 JVM에서 자바 객체를 내보내는(출력하는) 간단한 방법이다. 직렬화된 객체는 파일로 저장하거나, 네트워크로 전송하거나, 다른 I/O 인터페이스에 내보낼 수 있다.

 

ObjectInputStream과 ObjectOutputStream

자바에서는 객체의 직렬화, 역직렬화를 위해 ObjectInputStream과 ObjectOutputStream을 제공한다.

객체를 스트림에 쓰거나(출력) 읽는 기능(입력)을 제공하는 보조스트림(기반스트림 필요)

ObjectOutputStream extends OutputStream
- 직렬화 : 스트림에 객체를 출력하기 위해 사용
- writeObject()

ObjectInputStream extends InputStream
- 역직렬화 : 스트림으로부터 객체를 입력받기 위해 사용
- readObject() : Object로 리턴되므로 형변환 필요

writeObject()/readObject()뿐만 아니라 primitive(기본, 원시) 타입에 대응하는 메소드도 제공됨

 

참고로 또 다른 보조 스트림 중 DataInputStream/DataOutputStream은 Object 타입을 제외하고 writeByte(), wirteChar(), writeUTF()나 readByte(), readChar(), readUTF()와 같이 기본적인 데이터 타입을 유지하며 읽거나 쓰는 기능을 제공하는데, 직렬화의 기반 개념이 된 스트림이다.

 

객체 직렬화, 역직렬화의 간단한 예제

// 객체를 직렬화하여 파일에 저장
ObjectOutputStream oos = new ObjectOutputStream(new FileOutputStream("objectfile.ser"));
oos.writeObject(new Member());

// 파일로부터 객체를 읽어 객체 생성
ObjectInputStream ois = new ObjectInputStream(new FileInputStream("objectfile.ser"));
Member member = (Member) ois.readObject();  // Object로 리턴되므로 명시적 형변환 필요

 

Serializable

java.io.Serializable 인터페이스를 구현한 클래스만 객체를 직렬화할 수 있다.

Serializable 인터페이스는 구현해야하는 메소드가 없는, 객체의 직렬화를 명시하는 용도의 마크 인터페이스이다.

다음은 상속(is-a), 포함(has-a) 관계에서의 직렬화 조건(문법)을 정리한 것이다.

Serializable 인터페이스는 JVM에게 이 클래스가 직렬화될 수 있다는 것을 알려주는 역할을 한다.

📝 상속(is-a)
부모 클래스가 Serializable을 구현하면
- 자식 클래스는 항상 직렬화가 가능하다.
- 자식 클래스를 직렬화하면 부모 클래스의 인스턴스 변수도 함께 직렬화된다.

자식 클래스만 Serializable을 구현하면
- 부모 클래스의 인스턴스 변수는 직렬화되지 않는다.
- 부모 클래스의 인스턴스 변수도 직렬화 대상에 포함하려면 두 가지 방법이 있다.
1. 조상 클래스가 Serializable을 구현한다.
2. 직렬화 코드를 직접 구현한다.

📝 포함(has-a)
클래스가 직렬화할 수 없는 객체를 인스턴스 변수로 참조하고 있으면(변수 타입이 아닌 실제 객체의 타입에 의해 결정됨)
- 직렬화 불가(NotSerializableException)
- 직렬화 불가한 인스턴스 변수에는 transient를 붙여 제외하고 직렬화 가능

 

transient

위와 같이 직렬화하려는 클래스에 직렬화할 수 없는 객체를 포함하고 있으면 transient를 붙여 직렬화 대상에서 제외하고 직렬화할 수 있다.

- 직렬화 대상에서 제외
- transient 필드는 역직렬화 시 null(참조형) 또는 타입의 기본값으로 반환된다.

public class Member implements Serializable {
    
    String name;
    transient String password;  // 직렬화 대상에서 제외되어 직렬화 시 null 처리
}

 

직렬화와 ArrayList

직렬화 순서와 역직렬화 작업 순서를 일치시켜야 하기 때문에(객체 a, b c를 직렬화하면 역직렬화시에도 a, b, c 순으로 수행) 많은 객체를 직렬화할 때는 순서를 신경쓰지 않아도 되는 ArrayList와 같은 컬렉션에 담아 직렬화하는 것이 좋다.

 

// 개별 직렬화, 역직렬화
ObjectOutputStream oos = new ObjectOutputStream(new FileOutputStream("serialize_test.ser"));
oos.writeObject(new Member("Kate", 30, "1234"));
oos.writeObject(new Member("Jason", 23, "5678"));
oos.writeObject(new Member("Aaron", 35, "9012"));

ObjectInputStream ois = new ObjectInputStream(new FileInputStream("serialize_test.ser"));
System.out.println(ois.readObject());
System.out.println(ois.readObject());
System.out.println(ois.readObject());

System.out.println("==========================================");

// ArrayList에 담아 직렬화
List<Member> memberList = new ArrayList<>();
memberList.add(new Member("Kate", 30, "1234"));
memberList.add(new Member("Jason", 23, "5678"));
memberList.add(new Member("Aaron", 35, "9012"));

oos.writeObject(memberList);
System.out.println(ois.readObject());

🖥 실행 결과

Member{id=1001, name='Kate', age=30, password='null'}
Member{id=1002, name='Jason', age=23, password='null'}
Member{id=1003, name='Aaron', age=35, password='null'}
==========================================
[Member{id=1004, name='Kate', age=30, password='null'}, Member{id=1005, name='Jason', age=23, password='null'}, Member{id=1006, name='Aaron', age=35, password='null'}]

 

직렬화/역직렬화 직접 구현하기

ObjectOutputStream의 writeObject(), ObjectInputStream의 readObject()를 사용하면 간단하게 객체를 직렬화, 역직렬화할 수 있지만 부모 클래스의 인스턴스 변수는 직렬화되지 않는다는 제약 사항이 있다. 부모 클래스의 인스턴스 변수도 함께 직렬화하려면 Serializable을 구현한 자식 클래스에 writeObject(), readObject()를 선언하여 구현해야 한다.

 

private void writeObject(ObjectOutputStream oos) throws IOException {

    // 부모 직렬화
    oos.writeUTF(부모 클래스의 인스턴스 변수 이름);       // String
    oos.writeInt(부모 클래스의 인스턴스 변수 이름);       // int
    oos.writeDouble(부모 클래스의 인스턴스 변수 이름);    // double
    ...
    
    // 자기 자신 직렬화
    oos.defaultWriteObject();
}

private void readObject(ObjectInputStream ois) throws IOException, ClassNotFoundException {

    // 부모 역직렬화
    부모 클래스의 인스턴스 변수 이름 = ois.readUTF();     // String
    부모 클래스의 인스턴스 변수 이름 = ois.readInt();     // int
    부모 클래스의 인스턴스 변수 이름 = ois.readDouble();  // double
    ...
    
    // 자기 자신 직렬화
    ois.defaultReadObject();
}

 

serialVersionUID - 클래스 버전관리

- 직렬화 수행 시 클래스 정보를 가지고 자동으로 생성되는 클래스의 버전 값
- 역직렬화 수행 시 이 값을 비교해서 일치해야함
- 다를 경우 InvalidClassException 발생
- 직렬화에 영향이 없는 static 변수나 transient 변수 추가 시 InvalidClassException 방지 필요
- 이를 위해 직렬화 클래스에 serialVersionUID를  직접 정의
- 직접 정의하면 자동으로 생성하지 않고 이를 사용함
- 보통 jdk에 포함된 serialver 바이너리를 사용해서 생성

 

serialver를 사용한 serialVersionUID의 생성 예

 

JSON 직렬화, 역직렬화

지금까지는 객체 직렬화를 JVM과 ObjectInputStream/ObjectOutputStream에 위임하는 방식이었지만 XML, JSON과 같은 포맷을 이용한 직렬화도 가능하다. 이로 인한 장점은 다른 환경, 다른 언어로 만들어진 어플리케이션과도 통신이 가능해진다는 것이다.

 

JSON 파싱, 처리 라이브러리를 사용하여 자바 객체를 JSON으로 직렬화하거나 JSON 데이터를 자바 객체로 역직렬화할 수 있다. 여기서는 Jackson을 사용한다.

 

(1) Object to JSON(직렬화)

 

pom.xml

<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.11.1</version>
</dependency>

 

java

List<Member> memberList = new ArrayList<>();
memberList.add(new Member("Kate", 30, "1234"));
memberList.add(new Member("Jason", 23, "5678"));
memberList.add(new Member("Aaron", 35, "9012"));

ObjectMapper mapper = new ObjectMapper();

// object to json
mapper.configure(MapperFeature.PROPAGATE_TRANSIENT_MARKER, true);
mapper.writeValue(new File("test.json"), memberList);

 

test.json

[
  {
    "id": 1001,
    "name": "Kate",
    "age": 30
  },
  {
    "id": 1002,
    "name": "Jason",
    "age": 23
  },
  {
    "id": 1003,
    "name": "Aaron",
    "age": 35
  }
]

 

(2) JSON to Object(역직렬화)

java

ObjectMapper mapper = new ObjectMapper();

// json to object
mapper.configure(MapperFeature.PROPAGATE_TRANSIENT_MARKER, true);
mapper.writeValue(new File("test.json"), memberList);
System.out.println(mapper.readValue(new File("test.json"), new ArrayList<Member>().getClass()));

 

configure()는 transient 처리를 위해 추가한 코드이다.

필드에 직접 @JsonIgnore 애노테이션을 붙여도 된다.

 

🖥 실행 결과

[{id=1001, name=Kate, age=30}, {id=1002, name=Jason, age=23}, {id=1003, name=Aaron, age=35}]

Process finished with exit code 0