[Effective Java] 3.private 생성자나 열거 타입으로 싱글턴임을 보증하라

싱글턴이란 인스턴스를 오직 하나만 생성할 수 있는 클래스를 말한다. 스프링에서 빈을 관리하는 방식이 싱글턴이다.

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

타입을 인터페이스로 정의한 다음 그 인터페이스를 구현해서 만든 싱글턴이 아니라면 싱글턴 인스턴스를 가짜(mock) 구현으로 대체할 수 없기 때문이다.

 

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

우선 public static 멤버가 final 필드인 방식을 살펴보자.

// 코드 3-1 public static final 필드 방식의 싱글턴 (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!");
    }

    // 이 메서드는 보통 클래스 바깥(다른 클래스)에 작성해야 한다!
    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 생성자를 호출할 수 있다. 이러한 공격을 방어하려면 생성자를 수정하여 두 번째 객체가 생성되려 할 때 예외를 던지게 하면 된다.

 

싱글턴을 만드는 두 번째 방법은 정적 팩터리 메서드를 public static 멤버로 제공하는 것이다.

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

    // 이 메서드는 보통 클래스 바깥(다른 클래스)에 작성해야 한다!
    public static void main(String[] args) {
        Elvis elvis = Elvis.getInstance();
        elvis.leaveTheBuilding();
    }
}

 

Elvis.getInstance()는 항상 같은 객체의 참조를 반환하므로 제 2의 Elvis 인스턴스란 결코 만들어지지 않는다.

하지만 리플렉션을 통한 예외는 똑같이 적용된다.

public 필드 방식의 장점은 해당 클래스가 싱글턴임이 API에 명백히 드러난다는 것이다. 두번째 장점은 간결함이다.

 

한편 정적 팩터리 방식의 첫 번째 장점은 API를 바꾸지 않고도 싱글턴이 아니게 변경할 수 있다는 점이다.

두번째 장점은 원한다면 정적 팩터리를 제네릭 싱글턴 팩터리로 만들 수 있다는 점이다.(아이템 30)

->이 부분은 아이템 30 보고 다시 봐야할 것 같다.

 

세번째 장점은 정적 팩터리의 메서드 참조를 공급자로 사용할 수 있다는 점이다.

가령 Elvis::getInstance를 Supplier<Elvis>로 사용하는 식이다.

이러한 장점들이 필요하지 않다면 public 필드 방식이 좋다.

 

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

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

이렇게 하지 않으면 직렬화된 인스턴스를 역직렬화할 때 마다 새로운 인스턴스가 만들어진다고 한다.

정적 팩터리에서의 예라면 가짜 Elvis가 탄생한다는 뜻이다. 가짜 Elvis 탄생을 예방하고 싶다면 Elvis 클래스에 다음의 readResolve 메서드를 추가해야한다.

 

// 싱글턴임을 보장해주는 readResolve 메서드
private Object readResolve() {
    // '진짜' Elvis를 반환하고, 가짜 Elvis는 가비지 컬렉터에 맡긴다.
    return INSTANCE;
}

 

싱글턴을 만드는 세번째 방법은 원소가 하나인 열거 타입을 선언하는 것이다.

// 열거 타입 방식의 싱글턴 - 바람직한 방법 (25쪽)
public enum Elvis {
    INSTANCE;

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

    // 이 메서드는 보통 클래스 바깥(다른 클래스)에 작성해야 한다!
    public static void main(String[] args) {
        Elvis elvis = Elvis.INSTANCE;
        elvis.leaveTheBuilding();
    }
}

 

public 필드 방식과 비슷하지만 더 간결하고 추가 노력없이 직렬화 할 수 있다.

심지어 아주 복잡한 직렬화 상황이나 리플렉션 공격에서도 제 2의 인스턴스가 생기는 일을 완벽히 막아준다.

부자연스러워 보일 수 있으나 대부분 상황에서는 원소가 하나 뿐인 열거 타입이 싱글턴을 만드는 가장 좋은 방법이다.

 

내가 가지고 있는 지식으로는 정적 내부 클래스 방식으로 구현하는 방식이 싱글턴으로 인스턴스를 관리하는데에 가장 좋은 방법으로 알고 있다.

 

열거 타입으로 만들거나 정적 내부 클래스 방식으로 만드는 데에 각각의 장단점이 존재한다.

열거 타입 방식

장점

- 리플렉션을 통해 싱글톤을 깨트리는 공격에 안전하다.

- 직렬화를 보장해준다.

단점

- 싱글톤 초기화 과정에 다른 의존성이 끼어들 가능성이 높다

- Enum 초기화는 컴파일 타임에 결정되므로 매번 메소드 등을 호출할 때 Context 정보를 넘겨야 하는 비효율적 상황이 발생할 수 있다.

 

정적 내부 클래스 방식(Lazy Holder 기법)

장점

- 싱글톤 클래스에는 정적 내부 클래스의 변수가 없기 때문에 싱글톤 클래스 로딩 시 LazyHolder 클래스를 초기화하지 않는다.

- Class를 로딩하고 초기화하는 시점은 thread-safe를 보장한다.

- 정적내부 클래스의 instance가 static final이기 때문에 클래스 로딩 시점에 한번만 호출된다.

단점

- 리플렉션을 이용한 내부 생성자가 호출 가능하다.

- 역직렬화를 수행될 때 마다 새로운 객체가 생성된다.

 

위에서 보듯 각각의 장단점들이 서로 맞물리게 되므로 환경에 따라 사용하는 것이 좋겠다.

열거 타입 - 직렬화, 안정성이 중요시 되는 환경

Lazy Holder - 성능이 중요시 되는 환경

 

 

출처

https://jobjava00.github.io/language/java/basic/singleton/