본문 바로가기
회고/이펙티브 자바 3판

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

코동이 2021. 3. 10.

 싱글턴이란, 인스턴스를 오직 하나만 생성할 수 있는 클래스를 말한다. 예로, 함수(아이템24)같은 무상태 객체나 유일한 시스템 컴포넌트를 들 수 있다. 그런데 클래스를 싱글턴으로 만들면 이를 사용하는 클라이언트를 테스트하기거 어려울 수 있다. 타입을 인터페이스로 정의하고 구현해서 만든 싱글턴이 아니라면 mock 구현이 불가능하기 때문이다.

 

 * 3-1 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 클래스가 초기화될 때 만들어진 인스턴스는 전체 시스템에서 하나뿐임이 증명된다.

 

*장점

1. public 필드 방식이므로 해당 클래스래스가 싱글턴임이 명백히 드러난다.

 

2. final이니 절대 다른 객체를 참조할 수 없다.

 

 

* 3-2 정적 팩터리 방식의 싱글턴

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. 정적 팩터리 메서드를 제네릭 싱글턴 팩터리를 만들 수 있다.(아이템30)

 

3. 정적 팩터리 메서드 참조를 공급자(supplier)로 사용할 수 있다.

Elvis::getInstance를 Supplier<Elvis>로 사용할 수 있다.(아이템 43,44)

 

 하지만, 두 방법 모두 권한이 있는 클라이언트는 리플렉션 API(아이템65)인 AccessibleObject.setAccessible을 사용해 private 생성자를 호출 할 수도 있다. 이것을 방어하려면 생성자를 수정하여 두번쨰 객체가 생성되려 할 때 예외를 던진다.

 

 둘 중 하나의 방식으로 만든 싱글턴 클래스를 직렬화하려면(12장 참조) Serializeable을 구현하는 것만으로는 부족하다. 모든 인스턴스 필드를 임시적(trasient)로 선언하고 readResolve 메서드를 제공해야 한다(아이템89). 이렇게하지 않으며 직렬화된 인스턴스를 역직렬화할때마다 새로운 인스턴스가 만들어진다. 코드 3-2 예에서라면 가짜 Elvis가 탄생한다는 뜻이다. 다음의 메서드를 추가하자

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

  

* 3-3 열거 타입 방식의 싱글턴 - 바람직한 방법

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

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

반응형