JAVA/이펙티브 자바

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

간펴니 2023. 6. 10. 15:40
728x90

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

 

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

 

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

 

싱글턴을 만드는 방식은 보통 둘 중 하나다. 두 방식 모두 생성자는 private로 감춰두고 , 유일한 인스턴스에 접근할 수 있는 수단으로

 

public 적정 멤버를 만들어둔다.

 

  •  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!");
    }

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

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

 

public이나 protected 생성자가 없으므로 Elvis 클래스가 초기화될 때 만들어진 인스턴스가 전체 시스템에서 하나뿐임이 보장된다.

 

  • 정적 팩터리 방식의 싱글턴
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는 항상 같은 객체의 참조를 반환한다.

 

정적 팩터리 방식은 원한다면 싱글턴이 아니게 변경 할 수 있다.

 

getInstance()를 new Elvis()로 바꿔주거나, newInstance() 정적팩터리 메서드를 하나 만들어주면 새로운 인스턴스를 생성 할 수도 있다.

 

또, 제네릭 방식을 사용할 수 도 있다.

  • 제네릭 싱글턴 패턴
public class MetaElvis<T> {

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

    private MetaElvis() { }

    @SuppressWarnings("unchecked")
    public static <E> MetaElvis<E> getInstance() { return (MetaElvis<E>) INSTANCE; }

    public void say(T t) {
        System.out.println(t);
    }

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

    public static void main(String[] args) {
        MetaElvis<String> elvis1 = MetaElvis.getInstance();
        MetaElvis<Integer> elvis2 = MetaElvis.getInstance();
        System.out.println(elvis1);
        System.out.println(elvis2);
        elvis1.say("hello");
        elvis2.say(100);
    }

}

static 키워드는 해당 메서드 클래스 수준의 멤버로 선언되었음을 나타낸다.

 

<E>는 제네릭 타입 매개변수를 선언하는 부분이다.

 

이 부분은 메서드 시그니처에서 제네릭 타입을 사용할 수 있도록 해준다.

 

public static <E> MetaElvis<E> getInstance() 의 의미는 다음과 같다.

  • <E>: 제네릭 타입 매개변수로, 메서드 내에서 사용되는 타입을 파라미터화할 수 있도록 한다. E는 임의의 타입 변수 이름이며, 메서드 호출 시 실제 타입으로 대체된다.
  • MetaElvis<E>: 반환 타입으로, MetaElvis 클래스의 제네릭 버전을 나타낸다. E는 메서드 호출 시 전달된 실제 타입으로 대체된다.

따라서 public static <E> MetaElvis<E> getInstance() MetaElvis 클래스의 제네릭 싱글톤 인스턴스를 반환하는 메서드를 선언한 것이다.

 

메서드를 호출할 실제 타입을 명시하여 반환되는 인스턴스의 타입을 결정할 있다.

 

이런 방식으로 만든 싱글턴 클래스를 직렬화하려면 단수누히 Serializeable을 implements 해주는 것으로는 부족하다. 

 

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

 

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

 

 

 

  • 열거타입 방식
public enum Elvis {
    INSTANCE;

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

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

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

 

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

 

단! 만들려는 싱글턴이 Enum 외의 클래스를 상속해야 한다면 이 방법은 사용할 수 없다.

 

그래서 프로젝트 중 싱글턴 패턴을 많이 사용했었는데, enum으로 싱글턴을 구현한 경우는 거의 없었다.

 

 

728x90