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

728x90

(이번 장은 잘 이해하지 못하는 부분이 많았다. 2회독 3회독을 하면서 이 부분이 점점 익숙해지기를 바란다..)

싱글톤(singleton)이란 인스턴스를 오직 하나만 생성할 수 있는 클래스를 말한다. 싱글턴의 대표적인 예는 함수와 같은 무상태(stateless) 객체나 (설계상 유일해야하는) 시스템 컴포넌트가 있다.

클래스를 싱글턴으로 만들면 이를 사용하는 클라이언트를 테스트하기가 어려워질 수 있다. 싱글턴 인스턴스를 가짜(mock) 구현으로 대체할 수 없기 때문이다. 

싱글턴을 만드는 방식은 보통 둘 중 하나이다. 두 방식 모두 생성자는 private로 감춰두고, 유일한 인스턴스에 접근하는 수단으로 public static 멤버를 하나 만든다.

첫번째 방법. public static 멤버가 final 필드인 방식 

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

private 생성자는 public static final 필드인 Elvis.INSTANCE를 초기화할 때 딱 한번만 호출된다. public이나 protected 생성자가 없으므로 Elvis 클래스가 초기화될 때 만들어진 인스턴스가 하나뿐임이 보장된다. (리플렉션 API인 AccesibleObject.setAccessible을 사용해서 private 생성자를 호출할 수 있지만.... 이런 방법을 막을려면 생성자를 수정하여 두 번째 객체가 생성되려 할 때 예외를 던지게 하면 된다. 

두번째 방법. 정적 팩터리 메서드를 public static 멤버로 제공

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

Elvis.getInstance는 항상 같은 객체의 참조를 반환하므로 인스턴스가 하나뿐임을 보장한다. 

첫번째 방식의 public 필드 방식의 큰 장점은 해당 클래스가 싱글턴임이 API에 명백히 드러난다는 것이다. public static 필드가 final이니 절대로 다른 객체를 참조할 수 없다.

반면에 두번째 방식의 장점은 간결함이다. 정적 팩터리 방식의 장점은 1) API를 바꾸지 않고도 싱글턴이 아니게 변경할 수 있다. 2) 원한다면 정적 팩터리를 제네릭 싱글턴 팩터리로 만들 수 있다. 3) 정적 팩터리의 메서드 참조를 공급자(Supplier)로 사용할 수 있다는 점이다. (Elvis::getInstance를 Supplier<Elvis>로 사용하는 식이다)

이러한 장점들이 필요하지 않다면 public 필드 방식이 좋다. 

둘 중 하나의 방식으로 만든 싱글턴 클래스를 직렬화하려면 단순히 Serializable을 구현하고 선언하는 것만으로는 부족하다. 모든 인스턴스 필드를 일시적(transient)이라고 선언하고 readResolve 메서드를 제공해야 한다. 이렇게 하지 않으면 직렬화된 인스턴스를 역직렬화할 때마다 새로운 인스턴스가 만들어진다. 두번째 방법의 코드를 예로 들자면 가짜 Elvis가 탄생한다는 뜻이다. 가짜 Elvis 탄생을 예방하고 싶다면 Elvis 클래스에 다음과 같이 readResolve 메서드를 추가하자. 

private Object readResolve() {
    return INSTANCE;
}

 위 코드는 진짜 Elvis를 반환하고, 가짜 Elvis는 가비지 컬렉터에 맡긴다. 

세번째 방법. 원소가 하나인 열거 타입을 선언하는 방식

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

public 필드 방식과 비슷하지만, 더 간결하고, 추가 노력 없이 직렬화할 수 있고, 심지어 아주 복잡한 직렬화 상황이나 리플렉션 공격에서도 제2의 인스턴스가 생기는 일을 완벽히 막아준다. 대부분의 상황에서는 원소가 하나뿐인 열거 타입이 싱글턴을 만드는 가장 좋은 방법이다. 단, 만들려는 싱글턴이 Enum 외의 클래스를 상속해야 한다면 이 방법은 사용할 수 없다(열거 타입이 다른 인터페이스를 구현하도록 선언할 수는 있다).

 

728x90