아이템3. private 생성자나 열거 타입으로 싱글톤임을 보증하라.

아이템3. private 생성자나 열거 타입으로 싱글톤임을 보증하라.

싱글톤

• 단일 인스턴스
• 예시
  • 함수와 같은 무상태(stateless) 객체
  • 설계상 유일해야 하는 시스템 컴포넌트
• 싱글톤 클래스는 이를 사용하는 클라이언트를 테스트하기 어렵게 만들 수 있음 - mock 구현으로 대체가 어렵기 때문

싱글톤의 생성 방식

• 1, 2 모두 생성자는 private로 감추고, 인스턴스 접근 수단으로 public static 멤버를 남겨둠

1. private static final 필드 방식

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

• private 생성자는 private final인 싱글턴 인스턴스를 초기화할 때 단 한번만 호출된다.
• 코드가 싱글턴임이 API에 명백하게 드러난다는 장점
• 이 인스턴스가 싱글턴임이 보장되지만 유일하게 예외가 있는데, 리필렉션 API인 AccessibleObject.setAccessible을 사용해 private 생성자를 호출하는 공격이 있을 수 있다.
  • 이를 예방하려면 생성자 차원에서 2번째 객체가 생성되려 할 때 예외를 던지도록 한다.

2. 정적 팩터리 방식의 싱글턴

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

• 동일 객체의 참조를 반환하기에 싱글턴 보장(단, 이 경우에도 리플렉션을 통한 예외는 동일)
• 장점
  • API를 변경하지 않고도 싱글턴이 아니게 할 수 있다.
  • 정적 팩터리를 제네릭 싱글턴 팩터리로 만들 수 있다.
  • 정적 팩터리의 메서드 참조를 공급자(supplier)로 사용할 수 있다.
    • Elvis::getInstance를 Supplier<Elvis>로 사용하는 방식

3. 열거 타입 방식

public enum Elvis {
    INSTANCE;
    
    public void leaveTheBuilding() {...}

• 원소가 하나인 열거 타입을 선언하는 것
• public 필드 방식과 비슷하지만 추가적인 노력 없이 직렬화가 가능
• 복잡한 직렬화 상황이나 리플렉션 공격에서도 제2의 인스턴스 생성을 완전히 막음

직렬화

• 1과 2의 방식으로 만든 싱글턴 클래스를 직렬화하려면 단순히 implements Serializable로는 부족함
• 모든 인스턴스 필드를 일시적(transient)이라 선언하고 readResolve 메서드를 제공해야 함
  • 이렇게 하지 않을 경우 역직렬화할 때 마다 새로운 인스턴스가 만들어진다.

private Object readResolve() {
    // '진짜' Elvis를 반환하고, 가짜 Elvis는 가비지 컬렉터에 맡긴다.
    return INSTANCE;
}

정리

• 직렬화에 관해서 가장 용이한것은 3

  • 대부분 상황에서는 3의 방식: 원소가 하나뿐인 열거 타입이 싱글턴을 만드는 가장 좋은 방법
  • 단 Enum 외의 클래스를 상속해야 할 경우 3은 사용 불가
    • 열거 타입이 다른 인터페이스를 구현하도록 선언하는 것은 불가하기 때문

• 2의 장점: 변경 용이성 / 정적 팩터리의 메서드 참조를 공급자로 사용이 필요하지 않다면 1이 나음