학습기록 - private 생성자나 열거 타입으로 싱글턴임을 보증하라

싱글턴(singleton)이란?

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

 

싱글턴의 전형적인 예) 함수와 같은 무상태(stateless) 객체나 설계상 유일해야 하는 시스템 컴포넌트 등

 

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

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

 

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

 

public class Singleton {
    
    public static final Singleton INSTANCE = new Singleton();
    
    private Singleton() {
        // Private constructor to prevent instantiation from outside the class
    }
    
    public void someMethod() {
        // Code for the singleton class's method
    }
    
    // Other methods for the singleton class
    
}

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

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

이 방식의 장점은 해당 클래스가 싱글턴임이 API에 명백히 드러난다는 것이다. 또한, 코드가 간결하다.

 

예외는 단 한가지, 권한이 있는 클라이언트는 리플렉션 API인 AccessibleObject.setAcceessible을 사용해 private 생성자를 호출할 수 있다. 이러한 공격을 방어하려면 생성자를 수정하여 두 번쨰 객체가 생성되려 할 때 예외를 던지게 하면 된다.

 

싱글턴을 만드는 두 번째 방법에서는 정적 팩토리 메서드를 public static 멤버로 제공한다.

 

public class Singleton {
    
    private static Singleton instance;
    
    private Singleton() {
        // Private constructor to prevent instantiation from outside the class
    }
    
    public static Singleton getInstance() {
        if (instance == null) {
            instance = new Singleton();
        }
        return instance;
    }
    
    public void someMethod() {
        // Code for the singleton class's method
    }
    
    // Other methods for the singleton class
    
}​

Singleton.getInstance는 항상 같은 객체의 참조를 반환하므로 제 2의 Singleton 인스턴스는 절대 만들어 지지 않는다. (역시 리플렉션에 대한 예외는 똑같이 적용된다.)

위 방식에는 세 가지 장점이 존재한다.

 

1. API를 바꾸지 않고도 싱글턴이 아니게 변경할 수 있다는 점이다. 유일한 인스턴스를 반환하던 팩토리 메서드가 호출하는 스레드별로 다른 인스턴스를 넘겨주게 할 수 있다.

 

2. 원한다면 정적 팩토리를 제네릭 싱글턴 팩토리로 만들 수 있다는 점이다.

제네릭 싱글턴 팩토리란?

여러 타입의 객체들에 대해 싱글턴 패턴을 구현하는 팩토리 클래스이다.

 

3. 정적 팩토리의 메서드 참조를 공급자(supplier)로 사용할 수 있다는 점이다. 예를 들어, Singleton::getInstance를 Supplier<Singleton>으로 사용하는 식이다. 

 

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

 

둘 중 하나의 방식으로 만든 싱글턴 클래스를 직렬화하려면 단순히 Serializable을 구현한다고 선언하는 것만으로는 부족하다. 모든 인스턴스 필드를 일시적(transient)이라고 선언하고 readResolve 메서드를 제공해야 한다. 그렇지 않으면 직렬화된 인스턴스를 역직렬화할 때마다 새로운 인스턴스가 만들어진다. 새로운 인스턴스가 만들어진다면, 싱글턴을 사용하는 이유가 없다.

 

readResolve란?

readResolve 메서드를 이용하면 readObject 메서드가 만든 인스턴스를 다른 것으로 대체할 수 있다. 이때, readObject가 만들어낸 인스턴스는 가비지 컬렉션의 대상이 된다.

 

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

 

// 싱글턴임을 보장해주는 readResolve 메서드
private Object readResolve(){
	return INSTANCE;
}​

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

public enum Singleton{
	INSTANCE;
    
    public void SomeFunction(){ ... }
}

 

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

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

다만, 만들려는 싱글턴이 Enum외의 클래스를 상속해야 한다면 이 방법은 사용할 수 없다. (열거 타입이 다른 인터페이스를 구현하도록 선언할 수는 있다.)