item89. 인스턴스 수를 통제해야 한다면 readResolver보다는 열거 타입을 사용하라

public class Elvis {
	public static final Elvis INSTANCE = new Elvis();

	private Elvis() {...}
    
    public void leaveTheBuilding() {...}
}

 

바깥에서 생성자를 호출하지 못하게 막는 방식으로 인스턴스가 오직 하나만 만들어짐을 보장하는 싱글턴 패턴의 예이다.

하지만 implements Serializable을 추가하는 순간 역직렬화시 readObject 사용하며 이 클래스가 초기화될 때 만들어진 인스턴스와는 별개인 인스턴스를 반환하게 된다.

 

readResolve 기능을 이용하여 역직렬화 후 새로 생성된 객체를 인수로 이 메서드가 호출되고, 이 메서드가 원래 1개만 만들어져 있는  객체를 반환해 새로 생성된 객체는 참조가 해제되어 가비지 컬렉션 대상이 된다.

private object readResolve(){
	// 진짜 Elvis를 반환하고, 새로 생성된 Elvis는 가비지 컬렉터에 맡긴다.
	return INSTANCE;
}

 

Elvis 인스턴스의 직렬화 형태는 아무런 실 데이터를 가질 이유가 없으니 모든 인스턴스 필드를 transient로 선언해야한다.

readResolve를 인스턴스 통제 목적으로 사용한다면 객체 참조 타입 인스턴스 필드는 모두 transient로 선언해야한다.

그렇지 않으면 readResolve 메서드가 수행되기 전에 역직렬화된 객체의 참조를 공격할 여지가 남는다.

 

다소 복잡한 공격방법으로 싱글턴이 transient가 아닌 참조 필드를 가지고 있다면 그 필드의 내용은 readResolve 메서드가 실행되기 전에 역직렬화된다. 잘 조작된 스트림을 써서 해당 참조 필드의 내용이 역직렬화되는 시점에 그 역직렬화된 인스턴스의 참조를 훔쳐올 수 있다.

 

readResolve 메서드와 인트선스 필드 하나를 포함한 도둑 클래스를 작성한다.

이 인스턴스 필드는 도둑이 숨길 직렬화된 싱글턴을 참조하는 역할을 한다.

직렬화된 스트림에서 싱글턴의 비휘발성 필드를 이 도둑의 인스턴스로 교체한다.

이제 싱글턴은 도둑을 참조하고 도둑은 싱글턴을 참조하는 순환고리가 만들어 졌다.

 

싱글턴이 도둑을 포함하므로 싱글턴이 역직렬화될 때 도둑의 readResolve 메서드가 먼저 호출되어 도둑의 인스턴스 필드에는 역직렬화 도중인 싱글턴의 참조가 담겨있게 된다.

도둑의 readResolve 메서드는 이 인스턴스 필드가 참조한 값을 정적필드로 복사하여 readResolve가 끝난 후에도 참조할 수 있도록 하고 원래 필드 타입에 맞는 값을 반환한다.

이 과정을 생략하면 직렬화 시스템이 도둑의 참조를 이 필드에 저장할 때 ClassCastException이 난다.

 

이해가 잘 안갔지만 Elvis의 favoriteSongs 필드가 String[]이 아닌 ElvisStealer 타입으로 만들어낸 바이트 스트림으로 가공하여 역직렬화시 ElvisStealer 객체를 포함하고 있어 그 객체의 readResolve가 호출된다고 일단 생각하였다.

 

 

이 프로그램을 실행하면 다음의 결과를 출력하여 서로 다른 2개의 Elvis 인스턴스를 생성할 수 있음을 증명했다.

 

[Hound Dog, Heartbreaker Hotel]
[A Fool Such as I}

 

 

Enum 사용

favoritesong 필드를 transient로 선언하여 이 문제를 고칠 수 있지만 Elvis를 원소 하나짜리 열거 타입으로 바꾸는 편이 더 났다.

ElvisStealer 공격으로 보여줬듯 readResolve 메서드를 사용해 순간적으로 만들어진 역직렬화된 인스턴스에 접근하지 못하게 만드는 방법은 깨지기 쉽고 신경을 많이써야한다.

 

직렬화 가능한 인스턴스 통제 클래스를 열거 타입을 이용해 구현하면 선언한 상수 외의 다른 객체는 존재하지 않음을 자바가 보장해준다.

 

 

인스턴스 통제를 위해 readResolve를 사용하는 방식이 완전히 쓸모없는 것은 아니다. 직렬화 가능 인스턴스 통제 클래스를 작성해야 하는데, 컴파일 타임에는 어떤 인스턴스들이 있는지 알 수 없는 상황이라면 열거 타입으로 표현하는 것이 불가능하기 때문이다.

 

readResolve 메서드의 접근성은 매우 중요하다. final 클래스에서라면 readResolve 메서드는 private여야 한다.

final이 아닌 클래스에서는 private로 선언하면 하위클래스에서 사용할 수 없다.

package-private로 선언하면 같은 패키지에 속한 하위 클래스에서만 사용할 수 있다.

protected나 public으로 선언하면 이를 재정의하지 않은 모든 하위 클래스에서 사용할 수 있다.

protected나 public 이면서 하위 클래스에서 재정의하지 않았다면 하위 클래스의 인스턴스를 역직렬화 하면 상위 클래스의 인스턴스를 생성하여 ClassCastException을 일으킬 수 있다.

 

 

핵심정리

불변식을 지키기 위해 인스턴스를 통제해야 한다면 가능한 한 열거 타입을 사용하자. 여의치 않은 상황에서 직렬화와 인스턴스 통제가 모두 필요하다면 readResolve 메서드를 작성해 넣어야 하고, 그 클래스에서 모든 참조 타입 인스턴스 필드를 transient로 선언해야 한다.