[Effective_Java] Item 3 : private 생성자나 열거 타입으로 싱글턴임을 보장하라.

싱글턴(Singleton)

Springboot를 공부하다 한 번 쯤은 들어봤을 싱글턴. 싱글턴이란 무엇일까요?

싱글턴(Singleton)은

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

를 의미합니다.
그렇다면, Springboot에서 말하는 싱글턴 패턴이란, 클래스의 인스턴스가 딱 1개만 생성되는 것을 보장하는 디자인 패턴입니다. 또, 설계상 유일해야 하는 시스템 컴포넌트와 같은 것을 예로 들 수 있겠네요.

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

싱글턴을 만드는 방식

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

1. public static final 필드 방식

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

// 1. public static final 필드 방식의 싱글턴
public class Elvis {
    public static final Elvis INSTANCE = new Elvis();

    private Elvis() { }

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

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

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

물론 예외가 존재합니다.
권한이 있는 클라이언트가 리플랙션 API인 AccessibleObject.setAccessible을 사용하면 private 생성자를 호출할 수 있습니다. 이를 방어하기 위해서는 생성자를 수정해 두 번째 객체가 생성되려 할 때 예외를 던지면 됩니다. 하지만, 여기서는 이 내용에 대해 자세히 다루지 않겠습니다.

✅ 장점

1. 해당 클래스가 싱글턴임이 API에 명백히 들어납니다. 필드가 final이기 때문에 절대 다른 객체를 참조할 수 없습니다.
2. 간결합니다.

2. 정적 팩토리 메서드 방식

두 번째 방식은 정적 팩토리 메서드를 public static 맴버로 제공하는 것입니다.

// 2. 정적 팩터리 방식의 싱글턴
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!");
    }
}

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

1번과 다르게 INSTANCE가 private로 감춰져 있습니다.

Elvis.getInstance는 항상 같은 객체의 참조를 반환하기 때문에 제 2의 인스턴스는 만들어 질 수 없습니다.

✅ 장점

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

→ 이러한 장점들이 굳이 필요하지 않다면, 1번 방식인 public 필드 방식이 좋습니다.

3. 열거 타입 방식

세 번째 방법은 원소가 하나인 열거 타입(Enum Type)을 선언하는 것입니다.

// 3. 열거 타입 방식의 싱글턴 - 바람직한 방법
public enum Elvis {
    INSTANCE;

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

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

1번의 public 필드 방식과 유사합니다.

✅ 장점

1. 더 간결합니다.
2. 추가적인 노력없이 직렬화할 수 있습니다. 심지어 아주 복잡한 직렬화 상황이나 리플랙션 공격에서도 제 2의 인스턴스가 생기는 일을 완벽히 막을 수 있습니다.

💡정리

대부분의 상황에서는 원소가 하나뿐인 Enum Type이 싱글턴을 만드는 가장 좋은 방법입니다. 하지만, 만들려는 싱글턴이 Enum 외의 클래스를 상속해야 한다면 이 방법은 사용할 수 없습니다.