[Effective Java] 아이템 89. 인스턴스 수를 통제해야 한다면 readResolve 보다는 열거 타입을 사용하라

EFFECTIVE JAVA(이펙티브 자바)

 

이 포스팅에서 작성하는 내용은 EFFECTIVE JAVA(이펙티브자바) 에서 발췌하였습니다.

---

아이템 89. 인스턴스 수를 통제해야 한다면 readResolve 보다는 열거 타입을 사용하라

 

ex 1) 생성자 호출을 막은 싱글턴 패턴 예시

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

    public void leaveTheBuilding() { ... }
}

• 이 클래스는 바깥에서 생성자를 호출하지 못하게 막는 방식(private)으로 인스턴스가 오직 하나만 만들어짐을 보장했다.
• 아이템 3에서 이야기했듯 이 클래스는 선언에 implements Serializable을 추가하는 순간 싱글턴이 아니게 된다.
• 기본 직렬화를 쓰지 않더라도, 명시적인 readObject를 제공하더라도 싱글턴이 아니다.
• 어떤 readObject를 사용하든간에 이 클래스가 초기화될 때 만들어진 인스턴스와는 별개의 인스턴스를 반환하게 된다.

 

 

readResolve

• readObject가 만들어낸 인스턴스를 다른 것으로 대체할 수 있다.
• 역직렬화한 객체의 클래스가 readResolve 메서드를 적절히 정의해뒀다면, 역직렬화 후 새로 생성된 객체를 인수로 이 메서드가 호출되고, 이 메서드가 반환한 객체 참조가 새로 생성된 객체를 대신해 반환된다.
• 대부분의 경우 이 때 새로 생성된 객체의 참조는 유지하지 않으므로 GC의 대상이 된다.

 

 

ex 2) Serializable을 구현한 Elvis의 readResolve 메서드를 이용한 예시

private Object readResolve() {
    // 진짜 Elvis를 반환하고, 가짜는 알아서 GC에 맡겨짐
    return INSTANCE;
}

• 이 메서드는 역직렬화한 객체는 무시하고 클래스 초기화 때 만들어진 Elvis 인스턴스를 반환한다.
• Elvis 인스턴스 직렬화 형태는 실 데이터를 가질 이유가 없으니 모든 인스턴스 필드를 transient로 선언해야 한다.
• **사실, readResolve를 인스턴스 통제 목적으로 사용한다면 객체 참조 타입 인스턴스 필드는 모두 transient로 선언해야 한다. (**그렇지 않으면 아이템 88에서 언급한 공격을 받을 수 있다.)
• 공격 방법
  • 싱글턴이 transient가 아닌 참조 필드를 가지고 있다면, 그 필드의 내용은 readResolve 메서드가 실행되기 전에 역직렬화 된다.
  • 그렇다면 잘 조작된 스트림을 써서 해당 참조 필드의 내용이 역직렬화되는 시점에 그 역직렬화된 인스턴스의 참조를 훔쳐올 수 있다.

 

 

해결 방법 - 열거 타입

• 직렬화 가능한 인스턴스 통제 클래스를 열거 타입을 이용해 구현하면 선언한 상수 외의 다른 객체는 존재하지 않음을 자바가 보장해준다.
• 물론 공격자가 AccessibleObject.setAccessible 같은 특권 메서드를 악용한다면 이야기가 달라진다.
  (임의의 네이티브 코드를 수행할 수 있는 특권을 가로챈 공격자에게는 모든 방어가 무력화된다.)

 

 

ex 3) 위의 Elvis 를 열거 타입으로 구현한 예시

public enum Elvis {
    INSTANCE;

    private String[] favoriteSongs = { "Hound Dog", "Heartbreak Hotel" };

    public void printFavorites() {
        System.out.println(Arrays.toString(favoriteSongs));
    }
}

• 인스턴스 통제를 위해 readResolve를 사용하는 방식이 완전히 쓸모없는 것은 아니다.
• 직렬화 가능 인스턴스 통제 클래스를 작성해야 하는데, 컴파일 타임에 어떤 인스턴스들이 있는 지 알 수 없는 상황이라면 열거 타입으로 표현하는 것이 불가능하기 때문이다.
• readResolve 메서드의 접근성은 매우 중요하다.
  • final 클래스에서라면 readResolve 메서드는 private 이어야 한다.
  • final이 아닌 클래스에서는 다음의 몇 가지를 주의해서 고려해야 한다.
    • private 으로 선언하면 하위 클래스에서 사용할 수 없다.
    • package-private으로 선언하면 같은 패키지에 속한 하위 클래스에서만 사용할 수 있다.
    • protected나 public 으로 선언하면 이를 재정의하지 않은 모든 하위 클래스에서 사용할 수 있다.
    • protected나 public이면서 하위 클래스에서 재정의하지 않았다면, 하위 클래스의 인스턴스를 역직렬화하면서 상위 클래스의 인스턴스를 생성하여 ClassCastException을 일으킬 수 있다.

 

 

정리

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