입출력(I/O)(2) - 직렬화(Serialization)

1. 직렬화 개념 🏓

  직렬화(Serialization)란 객체를 데이터 스트림으로 만드는 것을 말한다. 즉, 현재 데이터(structure, object)의 상태를 영속적으로 저장하거나 다른 환경으로 전달(네트워크 통신 등) 하기 위해 어떠한 정해진 포맷으로 변환하는 과정이다. 변환된 데이터를 다시 원래 데이터로 변환하는 과정은 역직렬화(Deserialization)이라고 한다. 

// 직렬화를 하지 않은 경우
public class User{
	
	private String name;
	private String id;
	String password;
	
	public User(String name, String id, String password) {
		this.name = name;
		this.id = id;
		this.password = password;
	}

	@Override
	public String toString() {
		return "User [name=" + name + ", id=" + id + ", password=" + password + "]";
	}
}


public class Main {
	
	private static File target = new File("C:" + File.separator + "Amenable" + File.separator + "User.dat");
	
	public static void main(String[] args) throws IOException {
		write();
	}

	private static void write() {
		User user = new User("이바다", "Amenable", "1234");
		
		try(ObjectOutputStream objOut = new ObjectOutputStream(new FileOutputStream(target))){
			objOut.writeObject(user); // Error
			System.out.println("저장 완료");
		} catch (IOException e) {
			e.printStackTrace();
		}
	}
	
	private static void read() {
		try(ObjectInputStream objIn = new ObjectInputStream(new FileInputStream(target))){
			Object obj = objIn.readObject();
			if(obj instanceof User) {
				User user = (User) obj;
				System.out.println(user);
			}
		} catch (Exception e) {
			e.printStackTrace();
		}
	}
}

  위의 코드는 직렬화를 진행하지 않고 데이터를 저장하는 코드이다. 실행시켜 보면, "java.io.NotSerializableException"라는 에러메시지가 나온다. 즉, 객체를 통신 및 저장하기 위해선 반드시 직렬화를 구현해야 한다.

 

2. 직렬화하는 방법 🏸

  직렬화를 하는 방법은 간단하다. 직렬화하고자 하는 클래스가 java.io.Serializable인터페이스를 구현하도록 하면 된다. 만약 보안상 직렬화하면 안 되는 값이 있다면 transient를 붙일 수 있다. 그러면 인스턴스변수의 값은 그 타입의 기본값으로 지정된다. 

// 직렬화를 한 경우
public class User implements Serializable {
	private String name;
	private String id;
	transient String password; // 타입의 기본값으로 직렬화 진행
	
	public User(String name, String id, String password) {
		this.name = name;
		this.id = id;
		this.password = password;
	}

	@Override
	public String toString() {
		return "User [name=" + name + ", id=" + id + ", password=" + password + "]";
	}
}

public class Main {
	
	private static File target = new File("C:" + File.separator + "Amenable" + File.separator + "User.dat");
	
	public static void main(String[] args) throws IOException {
		write();
		read();
	}

	private static void write() {
		User user = new User("이바다", "Amenable", "1234");
		
		try(ObjectOutputStream objOut = new ObjectOutputStream(new FileOutputStream(target))){
			objOut.writeObject(user);
			System.out.println("저장 완료");
		} catch (IOException e) {
			e.printStackTrace();
		}
	}
	
	private static void read() {
		try(ObjectInputStream objIn = new ObjectInputStream(new FileInputStream(target))){
			Object obj = objIn.readObject();
			if(obj instanceof User) {
				User user = (User) obj;
				System.out.println(user);
			}
		} catch (Exception e) {
			e.printStackTrace();
		}
	}
}

// 저장 완료
// User [name=이바다, id=Amenable, password=null]

  만약 Serializable을 구현한 클래스를 상속받는다면 Serializable을 구현하지 않아도 된다.

public class User implements Serializable {
    int id;
    String name;
}

public class SubUser extends User {
	int country;
}

  직렬화하고자 하는 클래스에 직렬화되지 않은 객체가 있다면 주의가 필요하다. 간단하게는 위에서 살펴본 것처럼 transient를 사용해서 직렬화 대상에서 제외를 하면 된다. 하지만 해당 객체 또한 저장해야 하는 값이라면 해당 객체는 Serializable을 구현해야 한다.

// 방법1
public class User implements Serializable {
    private String name;
    transient SubUser subUser = new SubUser();
}

