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

싱글턴(singleton)

싱글턴이란?

인스턴스를 오직 하나만 생성할 수 있는 클래스를 말합니다.

 

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

 

그런데 클래스를 싱글턴으로 만들면 이를 사용하는 클라이언트를 테스트 하기가 어려워 질 수 있습니다.

-> 싱글턴 인스턴스를 가짜(mock) 구현으로 대체할 수 없기 때문입니다. (하나의 인스턴스만 존재하기 때문)

만약 타입을 인터페이스로 정의한 다음 그 인터페이스를 구현해서 만든 싱글턴이라면 싱글턴 인스턴스를 가짜 구현으로 대체할 수 있습니다.

---

싱글턴을 만드는 방법

싱글턴을 만드는 방법은 보통 두 가지가 있습니다.

두 방법 모두 생성자는 private로 외부에 공개하지 않고, 유일한 인스턴스에 접근할 수 있는 수단으로 public static 멤버를 만듭니다.

• public static 멤버가 final 필드인 방식
  • public static final MyClass INSTANCE = new MyClass();
• private static 필드를 public static 정적 팩터리 메서드로 제공하는 방법

 

public static 멤버가 final 필드인 방법

 

package item3_20210419;

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

    private MyClass() {
    }

    public void doSomething() {
        System.out.println("뭔가를 실행");
    }
}

 

예시 코드를 보면 private 생성자( private MyClass() { } )는 MyClass.INSTANCE 를 초기화 시킬 때 딱 한번 호출됩니다.

public 이나 protected 생성자가 없으므로

MyClass가 초기화 될때 만들어진 INSTANCE(public static final 필드)가 전체 시스템에서 하나뿐인 MyClass의 인스턴스임을 보장합니다.

 

예외가 있다면 리플렉션 API(아이템 65)인 AccessibleObject.setAccessible을 사용해 private 생성자를 호출할 수 있습니다.

이런 공격을 방어하려면 생성자를 수정하여 두번째 객체가 생성되려 할 때 예외를 던지게 하면 됩니다.

 

public 필드 방식의 장점

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

 

private static 멤버를 public static 정적 팩터리 메서드로 제공하는 방법

package item3_20210419;

public class MyClass2 {
    private static final MyClass2 INSTANCE = new MyClass2();

    public MyClass2() {
    }

    public static MyClass2 getInstance() {
        return INSTANCE;
    }
    
    public void doSomething() {
        System.out.println("뭔가를 실행함2");
    }
}

 

인스턴스를 생성한 필드는 private static 으로 두고 정적 팩터리 메서드를 public static 로 제공하는 방법입니다.

MyClass2.INSTANCE는 항상 같은 객체의 참조를 반환하므로 제2의 MyClass2의 인스턴스는 만들어지지 않습니다.

(하지만 리플렉션API를 이용한 공격을 통한 예외는 여전히 적용됩니다.)

 

장점

• API를 바꾸지 않고도 싱글턴이 아니게 변경할 수 있다.
• 원한다면 정적 팩터리 메서드를 제네릭 싱글턴 팩터리(아이템30)로 만들 수 있다는 점
• 정적 팩터리 메서드의 메서드 참조를 공급자(supplier)로 사용할 수 있다는 점
  • MyClass2::getInstance 와 같이 사용할 수 있습니다.
• 위의 장점들이 필요없다면 public static final 필드를 가지는 방법이 좋습니다.

 

---

싱글턴 사용시 주의사항

위 두가지 방법으로 만든 싱글턴 클래스를 직렬화(Serializable)하려면 단순히 Serializable을 구현만으로는 부족합니다.

모든 인스턴스 필드를 일시적(transient)이라고 선언하고 readResolve 메서드를 제공해야 합니다.

그렇지 않으면 직렬화된 인스턴스를 역직렬화할 때마다 새로운 인스턴스가 만들어집니다.

 

위의 예제에서 가짜 MyClass2가 탄생할 수 있다는 의미입니다.

이런 가짜 MyClass2의 탄생을 예방하려면 MyClass2에 readResolve 메서드를 추가해야 합니다.

 

package item3_20210419;

public class MyClass3 {
    private static final MyClass3 INSTANCE = new MyClass3();

    public MyClass3() {
    }
    
    public static MyClass3 getInstance() {
        return INSTANCE;
    }
    
    // 싱글턴임을 보장해주는 readResolve 메서드
    private Object readResolve() {
        return INSTANCE;
    }
}

 

---

싱글턴을 만드는 세번째 방법

위에서 언급하지 않았던 세번째 방법은 Enum 타입으로 만드는 것입니다.

 

package item3_20210419;

public enum MyClass4 {
    INSTANCE;

    public void doSomething() {
        System.out.println("뭔가를 실행3");
    }
}

 

public 필드 방식과 매우 비슷하지만,

• 더 간결하고
• 추가 노력 없이 직렬화가 가능하고
• 아주 복잡한 직렬화 상황이나 리플렉션 공격에서도 제2의 인스턴스가 생기는 일을 완벽하게 막아줍니다.

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

 

단, 만들려는 싱글턴이 Enum외의 클래스를 상속받아야 한다면 이 방법 외에 다른 방법을 사용해야합니다.