3. private 생성자나 열거 타입으로 싱글턴을 보장하라 - 이펙티브 자바
본 글은 조슈아 블로크의 이펙티브 자바 개정 3판을 읽고 정리한 글입니다.
싱글턴(singleton)이란 인스턴스를 오직 하나만 생성할 수 있는 클래스를 말한다.
클래스를 싱글턴으로 만들면 이를 사용하는 클라이언트를 테스트하기 어려워질 수 있다. -> 타입을 인터페이스로 정의한 다음, 그 인터페이스를 구현해서 만든 싱글턴이 아니면 싱글턴 인스턴스를 가짜(mock) 객체 구현으로 대체 불가능 하기 때문
싱글턴을 만드는 방식 두 가지
두 방식 모두 생성자는 private으로 감춰두고, 유일한 인스턴스에 접근할 수 있는 수단으로 public static 멤버를 하나 마련해둠.
1. public static 멤버가 final 필드인 방식
public class Elvis {
public static final Elvis INSTANCE = new Elvis();
private Elvis() { ... }
public void leaveTheBuilding()
}private 생성자는 public static final 필드를 초기화할 때 단 한 번만 호출됨.
public 이나 protected 생성자가 없으므로 Elvis 클래스가 초기화 될 때 만들어진 인스턴스가 전체 시스템에서 하나뿐임이 보장됨.
public 필드 방식의 장점은 해당 클래스가 싱글턴임이 API에 명백히 드러난다는 점이다. 또한 간결함을 가짐.
하지만, 클라이언트는 리플렉션API인 AccessibleObject.setAccessible을 사용해 private 생성자를 호출 가능하여, 이러한 공격 방어를 위해 생성자를 수정하여 두 번째 객체가 생성되려 할 때 예외를 던져야 한다.
private Elvis() {
if(INSTANCE != null){
throw new RuntimeException("생성자를 호출할 수 없습니다!");
}
}
2. 정적 팩터리 메서드를 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는 같은 객체의 참조를 반환하므로 제 2의 Elvis 인스턴스는 결코 만들어지지 않는다.
(리플렉션을 통한 예외는 똑같이 적용된다.)
정적 팩터리 방식의 장점
1. API를 바꾸지 않고도 싱글턴이 아니게 변경할 수 있다. 유일한 인스턴스를 반환하던 팩터리 메서드가 호출하는 스레드별로 다른 인스턴스를 넘길 수 있음.
2. 정적 팩터리를 제네릭 싱글턴 팩터리로 만들 수 있다.
3. 정적 팩터리의 메서드 참조를 공급자(supplier)로 사용할 수 있다는 점이다. Elvis::getInstance를 supplier<Elvis>로 사용하는 방식
Supplier: get메서드 만을 가지고 아무 type이나 리턴할 수 있는 인터페이스.
Supplier<Elvis> elvisSupplier = Elvis::getInstance;
Elvis elvis = elvisSupplier.get();
이러한 장점이 필요하지 않다면 public 필드 방식이 더 좋음.
[두 방식의 단점]
직렬화된 인스턴스를 역직렬화할 때마다 새로운 인스턴스가 만들어짐.
싱글턴 클래스를 직렬화하려면 모든 인스턴스 필드를 일시적(transient)라고 선언하고, readResolve 메서드를 제공해야 함.
정적 팩터리 방식에서 가짜 Elvis 탄생을 막으려면 Elvis 클래스에 readResolve 메서드를 추가해야 함.
private Obejct readResolve() {
return INSTANCE;
}진짜 Elvis를 반환하고 가짜 Elvis는 가비지 컬렉터에 맡기는 방식
3. 원소가 하나인 열거 타입을 선언하는 것
대부분 상황에서는 원소가 하나뿐인 열거 타입이 싱글턴을 만드는 가장 좋은 방법이다.
public enum Elvis {
INSTANCE;
public void leaveTheBuilding() { ... }
}public 필드 방식과 비슷하지만 더 간결하고, 추가 노력 없이 직렬화 가능. 복잡한 직렬화 상황이나 리플렉션 공격에서도 제 2의 인스턴스가 생기는 일을 막아준다.
단, 만들려는 싱글턴이 Enum외의 클래스를 상속해야 한다면 이 방법은 사용 불가능(열거 타입이 다른 인터페이스를 구현하도록 선언할 수 있음.)