private 생성자나 열거 타입으로 싱글턴임을 보장하라
싱글턴이란 인스턴스를 오직 하나만 생성할 수 있는 클래스를 말한다. 대표적으로 함수와 같은 무상태 객체나 설계상 유일해야 하는 시스템 컴포넌트를 들 수 있다.
하지만, 클래스를 싱글턴으로 만들 시 이를 사용하는 클라이언트를 테스트하기 어려워질 수 있다. 타입을 인터페이스로 정의하고 그 인터페이스를 구현해 만든 싱글턴이 아닌 이상 인스턴스를 가짜(mock) 구현으로 대체할 수 없기 때문이다. (한 번 만든 객체가 다른 작업 시 영향을 받을 수 있기 때문)
이를 만드는 방법은 보통 둘 중 하나다.
일단 두 방법 공통적으로 생성자는 private으로 감춰두고, 유일한 인스턴스에 접근할 수 있는 수단으로 public static 멤버를 하나 마련해둔다. public static 멤버가 final 필드 방식인 경우엔 다음과 같다.
public class Elvis {
public static final Elvis INSTANCE = new Elvis();
private Elvis() {...}
public void leaveTheBuilding() {...}
}private 생성자는 Elvis.INSTANCE를 초기화할 때 딱 한 번만 호출된다. public이나 protected 생성자가 없기 때문에 전체 시스템에서 딱 하나뿐인 인스턴스가 된다. 하지만, 예외적으로 권한이 있는 클라이언트는 리플렉션 API인 AccessibleObject.setAccessible을 사용해 private 생성자를 호출할 수 있다. 이런 경우를 막으려면 생성자를 수정하여 두 번째 객체가 생성되려할 때 예외를 던지면 된다.
첫 번째(public static 필드)의 장점은 해당 클래스가 싱글턴임이 API에 명확히 드러난다는 것이다. public static 필드가 final이니 절대로 다른 객체를 참조할 수 없다. 두 번째는 간결하다는 점이다.
두 번째는 정적 팩토리 메서드를 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를 통해 닥 하나의 인스턴스만 참조할 수 있다. (리플렉션 예외는 똑같음)
두 번째의 방식의 장점은 1. API를 바꾸지 않고도 싱글턴이 아니게 바꿀 수 있다. 팩토리 메서드가 호출하는 스레드별로 다른 인스턴스를 넘겨주게 할 수 있다. 다른 장점으로는 2. 원한다면 정적 팩토리를 제네릭 싱글턴 팩토리로 만들 수 있다. 3. 세번째 장점은 정적 팩토리의 메서드 참조를 공급자로 사용할 수 있다는 점이다. 가령 Elvis::getinstance를 Supplier로 사용하는 식이다. 이러한 장점이 필요하지 않은 경우는 public 필드(첫 번째 방식)을 사용하는 것이 좋다.
Supplier<Elvis> elvisSupplier = Elvis::getInstance;
Elvis elvis = elvisSupplier.get();
// Supplier : get 메서드를 통해 아무 type이나 리턴할 수 있는 인터페이스둘 중 한 방식으로 만든 싱글턴 클래스를 직렬화하려면 단순히 Serializable을 구현한다고 선언하는 것만으로는 부족하다. 모든 인스턴스 필드를 일시적(transient)라고 선언하고 readResolve 메서드를 제공해야한다. 그렇지 않으면 직렬화된 인스턴스를 역직렬화할 때마다 새로운 인스턴스가 만들어진다.
가짜 Elvis 생성을 막으려면 다음과 같이 readResolve 메서드를 추가해야한다.
//싱글턴임을 보장해주는 readResolve 메서드
private Object readResolve() {
//'진짜' Elvis를 반환하고, 가짜 Elvis는 가비지 컬렉터에 맡긴다.
return INSTANCE;
}싱글턴을 만드는 세 번째 방법은 원소가 하나인 열거타입을 선언하는 것이다.
public enum Elvis {
INSTANCE;
public void leaveTheBuilding() {...}
}public 필드 방식과 비슷하지만 더 간결하고 직렬화나 리플렉션 공격에도 제 2의 인스턴스가 생기는 것을 막아준다. 부자연스럽지만 대부분 상황에서는 원소가 하나뿐인 열거타입이 싱글턴 생성방법 중 가장 좋다. 단 만들려는 싱글턴이 Enum 외의 클래스를 상속해야 한다면 이 방법은 쓸 수 없다.(열거 타입이 다른 인터페이스를 구현하도록 선언할 수는 있다.)
