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

싱글턴(Singleton)

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

• 함수와 같은 무상태(stateless) 객체
• 설계상 유일해야하는 시스템 컴포넌트

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

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

 

 

싱글턴을 만드는 방식

생성자는 private로 감춰두고, 유일한 인스턴스에 접근할 수 있는 수단으로 public static 멤버를 하나 마련한다.

 

1) public static 멤버가 final 필드

public class Elvis {
    /**
     * 싱글톤 오브젝트
     */
    public static final Elvis INSTANCE = new Elvis();

    /**
     * 해당 클래스에서만 호출 가능
     */
    private Elvis() {
        ...
    }

    public void leaveTheBuilding() {
        ...
    }
}

▶ private 생성자 선언

private Elvis() {
    ...
}

private 생성자는 public static final 필드인 Elvis.INSTANCE를 초기화할때 딱 한번만 호출된다. 

 

예외상황

Elvis 클래스가 초기화될때 만들어진 인스턴스가 전체 시스템에서 하나뿐임이 보장되는데, 이때 단 한가지 예외가 존재한다. 권한이 있는 클라이언트는 리플렉션 API인 AccessibleObject.setAccessible을 사용해 private 생성자를 호출할 수 있다. 

 

이런 경우에는 생성자를 수정하여 두번째 객체가 생성되려 할때 예외를 던지게 하면 된다.

created 변수를 선언하여 최초 한번만 객체가 생성되도록 한다.

public class Elvis implements IElvis, Serializable {

    /**
     * 싱글톤 오브젝트
     */
    public static final Elvis INSTANCE = new Elvis();
    private static boolean created;

    /**
     * 해당 클래스에서만 호출 가능
     */
    private Elvis() {
        if (created) {
            throw new UnsupportedOperationException("can't be created by constructor.");
        }

        created = true;
    }

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

 

▶ 다른 객체 참조 불가능

public static final Elvis INSTANCE = new Elvis();

public static 필드가 final 이므로 절대로 다른 객체를 참조할 수 없다.

 

2) 정적 팩터리 메서드를 public static 멤버로 제공

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

이 방법 역시, 예외적으로 리플렉션을 사용하는 상황을 제외하고 getInstance()에서 항상 같은 객체의 참조를 반환한다.

 

▶  API를 바꾸지 않고도 싱글턴이 아니게 변경할 수 있다.

유일한 인스턴스를 반환하던 팩터리 메서드가 호출하는 스레드별로 다른 인스턴스를 넘겨주게 할 수 있다.

 

▶  정적 팩터리를 제네릭 싱글턴 팩토리로 만들 수 있다.

인프런 '이펙티브 자바 1부' 강의 참고

public class MetaElvis<T> { // scope : 인스턴스

    private static final MetaElvis<Object> INSTANCE = new MetaElvis<>();

    private MetaElvis() { }

    /* 클래스 선언 T가 아니다, E로 바꿔도된다. scope : static */
    @SuppressWarnings("unchecked")
    public static <E> MetaElvis<E> getInstance() {
        return (MetaElvis<E>) INSTANCE;
    }
    
    public static void main(String[] args) {
        /*
        인스턴스는 동일하다.
        각 원하는 타입을 갖는다.
         */
        MetaElvis<String> elvis1 = MetaElvis.getInstance();
        MetaElvis<Integer> elvis2 = MetaElvis.getInstance();
    }

}

 

▶  정적 팩터리의 메서드 참조를 공급자(supplier)로 사용할 수 있다.

인프런 '이펙티브 자바 1부' 강의 참고

public class Concert {
    // 공급자 Supplier (FunctionalInterface)
    public void start(Supplier<Singer> singerSupplier) {
        Singer singer = singerSupplier.get();
        singer.sing();
    }

    public static void main(String[] args) {
        Concert concert = new Concert();
        // T get();
        // getInstance()를 전달가능 : 인스턴스를 리턴하기 때문에 인자로 전달 가능
        concert.start(Elvis::getInstance);
    }
}

 

3) 열거 타입 방식의 싱글턴

public enum Elvis {
    INSTANCE;
    ...
}

1)번의 public 필드 방식과 비슷하지만, 더 간결하고, 추가 노력 없이 직렬화할 수 있고, 직렬화 상황이나 리플렉션 공격에서도 제 2의 인스턴스가 생기는 일을 완벽하게 막아준다. 대부분 상황에서는 원소가 하나뿐인 열거타입이 싱글턴을 만드는 가장 좋은 방법이다. 단, 싱글턴이 Enum 외의 클래스를 상속해야 한다면 이 방법은 사용할 수 없다. (열거 타입이 다른 인터페이스를 구현하도록 선언할 수는 있다.)

 

 

싱글턴 클래스 직렬화

단순히 Serializable을 구현한다고 선언하는 것만으로는 부족하다. 모든 인스턴스 필드를 일시적(transient)이라고 선언하고 readResolve 메서드를 제공해야한다. 이렇게 하지 않으면 직렬화된 인스턴스를 역질렬화할 때마다 새로운 인스턴스가 만들어진다.

 

가짜 Elvis 생성을 막기위해 readResolve 메서드를 추가하자.

private Object readResolve() {
    return INSTANCE;
}