// 방법2 
public class User implements Serializable {
    private String name;
    SubUser subUser = new SubUser();
}
public class SubUser implements Srializable {
	private String id;
}

 

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

  위의 예제에서 User에 국가(country)를 추가한다고 생각해 보자.

public class User implements Serializable {

	private String name;
	private String id;
	transient String password;
	private String country;
	
	public User(String name, String id, String password, String country) {
		this.name = name;
		this.id = id;
		this.password = password;
		this.country = country;
	}
	
	@Override
	public String toString() {
		return "User [name=" + name + ", id=" + id + ", password=" + password + ", country=" + country + "]";
	}
}

  그 후, read()를 통해서 값을 읽어오면 어떻게 되어야 할까? 일단 name, id, password(기본값이라도 값이 있다고 생각하자)은 이전에 저장해 놓았으니깐 그걸 불러오면 되고, country는 아직 저장하지 않았으니깐 null로 온다고 생각된다. 하지만 실제 실행시켜 보면
"java.io.InvalidClassException: test.User; local class incompatible: stream classdesc serialVersionUID = 2429090748191540600, local class serialVersionUID = 2845618176141831242"
이 나오게 된다. serialVersionUID가 일치하지 않는다는 것이다. 해결책부터 먼저 말하자면 serialVerisonUID를 설정해주어야 한다.

  serialVersionUID란 클래스의 변경 여부를 파악하기 위한 유일 키이다. 직렬화되는 객체에 serialVersionUID가 설정되지 않았을 경우 컴파일러가 자동으로 생성한다. 위의 예에서는 country로 인한 변경으로 인해 컴파일 시에 자동으로 새로운 serialVersionUID를 할당받았다.

  그래서 직렬화되는 객체에 대해서 serialVersionUID를 설정해 준다면 문제가 해결된다.

// serialVersionUID를 설정하고 write()를 통해 저장
public class User implements Serializable {

	private static final long serialVersionUID = 2429090748191540600L;
	private String name;
	private String id;
	transient String password;
	
	public User(String name, String id, String password) {
		this.name = name;
		this.id = id;
		this.password = password;
	}

	@Override
	public String toString() {
		return "User [name=" + name + ", id=" + id + ", password=" + password + "]";
	}
}

public class Main {
	
	private static File target = new File("C:" + File.separator + "Amenable" + File.separator + "User.dat");
	
	public static void main(String[] args) throws IOException {
		write();
	}

	private static void write() {
		User user = new User("이바다", "Amenable", "1234");
		
		try(ObjectOutputStream objOut = new ObjectOutputStream(new FileOutputStream(target))){
			objOut.writeObject(user);
			System.out.println("저장 완료");
		} catch (IOException e) {
			e.printStackTrace();
		}
	}
}

// User클래스에 country 추가
public class User implements Serializable {

	private static final long serialVersionUID = 2429090748191540600L;
	private String name;
	private String id;
	transient String password;
	private String country;
	
	public User(String name, String id, String password, String country) {
		this.name = name;
		this.id = id;
		this.password = password;
		this.country = country;
	}
	
	@Override
	public String toString() {
		return "User [name=" + name + ", id=" + id + ", password=" + password + ", country=" + country + "]";
	}
}

public class Main {
	
	private static File target = new File("C:" + File.separator + "Amenable" + File.separator + "User.dat");
	
	public static void main(String[] args) throws IOException {
		read();
	}
	
	private static void read() {
		try(ObjectInputStream objIn = new ObjectInputStream(new FileInputStream(target))){
			Object obj = objIn.readObject();
			if(obj instanceof User) {
				User user = (User) obj;
				System.out.println(user);
			}
		} catch (Exception e) {
			e.printStackTrace();
		}
	}
}

// User [name=이바다, id=Amenable, password=null, country=null]

  serialVersionUID를 설정한 후 클래스가 변경되면 우리가 예상한 것처럼 값을 가져올 수 있다.(User [name=이바다, id=Amenable, password=null, country=null])

  그러나 static변수나 상수 또는 transient가 붙은 인스턴스 변수가 추가되는 경우에는 직렬화에 영향을 미치지 않기 때문에 클래스의 버전을 다르게 인식하도록 할 필요는 없다. 

 

해당 글은 남궁 성님의 Java의 정석을 읽고 작성한 것입니다.