Effective Java - item3 (Private 생성자나 열거 타입으로 싱글턴임을 보증하라)

Private 생성자나 열거 타입으로 싱글턴임을 보증하라

 

싱글턴이란 인스턴스를 오직 하나만 생성할 수 있는 클래스를 말한다.

 

그런데 클래스를 싱글턴으로 만들면 이를 사용하는 클라이언틀르 테스트 하기가 어려워 질 수 있다.

타입을 인터페이스로 정의한 다음 그 인터페이스를 구현해서 만든 싱글턴이 아니라면 싱글턴 인스턴스를 가짜(mock) 구현으로 대체할 수 없기 때문이다.

 

싱글턴을 만드는 방식은 보통 두가지 이다.

 

두 방식 모두 생성자는 private으로 감춰두고, 유일한 인스턴스에 접근할 수 있는 수단으로, public static 멤버를 하나 마련해둔다.

 

방법 1. public static 멤버가 final 필드인 방식

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

 

private 생성자는 public static final 필드인 Elvis.INSTANCE를 초기화 할 때 딱 한번만 호출된다.

 

public 이나 protected 생성자가 없으므로 Elvis 클래스가 초기화 될 때 만들어진 인스턴스가 전체 시스템에서 하나뿐임이 보장된다.

 

예외가 하나 있는데, 권한이 있는 클라이언트는 리플렉션 API인 AccessibleObject.setAccessible을 사용해 private 생성자를 호출할 수 있다.

이러한 공격을 방어하려면 생성자를 수정하여 두 번째 객체가 생성되려 할 때 예외를 던지게 하면 된다.

 

방법 2. 정적 팩토리 메서드를 public static 멤버로 제공

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

Elvis.getInstance는 항상 같은 객체의 참조를 반환하므로 제2의 Elvis 인스턴스는 만들어지지 않는다.(리플렉션을 통한 예외는 똑같이 적용됨.)

 

방법1 의 장점은 첫번째로 해당 클래스가 싱글턴임이 API에 명백히 드러난다는 것이다.

public static 필드가 final이니 절대 다른 객체를 참조할 수 없다.

두 번째는 간결함이다.

 

방법2 의 장점은 정적 팩토리 방식의 첫 번째 장점은 상황에(마음이 바뀌면) 따라 API를 바꾸지 않고도 싱글턴이 아니게 변경할 수 있다는 점이다.

 

유일한 인스턴슬르 반환하던 팩토리 메서드가 호출하는 스레드별로 다른 인스턴스를 넘겨주게 할 수 있다.

 

두번째 장점은 원한다면 정적 팩토리를 제네릭 싱글턴 팩토리로 만들 수 있다는 점이다.

 

세번째 장점은 정적 팩토리의 메서드 참조를 공급자(supplier)로 사용할 수 있다는 점이다.

예를 들어, Elvis::getInstance를 Supplier<Elvis>로 사용하는 식이다.

 

이런 장점이 굳이 필요하지 않다면 public 필드 방식이 좋다.

 

둘 중 하나의 방식으로 싱글턴 클래스를 직렬화 하려면 단순히 Serializable을 구현한다고 선언하는 것만으로는 부족하다.

 

모든 인스턴스 필드를 일시적(transient)이라고 선언하고 readResolve 메서드를 제공해야 한다.

이렇게 하지 않으면 직렬화된 인스턴스를 역직렬화 할 때마다 새로운 인스턴스가 만들어진다.

방법2의 예에서라면 가짜 Elvis가 탄생한다는 뜻이다.

이를 예방하고 싶다면 readResolve 메서드를 다음과 같이 추가하면 된다.

 

// 싱글턴임을 보장해주는 readResolve 메서드
private Object readResolve(){
    // '진짜' Elvis를 반환하고, 가짜 Elvis는 가비지 컬렉터에 맡긴다.
    return INSTANCE;
}

 

싱글턴을 만드는 세번째 방법은 열거 타입을 선언하는 것이다.

 

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

public 필드 방식과 비슷하지만, 더 간결하고, 추가 노력 없이 직렬화 가능하다.

또한 아주 복잡한 직렬화 상황이나 리플렉션 공격에서도 제2의 인스턴스가 생기는 일을 완벽히 막아준다.

 

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

 

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