Serializable 객체직렬화

기존에 개발되어 있는 소스 코드를 보다 보니 implements java.io.Serializable과 같이 Serializable 인터페이스를 구현하는 VO(Value Object) 클래스들이 많이 보인다.

혹시 RMI(Remote Method Invocation) 통신이나 네트웍 통신을 할 때 직렬화를 사용하여 연동을 하나? 싶었지만 아니였다.

원인을 알고 싶었지만 개발된지 이미 5년이 넘은 시스템이고, 개발자는 5대째 계승되고 있는 시점이다.

결국 Serializable interface가 왜 구현되어 있는지는 모르겠지만 아마 습관적으로 붙이지 않았나 싶다.

이런 코드를 보니 나 조차도 Serializable에 대해 자세히 알고 있나라는 생각을 가지게 되었고, 한번쯤은 정리를 해봄으로써 확실히 알아가는 것이 좋을 것 같다.

직렬화란?

JVM 힙 영역에 존재하는 객체를 한 줄로 늘어선 바이트의 형태로 만드는 것을 객체의 직렬화라고 하고, 객체의 형태로 복원하는 작업을 역직렬화라고 한다.

java.io.Serializabe 인터페이스를 보면 구현해야 하는 메소드가 없다. 그 이유는 Serializable 인터페이스를 구현한 구현체가 직렬화 대상이다라는 것을 JVM에게 알려주는 역할만을 하기 때문이다.

다음은 Serializable, Externalizable 인터페이스를 이용한 샘플 코드이다.

Serializable 인터페이스를 이용하여 객체 직렬화 시 static, transient로 선언되어 있는 필드는 제외되는 반면에 Externalizable 인터페이스를 이용하여 객체 직렬화 시에는 writeExternal, readExternal 메소드를 구현하여 직렬화 대상의 필드를 직접 지정한다. 만약 name,age 순으로 직렬화 하여 write 한다면 read 시에도 name,age 순으로 역직렬화를 해와야 한다는 것을 알아야 한다. 순서를 지키지 않는 다면 java.io.EOFException 예외가 발생한다.

마지막으로 객체 직렬화 시 serialVersionUID가 Serializable 인터페이스를 구현한 클래스에 선언되어 있어야 한다. 명시적으로 선언하지 않았다면 JVM에서 자동 생성해 준다.

serialVersionUID가 필요한 이유는 무엇일까?

직렬화 과정에서 serialVersionUID의 버전이 포함되게 되고, 역직렬화 과정에서 java class에 선언되어 있는 serialVersionUID의 버전과 서로 동일한지 체크를 하게 된다.

serialVersionUID 버전 체크를 하는 이유는?

버전이 바뀌게 되면 객체의 상태가 바뀌었다는 것과 같은 의미이고, 결국 역직렬화 과정에서 오류가 발생하기 때문이다.

 

버전이 맞지 않으면 다음과 같은 예외 발생

java.io.InvalidClassException: serializable.AdminUser; local class incompatible: stream classdesc serialVersionUID = 1, local class serialVersionUID = 3

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115

package serializable;   import static org.hamcrest.CoreMatchers.*; import static org.junit.Assert.*;   import java.io.Externalizable; import java.io.File; import java.io.FileInputStream; import java.io.FileOutputStream; import java.io.IOException; import java.io.ObjectInput; import java.io.ObjectInputStream; import java.io.ObjectOutput; import java.io.ObjectOutputStream; import java.io.Serializable;   import lombok.Data;   import org.junit.Before; import org.junit.Test;   public class Serializer {   private String filePath; private String externalFilePath; private User user; private AdminUser adminUser;   @Before public void init() { filePath = "E:\\test\\serializable\\user.ser"; externalFilePath = "E:\\test\\serializable\\adminUser.ser";   user = new User(); user.setName("kyu"); user.setAge(32); user.setSocialNumber("222222-1111111");   adminUser = new AdminUser(); adminUser.setName("adminKyu"); adminUser.setAge(33); user.setSocialNumber("121212121-121212121"); }   @Test public void 객체직렬화테스트() throws IOException { FileOutputStream fos = new FileOutputStream(filePath); ObjectOutputStream oos = new ObjectOutputStream(fos); oos.writeObject(user); oos.close();   assertThat(true, is(new File(filePath).isFile())); }   @Test public void 객체역질렬화테스트() throws IOException, ClassNotFoundException { FileInputStream fis = new FileInputStream(filePath); ObjectInputStream ois = new ObjectInputStream(fis); User user = (User) ois.readObject(); ois.close();   assertThat("kyu", is(user.getName())); assertThat(32, is(user.getAge())); assertThat(null, is(user.getSocialNumber())); }   @Test public void externalWrite() throws IOException { FileOutputStream fos = new FileOutputStream(externalFilePath); ObjectOutputStream oos = new ObjectOutputStream(fos); oos.writeObject(adminUser); oos.close();   assertThat(true, is(new File(externalFilePath).isFile())); }   @Test public void externalRead() throws IOException, ClassNotFoundException { FileInputStream fis = new FileInputStream(externalFilePath); ObjectInputStream ois = new ObjectInputStream(fis); AdminUser adminUser = (AdminUser) ois.readObject();   assertThat("adminKyu", is(adminUser.getName())); assertThat(33, is(adminUser.getAge())); assertThat(null, is(adminUser.getSocialNumber())); } }   @Data class User implements Serializable { private static final long serialVersionUID = 1L; private String name; private int age; private transient String socialNumber; }   @Data class AdminUser implements Externalizable { private static final long serialVersionUID = 1L; private String name; private int age; private String socialNumber;   @Override public void writeExternal(ObjectOutput out) throws IOException { out.writeObject(name); out.writeInt(age); }   @Override public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException { this.name = (String) in.readObject(); this.age = in.readInt(); } }

view rawSerializer.java hosted with ❤ by GitHub