[Effective Java 3/E] 아이템3. private 생성자나 열거 타입으로 싱글턴임을 보증하라

싱글턴이란?

• 싱글턴(Singleton) 이란 인스턴스를 오직 하나만 생성할 수 있는 클래스를 말한다.
• 클래스를 싱글턴으로 만들면 이를 사용하는 클라이언트를 테스트하기 어려워질 수 있다.
  • 인터페이스를 구현한 싱글턴이 아니라면 Mock 구현으로 대체할 수 없기 때문에

싱글턴 생성 방식

1. public static final 필드

• private 생성자는 public static final 필드인 Elvis.INSTANCE를 초기화할 때 딱 한번 호출
• 예외 : 권한이 있는 클라이언트는 리플렉션 API인 AccessibleObject.setAccessible을 사용해 private 생성자를 호출할 수 있다.
  • 생성자에서 두번째 객체가 생성되려 할 때 예외를 던지게 하면 이러한 공격을 방어할 수 있다.

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

    public void leaveTheBuilding() { ... }
}

장점

• 클래스가 싱글턴임이 API에 명백히 드러난다.
• 간결하다.

2. 팩터리 메서드를 public static 멤버로 제공

• Elvis.getInstance는 항상 같은 객체의 참조를 반환(리플렉션 예외는 똑같이 적용)

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

    public void leaveTheBuilding() { ... }   
}

장점

• API를 바꾸지 않고도 싱글턴이 아니게 변경할 수 있다.
• 정적 팩터리를 제네릭 싱글턴 팩터리로 만들 수 있다(아이템 30).
• 정적 팩터리의 메서드 참조를 공급자(Supplier)로 사용할 수 있다(아이템 43, 44).
  • 예: Elvis::getInstance -> Supplier<Elvis>

이러한 장점들이 필요하지 않다면, pulbic static final 필드 방식이 좋다.

3. 열거 타입 방식의 싱글턴 - 바람직한 방법

대부분 상황에서 원소가 하나뿐인 열거 타입이 싱글턴을 만드는 가장 좋은 방법

public enum Elvis {
    INSTANCE;

    public void leaveTheBuilding() { ... }      
}

장점

• 1,2번 방식과 달리 추가적인 노력 없이 직렬화를 할 수 있다.
• 간결하다
• 아주 복잡한 직렬화 상황이나 리플렉션 공격에도 새로운 인스턴스가 생기는 일을 완벽히 막아준다.

단, 만들려는 싱글톤이 열거 타입은 Enum 외의 클래스를 상속해야 한다면 사용할 수 없다(열거 타입이 인터페이스를 구현하도록 선언할 수 있다).

싱글톤 클래스 직렬화

앞서 설명한 public static final 필드 방식과 팩터리 메서드 방식으로 만든 싱글톤 클래스를 직렬화하려면 단순히 Serializable을 구현하는 것만으로는 부족하다.

모든 인스턴스 필드를 제어자 transient를 붙여야 하고, readResolve 메서드를 제공해야 한다(아이템 89).

readResolve 메서드는 역직렬화하는 과정에서 만들어진 객체를 무시하고 INSTANCE를 반환한다.

그렇기 때문에 직렬화 할 때 데이터를 가질 이유가 없다 -> transient 제어자 사용 이유

private Object readResolve() {
    return INSTANCE;
}