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

싱글턴(SingleTon)

싱글턴 이란 인스턴스를 오직 하나만 생성할 수 있는 클래스를 말한다.

[싱글턴 구현]

public class Singleton {
    private static Singleton singleton = new Singleton();

    private Singleton() {
		// 외부에서 인스턴스를 생성하지 못하게 생성자 접근제어자를 private으로 설정.
    }

    public static Singleton getInstance(){
        return singleton;
    }
}

싱글턴을 사용하는 경우

싱글턴의 전형적인 예로는 함수와 같은 무상태 객체나 설계상 유일해야하는 시스템 컴포넌트를 들 수 있다.

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

싱글턴 생성 방식

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

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

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

public static 멤버가 final 필드인 방식 장점

• 해당 클래스가 싱글턴임이 API에 명백히 드러난다.
• public static 필드가 final이므로 절대 다른 객체를 참조할 수 없다.
• 간결하다.
  
  

[클래스가 초기화될 때 만들어진 인스턴스가 전체 시스템에서 하나뿐임을 보장]

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

        assertSame(elvis1, elvis2); // 성공
    }

예외
권한이 있는 클라이언트는 리플렉션 API인 AccessibleObject. setAccessible 을 사용해 private 생성자를 호출할 수 있다.

[리플렉션 API를 이용한 private 생성자 호출 예외]

Elvis elvis2 = Elvis.INSTANCE;

Constructor<Elvis> constructor = (Constructor<Elvis>) elvis2.getClass().getDeclaredConstructor();
constructor.setAccessible(true);

Elvis elvis3 = constructor.newInstance();
assertNotSame(elvis2, elvis3); // 인스턴스 같지않음

이런 예외를 막기 위해서는 생성자를 수정하여 두 번째 객체가 생성될 때 예외를 던지게 하면 된다.

[예외 해결방법]

private Elvis() {
        if(INSTANCE != null){
            throw new RuntimeException("생성자를 호출할 수 없습니다.");
        }
}

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

[정적 팩터리 방식의 싱글턴]

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

    private Elvis() {
	...
    }

    public static Elvis getInstance() {
        return INSTANCE;
    }

    public void leaveTheBuilding() {
	...
    }
}

Elvis.getInstance 는 항상 같은 객체의 참조를 반환하므로 제 2의 Elvis 인스턴스는 결코 만들어지지 않는다. (단, 역시 리플렉션을 통한 예외는 똑같이 적용된다.)

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

    assertSame(elvis1, elvis2); // 인스턴스 같음.
}

정적 팩터리 메서드를 public static 멤버로 제공 방식 장점

• API를 바꾸지 않고도 싱글턴이 아니게 변경가능
• 정적 팩터리를 제네릭 싱글턴 팩터리로 만들 수 있다.
• 정적 팩터리의 메서드 참조를 공급자(supplier)로 사용할 수 있다는 점.
  (Supplier 는 매개변수는 없이 get 메서드만으로 return 할 수 있는 인터페이스)

Supplier<Elvis> elvisSupplier = Elvis::getInstance;
Elvis elvis = elvisSupplier.get();
// 인스턴스를 리턴.

[public static final 필드]와 [정적 팩토리 방식]의 단점

위의 두 방식들을 사용하여 싱글턴 클래스를 직렬화하려면 단순히 Serializable을 구현하는 것만으로는 부족하다. 이때 모든 필드를 일시적이라고(transient) 선언하고 readReSolve 메서드를 사용해야 한다.
이렇게 하지 않으면 기본 생성자를 사용하지않고 값을 복사해서 인스턴스를 만드는 역직렬화는 새로운 인스턴스를 생성한다.

[가짜 Elvis 탄생을 막기위한 readResolve 메서드 추가]

private Object readResolve() {
        return INSTANCE;
        // [진짜] Elvis를 반환, [가짜] Elvis는 가비지 컬렉터에 맞긴다.
}

세 번째, 원소가 하나인 열거 타입을 선언

[열거 타입 방식의 싱글턴]

public enum Elvis {
    INSTANCE;

    public void leaveTheBuilding() {
	...
    }
}

public static final 필드 방식과 유사하지만 더 간결하고 추가 노력없이 직렬화가 가능하다. 아주 복잡한 직렬화 상황이나 리플렉션 공격에서도 제2의 인스턴스가 생기는 일을 완벽히 막아준다.

대부분의 상황에서 원소가 하나뿐인 열거 타입이 싱글턴을 만드는 가장 좋은 방법이다.

예외
단, 만들려는 싱글턴이 Enum 외의 클래스를 상속해야 한다면 이 방법은 사용할 수 없다. (열거 타입이 다른 인터페이스를 구현하도록 선언할 수는 있다.)

정리

싱글턴을 만드는 방식중 열거 타입을 이용하는 방식이 가장 좋지만 이 방법은 Enum외의 클래스를 상속받아야 한다면 사용이 불가능하다.

만약, 이런 경우가 발생한다면 public static필드와 private 생성자를 이용하는 방법을 사용하고 리플렉션 API를 이용해 인스턴스가 추가 생성될 경우를 예외처리해 주도록 하자.

[Reference]
이펙티브-자바-아이템-3.-private-생성자나-열거-타입으로-싱글턴임을-보증하라