[effective java] item 3. 싱글톤임을 보장하기 위해 private 생성자 또는 열거 타입을 사용해라

싱글톤(singleton)이란?

• 인스턴스를 오직 하나만 생성할 수 있는 클래스입니다.
• 함수와 같은 무상태(stateless) 객체나, 설계상 유일해야 하는 시스템 컴포넌트를 예시로 들 수 있습니다.

단점

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

 

 

싱글턴을 구현하는 3가지 방법

1. public static final 필드
2. private static 멤버를 정적 메토리 메서드로 제공
3. 열거 타입 방식의 싱글톤 BEST

1번과 2번 방법은 모두 생성자를 private 으로 감춰두고, 유일한 인스턴스에 접근할 수 있는 수단으로 static 멤버 변수를 하나 둡니다. 

우선, public static 멤버가 final 필드인 방식을 살펴봅시다.

 

1. public static final 필드 방식의 싱글톤 (p.23)

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

    private Elvis() { }

    public void leaveTheBuilding() {
        System.out.println("Whoa baby, I'm outta here!");
    }
}

main

public static void main(String[] args) {
    Elvis elvis = Elvis.INSTANCE;
    elvis.leaveTheBuilding();
}

 

특징

• private 생성자는 public static final 필드인 Elvis.INSTANCE를 초기화할 때 딱 한 번만 호출됩니다.
• public 이나 protected 생성자가 없으므로 Elvis 클래스가 초기화될 때 만들어진 인스턴스가 전체 시스템에서 하나뿐임을 보장합니다.
• 클라이언트는 손 쓸 방법이 없습니다.

 

장점

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

 

참고 싱글톤을 수정할 수 있는 예외: 리플렉션
권한이 있는 클라이언트가 리플렉션 API인 AccessibleObject.setAccessible을 사용해 private 생성자를 호출할 수 있습니다.
이러한 공격을 방어하려면, 생성자를 수정하여 두 번째 객체가 생성되려 할 때 예외를 던지게 합니다.

 

 

2. private static final 필드, 정적 팩토리 방식의 싱글톤 (p. 24)

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

    public void leaveTheBuilding() {
        System.out.println("Whoa baby, I'm outta here!");
    }
}

main

public static void main(String[] args) {
    Elvis elvis = Elvis.getInstance();
    elvis.leaveTheBuilding();
}

 

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

 

장점

• (마음이 바뀌면) API를 바꾸지 않고도 싱글톤이 아니게 변경할 수 있습니다.  
  예를 들어, 유일한 인스턴스를 반환하던 팩토리 메서드가 호출하는 스레드별로 다른 인스턴스를 넘기게 할 수 있습니다.
• 정적 팩토리를 제네릭 싱글톤 팩토리로 만들 수 있습니다.
• 정적 팩토리의 메서드 참조를 공급자(supplier)로 사용할 수 있습니다.
  가령, Elvis::getInstance를 Suppiler<Elvis>로 사용하는 방법입니다.

 

이와 같은 장점들이 굳이 필요하지 않다면 public 필드 방식이 좋습니다.

 

 

필드 방식의 문제점 - 가짜 인스턴스 생성

둘 중 하나의 방식으로 만든 싱글톤 클래스를 직렬화하려면 단순히 Serializable을 구현한다고 선언하는 것만으로는 부족합니다. 

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

 

싱글톤임을 보장해주는 readResolve 메서드

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

이렇게 하지 않으면 직렬화된 인스턴스를 역직렬화할 때마다 새로운 인스턴스가 만들어집니다. 위의 private static 필드 방식의 예에서라면 가짜 Elvis가 탄생한다는 뜻입니다. 가짜 Elvis 탄생을 예방하고 싶다면 Elvis 클래스에 위의 readResolve 메서드를 추가해야 합니다.

 

 

3. 열거 타입 방식의 싱글톤 : 바람직한 방법 (25p)

public enum Elvis {
    INSTANCE;

    public void leaveTheBuilding() {
        System.out.println("기다려 자기야, 지금 나갈께!");
    }
}

main

public static void main(String[] args) {
    Elvis elvis = Elvis.INSTANCE;
    elvis.leaveTheBuilding();
}

 

장점

• public 필드 방식과 비슷하지만 더 간결하고 추가 노력없이 직렬화할 수 있습니다. 
• 심지어 아주 복잡한 직렬화 상황이나 리플렉션 공격에서도 제2의 인스턴스가 생기는 일을 완벽히 막아줍니다. 

 

 

정리

• 조금 부자연스러워 보일 수는 있으나 대부분 상황에서는 원소가 하나뿐인 열거 타입이 싱글톤을 만드는 가장 좋은 방법입니다. 
• 단, 만들려는 싱글톤이 Enum 외의 클래스를 상속해야 한다면 이 방법은 사용할 수 없습니다. (열거 타입이 다른 인터페이스를 구현하도록 선언할 수는 있습니다.)

 

 

---

출처

https://www.yes24.com/Product/Goods/65551284

이펙티브 자바 Effective Java 3/E - YES24