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

아이템 3

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

싱글턴(Singleton)

: 인스턴스를 오직 하나만 생성할 수 있는 클래스

클래스를 싱글턴으로 만들면 이를 사용하는 클라이언트를 테스트하기가 어려워 질 수 있다. 타입을 인터페이스로 정의한 다음 그 인터페이스를 구현해서 만든 싱글턴이 아니라면 싱글턴 인스턴스를 가짜 구현으로 대체할 수 없기 때문이다.

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

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

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

	public void leaveTheBuilding()
}

생성자는 public static final 필드인 Elvis.INSTANCE를 초기화할 때 한 번만 호출된다. 생성자가 private이므로 Elvis 클래스가 초기화될 때 만들어진 인스턴스가 전체 시스템에서 하나 뿐임이 보장된다.

@Test
public void singletonTest(){
    Elvis elvis1 = Elvis.INSTANCE;
    Elvis elvis2 = Elvis.INSTANCE;

    assertSame(elvis1, elvis2); //success
}

리플렉션 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()
}

INSTANCE를 private으로 수정하고 getter를 이용해 반환하도록 한다. Elvis.getInstance() 는 항상 같은 객체의 참조를 반환한다.

장점
1. API를 바꾸지 않고도 싱글턴이 아니게 변경할 수 있다.
2. 정적 팩터리를 제네릭 싱글턴 팩터리로 만들 수 있다.
3. 정적 팩터리의 메서드 참조를 공급자로 사용할 수 있다.
: 공급자란 getter만을 가지고 아무 type이나 리턴할 수 있는 인터페이스를 말한다.

위의 두 방식으로 싱글턴 클래스를 직렬화하려면 Serializable을 구현한다고 선언하는 것만으로는 부족하다. 모든 인스턴스 필드를 transient라고 선언하고, readResolve 메서드를 제공해줘야한다. 이렇게 하지 않는다면 직렬화된 인스턴스를 역직렬화할 때마다 새로운 인스턴스가 만들어진다.

역직렬화시 호출되는 메소드를 싱글턴으로 리턴하도록 수정한 readResolve()는 다음과 같다.

private Obejct readResolve() {
	return INSTANCE;
}

3. 열거 타입 방식의 싱글턴

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

원소가 하나인 열거 타입을 선언하는 방식도 있다. 대부분 상황에서는 원소가 하나뿐인 열거 타입이 싱글턴을 만드는 가장 좋은 방법이다. 단, 만드려는 싱글턴이 Enum외의 클래스를 상속해야 한다면 이 방법은 사용할 수 없다.